Class: LineBotClient

AcquireChatControlRequest

Inherited from

LineBotClientBase.acquireChatControl

acquireChatControlWithHttpInfo()

acquireChatControlWithHttpInfo(chatId, acquireChatControlRequest?): Promise<ApiResponseType<MessageAPIResponseBase>>

Defined in: lib/line-bot-client.generated.ts:3221

If the Standby Channel wants to take the initiative (Chat Control), it calls the Acquire Control API. The channel that was previously an Active Channel will automatically switch to a Standby Channel. Calls POST https://api.line.me/v2/bot/chat/{chatId}/control/acquire. This method returns the response body together with the underlying httpResponse.

Parameters

chatId

string

The userId, roomId, or groupId

acquireChatControlRequest?

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

A promise resolving to the response body together with the underlying httpResponse.

See

AddAudienceToAudienceGroupRequest

Inherited from

LineBotClientBase.acquireChatControlWithHttpInfo

addAudienceToAudienceGroup()

addAudienceToAudienceGroup(addAudienceToAudienceGroupRequest): Promise<MessageAPIResponseBase>

Defined in: lib/line-bot-client.generated.ts:416

Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by JSON) Calls PUT https://api.line.me/v2/bot/audienceGroup/upload. To inspect the HTTP status code or response headers, use addAudienceToAudienceGroupWithHttpInfo.

Parameters

addAudienceToAudienceGroupRequest

Returns

Promise<MessageAPIResponseBase>

A promise resolving to the response body.

See

AddAudienceToAudienceGroupRequest

Inherited from

LineBotClientBase.addAudienceToAudienceGroup

addAudienceToAudienceGroupWithHttpInfo()

addAudienceToAudienceGroupWithHttpInfo(addAudienceToAudienceGroupRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Defined in: lib/line-bot-client.generated.ts:432

Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by JSON) Calls PUT https://api.line.me/v2/bot/audienceGroup/upload. This method returns the response body together with the underlying httpResponse.

Parameters

addAudienceToAudienceGroupRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.addAudienceToAudienceGroupWithHttpInfo

addLIFFApp()

addLIFFApp(addLiffAppRequest): Promise<AddLiffAppResponse>

Defined in: lib/line-bot-client.generated.ts:294

Adding the LIFF app to a channel Calls POST https://api.line.me/liff/v1/apps. To inspect the HTTP status code or response headers, use addLIFFAppWithHttpInfo.

Parameters

addLiffAppRequest

AddLiffAppRequest

Returns

Promise<AddLiffAppResponse>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.addLIFFApp

addLIFFAppWithHttpInfo()

addLIFFAppWithHttpInfo(addLiffAppRequest): Promise<ApiResponseType<AddLiffAppResponse>>

Defined in: lib/line-bot-client.generated.ts:309

Adding the LIFF app to a channel Calls POST https://api.line.me/liff/v1/apps. This method returns the response body together with the underlying httpResponse.

Parameters

addLiffAppRequest

AddLiffAppRequest

Returns

Promise<ApiResponseType<AddLiffAppResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.addLIFFAppWithHttpInfo

addUserIdsToAudience()

addUserIdsToAudience(file, audienceGroupId?, uploadDescription?): Promise<MessageAPIResponseBase>

Defined in: lib/line-bot-client.generated.ts:808

Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by file). Calls PUT https://api-data.line.me/v2/bot/audienceGroup/upload/byFile. To inspect the HTTP status code or response headers, use addUserIdsToAudienceWithHttpInfo.

Parameters

file

Blob

A text file with one user ID or IFA entered per line. Specify text/plain as Content-Type. Max file number: 1 Max number: 1,500,000

audienceGroupId?

number

The audience ID.

uploadDescription?

string

The description to register with the job

Returns

Promise<MessageAPIResponseBase>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.addUserIdsToAudience

addUserIdsToAudienceWithHttpInfo()

addUserIdsToAudienceWithHttpInfo(file, audienceGroupId?, uploadDescription?): Promise<ApiResponseType<MessageAPIResponseBase>>

Defined in: lib/line-bot-client.generated.ts:830

Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by file). Calls PUT https://api-data.line.me/v2/bot/audienceGroup/upload/byFile. This method returns the response body together with the underlying httpResponse.

Parameters

file

Blob

A text file with one user ID or IFA entered per line. Specify text/plain as Content-Type. Max file number: 1 Max number: 1,500,000

audienceGroupId?

number

The audience ID.

uploadDescription?

string

The description to register with the job

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.addUserIdsToAudienceWithHttpInfo

attachModule()

attachModule(grantType, code, redirectUri, codeVerifier?, clientId?, clientSecret?, region?, basicSearchId?, scope?, brandType?): Promise<AttachModuleResponse>

Defined in: lib/line-bot-client.generated.ts:3338

Attach by operation of the module channel provider Calls POST https://manager.line.biz/module/auth/v1/token. To inspect the HTTP status code or response headers, use attachModuleWithHttpInfo.

Parameters

grantType

string

authorization_code

code

string

Authorization code received from the LINE Platform.

redirectUri

string

Specify the redirect_uri specified in the URL for authentication and authorization.

codeVerifier?

string

Specify when using PKCE (Proof Key for Code Exchange) defined in the OAuth 2.0 extension specification as a countermeasure against authorization code interception attacks.

clientId?

string

Instead of using Authorization header, you can use this parameter to specify the channel ID of the module channel. You can find the channel ID of the module channel in the LINE Developers Console.

clientSecret?

string

Instead of using Authorization header, you can use this parameter to specify the channel secret of the module channel. You can find the channel secret of the module channel in the LINE Developers Console.

region?

string

If you specified a value for region in the URL for authentication and authorization, specify the same value.

basicSearchId?

string

If you specified a value for basic_search_id in the URL for authentication and authorization, specify the same value.

scope?

string

If you specified a value for scope in the URL for authentication and authorization, specify the same value.

brandType?

string

If you specified a value for brand_type in the URL for authentication and authorization, specify the same value.

Returns

Promise<AttachModuleResponse>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.attachModule

attachModuleWithHttpInfo()

attachModuleWithHttpInfo(grantType, code, redirectUri, codeVerifier?, clientId?, clientSecret?, region?, basicSearchId?, scope?, brandType?): Promise<ApiResponseType<AttachModuleResponse>>

Defined in: lib/line-bot-client.generated.ts:3381

Attach by operation of the module channel provider Calls POST https://manager.line.biz/module/auth/v1/token. This method returns the response body together with the underlying httpResponse.

Parameters

grantType

string

authorization_code

code

string

Authorization code received from the LINE Platform.

redirectUri

string

Specify the redirect_uri specified in the URL for authentication and authorization.

codeVerifier?

string

Specify when using PKCE (Proof Key for Code Exchange) defined in the OAuth 2.0 extension specification as a countermeasure against authorization code interception attacks.

clientId?

string

Instead of using Authorization header, you can use this parameter to specify the channel ID of the module channel. You can find the channel ID of the module channel in the LINE Developers Console.

clientSecret?

string

region?

string

If you specified a value for region in the URL for authentication and authorization, specify the same value.

basicSearchId?

string

If you specified a value for basic_search_id in the URL for authentication and authorization, specify the same value.

scope?

string

If you specified a value for scope in the URL for authentication and authorization, specify the same value.

brandType?

string

If you specified a value for brand_type in the URL for authentication and authorization, specify the same value.

Returns

Promise<ApiResponseType<AttachModuleResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.attachModuleWithHttpInfo

broadcast()

broadcast(broadcastRequest, xLineRetryKey?): Promise<object>

Defined in: lib/line-bot-client.generated.ts:903

Sends a message to multiple users at any time. Calls POST https://api.line.me/v2/bot/message/broadcast. To inspect the HTTP status code or response headers, use broadcastWithHttpInfo.

Parameters

broadcastRequest

BroadcastRequest

xLineRetryKey?

string

Retry key. Specifies the UUID in hexadecimal format (e.g., 123e4567-e89b-12d3-a456-426614174000) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.

Returns

Promise<object>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.broadcast

broadcastWithHttpInfo()

broadcastWithHttpInfo(broadcastRequest, xLineRetryKey?): Promise<ApiResponseType<object>>

Defined in: lib/line-bot-client.generated.ts:919

Sends a message to multiple users at any time. Calls POST https://api.line.me/v2/bot/message/broadcast. This method returns the response body together with the underlying httpResponse.

Parameters

broadcastRequest

BroadcastRequest

xLineRetryKey?

string

Returns

Promise<ApiResponseType<object>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.broadcastWithHttpInfo

cancelDefaultRichMenu()

cancelDefaultRichMenu(): Promise<MessageAPIResponseBase>

Defined in: lib/line-bot-client.generated.ts:936

Cancel default rich menu Calls DELETE https://api.line.me/v2/bot/user/all/richmenu. To inspect the HTTP status code or response headers, use cancelDefaultRichMenuWithHttpInfo.

Returns

Promise<MessageAPIResponseBase>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.cancelDefaultRichMenu

cancelDefaultRichMenuWithHttpInfo()

cancelDefaultRichMenuWithHttpInfo(): Promise<ApiResponseType<MessageAPIResponseBase>>

Defined in: lib/line-bot-client.generated.ts:947

Cancel default rich menu Calls DELETE https://api.line.me/v2/bot/user/all/richmenu. This method returns the response body together with the underlying httpResponse.

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.cancelDefaultRichMenuWithHttpInfo

closeCoupon()

closeCoupon(couponId): Promise<MessageAPIResponseBase>

Defined in: lib/line-bot-client.generated.ts:961

Close coupon Calls PUT https://api.line.me/v2/bot/coupon/{couponId}/close. To inspect the HTTP status code or response headers, use closeCouponWithHttpInfo.

Parameters

couponId

string

Returns

Promise<MessageAPIResponseBase>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.closeCoupon

closeCouponWithHttpInfo()

closeCouponWithHttpInfo(couponId): Promise<ApiResponseType<MessageAPIResponseBase>>

Defined in: lib/line-bot-client.generated.ts:975

Close coupon Calls PUT https://api.line.me/v2/bot/coupon/{couponId}/close. This method returns the response body together with the underlying httpResponse.

Parameters

couponId

string

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.closeCouponWithHttpInfo

createAudienceForUploadingUserIds()

createAudienceForUploadingUserIds(file, description?, isIfaAudience?, uploadDescription?): Promise<CreateAudienceGroupResponse>

Defined in: lib/line-bot-client.generated.ts:853

Create audience for uploading user IDs (by file). Calls POST https://api-data.line.me/v2/bot/audienceGroup/upload/byFile. To inspect the HTTP status code or response headers, use createAudienceForUploadingUserIdsWithHttpInfo.

Parameters

file

Blob

A text file with one user ID or IFA entered per line. Specify text/plain as Content-Type. Max file number: 1 Max number: 1,500,000

description?

string

The audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120

isIfaAudience?

boolean

To specify recipients by IFAs: set true. To specify recipients by user IDs: set false or omit isIfaAudience property.

uploadDescription?

string

The description to register for the job (in jobs[].description).

Returns

Promise<CreateAudienceGroupResponse>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.createAudienceForUploadingUserIds

createAudienceForUploadingUserIdsWithHttpInfo()

createAudienceForUploadingUserIdsWithHttpInfo(file, description?, isIfaAudience?, uploadDescription?): Promise<ApiResponseType<CreateAudienceGroupResponse>>

Defined in: lib/line-bot-client.generated.ts:878

Create audience for uploading user IDs (by file). Calls POST https://api-data.line.me/v2/bot/audienceGroup/upload/byFile. This method returns the response body together with the underlying httpResponse.

Parameters

file

Blob

A text file with one user ID or IFA entered per line. Specify text/plain as Content-Type. Max file number: 1 Max number: 1,500,000

description?

string

The audience's name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120

isIfaAudience?

boolean

To specify recipients by IFAs: set true. To specify recipients by user IDs: set false or omit isIfaAudience property.

uploadDescription?

string

The description to register for the job (in jobs[].description).

Returns

Promise<ApiResponseType<CreateAudienceGroupResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

CreateAudienceGroupRequest

Inherited from

LineBotClientBase.createAudienceForUploadingUserIdsWithHttpInfo

createAudienceGroup()

createAudienceGroup(createAudienceGroupRequest): Promise<CreateAudienceGroupResponse>

Defined in: lib/line-bot-client.generated.ts:448

Create audience for uploading user IDs (by JSON) Calls POST https://api.line.me/v2/bot/audienceGroup/upload. To inspect the HTTP status code or response headers, use createAudienceGroupWithHttpInfo.

Parameters

createAudienceGroupRequest

Returns

Promise<CreateAudienceGroupResponse>

A promise resolving to the response body.

See

CreateAudienceGroupRequest

Inherited from

LineBotClientBase.createAudienceGroup

createAudienceGroupWithHttpInfo()

createAudienceGroupWithHttpInfo(createAudienceGroupRequest): Promise<ApiResponseType<CreateAudienceGroupResponse>>

Defined in: lib/line-bot-client.generated.ts:464

Create audience for uploading user IDs (by JSON) Calls POST https://api.line.me/v2/bot/audienceGroup/upload. This method returns the response body together with the underlying httpResponse.

Parameters

createAudienceGroupRequest

Returns

Promise<ApiResponseType<CreateAudienceGroupResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

CreateClickBasedAudienceGroupRequest

Inherited from

LineBotClientBase.createAudienceGroupWithHttpInfo

createClickBasedAudienceGroup()

createClickBasedAudienceGroup(createClickBasedAudienceGroupRequest): Promise<CreateClickBasedAudienceGroupResponse>

Defined in: lib/line-bot-client.generated.ts:482

Create audience for click-based retargeting Calls POST https://api.line.me/v2/bot/audienceGroup/click. To inspect the HTTP status code or response headers, use createClickBasedAudienceGroupWithHttpInfo.

Parameters

createClickBasedAudienceGroupRequest

Returns

Promise<CreateClickBasedAudienceGroupResponse>

A promise resolving to the response body.

See

CreateClickBasedAudienceGroupRequest

Inherited from

LineBotClientBase.createClickBasedAudienceGroup

createClickBasedAudienceGroupWithHttpInfo()

createClickBasedAudienceGroupWithHttpInfo(createClickBasedAudienceGroupRequest): Promise<ApiResponseType<CreateClickBasedAudienceGroupResponse>>

Defined in: lib/line-bot-client.generated.ts:498

Create audience for click-based retargeting Calls POST https://api.line.me/v2/bot/audienceGroup/click. This method returns the response body together with the underlying httpResponse.

Parameters

createClickBasedAudienceGroupRequest

Returns

Promise<ApiResponseType<CreateClickBasedAudienceGroupResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.createClickBasedAudienceGroupWithHttpInfo

createCoupon()

createCoupon(couponCreateRequest?): Promise<CouponCreateResponse>

Defined in: lib/line-bot-client.generated.ts:989

Create a new coupon. Define coupon details such as type, title, and validity period. Calls POST https://api.line.me/v2/bot/coupon. To inspect the HTTP status code or response headers, use createCouponWithHttpInfo.

Parameters

couponCreateRequest?

CouponCreateRequest

Returns

Promise<CouponCreateResponse>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.createCoupon

createCouponWithHttpInfo()

createCouponWithHttpInfo(couponCreateRequest?): Promise<ApiResponseType<CouponCreateResponse>>

Defined in: lib/line-bot-client.generated.ts:1003

Create a new coupon. Define coupon details such as type, title, and validity period. Calls POST https://api.line.me/v2/bot/coupon. This method returns the response body together with the underlying httpResponse.

Parameters

couponCreateRequest?

CouponCreateRequest

Returns

Promise<ApiResponseType<CouponCreateResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

CreateImpBasedAudienceGroupRequest

Inherited from

LineBotClientBase.createCouponWithHttpInfo

createImpBasedAudienceGroup()

createImpBasedAudienceGroup(createImpBasedAudienceGroupRequest): Promise<CreateImpBasedAudienceGroupResponse>

Defined in: lib/line-bot-client.generated.ts:516

Create audience for impression-based retargeting Calls POST https://api.line.me/v2/bot/audienceGroup/imp. To inspect the HTTP status code or response headers, use createImpBasedAudienceGroupWithHttpInfo.

Parameters

createImpBasedAudienceGroupRequest

Returns

Promise<CreateImpBasedAudienceGroupResponse>

A promise resolving to the response body.

See

CreateImpBasedAudienceGroupRequest

Inherited from

LineBotClientBase.createImpBasedAudienceGroup

createImpBasedAudienceGroupWithHttpInfo()

createImpBasedAudienceGroupWithHttpInfo(createImpBasedAudienceGroupRequest): Promise<ApiResponseType<CreateImpBasedAudienceGroupResponse>>

Defined in: lib/line-bot-client.generated.ts:532

Create audience for impression-based retargeting Calls POST https://api.line.me/v2/bot/audienceGroup/imp. This method returns the response body together with the underlying httpResponse.

Parameters

createImpBasedAudienceGroupRequest

Returns

Promise<ApiResponseType<CreateImpBasedAudienceGroupResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.createImpBasedAudienceGroupWithHttpInfo

createRichMenu()

createRichMenu(richMenuRequest): Promise<RichMenuIdResponse>

Defined in: lib/line-bot-client.generated.ts:1019

Create rich menu Calls POST https://api.line.me/v2/bot/richmenu. To inspect the HTTP status code or response headers, use createRichMenuWithHttpInfo.

Parameters

richMenuRequest

Returns

Promise<RichMenuIdResponse>

A promise resolving to the response body.

See

CreateRichMenuAliasRequest

Inherited from

LineBotClientBase.createRichMenu

createRichMenuAlias()

createRichMenuAlias(createRichMenuAliasRequest): Promise<MessageAPIResponseBase>

Defined in: lib/line-bot-client.generated.ts:1049

Create rich menu alias Calls POST https://api.line.me/v2/bot/richmenu/alias. To inspect the HTTP status code or response headers, use createRichMenuAliasWithHttpInfo.

Parameters

createRichMenuAliasRequest

Returns

Promise<MessageAPIResponseBase>

A promise resolving to the response body.

See

CreateRichMenuAliasRequest

Inherited from

LineBotClientBase.createRichMenuAlias

createRichMenuAliasWithHttpInfo()

createRichMenuAliasWithHttpInfo(createRichMenuAliasRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Defined in: lib/line-bot-client.generated.ts:1065

Create rich menu alias Calls POST https://api.line.me/v2/bot/richmenu/alias. This method returns the response body together with the underlying httpResponse.

Parameters

createRichMenuAliasRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.createRichMenuAliasWithHttpInfo

createRichMenuWithHttpInfo()

createRichMenuWithHttpInfo(richMenuRequest): Promise<ApiResponseType<RichMenuIdResponse>>

Defined in: lib/line-bot-client.generated.ts:1033

Create rich menu Calls POST https://api.line.me/v2/bot/richmenu. This method returns the response body together with the underlying httpResponse.

Parameters

richMenuRequest

Returns

Promise<ApiResponseType<RichMenuIdResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.createRichMenuWithHttpInfo

deleteAudienceGroup()

deleteAudienceGroup(audienceGroupId): Promise<MessageAPIResponseBase>

Defined in: lib/line-bot-client.generated.ts:550

Delete audience Calls DELETE https://api.line.me/v2/bot/audienceGroup/{audienceGroupId}. To inspect the HTTP status code or response headers, use deleteAudienceGroupWithHttpInfo.

Parameters

audienceGroupId

number

The audience ID.

Returns

Promise<MessageAPIResponseBase>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.deleteAudienceGroup

deleteAudienceGroupWithHttpInfo()

deleteAudienceGroupWithHttpInfo(audienceGroupId): Promise<ApiResponseType<MessageAPIResponseBase>>

Defined in: lib/line-bot-client.generated.ts:564

Delete audience Calls DELETE https://api.line.me/v2/bot/audienceGroup/{audienceGroupId}. This method returns the response body together with the underlying httpResponse.

Parameters

audienceGroupId

number

The audience ID.

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.deleteAudienceGroupWithHttpInfo

deleteLIFFApp()

deleteLIFFApp(liffId): Promise<MessageAPIResponseBase>

Defined in: lib/line-bot-client.generated.ts:324

Deletes a LIFF app from a channel. Calls DELETE https://api.line.me/liff/v1/apps/{liffId}. To inspect the HTTP status code or response headers, use deleteLIFFAppWithHttpInfo.

Parameters

liffId

string

ID of the LIFF app to be updated

Returns

Promise<MessageAPIResponseBase>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.deleteLIFFApp

deleteLIFFAppWithHttpInfo()

deleteLIFFAppWithHttpInfo(liffId): Promise<ApiResponseType<MessageAPIResponseBase>>

Defined in: lib/line-bot-client.generated.ts:339

Deletes a LIFF app from a channel. Calls DELETE https://api.line.me/liff/v1/apps/{liffId}. This method returns the response body together with the underlying httpResponse.

Parameters

liffId

string

ID of the LIFF app to be updated

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.deleteLIFFAppWithHttpInfo

deleteRichMenu()

deleteRichMenu(richMenuId): Promise<MessageAPIResponseBase>

Defined in: lib/line-bot-client.generated.ts:1081

Deletes a rich menu. Calls DELETE https://api.line.me/v2/bot/richmenu/{richMenuId}. To inspect the HTTP status code or response headers, use deleteRichMenuWithHttpInfo.

Parameters

richMenuId

string

ID of a rich menu

Returns

Promise<MessageAPIResponseBase>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.deleteRichMenu

deleteRichMenuAlias()

deleteRichMenuAlias(richMenuAliasId): Promise<MessageAPIResponseBase>

Defined in: lib/line-bot-client.generated.ts:1109

Delete rich menu alias Calls DELETE https://api.line.me/v2/bot/richmenu/alias/{richMenuAliasId}. To inspect the HTTP status code or response headers, use deleteRichMenuAliasWithHttpInfo.

Parameters

richMenuAliasId

string

Rich menu alias ID that you want to delete.

Returns

Promise<MessageAPIResponseBase>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.deleteRichMenuAlias

deleteRichMenuAliasWithHttpInfo()

deleteRichMenuAliasWithHttpInfo(richMenuAliasId): Promise<ApiResponseType<MessageAPIResponseBase>>

Defined in: lib/line-bot-client.generated.ts:1123

Delete rich menu alias Calls DELETE https://api.line.me/v2/bot/richmenu/alias/{richMenuAliasId}. This method returns the response body together with the underlying httpResponse.

Parameters

richMenuAliasId

string

Rich menu alias ID that you want to delete.

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.deleteRichMenuAliasWithHttpInfo

deleteRichMenuWithHttpInfo()

deleteRichMenuWithHttpInfo(richMenuId): Promise<ApiResponseType<MessageAPIResponseBase>>

Defined in: lib/line-bot-client.generated.ts:1095

Deletes a rich menu. Calls DELETE https://api.line.me/v2/bot/richmenu/{richMenuId}. This method returns the response body together with the underlying httpResponse.

Parameters

richMenuId

string

ID of a rich menu

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.deleteRichMenuWithHttpInfo

detachModule()

detachModule(detachModuleRequest?): Promise<MessageAPIResponseBase>

Defined in: lib/line-bot-client.generated.ts:3239

The module channel admin calls the Detach API to detach the module channel from a LINE Official Account. Calls POST https://api.line.me/v2/bot/channel/detach. To inspect the HTTP status code or response headers, use detachModuleWithHttpInfo.

Parameters

detachModuleRequest?

DetachModuleRequest

Returns

Promise<MessageAPIResponseBase>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.detachModule

detachModuleWithHttpInfo()

detachModuleWithHttpInfo(detachModuleRequest?): Promise<ApiResponseType<MessageAPIResponseBase>>

Defined in: lib/line-bot-client.generated.ts:3253

The module channel admin calls the Detach API to detach the module channel from a LINE Official Account. Calls POST https://api.line.me/v2/bot/channel/detach. This method returns the response body together with the underlying httpResponse.

Parameters

detachModuleRequest?

DetachModuleRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.detachModuleWithHttpInfo

getAggregationUnitNameList()

getAggregationUnitNameList(limit?, start?): Promise<GetAggregationUnitNameListResponse>

Defined in: lib/line-bot-client.generated.ts:1140

Get name list of units used this month Calls GET https://api.line.me/v2/bot/message/aggregation/list. To inspect the HTTP status code or response headers, use getAggregationUnitNameListWithHttpInfo.

Parameters

limit?

string

The maximum number of aggregation units you can get per request.

start?

string

Value of the continuation token found in the next property of the JSON object returned in the response. If you can't get all the aggregation units in one request, include this parameter to get the remaining array.

Returns

Promise<GetAggregationUnitNameListResponse>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.getAggregationUnitNameList

getAggregationUnitNameListWithHttpInfo()

getAggregationUnitNameListWithHttpInfo(limit?, start?): Promise<ApiResponseType<GetAggregationUnitNameListResponse>>

Defined in: lib/line-bot-client.generated.ts:1156

Get name list of units used this month Calls GET https://api.line.me/v2/bot/message/aggregation/list. This method returns the response body together with the underlying httpResponse.

Parameters

limit?

string

The maximum number of aggregation units you can get per request.

start?

string

Returns

Promise<ApiResponseType<GetAggregationUnitNameListResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.getAggregationUnitNameListWithHttpInfo

getAggregationUnitUsage()

getAggregationUnitUsage(): Promise<GetAggregationUnitUsageResponse>

Defined in: lib/line-bot-client.generated.ts:1175

Get number of units used this month Calls GET https://api.line.me/v2/bot/message/aggregation/info. To inspect the HTTP status code or response headers, use getAggregationUnitUsageWithHttpInfo.

Returns

Promise<GetAggregationUnitUsageResponse>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.getAggregationUnitUsage

getAggregationUnitUsageWithHttpInfo()

getAggregationUnitUsageWithHttpInfo(): Promise<ApiResponseType<GetAggregationUnitUsageResponse>>

Defined in: lib/line-bot-client.generated.ts:1186

Get number of units used this month Calls GET https://api.line.me/v2/bot/message/aggregation/info. This method returns the response body together with the underlying httpResponse.

Returns

Promise<ApiResponseType<GetAggregationUnitUsageResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.getAggregationUnitUsageWithHttpInfo

getAllLIFFApps()

getAllLIFFApps(): Promise<GetAllLiffAppsResponse>

Defined in: lib/line-bot-client.generated.ts:353

Gets information on all the LIFF apps added to the channel. Calls GET https://api.line.me/liff/v1/apps. To inspect the HTTP status code or response headers, use getAllLIFFAppsWithHttpInfo.

Returns

Promise<GetAllLiffAppsResponse>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.getAllLIFFApps

getAllLIFFAppsWithHttpInfo()

getAllLIFFAppsWithHttpInfo(): Promise<ApiResponseType<GetAllLiffAppsResponse>>

Defined in: lib/line-bot-client.generated.ts:365

Gets information on all the LIFF apps added to the channel. Calls GET https://api.line.me/liff/v1/apps. This method returns the response body together with the underlying httpResponse.

Returns

Promise<ApiResponseType<GetAllLiffAppsResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.getAllLIFFAppsWithHttpInfo

getAudienceData()

getAudienceData(audienceGroupId): Promise<GetAudienceDataResponse>

Defined in: lib/line-bot-client.generated.ts:580

Gets audience data. Calls GET https://api.line.me/v2/bot/audienceGroup/{audienceGroupId}. To inspect the HTTP status code or response headers, use getAudienceDataWithHttpInfo.

Parameters

audienceGroupId

number

The audience ID.

Returns

Promise<GetAudienceDataResponse>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.getAudienceData

getAudienceDataWithHttpInfo()

getAudienceDataWithHttpInfo(audienceGroupId): Promise<ApiResponseType<GetAudienceDataResponse>>

Defined in: lib/line-bot-client.generated.ts:594

Gets audience data. Calls GET https://api.line.me/v2/bot/audienceGroup/{audienceGroupId}. This method returns the response body together with the underlying httpResponse.

Parameters

audienceGroupId

number

The audience ID.

Returns

Promise<ApiResponseType<GetAudienceDataResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.getAudienceDataWithHttpInfo

getAudienceGroups()

getAudienceGroups(page, description?, status?, size?, includesExternalPublicGroups?, createRoute?): Promise<GetAudienceGroupsResponse>

Defined in: lib/line-bot-client.generated.ts:615

Gets data for more than one audience. Calls GET https://api.line.me/v2/bot/audienceGroup/list. To inspect the HTTP status code or response headers, use getAudienceGroupsWithHttpInfo.

Parameters

page

number

The page to return when getting (paginated) results. Must be 1 or higher.

description?

string

The name of the audience(s) to return. You can search for partial matches. This is case-insensitive, meaning AUDIENCE and audience are considered identical. If omitted, the name of the audience(s) will not be used as a search criterion.

status?

The status of the audience(s) to return. If omitted, the status of the audience(s) will not be used as a search criterion.

size?

number

The number of audiences per page. Default: 20 Max: 40

includesExternalPublicGroups?

boolean

true (default): Get public audiences created in all channels linked to the same bot. false: Get audiences created in the same channel.

createRoute?

How the audience was created. If omitted, all audiences are included. OA_MANAGER: Return only audiences created with LINE Official Account Manager (opens new window). MESSAGING_API: Return only audiences created with Messaging API.

Returns

Promise<GetAudienceGroupsResponse>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.getAudienceGroups

getAudienceGroupsWithHttpInfo()

getAudienceGroupsWithHttpInfo(page, description?, status?, size?, includesExternalPublicGroups?, createRoute?): Promise<ApiResponseType<GetAudienceGroupsResponse>>

Defined in: lib/line-bot-client.generated.ts:646

Gets data for more than one audience. Calls GET https://api.line.me/v2/bot/audienceGroup/list. This method returns the response body together with the underlying httpResponse.

Parameters

page

number

The page to return when getting (paginated) results. Must be 1 or higher.

description?

string

status?

The status of the audience(s) to return. If omitted, the status of the audience(s) will not be used as a search criterion.

size?

number

The number of audiences per page. Default: 20 Max: 40

includesExternalPublicGroups?

boolean

true (default): Get public audiences created in all channels linked to the same bot. false: Get audiences created in the same channel.

createRoute?

Returns

Promise<ApiResponseType<GetAudienceGroupsResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.getAudienceGroupsWithHttpInfo

getBotInfo()

getBotInfo(): Promise<BotInfoResponse>

Defined in: lib/line-bot-client.generated.ts:1199

Get bot info Calls GET https://api.line.me/v2/bot/info. To inspect the HTTP status code or response headers, use getBotInfoWithHttpInfo.

Returns

Promise<BotInfoResponse>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.getBotInfo

getBotInfoWithHttpInfo()

getBotInfoWithHttpInfo(): Promise<ApiResponseType<BotInfoResponse>>

Defined in: lib/line-bot-client.generated.ts:1210

Get bot info Calls GET https://api.line.me/v2/bot/info. This method returns the response body together with the underlying httpResponse.

Returns

Promise<ApiResponseType<BotInfoResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.getBotInfoWithHttpInfo

getCouponDetail()

getCouponDetail(couponId): Promise<CouponResponse>

Defined in: lib/line-bot-client.generated.ts:1224

Get coupon detail Calls GET https://api.line.me/v2/bot/coupon/{couponId}. To inspect the HTTP status code or response headers, use getCouponDetailWithHttpInfo.

Parameters

couponId

string

Returns

Promise<CouponResponse>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.getCouponDetail

getCouponDetailWithHttpInfo()

getCouponDetailWithHttpInfo(couponId): Promise<ApiResponseType<CouponResponse>>

Defined in: lib/line-bot-client.generated.ts:1238

Get coupon detail Calls GET https://api.line.me/v2/bot/coupon/{couponId}. This method returns the response body together with the underlying httpResponse.

Parameters

couponId

string

Returns

Promise<ApiResponseType<CouponResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.getCouponDetailWithHttpInfo

getDefaultRichMenuId()

getDefaultRichMenuId(): Promise<RichMenuIdResponse>

Defined in: lib/line-bot-client.generated.ts:1251

Gets the ID of the default rich menu set with the Messaging API. Calls GET https://api.line.me/v2/bot/user/all/richmenu. To inspect the HTTP status code or response headers, use getDefaultRichMenuIdWithHttpInfo.

Returns

Promise<RichMenuIdResponse>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.getDefaultRichMenuId

getDefaultRichMenuIdWithHttpInfo()

getDefaultRichMenuIdWithHttpInfo(): Promise<ApiResponseType<RichMenuIdResponse>>

Defined in: lib/line-bot-client.generated.ts:1262

Gets the ID of the default rich menu set with the Messaging API. Calls GET https://api.line.me/v2/bot/user/all/richmenu. This method returns the response body together with the underlying httpResponse.

Returns

Promise<ApiResponseType<RichMenuIdResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.getDefaultRichMenuIdWithHttpInfo

getFollowers()

getFollowers(start?, limit?): Promise<GetFollowersResponse>

Defined in: lib/line-bot-client.generated.ts:1277

Get a list of users who added your LINE Official Account as a friend Calls GET https://api.line.me/v2/bot/followers/ids. To inspect the HTTP status code or response headers, use getFollowersWithHttpInfo.

Parameters

start?

string

Value of the continuation token found in the next property of the JSON object returned in the response. Include this parameter to get the next array of user IDs.

limit?

number

The maximum number of user IDs to retrieve in a single request.

Returns

Promise<GetFollowersResponse>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.getFollowers

getFollowersWithHttpInfo()

getFollowersWithHttpInfo(start?, limit?): Promise<ApiResponseType<GetFollowersResponse>>

Defined in: lib/line-bot-client.generated.ts:1293

Get a list of users who added your LINE Official Account as a friend Calls GET https://api.line.me/v2/bot/followers/ids. This method returns the response body together with the underlying httpResponse.

Parameters

start?

string

Value of the continuation token found in the next property of the JSON object returned in the response. Include this parameter to get the next array of user IDs.

limit?

number

The maximum number of user IDs to retrieve in a single request.

Returns

Promise<ApiResponseType<GetFollowersResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.getFollowersWithHttpInfo

getFriendsDemographics()

getFriendsDemographics(): Promise<GetFriendsDemographicsResponse>

Defined in: lib/line-bot-client.generated.ts:48

Retrieves the demographic attributes for a LINE Official Account's friends.You can only retrieve information about friends for LINE Official Accounts created by users in Japan (JP), Thailand (TH), Taiwan (TW) and Indonesia (ID). Calls GET https://api.line.me/v2/bot/insight/demographic. To inspect the HTTP status code or response headers, use getFriendsDemographicsWithHttpInfo.

Returns

Promise<GetFriendsDemographicsResponse>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.getFriendsDemographics

getFriendsDemographicsWithHttpInfo()

getFriendsDemographicsWithHttpInfo(): Promise<ApiResponseType<GetFriendsDemographicsResponse>>

Defined in: lib/line-bot-client.generated.ts:59

Retrieves the demographic attributes for a LINE Official Account's friends.You can only retrieve information about friends for LINE Official Accounts created by users in Japan (JP), Thailand (TH), Taiwan (TW) and Indonesia (ID). Calls GET https://api.line.me/v2/bot/insight/demographic. This method returns the response body together with the underlying httpResponse.

Returns

Promise<ApiResponseType<GetFriendsDemographicsResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.getFriendsDemographicsWithHttpInfo

getGroupMemberCount()

getGroupMemberCount(groupId): Promise<GroupMemberCountResponse>

Defined in: lib/line-bot-client.generated.ts:1308

Get number of users in a group chat Calls GET https://api.line.me/v2/bot/group/{groupId}/members/count. To inspect the HTTP status code or response headers, use getGroupMemberCountWithHttpInfo.

Parameters

groupId

string

Group ID

Returns

Promise<GroupMemberCountResponse>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.getGroupMemberCount

getGroupMemberCountWithHttpInfo()

getGroupMemberCountWithHttpInfo(groupId): Promise<ApiResponseType<GroupMemberCountResponse>>

Defined in: lib/line-bot-client.generated.ts:1322

Get number of users in a group chat Calls GET https://api.line.me/v2/bot/group/{groupId}/members/count. This method returns the response body together with the underlying httpResponse.

Parameters

groupId

string

Group ID

Returns

Promise<ApiResponseType<GroupMemberCountResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.getGroupMemberCountWithHttpInfo

getGroupMemberProfile()

getGroupMemberProfile(groupId, userId): Promise<GroupUserProfileResponse>

Defined in: lib/line-bot-client.generated.ts:1337

Get group chat member profile Calls GET https://api.line.me/v2/bot/group/{groupId}/member/{userId}. To inspect the HTTP status code or response headers, use getGroupMemberProfileWithHttpInfo.

Parameters

groupId

string

Group ID

userId

string

User ID

Returns

Promise<GroupUserProfileResponse>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.getGroupMemberProfile

getGroupMemberProfileWithHttpInfo()

getGroupMemberProfileWithHttpInfo(groupId, userId): Promise<ApiResponseType<GroupUserProfileResponse>>

Defined in: lib/line-bot-client.generated.ts:1353

Get group chat member profile Calls GET https://api.line.me/v2/bot/group/{groupId}/member/{userId}. This method returns the response body together with the underlying httpResponse.

Parameters

groupId

string

Group ID

userId

string

User ID

Returns

Promise<ApiResponseType<GroupUserProfileResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.getGroupMemberProfileWithHttpInfo

getGroupMembersIds()

getGroupMembersIds(groupId, start?): Promise<MembersIdsResponse>

Defined in: lib/line-bot-client.generated.ts:1372

Get group chat member user IDs Calls GET https://api.line.me/v2/bot/group/{groupId}/members/ids. To inspect the HTTP status code or response headers, use getGroupMembersIdsWithHttpInfo.

Parameters

groupId

string

Group ID

start?

string

Value of the continuation token found in the next property of the JSON object returned in the response. Include this parameter to get the next array of user IDs for the members of the group.

Returns

Promise<MembersIdsResponse>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.getGroupMembersIds

getGroupMembersIdsWithHttpInfo()

getGroupMembersIdsWithHttpInfo(groupId, start?): Promise<ApiResponseType<MembersIdsResponse>>

Defined in: lib/line-bot-client.generated.ts:1388

Get group chat member user IDs Calls GET https://api.line.me/v2/bot/group/{groupId}/members/ids. This method returns the response body together with the underlying httpResponse.

Parameters

groupId

string

Group ID

start?

string

Value of the continuation token found in the next property of the JSON object returned in the response. Include this parameter to get the next array of user IDs for the members of the group.

Returns

Promise<ApiResponseType<MembersIdsResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.getGroupMembersIdsWithHttpInfo

getGroupSummary()

getGroupSummary(groupId): Promise<GroupSummaryResponse>

Defined in: lib/line-bot-client.generated.ts:1406

Get group chat summary Calls GET https://api.line.me/v2/bot/group/{groupId}/summary. To inspect the HTTP status code or response headers, use getGroupSummaryWithHttpInfo.

Parameters

groupId

string

Group ID

Returns

Promise<GroupSummaryResponse>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.getGroupSummary

getGroupSummaryWithHttpInfo()

getGroupSummaryWithHttpInfo(groupId): Promise<ApiResponseType<GroupSummaryResponse>>

Defined in: lib/line-bot-client.generated.ts:1420

Get group chat summary Calls GET https://api.line.me/v2/bot/group/{groupId}/summary. This method returns the response body together with the underlying httpResponse.

Parameters

groupId

string

Group ID

Returns

Promise<ApiResponseType<GroupSummaryResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.getGroupSummaryWithHttpInfo

getJoinedMembershipUsers()

getJoinedMembershipUsers(membershipId, start?, limit?): Promise<GetJoinedMembershipUsersResponse>

Defined in: lib/line-bot-client.generated.ts:1436

Get a list of user IDs who joined the membership. Calls GET https://api.line.me/v2/bot/membership/{membershipId}/users/ids. To inspect the HTTP status code or response headers, use getJoinedMembershipUsersWithHttpInfo.

Parameters

membershipId

number

Membership plan ID.

start?

string

A continuation token to get next remaining membership user IDs. Returned only when there are remaining user IDs that weren't returned in the userIds property in the previous request. The continuation token expires in 24 hours (86,400 seconds).

limit?

number

The max number of items to return for this API call. The value is set to 300 by default, but the max acceptable value is 1000.

Returns

Promise<GetJoinedMembershipUsersResponse>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.getJoinedMembershipUsers

getJoinedMembershipUsersWithHttpInfo()

getJoinedMembershipUsersWithHttpInfo(membershipId, start?, limit?): Promise<ApiResponseType<GetJoinedMembershipUsersResponse>>

Defined in: lib/line-bot-client.generated.ts:1458

Get a list of user IDs who joined the membership. Calls GET https://api.line.me/v2/bot/membership/{membershipId}/users/ids. This method returns the response body together with the underlying httpResponse.

Parameters

membershipId

number

Membership plan ID.

start?

string

limit?

number

The max number of items to return for this API call. The value is set to 300 by default, but the max acceptable value is 1000.

Returns

Promise<ApiResponseType<GetJoinedMembershipUsersResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.getJoinedMembershipUsersWithHttpInfo

getMembershipList()

getMembershipList(): Promise<MembershipListResponse>

Defined in: lib/line-bot-client.generated.ts:1479

Get a list of memberships. Calls GET https://api.line.me/v2/bot/membership/list. To inspect the HTTP status code or response headers, use getMembershipListWithHttpInfo.

Returns

Promise<MembershipListResponse>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.getMembershipList

getMembershipListWithHttpInfo()

getMembershipListWithHttpInfo(): Promise<ApiResponseType<MembershipListResponse>>

Defined in: lib/line-bot-client.generated.ts:1490

Get a list of memberships. Calls GET https://api.line.me/v2/bot/membership/list. This method returns the response body together with the underlying httpResponse.

Returns

Promise<ApiResponseType<MembershipListResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.getMembershipListWithHttpInfo

getMembershipSubscription()

getMembershipSubscription(userId): Promise<GetMembershipSubscriptionResponse>

Defined in: lib/line-bot-client.generated.ts:1504

Get a user's membership subscription. Calls GET https://api.line.me/v2/bot/membership/subscription/{userId}. To inspect the HTTP status code or response headers, use getMembershipSubscriptionWithHttpInfo.

Parameters

userId

string

User ID

Returns

Promise<GetMembershipSubscriptionResponse>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.getMembershipSubscription

getMembershipSubscriptionWithHttpInfo()

getMembershipSubscriptionWithHttpInfo(userId): Promise<ApiResponseType<GetMembershipSubscriptionResponse>>

Defined in: lib/line-bot-client.generated.ts:1518

Get a user's membership subscription. Calls GET https://api.line.me/v2/bot/membership/subscription/{userId}. This method returns the response body together with the underlying httpResponse.

Parameters

userId

string

User ID

Returns

Promise<ApiResponseType<GetMembershipSubscriptionResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.getMembershipSubscriptionWithHttpInfo

getMessageContent()

getMessageContent(messageId): Promise<Readable>

Defined in: lib/line-bot-client.generated.ts:3048

Download image, video, and audio data sent from users. Calls GET https://api-data.line.me/v2/bot/message/{messageId}/content. To inspect the HTTP status code or response headers, use getMessageContentWithHttpInfo.

Parameters

messageId

string

Message ID of video or audio

Returns

Promise<Readable>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.getMessageContent

getMessageContentPreview()

getMessageContentPreview(messageId): Promise<Readable>

Defined in: lib/line-bot-client.generated.ts:3076

Get a preview image of the image or video Calls GET https://api-data.line.me/v2/bot/message/{messageId}/content/preview. To inspect the HTTP status code or response headers, use getMessageContentPreviewWithHttpInfo.

Parameters

messageId

string

Message ID of image or video

Returns

Promise<Readable>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.getMessageContentPreview

getMessageContentPreviewWithHttpInfo()

getMessageContentPreviewWithHttpInfo(messageId): Promise<ApiResponseType<Readable>>

Defined in: lib/line-bot-client.generated.ts:3088

Get a preview image of the image or video Calls GET https://api-data.line.me/v2/bot/message/{messageId}/content/preview. This method returns the response body together with the underlying httpResponse.

Parameters

messageId

string

Message ID of image or video

Returns

Promise<ApiResponseType<Readable>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.getMessageContentPreviewWithHttpInfo

getMessageContentTranscodingByMessageId()

getMessageContentTranscodingByMessageId(messageId): Promise<GetMessageContentTranscodingResponse>

Defined in: lib/line-bot-client.generated.ts:3104

Verify the preparation status of a video or audio for getting Calls GET https://api-data.line.me/v2/bot/message/{messageId}/content/transcoding. To inspect the HTTP status code or response headers, use getMessageContentTranscodingByMessageIdWithHttpInfo.

Parameters

messageId

string

Message ID of video or audio

Returns

Promise<GetMessageContentTranscodingResponse>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.getMessageContentTranscodingByMessageId

getMessageContentTranscodingByMessageIdWithHttpInfo()

getMessageContentTranscodingByMessageIdWithHttpInfo(messageId): Promise<ApiResponseType<GetMessageContentTranscodingResponse>>

Defined in: lib/line-bot-client.generated.ts:3120

Verify the preparation status of a video or audio for getting Calls GET https://api-data.line.me/v2/bot/message/{messageId}/content/transcoding. This method returns the response body together with the underlying httpResponse.

Parameters

messageId

string

Message ID of video or audio

Returns

Promise<ApiResponseType<GetMessageContentTranscodingResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.getMessageContentTranscodingByMessageIdWithHttpInfo

getMessageContentWithHttpInfo()

getMessageContentWithHttpInfo(messageId): Promise<ApiResponseType<Readable>>

Defined in: lib/line-bot-client.generated.ts:3060

Download image, video, and audio data sent from users. Calls GET https://api-data.line.me/v2/bot/message/{messageId}/content. This method returns the response body together with the underlying httpResponse.

Parameters

messageId

string

Message ID of video or audio

Returns

Promise<ApiResponseType<Readable>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.getMessageContentWithHttpInfo

getMessageEvent()

getMessageEvent(requestId): Promise<GetMessageEventResponse>

Defined in: lib/line-bot-client.generated.ts:74

Returns statistics about how users interact with narrowcast messages or broadcast messages sent from your LINE Official Account. Calls GET https://api.line.me/v2/bot/insight/message/event. To inspect the HTTP status code or response headers, use getMessageEventWithHttpInfo.

Parameters

requestId

string

Request ID of a narrowcast message or broadcast message. Each Messaging API request has a request ID.

Returns

Promise<GetMessageEventResponse>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.getMessageEvent

getMessageEventWithHttpInfo()

getMessageEventWithHttpInfo(requestId): Promise<ApiResponseType<GetMessageEventResponse>>

Defined in: lib/line-bot-client.generated.ts:89

Returns statistics about how users interact with narrowcast messages or broadcast messages sent from your LINE Official Account. Calls GET https://api.line.me/v2/bot/insight/message/event. This method returns the response body together with the underlying httpResponse.

Parameters

requestId

string

Request ID of a narrowcast message or broadcast message. Each Messaging API request has a request ID.

Returns

Promise<ApiResponseType<GetMessageEventResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.getMessageEventWithHttpInfo

getMessageQuota()

getMessageQuota(): Promise<MessageQuotaResponse>

Defined in: lib/line-bot-client.generated.ts:1535

Gets the target limit for sending messages in the current month. The total number of the free messages and the additional messages is returned. Calls GET https://api.line.me/v2/bot/message/quota. To inspect the HTTP status code or response headers, use getMessageQuotaWithHttpInfo.

Returns

Promise<MessageQuotaResponse>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.getMessageQuota

getMessageQuotaConsumption()

getMessageQuotaConsumption(): Promise<QuotaConsumptionResponse>

Defined in: lib/line-bot-client.generated.ts:1559

Gets the number of messages sent in the current month. Calls GET https://api.line.me/v2/bot/message/quota/consumption. To inspect the HTTP status code or response headers, use getMessageQuotaConsumptionWithHttpInfo.

Returns

Promise<QuotaConsumptionResponse>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.getMessageQuotaConsumption

getMessageQuotaConsumptionWithHttpInfo()

getMessageQuotaConsumptionWithHttpInfo(): Promise<ApiResponseType<QuotaConsumptionResponse>>

Defined in: lib/line-bot-client.generated.ts:1570

Gets the number of messages sent in the current month. Calls GET https://api.line.me/v2/bot/message/quota/consumption. This method returns the response body together with the underlying httpResponse.

Returns

Promise<ApiResponseType<QuotaConsumptionResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.getMessageQuotaConsumptionWithHttpInfo

getMessageQuotaWithHttpInfo()

getMessageQuotaWithHttpInfo(): Promise<ApiResponseType<MessageQuotaResponse>>

Defined in: lib/line-bot-client.generated.ts:1546

Gets the target limit for sending messages in the current month. The total number of the free messages and the additional messages is returned. Calls GET https://api.line.me/v2/bot/message/quota. This method returns the response body together with the underlying httpResponse.

Returns

Promise<ApiResponseType<MessageQuotaResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.getMessageQuotaWithHttpInfo

getModules()

getModules(start?, limit?): Promise<GetModulesResponse>

Defined in: lib/line-bot-client.generated.ts:3270

Gets a list of basic information about the bots of multiple LINE Official Accounts that have attached module channels. Calls GET https://api.line.me/v2/bot/list. To inspect the HTTP status code or response headers, use getModulesWithHttpInfo.

Parameters

start?

string

Value of the continuation token found in the next property of the JSON object returned in the response. If you can't get all basic information about the bots in one request, include this parameter to get the remaining array.

limit?

number

Specify the maximum number of bots that you get basic information from. The default value is 100. Max value: 100

Returns

Promise<GetModulesResponse>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.getModules

getModulesWithHttpInfo()

getModulesWithHttpInfo(start?, limit?): Promise<ApiResponseType<GetModulesResponse>>

Defined in: lib/line-bot-client.generated.ts:3286

Gets a list of basic information about the bots of multiple LINE Official Accounts that have attached module channels. Calls GET https://api.line.me/v2/bot/list. This method returns the response body together with the underlying httpResponse.

Parameters

start?

string

limit?

number

Specify the maximum number of bots that you get basic information from. The default value is 100. Max value: 100

Returns

Promise<ApiResponseType<GetModulesResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.getModulesWithHttpInfo

getNarrowcastProgress()

getNarrowcastProgress(requestId): Promise<NarrowcastProgressResponse>

Defined in: lib/line-bot-client.generated.ts:1584

Gets the status of a narrowcast message. Calls GET https://api.line.me/v2/bot/message/progress/narrowcast. To inspect the HTTP status code or response headers, use getNarrowcastProgressWithHttpInfo.

Parameters

requestId

string

The narrowcast message's request ID. Each Messaging API request has a request ID.

Returns

Promise<NarrowcastProgressResponse>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.getNarrowcastProgress

getNarrowcastProgressWithHttpInfo()

getNarrowcastProgressWithHttpInfo(requestId): Promise<ApiResponseType<NarrowcastProgressResponse>>

Defined in: lib/line-bot-client.generated.ts:1598

Gets the status of a narrowcast message. Calls GET https://api.line.me/v2/bot/message/progress/narrowcast. This method returns the response body together with the underlying httpResponse.

Parameters

requestId

string

The narrowcast message's request ID. Each Messaging API request has a request ID.

Returns

Promise<ApiResponseType<NarrowcastProgressResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.getNarrowcastProgressWithHttpInfo

getNumberOfFollowers()

getNumberOfFollowers(date?): Promise<GetNumberOfFollowersResponse>

Defined in: lib/line-bot-client.generated.ts:104

Returns the number of users who have added the LINE Official Account on or before a specified date. Calls GET https://api.line.me/v2/bot/insight/followers. To inspect the HTTP status code or response headers, use getNumberOfFollowersWithHttpInfo.

Parameters

date?

string

Date for which to retrieve the number of followers. Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns

Promise<GetNumberOfFollowersResponse>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.getNumberOfFollowers

getNumberOfFollowersWithHttpInfo()

getNumberOfFollowersWithHttpInfo(date?): Promise<ApiResponseType<GetNumberOfFollowersResponse>>

Defined in: lib/line-bot-client.generated.ts:119

Returns the number of users who have added the LINE Official Account on or before a specified date. Calls GET https://api.line.me/v2/bot/insight/followers. This method returns the response body together with the underlying httpResponse.

Parameters

date?

string

Date for which to retrieve the number of followers. Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns

Promise<ApiResponseType<GetNumberOfFollowersResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.getNumberOfFollowersWithHttpInfo

getNumberOfMessageDeliveries()

getNumberOfMessageDeliveries(date): Promise<GetNumberOfMessageDeliveriesResponse>

Defined in: lib/line-bot-client.generated.ts:134

Returns the number of messages sent from LINE Official Account on a specified day. Calls GET https://api.line.me/v2/bot/insight/message/delivery. To inspect the HTTP status code or response headers, use getNumberOfMessageDeliveriesWithHttpInfo.

Parameters

date

string

Date for which to retrieve number of sent messages. - Format: yyyyMMdd (e.g. 20191231) - Timezone: UTC+9

Returns

Promise<GetNumberOfMessageDeliveriesResponse>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.getNumberOfMessageDeliveries

getNumberOfMessageDeliveriesWithHttpInfo()

getNumberOfMessageDeliveriesWithHttpInfo(date): Promise<ApiResponseType<GetNumberOfMessageDeliveriesResponse>>

Defined in: lib/line-bot-client.generated.ts:149

Returns the number of messages sent from LINE Official Account on a specified day. Calls GET https://api.line.me/v2/bot/insight/message/delivery. This method returns the response body together with the underlying httpResponse.

Parameters

date

string

Date for which to retrieve number of sent messages. - Format: yyyyMMdd (e.g. 20191231) - Timezone: UTC+9

Returns

Promise<ApiResponseType<GetNumberOfMessageDeliveriesResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.getNumberOfMessageDeliveriesWithHttpInfo

getNumberOfSentBroadcastMessages()

getNumberOfSentBroadcastMessages(date): Promise<NumberOfMessagesResponse>

Defined in: lib/line-bot-client.generated.ts:1614

Get number of sent broadcast messages Calls GET https://api.line.me/v2/bot/message/delivery/broadcast. To inspect the HTTP status code or response headers, use getNumberOfSentBroadcastMessagesWithHttpInfo.

Parameters

date

string

Date the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.getNumberOfSentBroadcastMessages

getNumberOfSentBroadcastMessagesWithHttpInfo()

getNumberOfSentBroadcastMessagesWithHttpInfo(date): Promise<ApiResponseType<NumberOfMessagesResponse>>

Defined in: lib/line-bot-client.generated.ts:1628

Get number of sent broadcast messages Calls GET https://api.line.me/v2/bot/message/delivery/broadcast. This method returns the response body together with the underlying httpResponse.

Parameters

date

string

Date the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns

Promise<ApiResponseType<NumberOfMessagesResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.getNumberOfSentBroadcastMessagesWithHttpInfo

getNumberOfSentMulticastMessages()

getNumberOfSentMulticastMessages(date): Promise<NumberOfMessagesResponse>

Defined in: lib/line-bot-client.generated.ts:1644

Get number of sent multicast messages Calls GET https://api.line.me/v2/bot/message/delivery/multicast. To inspect the HTTP status code or response headers, use getNumberOfSentMulticastMessagesWithHttpInfo.

Parameters

date

string

Date the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.getNumberOfSentMulticastMessages

getNumberOfSentMulticastMessagesWithHttpInfo()

getNumberOfSentMulticastMessagesWithHttpInfo(date): Promise<ApiResponseType<NumberOfMessagesResponse>>

Defined in: lib/line-bot-client.generated.ts:1658

Get number of sent multicast messages Calls GET https://api.line.me/v2/bot/message/delivery/multicast. This method returns the response body together with the underlying httpResponse.

Parameters

date

string

Date the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns

Promise<ApiResponseType<NumberOfMessagesResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.getNumberOfSentMulticastMessagesWithHttpInfo

getNumberOfSentPushMessages()

getNumberOfSentPushMessages(date): Promise<NumberOfMessagesResponse>

Defined in: lib/line-bot-client.generated.ts:1674

Get number of sent push messages Calls GET https://api.line.me/v2/bot/message/delivery/push. To inspect the HTTP status code or response headers, use getNumberOfSentPushMessagesWithHttpInfo.

Parameters

date

string

Date the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.getNumberOfSentPushMessages

getNumberOfSentPushMessagesWithHttpInfo()

getNumberOfSentPushMessagesWithHttpInfo(date): Promise<ApiResponseType<NumberOfMessagesResponse>>

Defined in: lib/line-bot-client.generated.ts:1688

Get number of sent push messages Calls GET https://api.line.me/v2/bot/message/delivery/push. This method returns the response body together with the underlying httpResponse.

Parameters

date

string

Date the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns

Promise<ApiResponseType<NumberOfMessagesResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.getNumberOfSentPushMessagesWithHttpInfo

getNumberOfSentReplyMessages()

getNumberOfSentReplyMessages(date): Promise<NumberOfMessagesResponse>

Defined in: lib/line-bot-client.generated.ts:1704

Get number of sent reply messages Calls GET https://api.line.me/v2/bot/message/delivery/reply. To inspect the HTTP status code or response headers, use getNumberOfSentReplyMessagesWithHttpInfo.

Parameters

date

string

Date the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.getNumberOfSentReplyMessages

getNumberOfSentReplyMessagesWithHttpInfo()

getNumberOfSentReplyMessagesWithHttpInfo(date): Promise<ApiResponseType<NumberOfMessagesResponse>>

Defined in: lib/line-bot-client.generated.ts:1718

Get number of sent reply messages Calls GET https://api.line.me/v2/bot/message/delivery/reply. This method returns the response body together with the underlying httpResponse.

Parameters

date

string

Date the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9

Returns

Promise<ApiResponseType<NumberOfMessagesResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.getNumberOfSentReplyMessagesWithHttpInfo

getPNPMessageStatistics()

getPNPMessageStatistics(date): Promise<NumberOfMessagesResponse>

Defined in: lib/line-bot-client.generated.ts:1734

Get number of sent LINE notification messages Calls GET https://api.line.me/v2/bot/message/delivery/pnp. To inspect the HTTP status code or response headers, use getPNPMessageStatisticsWithHttpInfo.

Parameters

date

string

Date the message was sent Format: yyyyMMdd (Example:20211231) Time zone: UTC+9

Returns

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.getPNPMessageStatistics

getPNPMessageStatisticsWithHttpInfo()

getPNPMessageStatisticsWithHttpInfo(date): Promise<ApiResponseType<NumberOfMessagesResponse>>

Defined in: lib/line-bot-client.generated.ts:1748

Get number of sent LINE notification messages Calls GET https://api.line.me/v2/bot/message/delivery/pnp. This method returns the response body together with the underlying httpResponse.

Parameters

date

string

Date the message was sent Format: yyyyMMdd (Example:20211231) Time zone: UTC+9

Returns

Promise<ApiResponseType<NumberOfMessagesResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.getPNPMessageStatisticsWithHttpInfo

getPNPTemplatedMessageStatistics()

getPNPTemplatedMessageStatistics(date): Promise<NumberOfMessagesResponse>

Defined in: lib/line-bot-client.generated.ts:1762

Get number of sent LINE notification messages (template) Calls GET https://api.line.me/v2/bot/message/delivery/pnp/templated. To inspect the HTTP status code or response headers, use getPNPTemplatedMessageStatisticsWithHttpInfo.

Parameters

date

string

Date the message was sent Format: yyyyMMdd (Example:20211231) Time zone: UTC+9

Returns

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.getPNPTemplatedMessageStatistics

getPNPTemplatedMessageStatisticsWithHttpInfo()

getPNPTemplatedMessageStatisticsWithHttpInfo(date): Promise<ApiResponseType<NumberOfMessagesResponse>>

Defined in: lib/line-bot-client.generated.ts:1776

Get number of sent LINE notification messages (template) Calls GET https://api.line.me/v2/bot/message/delivery/pnp/templated. This method returns the response body together with the underlying httpResponse.

Parameters

date

string

Date the message was sent Format: yyyyMMdd (Example:20211231) Time zone: UTC+9

Returns

Promise<ApiResponseType<NumberOfMessagesResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.getPNPTemplatedMessageStatisticsWithHttpInfo

getProfile()

getProfile(userId): Promise<UserProfileResponse>

Defined in: lib/line-bot-client.generated.ts:1792

Get profile Calls GET https://api.line.me/v2/bot/profile/{userId}. To inspect the HTTP status code or response headers, use getProfileWithHttpInfo.

Parameters

userId

string

User ID

Returns

Promise<UserProfileResponse>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.getProfile

getProfileWithHttpInfo()

getProfileWithHttpInfo(userId): Promise<ApiResponseType<UserProfileResponse>>

Defined in: lib/line-bot-client.generated.ts:1806

Get profile Calls GET https://api.line.me/v2/bot/profile/{userId}. This method returns the response body together with the underlying httpResponse.

Parameters

userId

string

User ID

Returns

Promise<ApiResponseType<UserProfileResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.getProfileWithHttpInfo

getRichMenu()

getRichMenu(richMenuId): Promise<RichMenuResponse>

Defined in: lib/line-bot-client.generated.ts:1820

Gets a rich menu via a rich menu ID. Calls GET https://api.line.me/v2/bot/richmenu/{richMenuId}. To inspect the HTTP status code or response headers, use getRichMenuWithHttpInfo.

Parameters

richMenuId

string

ID of a rich menu

Returns

Promise<RichMenuResponse>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.getRichMenu

getRichMenuAlias()

getRichMenuAlias(richMenuAliasId): Promise<RichMenuAliasResponse>

Defined in: lib/line-bot-client.generated.ts:1848

Get rich menu alias information Calls GET https://api.line.me/v2/bot/richmenu/alias/{richMenuAliasId}. To inspect the HTTP status code or response headers, use getRichMenuAliasWithHttpInfo.

Parameters

richMenuAliasId

string

The rich menu alias ID whose information you want to obtain.

Returns

Promise<RichMenuAliasResponse>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.getRichMenuAlias

getRichMenuAliasList()

getRichMenuAliasList(): Promise<RichMenuAliasListResponse>

Defined in: lib/line-bot-client.generated.ts:1877

Get list of rich menu alias Calls GET https://api.line.me/v2/bot/richmenu/alias/list. To inspect the HTTP status code or response headers, use getRichMenuAliasListWithHttpInfo.

Returns

Promise<RichMenuAliasListResponse>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.getRichMenuAliasList

getRichMenuAliasListWithHttpInfo()

getRichMenuAliasListWithHttpInfo(): Promise<ApiResponseType<RichMenuAliasListResponse>>

Defined in: lib/line-bot-client.generated.ts:1888

Get list of rich menu alias Calls GET https://api.line.me/v2/bot/richmenu/alias/list. This method returns the response body together with the underlying httpResponse.

Returns

Promise<ApiResponseType<RichMenuAliasListResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.getRichMenuAliasListWithHttpInfo

getRichMenuAliasWithHttpInfo()

getRichMenuAliasWithHttpInfo(richMenuAliasId): Promise<ApiResponseType<RichMenuAliasResponse>>

Defined in: lib/line-bot-client.generated.ts:1862

Get rich menu alias information Calls GET https://api.line.me/v2/bot/richmenu/alias/{richMenuAliasId}. This method returns the response body together with the underlying httpResponse.

Parameters

richMenuAliasId

string

The rich menu alias ID whose information you want to obtain.

Returns

Promise<ApiResponseType<RichMenuAliasResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.getRichMenuAliasWithHttpInfo

getRichMenuBatchProgress()

getRichMenuBatchProgress(requestId): Promise<RichMenuBatchProgressResponse>

Defined in: lib/line-bot-client.generated.ts:1902

Get the status of Replace or unlink a linked rich menus in batches. Calls GET https://api.line.me/v2/bot/richmenu/progress/batch. To inspect the HTTP status code or response headers, use getRichMenuBatchProgressWithHttpInfo.

Parameters

requestId

string

A request ID used to batch control the rich menu linked to the user. Each Messaging API request has a request ID.

Returns

Promise<RichMenuBatchProgressResponse>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.getRichMenuBatchProgress

getRichMenuBatchProgressWithHttpInfo()

getRichMenuBatchProgressWithHttpInfo(requestId): Promise<ApiResponseType<RichMenuBatchProgressResponse>>

Defined in: lib/line-bot-client.generated.ts:1916

Get the status of Replace or unlink a linked rich menus in batches. Calls GET https://api.line.me/v2/bot/richmenu/progress/batch. This method returns the response body together with the underlying httpResponse.

Parameters

requestId

string

A request ID used to batch control the rich menu linked to the user. Each Messaging API request has a request ID.

Returns

Promise<ApiResponseType<RichMenuBatchProgressResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.getRichMenuBatchProgressWithHttpInfo

getRichMenuIdOfUser()

getRichMenuIdOfUser(userId): Promise<RichMenuIdResponse>

Defined in: lib/line-bot-client.generated.ts:1934

Get rich menu ID of user Calls GET https://api.line.me/v2/bot/user/{userId}/richmenu. To inspect the HTTP status code or response headers, use getRichMenuIdOfUserWithHttpInfo.

Parameters

userId

string

User ID. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE.

Returns

Promise<RichMenuIdResponse>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.getRichMenuIdOfUser

getRichMenuIdOfUserWithHttpInfo()

getRichMenuIdOfUserWithHttpInfo(userId): Promise<ApiResponseType<RichMenuIdResponse>>

Defined in: lib/line-bot-client.generated.ts:1948

Get rich menu ID of user Calls GET https://api.line.me/v2/bot/user/{userId}/richmenu. This method returns the response body together with the underlying httpResponse.

Parameters

userId

string

User ID. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE.

Returns

Promise<ApiResponseType<RichMenuIdResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.getRichMenuIdOfUserWithHttpInfo

getRichMenuImage()

getRichMenuImage(richMenuId): Promise<Readable>

Defined in: lib/line-bot-client.generated.ts:3138

Download rich menu image. Calls GET https://api-data.line.me/v2/bot/richmenu/{richMenuId}/content. To inspect the HTTP status code or response headers, use getRichMenuImageWithHttpInfo.

Parameters

richMenuId

string

ID of the rich menu with the image to be downloaded

Returns

Promise<Readable>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.getRichMenuImage

getRichMenuImageWithHttpInfo()

getRichMenuImageWithHttpInfo(richMenuId): Promise<ApiResponseType<Readable>>

Defined in: lib/line-bot-client.generated.ts:3150

Download rich menu image. Calls GET https://api-data.line.me/v2/bot/richmenu/{richMenuId}/content. This method returns the response body together with the underlying httpResponse.

Parameters

richMenuId

string

ID of the rich menu with the image to be downloaded

Returns

Promise<ApiResponseType<Readable>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.getRichMenuImageWithHttpInfo

getRichMenuInsightDaily()

getRichMenuInsightDaily(richMenuId, from, to): Promise<GetRichMenuInsightDailyResponse>

Defined in: lib/line-bot-client.generated.ts:168

Gets rich menu statistics broken down by day for the specified period, for a rich menu created via the Messaging API. Returns the daily impression count for the whole rich menu and the daily click count for each tappable area. When the total number of unique clicks during the period is below the privacy threshold, only richMenuId is returned and the other fields are omitted. Calls GET https://api.line.me/v2/bot/insight/richmenu/{richMenuId}/daily. To inspect the HTTP status code or response headers, use getRichMenuInsightDailyWithHttpInfo.

Parameters

richMenuId

string

ID of the rich menu created via the Messaging API.

from

string

Start date of the aggregation period (inclusive). Must be within the most recent 3 years. Format: yyyyMMdd (e.g. 20260213) Time zone: UTC+9

to

string

End date of the aggregation period (inclusive). The end date can be specified for up to 99 days after the start date. Format: yyyyMMdd (e.g. 20260215) Time zone: UTC+9

Returns

Promise<GetRichMenuInsightDailyResponse>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.getRichMenuInsightDaily

getRichMenuInsightDailyWithHttpInfo()

getRichMenuInsightDailyWithHttpInfo(richMenuId, from, to): Promise<ApiResponseType<GetRichMenuInsightDailyResponse>>

Defined in: lib/line-bot-client.generated.ts:187

Gets rich menu statistics broken down by day for the specified period, for a rich menu created via the Messaging API. Returns the daily impression count for the whole rich menu and the daily click count for each tappable area. When the total number of unique clicks during the period is below the privacy threshold, only richMenuId is returned and the other fields are omitted. Calls GET https://api.line.me/v2/bot/insight/richmenu/{richMenuId}/daily. This method returns the response body together with the underlying httpResponse.

Parameters

richMenuId

string

ID of the rich menu created via the Messaging API.

from

string

Start date of the aggregation period (inclusive). Must be within the most recent 3 years. Format: yyyyMMdd (e.g. 20260213) Time zone: UTC+9

to

string

End date of the aggregation period (inclusive). The end date can be specified for up to 99 days after the start date. Format: yyyyMMdd (e.g. 20260215) Time zone: UTC+9

Returns

Promise<ApiResponseType<GetRichMenuInsightDailyResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.getRichMenuInsightDailyWithHttpInfo

getRichMenuInsightSummary()

getRichMenuInsightSummary(richMenuId, from, to): Promise<GetRichMenuInsightSummaryResponse>

Defined in: lib/line-bot-client.generated.ts:210

Gets a summary of rich menu statistics for the specified period, for a rich menu created via the Messaging API. Returns the total impression count for the whole rich menu and the click count for each tappable area, aggregated over the entire period as a single result. When the total number of unique clicks during the period is below the privacy threshold, only richMenuId is returned and the other fields are omitted. Calls GET https://api.line.me/v2/bot/insight/richmenu/{richMenuId}/summary. To inspect the HTTP status code or response headers, use getRichMenuInsightSummaryWithHttpInfo.

Parameters

richMenuId

string

ID of the rich menu created via the Messaging API.

from

string

Start date of the aggregation period (inclusive). Must be within the most recent 3 years. Format: yyyyMMdd (e.g. 20260213) Time zone: UTC+9

to

string

End date of the aggregation period (inclusive). The end date can be specified for up to 396 days after the start date. Format: yyyyMMdd (e.g. 20260215) Time zone: UTC+9

Returns

Promise<GetRichMenuInsightSummaryResponse>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.getRichMenuInsightSummary

getRichMenuInsightSummaryWithHttpInfo()

getRichMenuInsightSummaryWithHttpInfo(richMenuId, from, to): Promise<ApiResponseType<GetRichMenuInsightSummaryResponse>>

Defined in: lib/line-bot-client.generated.ts:229

Gets a summary of rich menu statistics for the specified period, for a rich menu created via the Messaging API. Returns the total impression count for the whole rich menu and the click count for each tappable area, aggregated over the entire period as a single result. When the total number of unique clicks during the period is below the privacy threshold, only richMenuId is returned and the other fields are omitted. Calls GET https://api.line.me/v2/bot/insight/richmenu/{richMenuId}/summary. This method returns the response body together with the underlying httpResponse.

Parameters

richMenuId

string

ID of the rich menu created via the Messaging API.

from

string

Start date of the aggregation period (inclusive). Must be within the most recent 3 years. Format: yyyyMMdd (e.g. 20260213) Time zone: UTC+9

to

string

End date of the aggregation period (inclusive). The end date can be specified for up to 396 days after the start date. Format: yyyyMMdd (e.g. 20260215) Time zone: UTC+9

Returns

Promise<ApiResponseType<GetRichMenuInsightSummaryResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.getRichMenuInsightSummaryWithHttpInfo

getRichMenuList()

getRichMenuList(): Promise<RichMenuListResponse>

Defined in: lib/line-bot-client.generated.ts:1961

Get rich menu list Calls GET https://api.line.me/v2/bot/richmenu/list. To inspect the HTTP status code or response headers, use getRichMenuListWithHttpInfo.

Returns

Promise<RichMenuListResponse>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.getRichMenuList

getRichMenuListWithHttpInfo()

getRichMenuListWithHttpInfo(): Promise<ApiResponseType<RichMenuListResponse>>

Defined in: lib/line-bot-client.generated.ts:1972

Get rich menu list Calls GET https://api.line.me/v2/bot/richmenu/list. This method returns the response body together with the underlying httpResponse.

Returns

Promise<ApiResponseType<RichMenuListResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.getRichMenuListWithHttpInfo

getRichMenuWithHttpInfo()

getRichMenuWithHttpInfo(richMenuId): Promise<ApiResponseType<RichMenuResponse>>

Defined in: lib/line-bot-client.generated.ts:1834

Gets a rich menu via a rich menu ID. Calls GET https://api.line.me/v2/bot/richmenu/{richMenuId}. This method returns the response body together with the underlying httpResponse.

Parameters

richMenuId

string

ID of a rich menu

Returns

Promise<ApiResponseType<RichMenuResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.getRichMenuWithHttpInfo

getRoomMemberCount()

getRoomMemberCount(roomId): Promise<RoomMemberCountResponse>

Defined in: lib/line-bot-client.generated.ts:1986

Get number of users in a multi-person chat Calls GET https://api.line.me/v2/bot/room/{roomId}/members/count. To inspect the HTTP status code or response headers, use getRoomMemberCountWithHttpInfo.

Parameters

roomId

string

Room ID

Returns

Promise<RoomMemberCountResponse>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.getRoomMemberCount

getRoomMemberCountWithHttpInfo()

getRoomMemberCountWithHttpInfo(roomId): Promise<ApiResponseType<RoomMemberCountResponse>>

Defined in: lib/line-bot-client.generated.ts:2000

Get number of users in a multi-person chat Calls GET https://api.line.me/v2/bot/room/{roomId}/members/count. This method returns the response body together with the underlying httpResponse.

Parameters

roomId

string

Room ID

Returns

Promise<ApiResponseType<RoomMemberCountResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.getRoomMemberCountWithHttpInfo

getRoomMemberProfile()

getRoomMemberProfile(roomId, userId): Promise<RoomUserProfileResponse>

Defined in: lib/line-bot-client.generated.ts:2015

Get multi-person chat member profile Calls GET https://api.line.me/v2/bot/room/{roomId}/member/{userId}. To inspect the HTTP status code or response headers, use getRoomMemberProfileWithHttpInfo.

Parameters

roomId

string

Room ID

userId

string

User ID

Returns

Promise<RoomUserProfileResponse>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.getRoomMemberProfile

getRoomMemberProfileWithHttpInfo()

getRoomMemberProfileWithHttpInfo(roomId, userId): Promise<ApiResponseType<RoomUserProfileResponse>>

Defined in: lib/line-bot-client.generated.ts:2031

Get multi-person chat member profile Calls GET https://api.line.me/v2/bot/room/{roomId}/member/{userId}. This method returns the response body together with the underlying httpResponse.

Parameters

roomId

string

Room ID

userId

string

User ID

Returns

Promise<ApiResponseType<RoomUserProfileResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.getRoomMemberProfileWithHttpInfo

getRoomMembersIds()

getRoomMembersIds(roomId, start?): Promise<MembersIdsResponse>

Defined in: lib/line-bot-client.generated.ts:2050

Get multi-person chat member user IDs Calls GET https://api.line.me/v2/bot/room/{roomId}/members/ids. To inspect the HTTP status code or response headers, use getRoomMembersIdsWithHttpInfo.

Parameters

roomId

string

Room ID

start?

string

Value of the continuation token found in the next property of the JSON object returned in the response. Include this parameter to get the next array of user IDs for the members of the group.

Returns

Promise<MembersIdsResponse>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.getRoomMembersIds

getRoomMembersIdsWithHttpInfo()

getRoomMembersIdsWithHttpInfo(roomId, start?): Promise<ApiResponseType<MembersIdsResponse>>

Defined in: lib/line-bot-client.generated.ts:2066

Get multi-person chat member user IDs Calls GET https://api.line.me/v2/bot/room/{roomId}/members/ids. This method returns the response body together with the underlying httpResponse.

Parameters

roomId

string

Room ID

start?

string

Value of the continuation token found in the next property of the JSON object returned in the response. Include this parameter to get the next array of user IDs for the members of the group.

Returns

Promise<ApiResponseType<MembersIdsResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.getRoomMembersIdsWithHttpInfo

getSharedAudienceData()

getSharedAudienceData(audienceGroupId): Promise<GetSharedAudienceDataResponse>

Defined in: lib/line-bot-client.generated.ts:672

Gets audience data. Calls GET https://api.line.me/v2/bot/audienceGroup/shared/{audienceGroupId}. To inspect the HTTP status code or response headers, use getSharedAudienceDataWithHttpInfo.

Parameters

audienceGroupId

number

The audience ID.

Returns

Promise<GetSharedAudienceDataResponse>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.getSharedAudienceData

getSharedAudienceDataWithHttpInfo()

getSharedAudienceDataWithHttpInfo(audienceGroupId): Promise<ApiResponseType<GetSharedAudienceDataResponse>>

Defined in: lib/line-bot-client.generated.ts:686

Gets audience data. Calls GET https://api.line.me/v2/bot/audienceGroup/shared/{audienceGroupId}. This method returns the response body together with the underlying httpResponse.

Parameters

audienceGroupId

number

The audience ID.

Returns

Promise<ApiResponseType<GetSharedAudienceDataResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.getSharedAudienceDataWithHttpInfo

getSharedAudienceGroups()

getSharedAudienceGroups(page, description?, status?, size?, createRoute?, includesOwnedAudienceGroups?): Promise<GetSharedAudienceGroupsResponse>

Defined in: lib/line-bot-client.generated.ts:709

Gets data for more than one audience, including those shared by the Business Manager. Calls GET https://api.line.me/v2/bot/audienceGroup/shared/list. To inspect the HTTP status code or response headers, use getSharedAudienceGroupsWithHttpInfo.

Parameters

page

number

The page to return when getting (paginated) results. Must be 1 or higher.

description?

string

status?

The status of the audience(s) to return. If omitted, the status of the audience(s) will not be used as a search criterion.

size?

number

The number of audiences per page. Default: 20 Max: 40

createRoute?

includesOwnedAudienceGroups?

boolean

true: Include audienceGroups owned by LINE Official Account Manager false: Respond only audienceGroups shared by Business Manager

Returns

Promise<GetSharedAudienceGroupsResponse>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.getSharedAudienceGroups

getSharedAudienceGroupsWithHttpInfo()

getSharedAudienceGroupsWithHttpInfo(page, description?, status?, size?, createRoute?, includesOwnedAudienceGroups?): Promise<ApiResponseType<GetSharedAudienceGroupsResponse>>

Defined in: lib/line-bot-client.generated.ts:740

Gets data for more than one audience, including those shared by the Business Manager. Calls GET https://api.line.me/v2/bot/audienceGroup/shared/list. This method returns the response body together with the underlying httpResponse.

Parameters

page

number

The page to return when getting (paginated) results. Must be 1 or higher.

description?

string

status?

The status of the audience(s) to return. If omitted, the status of the audience(s) will not be used as a search criterion.

size?

number

The number of audiences per page. Default: 20 Max: 40

createRoute?

includesOwnedAudienceGroups?

boolean

true: Include audienceGroups owned by LINE Official Account Manager false: Respond only audienceGroups shared by Business Manager

Returns

Promise<ApiResponseType<GetSharedAudienceGroupsResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.getSharedAudienceGroupsWithHttpInfo

getStatisticsPerUnit()

getStatisticsPerUnit(customAggregationUnit, from, to): Promise<GetStatisticsPerUnitResponse>

Defined in: lib/line-bot-client.generated.ts:251

You can check the per-unit statistics of how users interact with push messages and multicast messages sent from your LINE Official Account. Calls GET https://api.line.me/v2/bot/insight/message/event/aggregation. To inspect the HTTP status code or response headers, use getStatisticsPerUnitWithHttpInfo.

Parameters

customAggregationUnit

string

Name of aggregation unit specified when sending the message. Case-sensitive. For example, Promotion_a and Promotion_A are regarded as different unit names.

from

string

Start date of aggregation period. Format: yyyyMMdd (e.g. 20210301) Time zone: UTC+9

to

string

End date of aggregation period. The end date can be specified for up to 30 days later. For example, if the start date is 20210301, the latest end date is 20210331. Format: yyyyMMdd (e.g. 20210301) Time zone: UTC+9

Returns

Promise<GetStatisticsPerUnitResponse>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.getStatisticsPerUnit

getStatisticsPerUnitWithHttpInfo()

getStatisticsPerUnitWithHttpInfo(customAggregationUnit, from, to): Promise<ApiResponseType<GetStatisticsPerUnitResponse>>

Defined in: lib/line-bot-client.generated.ts:273

You can check the per-unit statistics of how users interact with push messages and multicast messages sent from your LINE Official Account. Calls GET https://api.line.me/v2/bot/insight/message/event/aggregation. This method returns the response body together with the underlying httpResponse.

Parameters

customAggregationUnit

string

Name of aggregation unit specified when sending the message. Case-sensitive. For example, Promotion_a and Promotion_A are regarded as different unit names.

from

string

Start date of aggregation period. Format: yyyyMMdd (e.g. 20210301) Time zone: UTC+9

to

string

Returns

Promise<ApiResponseType<GetStatisticsPerUnitResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.getStatisticsPerUnitWithHttpInfo

getWebhookEndpoint()

getWebhookEndpoint(): Promise<GetWebhookEndpointResponse>

Defined in: lib/line-bot-client.generated.ts:2083

Get webhook endpoint information Calls GET https://api.line.me/v2/bot/channel/webhook/endpoint. To inspect the HTTP status code or response headers, use getWebhookEndpointWithHttpInfo.

Returns

Promise<GetWebhookEndpointResponse>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.getWebhookEndpoint

getWebhookEndpointWithHttpInfo()

getWebhookEndpointWithHttpInfo(): Promise<ApiResponseType<GetWebhookEndpointResponse>>

Defined in: lib/line-bot-client.generated.ts:2094

Get webhook endpoint information Calls GET https://api.line.me/v2/bot/channel/webhook/endpoint. This method returns the response body together with the underlying httpResponse.

Returns

Promise<ApiResponseType<GetWebhookEndpointResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.getWebhookEndpointWithHttpInfo

issueLinkToken()

issueLinkToken(userId): Promise<IssueLinkTokenResponse>

Defined in: lib/line-bot-client.generated.ts:2108

Issue link token Calls POST https://api.line.me/v2/bot/user/{userId}/linkToken. To inspect the HTTP status code or response headers, use issueLinkTokenWithHttpInfo.

Parameters

userId

string

User ID for the LINE account to be linked. Found in the source object of account link event objects. Do not use the LINE ID used in LINE.

Returns

Promise<IssueLinkTokenResponse>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.issueLinkToken

issueLinkTokenWithHttpInfo()

issueLinkTokenWithHttpInfo(userId): Promise<ApiResponseType<IssueLinkTokenResponse>>

Defined in: lib/line-bot-client.generated.ts:2122

Issue link token Calls POST https://api.line.me/v2/bot/user/{userId}/linkToken. This method returns the response body together with the underlying httpResponse.

Parameters

userId

string

User ID for the LINE account to be linked. Found in the source object of account link event objects. Do not use the LINE ID used in LINE.

Returns

Promise<ApiResponseType<IssueLinkTokenResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.issueLinkTokenWithHttpInfo

leaveGroup()

leaveGroup(groupId): Promise<MessageAPIResponseBase>

Defined in: lib/line-bot-client.generated.ts:2136

Leave group chat Calls POST https://api.line.me/v2/bot/group/{groupId}/leave. To inspect the HTTP status code or response headers, use leaveGroupWithHttpInfo.

Parameters

groupId

string

Group ID

Returns

Promise<MessageAPIResponseBase>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.leaveGroup

leaveGroupWithHttpInfo()

leaveGroupWithHttpInfo(groupId): Promise<ApiResponseType<MessageAPIResponseBase>>

Defined in: lib/line-bot-client.generated.ts:2150

Leave group chat Calls POST https://api.line.me/v2/bot/group/{groupId}/leave. This method returns the response body together with the underlying httpResponse.

Parameters

groupId

string

Group ID

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.leaveGroupWithHttpInfo

leaveRoom()

leaveRoom(roomId): Promise<MessageAPIResponseBase>

Defined in: lib/line-bot-client.generated.ts:2164

Leave multi-person chat Calls POST https://api.line.me/v2/bot/room/{roomId}/leave. To inspect the HTTP status code or response headers, use leaveRoomWithHttpInfo.

Parameters

roomId

string

Room ID

Returns

Promise<MessageAPIResponseBase>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.leaveRoom

leaveRoomWithHttpInfo()

leaveRoomWithHttpInfo(roomId): Promise<ApiResponseType<MessageAPIResponseBase>>

Defined in: lib/line-bot-client.generated.ts:2178

Leave multi-person chat Calls POST https://api.line.me/v2/bot/room/{roomId}/leave. This method returns the response body together with the underlying httpResponse.

Parameters

roomId

string

Room ID

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.leaveRoomWithHttpInfo

linkRichMenuIdToUser()

linkRichMenuIdToUser(userId, richMenuId): Promise<MessageAPIResponseBase>

Defined in: lib/line-bot-client.generated.ts:2193

Link rich menu to user. Calls POST https://api.line.me/v2/bot/user/{userId}/richmenu/{richMenuId}. To inspect the HTTP status code or response headers, use linkRichMenuIdToUserWithHttpInfo.

Parameters

userId

string

User ID. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE.

richMenuId

string

ID of a rich menu

Returns

Promise<MessageAPIResponseBase>

A promise resolving to the response body.

See

RichMenuBulkLinkRequest

Inherited from

LineBotClientBase.linkRichMenuIdToUser

linkRichMenuIdToUsers()

linkRichMenuIdToUsers(richMenuBulkLinkRequest): Promise<MessageAPIResponseBase>

Defined in: lib/line-bot-client.generated.ts:2227

Link rich menu to multiple users Calls POST https://api.line.me/v2/bot/richmenu/bulk/link. To inspect the HTTP status code or response headers, use linkRichMenuIdToUsersWithHttpInfo.

Parameters

richMenuBulkLinkRequest

Returns

Promise<MessageAPIResponseBase>

A promise resolving to the response body.

See

RichMenuBulkLinkRequest

Inherited from

LineBotClientBase.linkRichMenuIdToUsers

linkRichMenuIdToUsersWithHttpInfo()

linkRichMenuIdToUsersWithHttpInfo(richMenuBulkLinkRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Defined in: lib/line-bot-client.generated.ts:2243

Link rich menu to multiple users Calls POST https://api.line.me/v2/bot/richmenu/bulk/link. This method returns the response body together with the underlying httpResponse.

Parameters

richMenuBulkLinkRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.linkRichMenuIdToUsersWithHttpInfo

linkRichMenuIdToUserWithHttpInfo()

linkRichMenuIdToUserWithHttpInfo(userId, richMenuId): Promise<ApiResponseType<MessageAPIResponseBase>>

Defined in: lib/line-bot-client.generated.ts:2209

Link rich menu to user. Calls POST https://api.line.me/v2/bot/user/{userId}/richmenu/{richMenuId}. This method returns the response body together with the underlying httpResponse.

Parameters

userId

string

User ID. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE.

richMenuId

string

ID of a rich menu

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.linkRichMenuIdToUserWithHttpInfo

listCoupon()

listCoupon(status?, start?, limit?): Promise<MessagingApiPagerCouponListResponse>

Defined in: lib/line-bot-client.generated.ts:2261

Get a paginated list of coupons. Calls GET https://api.line.me/v2/bot/coupon. To inspect the HTTP status code or response headers, use listCouponWithHttpInfo.

Parameters

status?

Set<"DRAFT" | "RUNNING" | "CLOSED">

Filter coupons by their status.

start?

string

Pagination token to retrieve the next page of results.

limit?

number

Maximum number of coupons to return per request.

Returns

Promise<MessagingApiPagerCouponListResponse>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.listCoupon

listCouponWithHttpInfo()

listCouponWithHttpInfo(status?, start?, limit?): Promise<ApiResponseType<MessagingApiPagerCouponListResponse>>

Defined in: lib/line-bot-client.generated.ts:2279

Get a paginated list of coupons. Calls GET https://api.line.me/v2/bot/coupon. This method returns the response body together with the underlying httpResponse.

Parameters

status?

Set<"DRAFT" | "RUNNING" | "CLOSED">

Filter coupons by their status.

start?

string

Pagination token to retrieve the next page of results.

limit?

number

Maximum number of coupons to return per request.

Returns

Promise<ApiResponseType<MessagingApiPagerCouponListResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

MarkMessagesAsReadRequest

Inherited from

LineBotClientBase.listCouponWithHttpInfo

markMessagesAsRead()

markMessagesAsRead(markMessagesAsReadRequest): Promise<MessageAPIResponseBase>

Defined in: lib/line-bot-client.generated.ts:2301

Mark messages from users as read Calls POST https://api.line.me/v2/bot/message/markAsRead. To inspect the HTTP status code or response headers, use markMessagesAsReadWithHttpInfo.

Parameters

markMessagesAsReadRequest

Returns

Promise<MessageAPIResponseBase>

A promise resolving to the response body.

See

MarkMessagesAsReadByTokenRequest

Inherited from

LineBotClientBase.markMessagesAsRead

markMessagesAsReadByToken()

markMessagesAsReadByToken(markMessagesAsReadByTokenRequest): Promise<MessageAPIResponseBase>

Defined in: lib/line-bot-client.generated.ts:2333

Mark messages from users as read by token Calls POST https://api.line.me/v2/bot/chat/markAsRead. To inspect the HTTP status code or response headers, use markMessagesAsReadByTokenWithHttpInfo.

Parameters

markMessagesAsReadByTokenRequest

Returns

Promise<MessageAPIResponseBase>

A promise resolving to the response body.

See

MarkMessagesAsReadByTokenRequest

Inherited from

LineBotClientBase.markMessagesAsReadByToken

markMessagesAsReadByTokenWithHttpInfo()

markMessagesAsReadByTokenWithHttpInfo(markMessagesAsReadByTokenRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Defined in: lib/line-bot-client.generated.ts:2349

Mark messages from users as read by token Calls POST https://api.line.me/v2/bot/chat/markAsRead. This method returns the response body together with the underlying httpResponse.

Parameters

markMessagesAsReadByTokenRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

A promise resolving to the response body together with the underlying httpResponse.

See

MarkMessagesAsReadRequest

Inherited from

LineBotClientBase.markMessagesAsReadByTokenWithHttpInfo

markMessagesAsReadWithHttpInfo()

markMessagesAsReadWithHttpInfo(markMessagesAsReadRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Defined in: lib/line-bot-client.generated.ts:2317

Mark messages from users as read Calls POST https://api.line.me/v2/bot/message/markAsRead. This method returns the response body together with the underlying httpResponse.

Parameters

markMessagesAsReadRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.markMessagesAsReadWithHttpInfo

missionStickerV3()

missionStickerV3(missionStickerRequest): Promise<MessageAPIResponseBase>

Defined in: lib/line-bot-client.generated.ts:3415

Sends a mission sticker. Calls POST https://api.line.me/shop/v3/mission. To inspect the HTTP status code or response headers, use missionStickerV3WithHttpInfo.

Parameters

missionStickerRequest

MissionStickerRequest

Returns

Promise<MessageAPIResponseBase>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.missionStickerV3

missionStickerV3WithHttpInfo()

missionStickerV3WithHttpInfo(missionStickerRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Defined in: lib/line-bot-client.generated.ts:3429

Sends a mission sticker. Calls POST https://api.line.me/shop/v3/mission. This method returns the response body together with the underlying httpResponse.

Parameters

missionStickerRequest

MissionStickerRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.missionStickerV3WithHttpInfo

multicast()

multicast(multicastRequest, xLineRetryKey?): Promise<object>

Defined in: lib/line-bot-client.generated.ts:2366

An API that efficiently sends the same message to multiple user IDs. You can't send messages to group chats or multi-person chats. Calls POST https://api.line.me/v2/bot/message/multicast. To inspect the HTTP status code or response headers, use multicastWithHttpInfo.

Parameters

multicastRequest

MulticastRequest

xLineRetryKey?

string

Returns

Promise<object>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.multicast

multicastWithHttpInfo()

multicastWithHttpInfo(multicastRequest, xLineRetryKey?): Promise<ApiResponseType<object>>

Defined in: lib/line-bot-client.generated.ts:2382

An API that efficiently sends the same message to multiple user IDs. You can't send messages to group chats or multi-person chats. Calls POST https://api.line.me/v2/bot/message/multicast. This method returns the response body together with the underlying httpResponse.

Parameters

multicastRequest

MulticastRequest

xLineRetryKey?

string

Returns

Promise<ApiResponseType<object>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.multicastWithHttpInfo

narrowcast()

narrowcast(narrowcastRequest, xLineRetryKey?): Promise<object>

Defined in: lib/line-bot-client.generated.ts:2401

Send narrowcast message Calls POST https://api.line.me/v2/bot/message/narrowcast. To inspect the HTTP status code or response headers, use narrowcastWithHttpInfo.

Parameters

narrowcastRequest

NarrowcastRequest

xLineRetryKey?

string

Returns

Promise<object>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.narrowcast

narrowcastWithHttpInfo()

narrowcastWithHttpInfo(narrowcastRequest, xLineRetryKey?): Promise<ApiResponseType<object>>

Defined in: lib/line-bot-client.generated.ts:2420

Send narrowcast message Calls POST https://api.line.me/v2/bot/message/narrowcast. This method returns the response body together with the underlying httpResponse.

Parameters

narrowcastRequest

NarrowcastRequest

xLineRetryKey?

string

Returns

Promise<ApiResponseType<object>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.narrowcastWithHttpInfo

pushMessage()

pushMessage(pushMessageRequest, xLineRetryKey?): Promise<PushMessageResponse>

Defined in: lib/line-bot-client.generated.ts:2439

Sends a message to a user, group chat, or multi-person chat at any time. Calls POST https://api.line.me/v2/bot/message/push. To inspect the HTTP status code or response headers, use pushMessageWithHttpInfo.

Parameters

pushMessageRequest

PushMessageRequest

xLineRetryKey?

string

Returns

Promise<PushMessageResponse>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.pushMessage

pushMessagesByPhone()

pushMessagesByPhone(pnpMessagesRequest, xLineDeliveryTag?): Promise<MessageAPIResponseBase>

Defined in: lib/line-bot-client.generated.ts:2477

Send LINE notification message Calls POST https://api.line.me/bot/pnp/push. To inspect the HTTP status code or response headers, use pushMessagesByPhoneWithHttpInfo.

Parameters

pnpMessagesRequest

PnpMessagesRequest

xLineDeliveryTag?

string

String returned in the delivery.data property of the delivery completion event via Webhook.

Returns

Promise<MessageAPIResponseBase>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.pushMessagesByPhone

pushMessagesByPhoneWithHttpInfo()

pushMessagesByPhoneWithHttpInfo(pnpMessagesRequest, xLineDeliveryTag?): Promise<ApiResponseType<MessageAPIResponseBase>>

Defined in: lib/line-bot-client.generated.ts:2496

Send LINE notification message Calls POST https://api.line.me/bot/pnp/push. This method returns the response body together with the underlying httpResponse.

Parameters

pnpMessagesRequest

PnpMessagesRequest

xLineDeliveryTag?

string

String returned in the delivery.data property of the delivery completion event via Webhook.

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.pushMessagesByPhoneWithHttpInfo

pushMessageWithHttpInfo()

pushMessageWithHttpInfo(pushMessageRequest, xLineRetryKey?): Promise<ApiResponseType<PushMessageResponse>>

Defined in: lib/line-bot-client.generated.ts:2458

Sends a message to a user, group chat, or multi-person chat at any time. Calls POST https://api.line.me/v2/bot/message/push. This method returns the response body together with the underlying httpResponse.

Parameters

pushMessageRequest

PushMessageRequest

xLineRetryKey?

string

Returns

Promise<ApiResponseType<PushMessageResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

PnpTemplatedMessageRequest

Inherited from

LineBotClientBase.pushMessageWithHttpInfo

pushTemplatedMessagesByPhone()

pushTemplatedMessagesByPhone(pnpTemplatedMessageRequest, xLineDeliveryTag?): Promise<MessageAPIResponseBase>

Defined in: lib/line-bot-client.generated.ts:2515

Send LINE notification message (template) Calls POST https://api.line.me/v2/bot/message/pnp/templated/push. To inspect the HTTP status code or response headers, use pushTemplatedMessagesByPhoneWithHttpInfo.

Parameters

pnpTemplatedMessageRequest

xLineDeliveryTag?

string

String returned in the delivery.data property of the delivery completion event via Webhook.

Returns

Promise<MessageAPIResponseBase>

A promise resolving to the response body.

See

PnpTemplatedMessageRequest

Inherited from

LineBotClientBase.pushTemplatedMessagesByPhone

pushTemplatedMessagesByPhoneWithHttpInfo()

pushTemplatedMessagesByPhoneWithHttpInfo(pnpTemplatedMessageRequest, xLineDeliveryTag?): Promise<ApiResponseType<MessageAPIResponseBase>>

Defined in: lib/line-bot-client.generated.ts:2534

Send LINE notification message (template) Calls POST https://api.line.me/v2/bot/message/pnp/templated/push. This method returns the response body together with the underlying httpResponse.

Parameters

pnpTemplatedMessageRequest

xLineDeliveryTag?

string

String returned in the delivery.data property of the delivery completion event via Webhook.

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.pushTemplatedMessagesByPhoneWithHttpInfo

releaseChatControl()

releaseChatControl(chatId): Promise<MessageAPIResponseBase>

Defined in: lib/line-bot-client.generated.ts:3301

To return the initiative (Chat Control) of Active Channel to Primary Channel, call the Release Control API. Calls POST https://api.line.me/v2/bot/chat/{chatId}/control/release. To inspect the HTTP status code or response headers, use releaseChatControlWithHttpInfo.

Parameters

chatId

string

The userId, roomId, or groupId

Returns

Promise<MessageAPIResponseBase>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.releaseChatControl

releaseChatControlWithHttpInfo()

releaseChatControlWithHttpInfo(chatId): Promise<ApiResponseType<MessageAPIResponseBase>>

Defined in: lib/line-bot-client.generated.ts:3315

To return the initiative (Chat Control) of Active Channel to Primary Channel, call the Release Control API. Calls POST https://api.line.me/v2/bot/chat/{chatId}/control/release. This method returns the response body together with the underlying httpResponse.

Parameters

chatId

string

The userId, roomId, or groupId

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.releaseChatControlWithHttpInfo

replyMessage()

replyMessage(replyMessageRequest): Promise<ReplyMessageResponse>

Defined in: lib/line-bot-client.generated.ts:2552

Send reply message Calls POST https://api.line.me/v2/bot/message/reply. To inspect the HTTP status code or response headers, use replyMessageWithHttpInfo.

Parameters

replyMessageRequest

ReplyMessageRequest

Returns

Promise<ReplyMessageResponse>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.replyMessage

replyMessageWithHttpInfo()

replyMessageWithHttpInfo(replyMessageRequest): Promise<ApiResponseType<ReplyMessageResponse>>

Defined in: lib/line-bot-client.generated.ts:2566

Send reply message Calls POST https://api.line.me/v2/bot/message/reply. This method returns the response body together with the underlying httpResponse.

Parameters

replyMessageRequest

ReplyMessageRequest

Returns

Promise<ApiResponseType<ReplyMessageResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.replyMessageWithHttpInfo

richMenuBatch()

richMenuBatch(richMenuBatchRequest): Promise<MessageAPIResponseBase>

Defined in: lib/line-bot-client.generated.ts:2582

You can use this endpoint to batch control the rich menu linked to the users using the endpoint such as Link rich menu to user. The following operations are available: 1. Replace a rich menu with another rich menu for all users linked to a specific rich menu 2. Unlink a rich menu for all users linked to a specific rich menu 3. Unlink a rich menu for all users linked the rich menu Calls POST https://api.line.me/v2/bot/richmenu/batch. To inspect the HTTP status code or response headers, use richMenuBatchWithHttpInfo.

Parameters

richMenuBatchRequest

Returns

Promise<MessageAPIResponseBase>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.richMenuBatch

richMenuBatchWithHttpInfo()

richMenuBatchWithHttpInfo(richMenuBatchRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Defined in: lib/line-bot-client.generated.ts:2596

You can use this endpoint to batch control the rich menu linked to the users using the endpoint such as Link rich menu to user. The following operations are available: 1. Replace a rich menu with another rich menu for all users linked to a specific rich menu 2. Unlink a rich menu for all users linked to a specific rich menu 3. Unlink a rich menu for all users linked the rich menu Calls POST https://api.line.me/v2/bot/richmenu/batch. This method returns the response body together with the underlying httpResponse.

Parameters

richMenuBatchRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.richMenuBatchWithHttpInfo

setDefaultRichMenu()

setDefaultRichMenu(richMenuId): Promise<MessageAPIResponseBase>

Defined in: lib/line-bot-client.generated.ts:2612

Set default rich menu Calls POST https://api.line.me/v2/bot/user/all/richmenu/{richMenuId}. To inspect the HTTP status code or response headers, use setDefaultRichMenuWithHttpInfo.

Parameters

richMenuId

string

ID of a rich menu

Returns

Promise<MessageAPIResponseBase>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.setDefaultRichMenu

setDefaultRichMenuWithHttpInfo()

setDefaultRichMenuWithHttpInfo(richMenuId): Promise<ApiResponseType<MessageAPIResponseBase>>

Defined in: lib/line-bot-client.generated.ts:2626

Set default rich menu Calls POST https://api.line.me/v2/bot/user/all/richmenu/{richMenuId}. This method returns the response body together with the underlying httpResponse.

Parameters

richMenuId

string

ID of a rich menu

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.setDefaultRichMenuWithHttpInfo

setRichMenuImage()

setRichMenuImage(richMenuId, body): Promise<MessageAPIResponseBase>

Defined in: lib/line-bot-client.generated.ts:3167

Upload rich menu image Calls POST https://api-data.line.me/v2/bot/richmenu/{richMenuId}/content. To inspect the HTTP status code or response headers, use setRichMenuImageWithHttpInfo.

Parameters

richMenuId

string

The ID of the rich menu to attach the image to

body

Blob

Returns

Promise<MessageAPIResponseBase>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.setRichMenuImage

setRichMenuImageWithHttpInfo()

setRichMenuImageWithHttpInfo(richMenuId, body): Promise<ApiResponseType<MessageAPIResponseBase>>

Defined in: lib/line-bot-client.generated.ts:3183

Upload rich menu image Calls POST https://api-data.line.me/v2/bot/richmenu/{richMenuId}/content. This method returns the response body together with the underlying httpResponse.

Parameters

richMenuId

string

The ID of the rich menu to attach the image to

body

Blob

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

A promise resolving to the response body together with the underlying httpResponse.

See

SetWebhookEndpointRequest

Inherited from

LineBotClientBase.setRichMenuImageWithHttpInfo

setWebhookEndpoint()

setWebhookEndpoint(setWebhookEndpointRequest): Promise<MessageAPIResponseBase>

Defined in: lib/line-bot-client.generated.ts:2640

Set webhook endpoint URL Calls PUT https://api.line.me/v2/bot/channel/webhook/endpoint. To inspect the HTTP status code or response headers, use setWebhookEndpointWithHttpInfo.

Parameters

setWebhookEndpointRequest

Returns

Promise<MessageAPIResponseBase>

A promise resolving to the response body.

See

SetWebhookEndpointRequest

Inherited from

LineBotClientBase.setWebhookEndpoint

setWebhookEndpointWithHttpInfo()

setWebhookEndpointWithHttpInfo(setWebhookEndpointRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Defined in: lib/line-bot-client.generated.ts:2656

Set webhook endpoint URL Calls PUT https://api.line.me/v2/bot/channel/webhook/endpoint. This method returns the response body together with the underlying httpResponse.

Parameters

setWebhookEndpointRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

A promise resolving to the response body together with the underlying httpResponse.

See

ShowLoadingAnimationRequest

Inherited from

LineBotClientBase.setWebhookEndpointWithHttpInfo

showLoadingAnimation()

showLoadingAnimation(showLoadingAnimationRequest): Promise<object>

Defined in: lib/line-bot-client.generated.ts:2672

Display a loading animation in one-on-one chats between users and LINE Official Accounts. Calls POST https://api.line.me/v2/bot/chat/loading/start. To inspect the HTTP status code or response headers, use showLoadingAnimationWithHttpInfo.

Parameters

showLoadingAnimationRequest

Returns

Promise<object>

A promise resolving to the response body.

See

ShowLoadingAnimationRequest

Inherited from

LineBotClientBase.showLoadingAnimation

showLoadingAnimationWithHttpInfo()

showLoadingAnimationWithHttpInfo(showLoadingAnimationRequest): Promise<ApiResponseType<object>>

Defined in: lib/line-bot-client.generated.ts:2688

Display a loading animation in one-on-one chats between users and LINE Official Accounts. Calls POST https://api.line.me/v2/bot/chat/loading/start. This method returns the response body together with the underlying httpResponse.

Parameters

showLoadingAnimationRequest

Returns

Promise<ApiResponseType<object>>

A promise resolving to the response body together with the underlying httpResponse.

See

TestWebhookEndpointRequest

Inherited from

LineBotClientBase.showLoadingAnimationWithHttpInfo

testWebhookEndpoint()

testWebhookEndpoint(testWebhookEndpointRequest?): Promise<TestWebhookEndpointResponse>

Defined in: lib/line-bot-client.generated.ts:2704

Test webhook endpoint Calls POST https://api.line.me/v2/bot/channel/webhook/test. To inspect the HTTP status code or response headers, use testWebhookEndpointWithHttpInfo.

Parameters

testWebhookEndpointRequest?

Returns

Promise<TestWebhookEndpointResponse>

A promise resolving to the response body.

See

TestWebhookEndpointRequest

Inherited from

LineBotClientBase.testWebhookEndpoint

testWebhookEndpointWithHttpInfo()

testWebhookEndpointWithHttpInfo(testWebhookEndpointRequest?): Promise<ApiResponseType<TestWebhookEndpointResponse>>

Defined in: lib/line-bot-client.generated.ts:2720

Test webhook endpoint Calls POST https://api.line.me/v2/bot/channel/webhook/test. This method returns the response body together with the underlying httpResponse.

Parameters

testWebhookEndpointRequest?

Returns

Promise<ApiResponseType<TestWebhookEndpointResponse>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.testWebhookEndpointWithHttpInfo

unlinkRichMenuIdFromUser()

unlinkRichMenuIdFromUser(userId): Promise<MessageAPIResponseBase>

Defined in: lib/line-bot-client.generated.ts:2736

Unlink rich menu from user Calls DELETE https://api.line.me/v2/bot/user/{userId}/richmenu. To inspect the HTTP status code or response headers, use unlinkRichMenuIdFromUserWithHttpInfo.

Parameters

userId

string

User ID. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE.

Returns

Promise<MessageAPIResponseBase>

A promise resolving to the response body.

See

RichMenuBulkUnlinkRequest

Inherited from

LineBotClientBase.unlinkRichMenuIdFromUser

unlinkRichMenuIdFromUsers()

unlinkRichMenuIdFromUsers(richMenuBulkUnlinkRequest): Promise<MessageAPIResponseBase>

Defined in: lib/line-bot-client.generated.ts:2766

Unlink rich menus from multiple users Calls POST https://api.line.me/v2/bot/richmenu/bulk/unlink. To inspect the HTTP status code or response headers, use unlinkRichMenuIdFromUsersWithHttpInfo.

Parameters

richMenuBulkUnlinkRequest

Returns

Promise<MessageAPIResponseBase>

A promise resolving to the response body.

See

RichMenuBulkUnlinkRequest

Inherited from

LineBotClientBase.unlinkRichMenuIdFromUsers

unlinkRichMenuIdFromUsersWithHttpInfo()

unlinkRichMenuIdFromUsersWithHttpInfo(richMenuBulkUnlinkRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Defined in: lib/line-bot-client.generated.ts:2782

Unlink rich menus from multiple users Calls POST https://api.line.me/v2/bot/richmenu/bulk/unlink. This method returns the response body together with the underlying httpResponse.

Parameters

richMenuBulkUnlinkRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.unlinkRichMenuIdFromUsersWithHttpInfo

unlinkRichMenuIdFromUserWithHttpInfo()

unlinkRichMenuIdFromUserWithHttpInfo(userId): Promise<ApiResponseType<MessageAPIResponseBase>>

Defined in: lib/line-bot-client.generated.ts:2750

Unlink rich menu from user Calls DELETE https://api.line.me/v2/bot/user/{userId}/richmenu. This method returns the response body together with the underlying httpResponse.

Parameters

userId

string

User ID. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE.

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

A promise resolving to the response body together with the underlying httpResponse.

See

UpdateAudienceGroupDescriptionRequest

Inherited from

LineBotClientBase.unlinkRichMenuIdFromUserWithHttpInfo

updateAudienceGroupDescription()

updateAudienceGroupDescription(audienceGroupId, updateAudienceGroupDescriptionRequest): Promise<MessageAPIResponseBase>

Defined in: lib/line-bot-client.generated.ts:769

Renames an existing audience. Calls PUT https://api.line.me/v2/bot/audienceGroup/{audienceGroupId}/updateDescription. To inspect the HTTP status code or response headers, use updateAudienceGroupDescriptionWithHttpInfo.

Parameters

audienceGroupId

number

The audience ID.

updateAudienceGroupDescriptionRequest

Returns

Promise<MessageAPIResponseBase>

A promise resolving to the response body.

See

UpdateAudienceGroupDescriptionRequest

Inherited from

LineBotClientBase.updateAudienceGroupDescription

updateAudienceGroupDescriptionWithHttpInfo()

updateAudienceGroupDescriptionWithHttpInfo(audienceGroupId, updateAudienceGroupDescriptionRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Defined in: lib/line-bot-client.generated.ts:788

Renames an existing audience. Calls PUT https://api.line.me/v2/bot/audienceGroup/{audienceGroupId}/updateDescription. This method returns the response body together with the underlying httpResponse.

Parameters

audienceGroupId

number

The audience ID.

updateAudienceGroupDescriptionRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.updateAudienceGroupDescriptionWithHttpInfo

updateLIFFApp()

updateLIFFApp(liffId, updateLiffAppRequest): Promise<MessageAPIResponseBase>

Defined in: lib/line-bot-client.generated.ts:381

Update LIFF app settings Calls PUT https://api.line.me/liff/v1/apps/{liffId}. To inspect the HTTP status code or response headers, use updateLIFFAppWithHttpInfo.

Parameters

liffId

string

ID of the LIFF app to be updated

updateLiffAppRequest

UpdateLiffAppRequest

Returns

Promise<MessageAPIResponseBase>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.updateLIFFApp

updateLIFFAppWithHttpInfo()

updateLIFFAppWithHttpInfo(liffId, updateLiffAppRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Defined in: lib/line-bot-client.generated.ts:398

Update LIFF app settings Calls PUT https://api.line.me/liff/v1/apps/{liffId}. This method returns the response body together with the underlying httpResponse.

Parameters

liffId

string

ID of the LIFF app to be updated

updateLiffAppRequest

UpdateLiffAppRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

A promise resolving to the response body together with the underlying httpResponse.

See

UpdateRichMenuAliasRequest

Inherited from

LineBotClientBase.updateLIFFAppWithHttpInfo

updateRichMenuAlias()

updateRichMenuAlias(richMenuAliasId, updateRichMenuAliasRequest): Promise<MessageAPIResponseBase>

Defined in: lib/line-bot-client.generated.ts:2799

Update rich menu alias Calls POST https://api.line.me/v2/bot/richmenu/alias/{richMenuAliasId}. To inspect the HTTP status code or response headers, use updateRichMenuAliasWithHttpInfo.

Parameters

richMenuAliasId

string

The rich menu alias ID you want to update.

updateRichMenuAliasRequest

Returns

Promise<MessageAPIResponseBase>

A promise resolving to the response body.

See

UpdateRichMenuAliasRequest

Inherited from

LineBotClientBase.updateRichMenuAlias

updateRichMenuAliasWithHttpInfo()

updateRichMenuAliasWithHttpInfo(richMenuAliasId, updateRichMenuAliasRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Defined in: lib/line-bot-client.generated.ts:2818

Update rich menu alias Calls POST https://api.line.me/v2/bot/richmenu/alias/{richMenuAliasId}. This method returns the response body together with the underlying httpResponse.

Parameters

richMenuAliasId

string

The rich menu alias ID you want to update.

updateRichMenuAliasRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.updateRichMenuAliasWithHttpInfo

validateBroadcast()

validateBroadcast(validateMessageRequest): Promise<MessageAPIResponseBase>

Defined in: lib/line-bot-client.generated.ts:2836

Validate message objects of a broadcast message Calls POST https://api.line.me/v2/bot/message/validate/broadcast. To inspect the HTTP status code or response headers, use validateBroadcastWithHttpInfo.

Parameters

validateMessageRequest

Returns

Promise<MessageAPIResponseBase>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.validateBroadcast

validateBroadcastWithHttpInfo()

validateBroadcastWithHttpInfo(validateMessageRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Defined in: lib/line-bot-client.generated.ts:2850

Validate message objects of a broadcast message Calls POST https://api.line.me/v2/bot/message/validate/broadcast. This method returns the response body together with the underlying httpResponse.

Parameters

validateMessageRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.validateBroadcastWithHttpInfo

validateMulticast()

validateMulticast(validateMessageRequest): Promise<MessageAPIResponseBase>

Defined in: lib/line-bot-client.generated.ts:2866

Validate message objects of a multicast message Calls POST https://api.line.me/v2/bot/message/validate/multicast. To inspect the HTTP status code or response headers, use validateMulticastWithHttpInfo.

Parameters

validateMessageRequest

Returns

Promise<MessageAPIResponseBase>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.validateMulticast

validateMulticastWithHttpInfo()

validateMulticastWithHttpInfo(validateMessageRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Defined in: lib/line-bot-client.generated.ts:2880

Validate message objects of a multicast message Calls POST https://api.line.me/v2/bot/message/validate/multicast. This method returns the response body together with the underlying httpResponse.

Parameters

validateMessageRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.validateMulticastWithHttpInfo

validateNarrowcast()

validateNarrowcast(validateMessageRequest): Promise<MessageAPIResponseBase>

Defined in: lib/line-bot-client.generated.ts:2896

Validate message objects of a narrowcast message Calls POST https://api.line.me/v2/bot/message/validate/narrowcast. To inspect the HTTP status code or response headers, use validateNarrowcastWithHttpInfo.

Parameters

validateMessageRequest

Returns

Promise<MessageAPIResponseBase>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.validateNarrowcast

validateNarrowcastWithHttpInfo()

validateNarrowcastWithHttpInfo(validateMessageRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Defined in: lib/line-bot-client.generated.ts:2910

Validate message objects of a narrowcast message Calls POST https://api.line.me/v2/bot/message/validate/narrowcast. This method returns the response body together with the underlying httpResponse.

Parameters

validateMessageRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.validateNarrowcastWithHttpInfo

validatePush()

validatePush(validateMessageRequest): Promise<MessageAPIResponseBase>

Defined in: lib/line-bot-client.generated.ts:2926

Validate message objects of a push message Calls POST https://api.line.me/v2/bot/message/validate/push. To inspect the HTTP status code or response headers, use validatePushWithHttpInfo.

Parameters

validateMessageRequest

Returns

Promise<MessageAPIResponseBase>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.validatePush

validatePushWithHttpInfo()

validatePushWithHttpInfo(validateMessageRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Defined in: lib/line-bot-client.generated.ts:2940

Validate message objects of a push message Calls POST https://api.line.me/v2/bot/message/validate/push. This method returns the response body together with the underlying httpResponse.

Parameters

validateMessageRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.validatePushWithHttpInfo

validateReply()

validateReply(validateMessageRequest): Promise<MessageAPIResponseBase>

Defined in: lib/line-bot-client.generated.ts:2956

Validate message objects of a reply message Calls POST https://api.line.me/v2/bot/message/validate/reply. To inspect the HTTP status code or response headers, use validateReplyWithHttpInfo.

Parameters

validateMessageRequest

Returns

Promise<MessageAPIResponseBase>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.validateReply

validateReplyWithHttpInfo()

validateReplyWithHttpInfo(validateMessageRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Defined in: lib/line-bot-client.generated.ts:2970

Validate message objects of a reply message Calls POST https://api.line.me/v2/bot/message/validate/reply. This method returns the response body together with the underlying httpResponse.

Parameters

validateMessageRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.validateReplyWithHttpInfo

validateRichMenuBatchRequest()

validateRichMenuBatchRequest(richMenuBatchRequest): Promise<MessageAPIResponseBase>

Defined in: lib/line-bot-client.generated.ts:2986

Validate a request body of the Replace or unlink the linked rich menus in batches endpoint. Calls POST https://api.line.me/v2/bot/richmenu/validate/batch. To inspect the HTTP status code or response headers, use validateRichMenuBatchRequestWithHttpInfo.

Parameters

richMenuBatchRequest

Returns

Promise<MessageAPIResponseBase>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.validateRichMenuBatchRequest

validateRichMenuBatchRequestWithHttpInfo()

validateRichMenuBatchRequestWithHttpInfo(richMenuBatchRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Defined in: lib/line-bot-client.generated.ts:3002

Validate a request body of the Replace or unlink the linked rich menus in batches endpoint. Calls POST https://api.line.me/v2/bot/richmenu/validate/batch. This method returns the response body together with the underlying httpResponse.

Parameters

richMenuBatchRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

A promise resolving to the response body together with the underlying httpResponse.

See

Inherited from

LineBotClientBase.validateRichMenuBatchRequestWithHttpInfo

validateRichMenuObject()

validateRichMenuObject(richMenuRequest): Promise<MessageAPIResponseBase>

Defined in: lib/line-bot-client.generated.ts:3018

Validate rich menu object Calls POST https://api.line.me/v2/bot/richmenu/validate. To inspect the HTTP status code or response headers, use validateRichMenuObjectWithHttpInfo.

Parameters

richMenuRequest

Returns

Promise<MessageAPIResponseBase>

A promise resolving to the response body.

See

Inherited from

LineBotClientBase.validateRichMenuObject

validateRichMenuObjectWithHttpInfo()

validateRichMenuObjectWithHttpInfo(richMenuRequest): Promise<ApiResponseType<MessageAPIResponseBase>>

Defined in: lib/line-bot-client.generated.ts:3032

Validate rich menu object Calls POST https://api.line.me/v2/bot/richmenu/validate. This method returns the response body together with the underlying httpResponse.

Parameters

richMenuRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

A promise resolving to the response body together with the underlying httpResponse.

See