Appearance
@line/bot-sdk / LineBotClient
Class: LineBotClient
Defined in: lib/line-bot-client.ts:84
A single client for all LINE Bot APIs, except channel access token management.
Wraps all individual API clients (Messaging API, LIFF, Insight, etc.) and exposes their methods directly, so you don't need to manage multiple client instances. For channel access token operations, use ChannelAccessTokenClient directly.
Examples
typescript
const client = LineBotClient.fromChannelAccessToken({ channelAccessToken: "..." });typescript
await client.pushMessage({
to: userId,
messages: [{ type: "text", text: "Hi there!" }],
});typescript
const profile = await client.getProfile(userId);
console.log(profile.displayName);Extends
LineBotClientBase
Properties
clients
protectedreadonlyclients:LineBotClientDelegates
Defined in: lib/line-bot-client.ts:85
Overrides
LineBotClientBase.clients
Methods
acquireChatControl()
acquireChatControl(
chatId,acquireChatControlRequest?):Promise<MessageAPIResponseBase>
Defined in: lib/line-bot-client.generated.ts:2766
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.
Parameters
chatId
string
The userId, roomId, or groupId
acquireChatControlRequest?
Returns
Promise<MessageAPIResponseBase>
See
Inherited from
LineBotClientBase.acquireChatControl
acquireChatControlWithHttpInfo()
acquireChatControlWithHttpInfo(
chatId,acquireChatControlRequest?):Promise<ApiResponseType<MessageAPIResponseBase>>
Defined in: lib/line-bot-client.generated.ts:2784
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. . This method includes HttpInfo object to return additional information.
Parameters
chatId
string
The userId, roomId, or groupId
acquireChatControlRequest?
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Inherited from
LineBotClientBase.acquireChatControlWithHttpInfo
addAudienceToAudienceGroup()
addAudienceToAudienceGroup(
addAudienceToAudienceGroupRequest):Promise<MessageAPIResponseBase>
Defined in: lib/line-bot-client.generated.ts:303
Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by JSON)
Parameters
addAudienceToAudienceGroupRequest
AddAudienceToAudienceGroupRequest
Returns
Promise<MessageAPIResponseBase>
See
Inherited from
LineBotClientBase.addAudienceToAudienceGroup
addAudienceToAudienceGroupWithHttpInfo()
addAudienceToAudienceGroupWithHttpInfo(
addAudienceToAudienceGroupRequest):Promise<ApiResponseType<MessageAPIResponseBase>>
Defined in: lib/line-bot-client.generated.ts:318
Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by JSON). This method includes HttpInfo object to return additional information.
Parameters
addAudienceToAudienceGroupRequest
AddAudienceToAudienceGroupRequest
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Inherited from
LineBotClientBase.addAudienceToAudienceGroupWithHttpInfo
addLIFFApp()
addLIFFApp(
addLiffAppRequest):Promise<AddLiffAppResponse>
Defined in: lib/line-bot-client.generated.ts:193
Adding the LIFF app to a channel
Parameters
addLiffAppRequest
Returns
Promise<AddLiffAppResponse>
See
Inherited from
LineBotClientBase.addLIFFApp
addLIFFAppWithHttpInfo()
addLIFFAppWithHttpInfo(
addLiffAppRequest):Promise<ApiResponseType<AddLiffAppResponse>>
Defined in: lib/line-bot-client.generated.ts:207
Adding the LIFF app to a channel. This method includes HttpInfo object to return additional information.
Parameters
addLiffAppRequest
Returns
Promise<ApiResponseType<AddLiffAppResponse>>
See
Inherited from
LineBotClientBase.addLIFFAppWithHttpInfo
addUserIdsToAudience()
addUserIdsToAudience(
file,audienceGroupId?,uploadDescription?):Promise<MessageAPIResponseBase>
Defined in: lib/line-bot-client.generated.ts:665
Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by file).
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>
See
Inherited from
LineBotClientBase.addUserIdsToAudience
addUserIdsToAudienceWithHttpInfo()
addUserIdsToAudienceWithHttpInfo(
file,audienceGroupId?,uploadDescription?):Promise<ApiResponseType<MessageAPIResponseBase>>
Defined in: lib/line-bot-client.generated.ts:686
Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by file).. This method includes HttpInfo object to return additional information.
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>>
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:2890
Attach by operation of the module channel provider
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>
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:2932
Attach by operation of the module channel provider. This method includes HttpInfo object to return additional information.
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<ApiResponseType<AttachModuleResponse>>
See
Inherited from
LineBotClientBase.attachModuleWithHttpInfo
broadcast()
broadcast(
broadcastRequest,xLineRetryKey?):Promise<object>
Defined in: lib/line-bot-client.generated.ts:754
Sends a message to multiple users at any time.
Parameters
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>
See
Inherited from
LineBotClientBase.broadcast
broadcastWithHttpInfo()
broadcastWithHttpInfo(
broadcastRequest,xLineRetryKey?):Promise<ApiResponseType<object>>
Defined in: lib/line-bot-client.generated.ts:769
Sends a message to multiple users at any time.. This method includes HttpInfo object to return additional information.
Parameters
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<ApiResponseType<object>>
See
Inherited from
LineBotClientBase.broadcastWithHttpInfo
cancelDefaultRichMenu()
cancelDefaultRichMenu():
Promise<MessageAPIResponseBase>
Defined in: lib/line-bot-client.generated.ts:784
Cancel default rich menu
Returns
Promise<MessageAPIResponseBase>
See
Inherited from
LineBotClientBase.cancelDefaultRichMenu
cancelDefaultRichMenuWithHttpInfo()
cancelDefaultRichMenuWithHttpInfo():
Promise<ApiResponseType<MessageAPIResponseBase>>
Defined in: lib/line-bot-client.generated.ts:794
Cancel default rich menu. This method includes HttpInfo object to return additional information.
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Inherited from
LineBotClientBase.cancelDefaultRichMenuWithHttpInfo
closeCoupon()
closeCoupon(
couponId):Promise<MessageAPIResponseBase>
Defined in: lib/line-bot-client.generated.ts:806
Close coupon
Parameters
couponId
string
Returns
Promise<MessageAPIResponseBase>
See
Inherited from
LineBotClientBase.closeCoupon
closeCouponWithHttpInfo()
closeCouponWithHttpInfo(
couponId):Promise<ApiResponseType<MessageAPIResponseBase>>
Defined in: lib/line-bot-client.generated.ts:819
Close coupon. This method includes HttpInfo object to return additional information.
Parameters
couponId
string
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Inherited from
LineBotClientBase.closeCouponWithHttpInfo
createAudienceForUploadingUserIds()
createAudienceForUploadingUserIds(
file,description?,isIfaAudience?,uploadDescription?):Promise<CreateAudienceGroupResponse>
Defined in: lib/line-bot-client.generated.ts:707
Create audience for uploading user IDs (by file).
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>
See
Inherited from
LineBotClientBase.createAudienceForUploadingUserIds
createAudienceForUploadingUserIdsWithHttpInfo()
createAudienceForUploadingUserIdsWithHttpInfo(
file,description?,isIfaAudience?,uploadDescription?):Promise<ApiResponseType<CreateAudienceGroupResponse>>
Defined in: lib/line-bot-client.generated.ts:731
Create audience for uploading user IDs (by file).. This method includes HttpInfo object to return additional information.
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>>
See
Inherited from
LineBotClientBase.createAudienceForUploadingUserIdsWithHttpInfo
createAudienceGroup()
createAudienceGroup(
createAudienceGroupRequest):Promise<CreateAudienceGroupResponse>
Defined in: lib/line-bot-client.generated.ts:332
Create audience for uploading user IDs (by JSON)
Parameters
createAudienceGroupRequest
Returns
Promise<CreateAudienceGroupResponse>
See
Inherited from
LineBotClientBase.createAudienceGroup
createAudienceGroupWithHttpInfo()
createAudienceGroupWithHttpInfo(
createAudienceGroupRequest):Promise<ApiResponseType<CreateAudienceGroupResponse>>
Defined in: lib/line-bot-client.generated.ts:347
Create audience for uploading user IDs (by JSON). This method includes HttpInfo object to return additional information.
Parameters
createAudienceGroupRequest
Returns
Promise<ApiResponseType<CreateAudienceGroupResponse>>
See
Inherited from
LineBotClientBase.createAudienceGroupWithHttpInfo
createClickBasedAudienceGroup()
createClickBasedAudienceGroup(
createClickBasedAudienceGroupRequest):Promise<CreateClickBasedAudienceGroupResponse>
Defined in: lib/line-bot-client.generated.ts:363
Create audience for click-based retargeting
Parameters
createClickBasedAudienceGroupRequest
CreateClickBasedAudienceGroupRequest
Returns
Promise<CreateClickBasedAudienceGroupResponse>
See
Inherited from
LineBotClientBase.createClickBasedAudienceGroup
createClickBasedAudienceGroupWithHttpInfo()
createClickBasedAudienceGroupWithHttpInfo(
createClickBasedAudienceGroupRequest):Promise<ApiResponseType<CreateClickBasedAudienceGroupResponse>>
Defined in: lib/line-bot-client.generated.ts:378
Create audience for click-based retargeting. This method includes HttpInfo object to return additional information.
Parameters
createClickBasedAudienceGroupRequest
CreateClickBasedAudienceGroupRequest
Returns
Promise<ApiResponseType<CreateClickBasedAudienceGroupResponse>>
See
Inherited from
LineBotClientBase.createClickBasedAudienceGroupWithHttpInfo
createCoupon()
createCoupon(
couponCreateRequest?):Promise<CouponCreateResponse>
Defined in: lib/line-bot-client.generated.ts:831
Create a new coupon. Define coupon details such as type, title, and validity period.
Parameters
couponCreateRequest?
Returns
Promise<CouponCreateResponse>
See
Inherited from
LineBotClientBase.createCoupon
createCouponWithHttpInfo()
createCouponWithHttpInfo(
couponCreateRequest?):Promise<ApiResponseType<CouponCreateResponse>>
Defined in: lib/line-bot-client.generated.ts:844
Create a new coupon. Define coupon details such as type, title, and validity period.. This method includes HttpInfo object to return additional information.
Parameters
couponCreateRequest?
Returns
Promise<ApiResponseType<CouponCreateResponse>>
See
Inherited from
LineBotClientBase.createCouponWithHttpInfo
createImpBasedAudienceGroup()
createImpBasedAudienceGroup(
createImpBasedAudienceGroupRequest):Promise<CreateImpBasedAudienceGroupResponse>
Defined in: lib/line-bot-client.generated.ts:394
Create audience for impression-based retargeting
Parameters
createImpBasedAudienceGroupRequest
CreateImpBasedAudienceGroupRequest
Returns
Promise<CreateImpBasedAudienceGroupResponse>
See
Inherited from
LineBotClientBase.createImpBasedAudienceGroup
createImpBasedAudienceGroupWithHttpInfo()
createImpBasedAudienceGroupWithHttpInfo(
createImpBasedAudienceGroupRequest):Promise<ApiResponseType<CreateImpBasedAudienceGroupResponse>>
Defined in: lib/line-bot-client.generated.ts:409
Create audience for impression-based retargeting. This method includes HttpInfo object to return additional information.
Parameters
createImpBasedAudienceGroupRequest
CreateImpBasedAudienceGroupRequest
Returns
Promise<ApiResponseType<CreateImpBasedAudienceGroupResponse>>
See
Inherited from
LineBotClientBase.createImpBasedAudienceGroupWithHttpInfo
createRichMenu()
createRichMenu(
richMenuRequest):Promise<RichMenuIdResponse>
Defined in: lib/line-bot-client.generated.ts:858
Create rich menu
Parameters
richMenuRequest
Returns
Promise<RichMenuIdResponse>
See
Inherited from
LineBotClientBase.createRichMenu
createRichMenuAlias()
createRichMenuAlias(
createRichMenuAliasRequest):Promise<MessageAPIResponseBase>
Defined in: lib/line-bot-client.generated.ts:885
Create rich menu alias
Parameters
createRichMenuAliasRequest
Returns
Promise<MessageAPIResponseBase>
See
Inherited from
LineBotClientBase.createRichMenuAlias
createRichMenuAliasWithHttpInfo()
createRichMenuAliasWithHttpInfo(
createRichMenuAliasRequest):Promise<ApiResponseType<MessageAPIResponseBase>>
Defined in: lib/line-bot-client.generated.ts:900
Create rich menu alias. This method includes HttpInfo object to return additional information.
Parameters
createRichMenuAliasRequest
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Inherited from
LineBotClientBase.createRichMenuAliasWithHttpInfo
createRichMenuWithHttpInfo()
createRichMenuWithHttpInfo(
richMenuRequest):Promise<ApiResponseType<RichMenuIdResponse>>
Defined in: lib/line-bot-client.generated.ts:871
Create rich menu. This method includes HttpInfo object to return additional information.
Parameters
richMenuRequest
Returns
Promise<ApiResponseType<RichMenuIdResponse>>
See
Inherited from
LineBotClientBase.createRichMenuWithHttpInfo
deleteAudienceGroup()
deleteAudienceGroup(
audienceGroupId):Promise<MessageAPIResponseBase>
Defined in: lib/line-bot-client.generated.ts:425
Delete audience
Parameters
audienceGroupId
number
The audience ID.
Returns
Promise<MessageAPIResponseBase>
See
Inherited from
LineBotClientBase.deleteAudienceGroup
deleteAudienceGroupWithHttpInfo()
deleteAudienceGroupWithHttpInfo(
audienceGroupId):Promise<ApiResponseType<MessageAPIResponseBase>>
Defined in: lib/line-bot-client.generated.ts:438
Delete audience. This method includes HttpInfo object to return additional information.
Parameters
audienceGroupId
number
The audience ID.
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Inherited from
LineBotClientBase.deleteAudienceGroupWithHttpInfo
deleteLIFFApp()
deleteLIFFApp(
liffId):Promise<MessageAPIResponseBase>
Defined in: lib/line-bot-client.generated.ts:220
Deletes a LIFF app from a channel.
Parameters
liffId
string
ID of the LIFF app to be updated
Returns
Promise<MessageAPIResponseBase>
See
Delete LIFF app from a channel Documentation
Inherited from
LineBotClientBase.deleteLIFFApp
deleteLIFFAppWithHttpInfo()
deleteLIFFAppWithHttpInfo(
liffId):Promise<ApiResponseType<MessageAPIResponseBase>>
Defined in: lib/line-bot-client.generated.ts:234
Deletes a LIFF app from a channel. . This method includes HttpInfo object to return additional information.
Parameters
liffId
string
ID of the LIFF app to be updated
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Delete LIFF app from a channel Documentation
Inherited from
LineBotClientBase.deleteLIFFAppWithHttpInfo
deleteRichMenu()
deleteRichMenu(
richMenuId):Promise<MessageAPIResponseBase>
Defined in: lib/line-bot-client.generated.ts:914
Deletes a rich menu.
Parameters
richMenuId
string
ID of a rich menu
Returns
Promise<MessageAPIResponseBase>
See
Inherited from
LineBotClientBase.deleteRichMenu
deleteRichMenuAlias()
deleteRichMenuAlias(
richMenuAliasId):Promise<MessageAPIResponseBase>
Defined in: lib/line-bot-client.generated.ts:939
Delete rich menu alias
Parameters
richMenuAliasId
string
Rich menu alias ID that you want to delete.
Returns
Promise<MessageAPIResponseBase>
See
Inherited from
LineBotClientBase.deleteRichMenuAlias
deleteRichMenuAliasWithHttpInfo()
deleteRichMenuAliasWithHttpInfo(
richMenuAliasId):Promise<ApiResponseType<MessageAPIResponseBase>>
Defined in: lib/line-bot-client.generated.ts:952
Delete rich menu alias. This method includes HttpInfo object to return additional information.
Parameters
richMenuAliasId
string
Rich menu alias ID that you want to delete.
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Inherited from
LineBotClientBase.deleteRichMenuAliasWithHttpInfo
deleteRichMenuWithHttpInfo()
deleteRichMenuWithHttpInfo(
richMenuId):Promise<ApiResponseType<MessageAPIResponseBase>>
Defined in: lib/line-bot-client.generated.ts:927
Deletes a rich menu.. This method includes HttpInfo object to return additional information.
Parameters
richMenuId
string
ID of a rich menu
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Inherited from
LineBotClientBase.deleteRichMenuWithHttpInfo
detachModule()
detachModule(
detachModuleRequest?):Promise<MessageAPIResponseBase>
Defined in: lib/line-bot-client.generated.ts:2800
The module channel admin calls the Detach API to detach the module channel from a LINE Official Account.
Parameters
detachModuleRequest?
Returns
Promise<MessageAPIResponseBase>
See
Inherited from
LineBotClientBase.detachModule
detachModuleWithHttpInfo()
detachModuleWithHttpInfo(
detachModuleRequest?):Promise<ApiResponseType<MessageAPIResponseBase>>
Defined in: lib/line-bot-client.generated.ts:2813
The module channel admin calls the Detach API to detach the module channel from a LINE Official Account.. This method includes HttpInfo object to return additional information.
Parameters
detachModuleRequest?
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Inherited from
LineBotClientBase.detachModuleWithHttpInfo
getAggregationUnitNameList()
getAggregationUnitNameList(
limit?,start?):Promise<GetAggregationUnitNameListResponse>
Defined in: lib/line-bot-client.generated.ts:967
Get name list of units used this month
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>
See
Inherited from
LineBotClientBase.getAggregationUnitNameList
getAggregationUnitNameListWithHttpInfo()
getAggregationUnitNameListWithHttpInfo(
limit?,start?):Promise<ApiResponseType<GetAggregationUnitNameListResponse>>
Defined in: lib/line-bot-client.generated.ts:982
Get name list of units used this month. This method includes HttpInfo object to return additional information.
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<ApiResponseType<GetAggregationUnitNameListResponse>>
See
Inherited from
LineBotClientBase.getAggregationUnitNameListWithHttpInfo
getAggregationUnitUsage()
getAggregationUnitUsage():
Promise<GetAggregationUnitUsageResponse>
Defined in: lib/line-bot-client.generated.ts:999
Get number of units used this month
Returns
Promise<GetAggregationUnitUsageResponse>
See
Inherited from
LineBotClientBase.getAggregationUnitUsage
getAggregationUnitUsageWithHttpInfo()
getAggregationUnitUsageWithHttpInfo():
Promise<ApiResponseType<GetAggregationUnitUsageResponse>>
Defined in: lib/line-bot-client.generated.ts:1009
Get number of units used this month. This method includes HttpInfo object to return additional information.
Returns
Promise<ApiResponseType<GetAggregationUnitUsageResponse>>
See
Inherited from
LineBotClientBase.getAggregationUnitUsageWithHttpInfo
getAllLIFFApps()
getAllLIFFApps():
Promise<GetAllLiffAppsResponse>
Defined in: lib/line-bot-client.generated.ts:246
Gets information on all the LIFF apps added to the channel.
Returns
Promise<GetAllLiffAppsResponse>
See
Get all LIFF apps Documentation
Inherited from
LineBotClientBase.getAllLIFFApps
getAllLIFFAppsWithHttpInfo()
getAllLIFFAppsWithHttpInfo():
Promise<ApiResponseType<GetAllLiffAppsResponse>>
Defined in: lib/line-bot-client.generated.ts:257
Gets information on all the LIFF apps added to the channel.. This method includes HttpInfo object to return additional information.
Returns
Promise<ApiResponseType<GetAllLiffAppsResponse>>
See
Get all LIFF apps Documentation
Inherited from
LineBotClientBase.getAllLIFFAppsWithHttpInfo
getAudienceData()
getAudienceData(
audienceGroupId):Promise<GetAudienceDataResponse>
Defined in: lib/line-bot-client.generated.ts:452
Gets audience data.
Parameters
audienceGroupId
number
The audience ID.
Returns
Promise<GetAudienceDataResponse>
See
Inherited from
LineBotClientBase.getAudienceData
getAudienceDataWithHttpInfo()
getAudienceDataWithHttpInfo(
audienceGroupId):Promise<ApiResponseType<GetAudienceDataResponse>>
Defined in: lib/line-bot-client.generated.ts:465
Gets audience data.. This method includes HttpInfo object to return additional information.
Parameters
audienceGroupId
number
The audience ID.
Returns
Promise<ApiResponseType<GetAudienceDataResponse>>
See
Inherited from
LineBotClientBase.getAudienceDataWithHttpInfo
getAudienceGroups()
getAudienceGroups(
page,description?,status?,size?,includesExternalPublicGroups?,createRoute?):Promise<GetAudienceGroupsResponse>
Defined in: lib/line-bot-client.generated.ts:484
Gets data for more than one audience.
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>
See
Inherited from
LineBotClientBase.getAudienceGroups
getAudienceGroupsWithHttpInfo()
getAudienceGroupsWithHttpInfo(
page,description?,status?,size?,includesExternalPublicGroups?,createRoute?):Promise<ApiResponseType<GetAudienceGroupsResponse>>
Defined in: lib/line-bot-client.generated.ts:514
Gets data for more than one audience.. This method includes HttpInfo object to return additional information.
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<ApiResponseType<GetAudienceGroupsResponse>>
See
Inherited from
LineBotClientBase.getAudienceGroupsWithHttpInfo
getBotInfo()
getBotInfo():
Promise<BotInfoResponse>
Defined in: lib/line-bot-client.generated.ts:1020
Get bot info
Returns
Promise<BotInfoResponse>
See
Inherited from
LineBotClientBase.getBotInfo
getBotInfoWithHttpInfo()
getBotInfoWithHttpInfo():
Promise<ApiResponseType<BotInfoResponse>>
Defined in: lib/line-bot-client.generated.ts:1030
Get bot info. This method includes HttpInfo object to return additional information.
Returns
Promise<ApiResponseType<BotInfoResponse>>
See
Inherited from
LineBotClientBase.getBotInfoWithHttpInfo
getCouponDetail()
getCouponDetail(
couponId):Promise<CouponResponse>
Defined in: lib/line-bot-client.generated.ts:1042
Get coupon detail
Parameters
couponId
string
Returns
Promise<CouponResponse>
See
Inherited from
LineBotClientBase.getCouponDetail
getCouponDetailWithHttpInfo()
getCouponDetailWithHttpInfo(
couponId):Promise<ApiResponseType<CouponResponse>>
Defined in: lib/line-bot-client.generated.ts:1055
Get coupon detail. This method includes HttpInfo object to return additional information.
Parameters
couponId
string
Returns
Promise<ApiResponseType<CouponResponse>>
See
Inherited from
LineBotClientBase.getCouponDetailWithHttpInfo
getDefaultRichMenuId()
getDefaultRichMenuId():
Promise<RichMenuIdResponse>
Defined in: lib/line-bot-client.generated.ts:1066
Gets the ID of the default rich menu set with the Messaging API.
Returns
Promise<RichMenuIdResponse>
See
Inherited from
LineBotClientBase.getDefaultRichMenuId
getDefaultRichMenuIdWithHttpInfo()
getDefaultRichMenuIdWithHttpInfo():
Promise<ApiResponseType<RichMenuIdResponse>>
Defined in: lib/line-bot-client.generated.ts:1076
Gets the ID of the default rich menu set with the Messaging API.. This method includes HttpInfo object to return additional information.
Returns
Promise<ApiResponseType<RichMenuIdResponse>>
See
Inherited from
LineBotClientBase.getDefaultRichMenuIdWithHttpInfo
getFollowers()
getFollowers(
start?,limit?):Promise<GetFollowersResponse>
Defined in: lib/line-bot-client.generated.ts:1089
Get a list of users who added your LINE Official Account as a friend
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>
See
Inherited from
LineBotClientBase.getFollowers
getFollowersWithHttpInfo()
getFollowersWithHttpInfo(
start?,limit?):Promise<ApiResponseType<GetFollowersResponse>>
Defined in: lib/line-bot-client.generated.ts:1104
Get a list of users who added your LINE Official Account as a friend. This method includes HttpInfo object to return additional information.
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>>
See
Inherited from
LineBotClientBase.getFollowersWithHttpInfo
getFriendsDemographics()
getFriendsDemographics():
Promise<GetFriendsDemographicsResponse>
Defined in: lib/line-bot-client.generated.ts:46
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).
Returns
Promise<GetFriendsDemographicsResponse>
See
Inherited from
LineBotClientBase.getFriendsDemographics
getFriendsDemographicsWithHttpInfo()
getFriendsDemographicsWithHttpInfo():
Promise<ApiResponseType<GetFriendsDemographicsResponse>>
Defined in: lib/line-bot-client.generated.ts:56
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). . This method includes HttpInfo object to return additional information.
Returns
Promise<ApiResponseType<GetFriendsDemographicsResponse>>
See
Inherited from
LineBotClientBase.getFriendsDemographicsWithHttpInfo
getGroupMemberCount()
getGroupMemberCount(
groupId):Promise<GroupMemberCountResponse>
Defined in: lib/line-bot-client.generated.ts:1117
Get number of users in a group chat
Parameters
groupId
string
Group ID
Returns
Promise<GroupMemberCountResponse>
See
Inherited from
LineBotClientBase.getGroupMemberCount
getGroupMemberCountWithHttpInfo()
getGroupMemberCountWithHttpInfo(
groupId):Promise<ApiResponseType<GroupMemberCountResponse>>
Defined in: lib/line-bot-client.generated.ts:1130
Get number of users in a group chat. This method includes HttpInfo object to return additional information.
Parameters
groupId
string
Group ID
Returns
Promise<ApiResponseType<GroupMemberCountResponse>>
See
Inherited from
LineBotClientBase.getGroupMemberCountWithHttpInfo
getGroupMemberProfile()
getGroupMemberProfile(
groupId,userId):Promise<GroupUserProfileResponse>
Defined in: lib/line-bot-client.generated.ts:1143
Get group chat member profile
Parameters
groupId
string
Group ID
userId
string
User ID
Returns
Promise<GroupUserProfileResponse>
See
Inherited from
LineBotClientBase.getGroupMemberProfile
getGroupMemberProfileWithHttpInfo()
getGroupMemberProfileWithHttpInfo(
groupId,userId):Promise<ApiResponseType<GroupUserProfileResponse>>
Defined in: lib/line-bot-client.generated.ts:1158
Get group chat member profile. This method includes HttpInfo object to return additional information.
Parameters
groupId
string
Group ID
userId
string
User ID
Returns
Promise<ApiResponseType<GroupUserProfileResponse>>
See
Inherited from
LineBotClientBase.getGroupMemberProfileWithHttpInfo
getGroupMembersIds()
getGroupMembersIds(
groupId,start?):Promise<MembersIdsResponse>
Defined in: lib/line-bot-client.generated.ts:1175
Get group chat member user IDs
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>
See
Inherited from
LineBotClientBase.getGroupMembersIds
getGroupMembersIdsWithHttpInfo()
getGroupMembersIdsWithHttpInfo(
groupId,start?):Promise<ApiResponseType<MembersIdsResponse>>
Defined in: lib/line-bot-client.generated.ts:1190
Get group chat member user IDs. This method includes HttpInfo object to return additional information.
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>>
See
Inherited from
LineBotClientBase.getGroupMembersIdsWithHttpInfo
getGroupSummary()
getGroupSummary(
groupId):Promise<GroupSummaryResponse>
Defined in: lib/line-bot-client.generated.ts:1206
Get group chat summary
Parameters
groupId
string
Group ID
Returns
Promise<GroupSummaryResponse>
See
Inherited from
LineBotClientBase.getGroupSummary
getGroupSummaryWithHttpInfo()
getGroupSummaryWithHttpInfo(
groupId):Promise<ApiResponseType<GroupSummaryResponse>>
Defined in: lib/line-bot-client.generated.ts:1219
Get group chat summary. This method includes HttpInfo object to return additional information.
Parameters
groupId
string
Group ID
Returns
Promise<ApiResponseType<GroupSummaryResponse>>
See
Inherited from
LineBotClientBase.getGroupSummaryWithHttpInfo
getJoinedMembershipUsers()
getJoinedMembershipUsers(
membershipId,start?,limit?):Promise<GetJoinedMembershipUsersResponse>
Defined in: lib/line-bot-client.generated.ts:1233
Get a list of user IDs who joined the membership.
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>
See
Inherited from
LineBotClientBase.getJoinedMembershipUsers
getJoinedMembershipUsersWithHttpInfo()
getJoinedMembershipUsersWithHttpInfo(
membershipId,start?,limit?):Promise<ApiResponseType<GetJoinedMembershipUsersResponse>>
Defined in: lib/line-bot-client.generated.ts:1254
Get a list of user IDs who joined the membership.. This method includes HttpInfo object to return additional information.
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<ApiResponseType<GetJoinedMembershipUsersResponse>>
See
Inherited from
LineBotClientBase.getJoinedMembershipUsersWithHttpInfo
getMembershipList()
getMembershipList():
Promise<MembershipListResponse>
Defined in: lib/line-bot-client.generated.ts:1273
Get a list of memberships.
Returns
Promise<MembershipListResponse>
See
Inherited from
LineBotClientBase.getMembershipList
getMembershipListWithHttpInfo()
getMembershipListWithHttpInfo():
Promise<ApiResponseType<MembershipListResponse>>
Defined in: lib/line-bot-client.generated.ts:1283
Get a list of memberships.. This method includes HttpInfo object to return additional information.
Returns
Promise<ApiResponseType<MembershipListResponse>>
See
Inherited from
LineBotClientBase.getMembershipListWithHttpInfo
getMembershipSubscription()
getMembershipSubscription(
userId):Promise<GetMembershipSubscriptionResponse>
Defined in: lib/line-bot-client.generated.ts:1295
Get a user's membership subscription.
Parameters
userId
string
User ID
Returns
Promise<GetMembershipSubscriptionResponse>
See
Inherited from
LineBotClientBase.getMembershipSubscription
getMembershipSubscriptionWithHttpInfo()
getMembershipSubscriptionWithHttpInfo(
userId):Promise<ApiResponseType<GetMembershipSubscriptionResponse>>
Defined in: lib/line-bot-client.generated.ts:1308
Get a user's membership subscription.. This method includes HttpInfo object to return additional information.
Parameters
userId
string
User ID
Returns
Promise<ApiResponseType<GetMembershipSubscriptionResponse>>
See
Inherited from
LineBotClientBase.getMembershipSubscriptionWithHttpInfo
getMessageContent()
getMessageContent(
messageId):Promise<Readable>
Defined in: lib/line-bot-client.generated.ts:2627
Download image, video, and audio data sent from users.
Parameters
messageId
string
Message ID of video or audio
Returns
Promise<Readable>
See
Inherited from
LineBotClientBase.getMessageContent
getMessageContentPreview()
getMessageContentPreview(
messageId):Promise<Readable>
Defined in: lib/line-bot-client.generated.ts:2652
Get a preview image of the image or video
Parameters
messageId
string
Message ID of image or video
Returns
Promise<Readable>
See
Inherited from
LineBotClientBase.getMessageContentPreview
getMessageContentPreviewWithHttpInfo()
getMessageContentPreviewWithHttpInfo(
messageId):Promise<ApiResponseType<Readable>>
Defined in: lib/line-bot-client.generated.ts:2663
Get a preview image of the image or video. This method includes HttpInfo object to return additional information.
Parameters
messageId
string
Message ID of image or video
Returns
Promise<ApiResponseType<Readable>>
See
Inherited from
LineBotClientBase.getMessageContentPreviewWithHttpInfo
getMessageContentTranscodingByMessageId()
getMessageContentTranscodingByMessageId(
messageId):Promise<GetMessageContentTranscodingResponse>
Defined in: lib/line-bot-client.generated.ts:2677
Verify the preparation status of a video or audio for getting
Parameters
messageId
string
Message ID of video or audio
Returns
Promise<GetMessageContentTranscodingResponse>
See
Inherited from
LineBotClientBase.getMessageContentTranscodingByMessageId
getMessageContentTranscodingByMessageIdWithHttpInfo()
getMessageContentTranscodingByMessageIdWithHttpInfo(
messageId):Promise<ApiResponseType<GetMessageContentTranscodingResponse>>
Defined in: lib/line-bot-client.generated.ts:2692
Verify the preparation status of a video or audio for getting. This method includes HttpInfo object to return additional information.
Parameters
messageId
string
Message ID of video or audio
Returns
Promise<ApiResponseType<GetMessageContentTranscodingResponse>>
See
Inherited from
LineBotClientBase.getMessageContentTranscodingByMessageIdWithHttpInfo
getMessageContentWithHttpInfo()
getMessageContentWithHttpInfo(
messageId):Promise<ApiResponseType<Readable>>
Defined in: lib/line-bot-client.generated.ts:2638
Download image, video, and audio data sent from users.. This method includes HttpInfo object to return additional information.
Parameters
messageId
string
Message ID of video or audio
Returns
Promise<ApiResponseType<Readable>>
See
Inherited from
LineBotClientBase.getMessageContentWithHttpInfo
getMessageEvent()
getMessageEvent(
requestId):Promise<GetMessageEventResponse>
Defined in: lib/line-bot-client.generated.ts:69
Returns statistics about how users interact with narrowcast messages or broadcast messages sent from your LINE Official Account.
Parameters
requestId
string
Request ID of a narrowcast message or broadcast message. Each Messaging API request has a request ID.
Returns
Promise<GetMessageEventResponse>
See
Get user interaction statistics Documentation
Inherited from
LineBotClientBase.getMessageEvent
getMessageEventWithHttpInfo()
getMessageEventWithHttpInfo(
requestId):Promise<ApiResponseType<GetMessageEventResponse>>
Defined in: lib/line-bot-client.generated.ts:83
Returns statistics about how users interact with narrowcast messages or broadcast messages sent from your LINE Official Account. . This method includes HttpInfo object to return additional information.
Parameters
requestId
string
Request ID of a narrowcast message or broadcast message. Each Messaging API request has a request ID.
Returns
Promise<ApiResponseType<GetMessageEventResponse>>
See
Get user interaction statistics Documentation
Inherited from
LineBotClientBase.getMessageEventWithHttpInfo
getMessageQuota()
getMessageQuota():
Promise<MessageQuotaResponse>
Defined in: lib/line-bot-client.generated.ts:1323
Gets the target limit for sending messages in the current month. The total number of the free messages and the additional messages is returned.
Returns
Promise<MessageQuotaResponse>
See
Inherited from
LineBotClientBase.getMessageQuota
getMessageQuotaConsumption()
getMessageQuotaConsumption():
Promise<QuotaConsumptionResponse>
Defined in: lib/line-bot-client.generated.ts:1344
Gets the number of messages sent in the current month.
Returns
Promise<QuotaConsumptionResponse>
See
Inherited from
LineBotClientBase.getMessageQuotaConsumption
getMessageQuotaConsumptionWithHttpInfo()
getMessageQuotaConsumptionWithHttpInfo():
Promise<ApiResponseType<QuotaConsumptionResponse>>
Defined in: lib/line-bot-client.generated.ts:1354
Gets the number of messages sent in the current month.. This method includes HttpInfo object to return additional information.
Returns
Promise<ApiResponseType<QuotaConsumptionResponse>>
See
Inherited from
LineBotClientBase.getMessageQuotaConsumptionWithHttpInfo
getMessageQuotaWithHttpInfo()
getMessageQuotaWithHttpInfo():
Promise<ApiResponseType<MessageQuotaResponse>>
Defined in: lib/line-bot-client.generated.ts:1333
Gets the target limit for sending messages in the current month. The total number of the free messages and the additional messages is returned.. This method includes HttpInfo object to return additional information.
Returns
Promise<ApiResponseType<MessageQuotaResponse>>
See
Inherited from
LineBotClientBase.getMessageQuotaWithHttpInfo
getModules()
getModules(
start?,limit?):Promise<GetModulesResponse>
Defined in: lib/line-bot-client.generated.ts:2828
Gets a list of basic information about the bots of multiple LINE Official Accounts that have attached module channels.
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>
See
Inherited from
LineBotClientBase.getModules
getModulesWithHttpInfo()
getModulesWithHttpInfo(
start?,limit?):Promise<ApiResponseType<GetModulesResponse>>
Defined in: lib/line-bot-client.generated.ts:2843
Gets a list of basic information about the bots of multiple LINE Official Accounts that have attached module channels.. This method includes HttpInfo object to return additional information.
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<ApiResponseType<GetModulesResponse>>
See
Inherited from
LineBotClientBase.getModulesWithHttpInfo
getNarrowcastProgress()
getNarrowcastProgress(
requestId):Promise<NarrowcastProgressResponse>
Defined in: lib/line-bot-client.generated.ts:1366
Gets the status of a narrowcast message.
Parameters
requestId
string
The narrowcast message's request ID. Each Messaging API request has a request ID.
Returns
Promise<NarrowcastProgressResponse>
See
Inherited from
LineBotClientBase.getNarrowcastProgress
getNarrowcastProgressWithHttpInfo()
getNarrowcastProgressWithHttpInfo(
requestId):Promise<ApiResponseType<NarrowcastProgressResponse>>
Defined in: lib/line-bot-client.generated.ts:1379
Gets the status of a narrowcast message.. This method includes HttpInfo object to return additional information.
Parameters
requestId
string
The narrowcast message's request ID. Each Messaging API request has a request ID.
Returns
Promise<ApiResponseType<NarrowcastProgressResponse>>
See
Inherited from
LineBotClientBase.getNarrowcastProgressWithHttpInfo
getNumberOfFollowers()
getNumberOfFollowers(
date?):Promise<GetNumberOfFollowersResponse>
Defined in: lib/line-bot-client.generated.ts:96
Returns the number of users who have added the LINE Official Account on or before a specified date.
Parameters
date?
string
Date for which to retrieve the number of followers. Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9
Returns
Promise<GetNumberOfFollowersResponse>
See
Get number of followers Documentation
Inherited from
LineBotClientBase.getNumberOfFollowers
getNumberOfFollowersWithHttpInfo()
getNumberOfFollowersWithHttpInfo(
date?):Promise<ApiResponseType<GetNumberOfFollowersResponse>>
Defined in: lib/line-bot-client.generated.ts:110
Returns the number of users who have added the LINE Official Account on or before a specified date. . This method includes HttpInfo object to return additional information.
Parameters
date?
string
Date for which to retrieve the number of followers. Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9
Returns
Promise<ApiResponseType<GetNumberOfFollowersResponse>>
See
Get number of followers Documentation
Inherited from
LineBotClientBase.getNumberOfFollowersWithHttpInfo
getNumberOfMessageDeliveries()
getNumberOfMessageDeliveries(
date):Promise<GetNumberOfMessageDeliveriesResponse>
Defined in: lib/line-bot-client.generated.ts:123
Returns the number of messages sent from LINE Official Account on a specified day.
Parameters
date
string
Date for which to retrieve number of sent messages. - Format: yyyyMMdd (e.g. 20191231) - Timezone: UTC+9
Returns
Promise<GetNumberOfMessageDeliveriesResponse>
See
Get number of message deliveries Documentation
Inherited from
LineBotClientBase.getNumberOfMessageDeliveries
getNumberOfMessageDeliveriesWithHttpInfo()
getNumberOfMessageDeliveriesWithHttpInfo(
date):Promise<ApiResponseType<GetNumberOfMessageDeliveriesResponse>>
Defined in: lib/line-bot-client.generated.ts:137
Returns the number of messages sent from LINE Official Account on a specified day. . This method includes HttpInfo object to return additional information.
Parameters
date
string
Date for which to retrieve number of sent messages. - Format: yyyyMMdd (e.g. 20191231) - Timezone: UTC+9
Returns
Promise<ApiResponseType<GetNumberOfMessageDeliveriesResponse>>
See
Get number of message deliveries Documentation
Inherited from
LineBotClientBase.getNumberOfMessageDeliveriesWithHttpInfo
getNumberOfSentBroadcastMessages()
getNumberOfSentBroadcastMessages(
date):Promise<NumberOfMessagesResponse>
Defined in: lib/line-bot-client.generated.ts:1393
Get number of sent broadcast messages
Parameters
date
string
Date the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9
Returns
Promise<NumberOfMessagesResponse>
See
Inherited from
LineBotClientBase.getNumberOfSentBroadcastMessages
getNumberOfSentBroadcastMessagesWithHttpInfo()
getNumberOfSentBroadcastMessagesWithHttpInfo(
date):Promise<ApiResponseType<NumberOfMessagesResponse>>
Defined in: lib/line-bot-client.generated.ts:1406
Get number of sent broadcast messages. This method includes HttpInfo object to return additional information.
Parameters
date
string
Date the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9
Returns
Promise<ApiResponseType<NumberOfMessagesResponse>>
See
Inherited from
LineBotClientBase.getNumberOfSentBroadcastMessagesWithHttpInfo
getNumberOfSentMulticastMessages()
getNumberOfSentMulticastMessages(
date):Promise<NumberOfMessagesResponse>
Defined in: lib/line-bot-client.generated.ts:1420
Get number of sent multicast messages
Parameters
date
string
Date the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9
Returns
Promise<NumberOfMessagesResponse>
See
Inherited from
LineBotClientBase.getNumberOfSentMulticastMessages
getNumberOfSentMulticastMessagesWithHttpInfo()
getNumberOfSentMulticastMessagesWithHttpInfo(
date):Promise<ApiResponseType<NumberOfMessagesResponse>>
Defined in: lib/line-bot-client.generated.ts:1433
Get number of sent multicast messages. This method includes HttpInfo object to return additional information.
Parameters
date
string
Date the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9
Returns
Promise<ApiResponseType<NumberOfMessagesResponse>>
See
Inherited from
LineBotClientBase.getNumberOfSentMulticastMessagesWithHttpInfo
getNumberOfSentPushMessages()
getNumberOfSentPushMessages(
date):Promise<NumberOfMessagesResponse>
Defined in: lib/line-bot-client.generated.ts:1447
Get number of sent push messages
Parameters
date
string
Date the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9
Returns
Promise<NumberOfMessagesResponse>
See
Inherited from
LineBotClientBase.getNumberOfSentPushMessages
getNumberOfSentPushMessagesWithHttpInfo()
getNumberOfSentPushMessagesWithHttpInfo(
date):Promise<ApiResponseType<NumberOfMessagesResponse>>
Defined in: lib/line-bot-client.generated.ts:1460
Get number of sent push messages. This method includes HttpInfo object to return additional information.
Parameters
date
string
Date the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9
Returns
Promise<ApiResponseType<NumberOfMessagesResponse>>
See
Inherited from
LineBotClientBase.getNumberOfSentPushMessagesWithHttpInfo
getNumberOfSentReplyMessages()
getNumberOfSentReplyMessages(
date):Promise<NumberOfMessagesResponse>
Defined in: lib/line-bot-client.generated.ts:1474
Get number of sent reply messages
Parameters
date
string
Date the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9
Returns
Promise<NumberOfMessagesResponse>
See
Inherited from
LineBotClientBase.getNumberOfSentReplyMessages
getNumberOfSentReplyMessagesWithHttpInfo()
getNumberOfSentReplyMessagesWithHttpInfo(
date):Promise<ApiResponseType<NumberOfMessagesResponse>>
Defined in: lib/line-bot-client.generated.ts:1487
Get number of sent reply messages. This method includes HttpInfo object to return additional information.
Parameters
date
string
Date the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9
Returns
Promise<ApiResponseType<NumberOfMessagesResponse>>
See
Inherited from
LineBotClientBase.getNumberOfSentReplyMessagesWithHttpInfo
getPNPMessageStatistics()
getPNPMessageStatistics(
date):Promise<NumberOfMessagesResponse>
Defined in: lib/line-bot-client.generated.ts:1501
Get number of sent LINE notification messages
Parameters
date
string
Date the message was sent Format: yyyyMMdd (Example:20211231) Time zone: UTC+9
Returns
Promise<NumberOfMessagesResponse>
See
Inherited from
LineBotClientBase.getPNPMessageStatistics
getPNPMessageStatisticsWithHttpInfo()
getPNPMessageStatisticsWithHttpInfo(
date):Promise<ApiResponseType<NumberOfMessagesResponse>>
Defined in: lib/line-bot-client.generated.ts:1514
Get number of sent LINE notification messages . This method includes HttpInfo object to return additional information.
Parameters
date
string
Date the message was sent Format: yyyyMMdd (Example:20211231) Time zone: UTC+9
Returns
Promise<ApiResponseType<NumberOfMessagesResponse>>
See
Inherited from
LineBotClientBase.getPNPMessageStatisticsWithHttpInfo
getProfile()
getProfile(
userId):Promise<UserProfileResponse>
Defined in: lib/line-bot-client.generated.ts:1526
Get profile
Parameters
userId
string
User ID
Returns
Promise<UserProfileResponse>
See
Inherited from
LineBotClientBase.getProfile
getProfileWithHttpInfo()
getProfileWithHttpInfo(
userId):Promise<ApiResponseType<UserProfileResponse>>
Defined in: lib/line-bot-client.generated.ts:1539
Get profile. This method includes HttpInfo object to return additional information.
Parameters
userId
string
User ID
Returns
Promise<ApiResponseType<UserProfileResponse>>
See
Inherited from
LineBotClientBase.getProfileWithHttpInfo
getRichMenu()
getRichMenu(
richMenuId):Promise<RichMenuResponse>
Defined in: lib/line-bot-client.generated.ts:1551
Gets a rich menu via a rich menu ID.
Parameters
richMenuId
string
ID of a rich menu
Returns
Promise<RichMenuResponse>
See
Inherited from
LineBotClientBase.getRichMenu
getRichMenuAlias()
getRichMenuAlias(
richMenuAliasId):Promise<RichMenuAliasResponse>
Defined in: lib/line-bot-client.generated.ts:1576
Get rich menu alias information
Parameters
richMenuAliasId
string
The rich menu alias ID whose information you want to obtain.
Returns
Promise<RichMenuAliasResponse>
See
Inherited from
LineBotClientBase.getRichMenuAlias
getRichMenuAliasList()
getRichMenuAliasList():
Promise<RichMenuAliasListResponse>
Defined in: lib/line-bot-client.generated.ts:1602
Get list of rich menu alias
Returns
Promise<RichMenuAliasListResponse>
See
Inherited from
LineBotClientBase.getRichMenuAliasList
getRichMenuAliasListWithHttpInfo()
getRichMenuAliasListWithHttpInfo():
Promise<ApiResponseType<RichMenuAliasListResponse>>
Defined in: lib/line-bot-client.generated.ts:1612
Get list of rich menu alias. This method includes HttpInfo object to return additional information.
Returns
Promise<ApiResponseType<RichMenuAliasListResponse>>
See
Inherited from
LineBotClientBase.getRichMenuAliasListWithHttpInfo
getRichMenuAliasWithHttpInfo()
getRichMenuAliasWithHttpInfo(
richMenuAliasId):Promise<ApiResponseType<RichMenuAliasResponse>>
Defined in: lib/line-bot-client.generated.ts:1589
Get rich menu alias information. This method includes HttpInfo object to return additional information.
Parameters
richMenuAliasId
string
The rich menu alias ID whose information you want to obtain.
Returns
Promise<ApiResponseType<RichMenuAliasResponse>>
See
Inherited from
LineBotClientBase.getRichMenuAliasWithHttpInfo
getRichMenuBatchProgress()
getRichMenuBatchProgress(
requestId):Promise<RichMenuBatchProgressResponse>
Defined in: lib/line-bot-client.generated.ts:1624
Get the status of Replace or unlink a linked rich menus in batches.
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>
See
Inherited from
LineBotClientBase.getRichMenuBatchProgress
getRichMenuBatchProgressWithHttpInfo()
getRichMenuBatchProgressWithHttpInfo(
requestId):Promise<ApiResponseType<RichMenuBatchProgressResponse>>
Defined in: lib/line-bot-client.generated.ts:1637
Get the status of Replace or unlink a linked rich menus in batches.. This method includes HttpInfo object to return additional information.
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>>
See
Inherited from
LineBotClientBase.getRichMenuBatchProgressWithHttpInfo
getRichMenuIdOfUser()
getRichMenuIdOfUser(
userId):Promise<RichMenuIdResponse>
Defined in: lib/line-bot-client.generated.ts:1653
Get rich menu ID of user
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>
See
Inherited from
LineBotClientBase.getRichMenuIdOfUser
getRichMenuIdOfUserWithHttpInfo()
getRichMenuIdOfUserWithHttpInfo(
userId):Promise<ApiResponseType<RichMenuIdResponse>>
Defined in: lib/line-bot-client.generated.ts:1666
Get rich menu ID of user. This method includes HttpInfo object to return additional information.
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>>
See
Inherited from
LineBotClientBase.getRichMenuIdOfUserWithHttpInfo
getRichMenuImage()
getRichMenuImage(
richMenuId):Promise<Readable>
Defined in: lib/line-bot-client.generated.ts:2708
Download rich menu image.
Parameters
richMenuId
string
ID of the rich menu with the image to be downloaded
Returns
Promise<Readable>
See
Inherited from
LineBotClientBase.getRichMenuImage
getRichMenuImageWithHttpInfo()
getRichMenuImageWithHttpInfo(
richMenuId):Promise<ApiResponseType<Readable>>
Defined in: lib/line-bot-client.generated.ts:2719
Download rich menu image.. This method includes HttpInfo object to return additional information.
Parameters
richMenuId
string
ID of the rich menu with the image to be downloaded
Returns
Promise<ApiResponseType<Readable>>
See
Inherited from
LineBotClientBase.getRichMenuImageWithHttpInfo
getRichMenuList()
getRichMenuList():
Promise<RichMenuListResponse>
Defined in: lib/line-bot-client.generated.ts:1677
Get rich menu list
Returns
Promise<RichMenuListResponse>
See
Inherited from
LineBotClientBase.getRichMenuList
getRichMenuListWithHttpInfo()
getRichMenuListWithHttpInfo():
Promise<ApiResponseType<RichMenuListResponse>>
Defined in: lib/line-bot-client.generated.ts:1687
Get rich menu list. This method includes HttpInfo object to return additional information.
Returns
Promise<ApiResponseType<RichMenuListResponse>>
See
Inherited from
LineBotClientBase.getRichMenuListWithHttpInfo
getRichMenuWithHttpInfo()
getRichMenuWithHttpInfo(
richMenuId):Promise<ApiResponseType<RichMenuResponse>>
Defined in: lib/line-bot-client.generated.ts:1564
Gets a rich menu via a rich menu ID.. This method includes HttpInfo object to return additional information.
Parameters
richMenuId
string
ID of a rich menu
Returns
Promise<ApiResponseType<RichMenuResponse>>
See
Inherited from
LineBotClientBase.getRichMenuWithHttpInfo
getRoomMemberCount()
getRoomMemberCount(
roomId):Promise<RoomMemberCountResponse>
Defined in: lib/line-bot-client.generated.ts:1699
Get number of users in a multi-person chat
Parameters
roomId
string
Room ID
Returns
Promise<RoomMemberCountResponse>
See
Inherited from
LineBotClientBase.getRoomMemberCount
getRoomMemberCountWithHttpInfo()
getRoomMemberCountWithHttpInfo(
roomId):Promise<ApiResponseType<RoomMemberCountResponse>>
Defined in: lib/line-bot-client.generated.ts:1712
Get number of users in a multi-person chat. This method includes HttpInfo object to return additional information.
Parameters
roomId
string
Room ID
Returns
Promise<ApiResponseType<RoomMemberCountResponse>>
See
Inherited from
LineBotClientBase.getRoomMemberCountWithHttpInfo
getRoomMemberProfile()
getRoomMemberProfile(
roomId,userId):Promise<RoomUserProfileResponse>
Defined in: lib/line-bot-client.generated.ts:1725
Get multi-person chat member profile
Parameters
roomId
string
Room ID
userId
string
User ID
Returns
Promise<RoomUserProfileResponse>
See
Inherited from
LineBotClientBase.getRoomMemberProfile
getRoomMemberProfileWithHttpInfo()
getRoomMemberProfileWithHttpInfo(
roomId,userId):Promise<ApiResponseType<RoomUserProfileResponse>>
Defined in: lib/line-bot-client.generated.ts:1740
Get multi-person chat member profile. This method includes HttpInfo object to return additional information.
Parameters
roomId
string
Room ID
userId
string
User ID
Returns
Promise<ApiResponseType<RoomUserProfileResponse>>
See
Inherited from
LineBotClientBase.getRoomMemberProfileWithHttpInfo
getRoomMembersIds()
getRoomMembersIds(
roomId,start?):Promise<MembersIdsResponse>
Defined in: lib/line-bot-client.generated.ts:1757
Get multi-person chat member user IDs
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>
See
Inherited from
LineBotClientBase.getRoomMembersIds
getRoomMembersIdsWithHttpInfo()
getRoomMembersIdsWithHttpInfo(
roomId,start?):Promise<ApiResponseType<MembersIdsResponse>>
Defined in: lib/line-bot-client.generated.ts:1772
Get multi-person chat member user IDs. This method includes HttpInfo object to return additional information.
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>>
See
Inherited from
LineBotClientBase.getRoomMembersIdsWithHttpInfo
getSharedAudienceData()
getSharedAudienceData(
audienceGroupId):Promise<GetSharedAudienceDataResponse>
Defined in: lib/line-bot-client.generated.ts:538
Gets audience data.
Parameters
audienceGroupId
number
The audience ID.
Returns
Promise<GetSharedAudienceDataResponse>
See
Inherited from
LineBotClientBase.getSharedAudienceData
getSharedAudienceDataWithHttpInfo()
getSharedAudienceDataWithHttpInfo(
audienceGroupId):Promise<ApiResponseType<GetSharedAudienceDataResponse>>
Defined in: lib/line-bot-client.generated.ts:551
Gets audience data.. This method includes HttpInfo object to return additional information.
Parameters
audienceGroupId
number
The audience ID.
Returns
Promise<ApiResponseType<GetSharedAudienceDataResponse>>
See
Inherited from
LineBotClientBase.getSharedAudienceDataWithHttpInfo
getSharedAudienceGroups()
getSharedAudienceGroups(
page,description?,status?,size?,createRoute?,includesOwnedAudienceGroups?):Promise<GetSharedAudienceGroupsResponse>
Defined in: lib/line-bot-client.generated.ts:572
Gets data for more than one audience, including those shared by the Business Manager.
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
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.
includesOwnedAudienceGroups?
boolean
true: Include audienceGroups owned by LINE Official Account Manager false: Respond only audienceGroups shared by Business Manager
Returns
Promise<GetSharedAudienceGroupsResponse>
See
Inherited from
LineBotClientBase.getSharedAudienceGroups
getSharedAudienceGroupsWithHttpInfo()
getSharedAudienceGroupsWithHttpInfo(
page,description?,status?,size?,createRoute?,includesOwnedAudienceGroups?):Promise<ApiResponseType<GetSharedAudienceGroupsResponse>>
Defined in: lib/line-bot-client.generated.ts:602
Gets data for more than one audience, including those shared by the Business Manager.. This method includes HttpInfo object to return additional information.
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
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.
includesOwnedAudienceGroups?
boolean
true: Include audienceGroups owned by LINE Official Account Manager false: Respond only audienceGroups shared by Business Manager
Returns
Promise<ApiResponseType<GetSharedAudienceGroupsResponse>>
See
Inherited from
LineBotClientBase.getSharedAudienceGroupsWithHttpInfo
getStatisticsPerUnit()
getStatisticsPerUnit(
customAggregationUnit,from,to):Promise<GetStatisticsPerUnitResponse>
Defined in: lib/line-bot-client.generated.ts:153
You can check the per-unit statistics of how users interact with push messages and multicast messages sent from your LINE Official Account.
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>
See
Inherited from
LineBotClientBase.getStatisticsPerUnit
getStatisticsPerUnitWithHttpInfo()
getStatisticsPerUnitWithHttpInfo(
customAggregationUnit,from,to):Promise<ApiResponseType<GetStatisticsPerUnitResponse>>
Defined in: lib/line-bot-client.generated.ts:174
You can check the per-unit statistics of how users interact with push messages and multicast messages sent from your LINE Official Account. . This method includes HttpInfo object to return additional information.
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<ApiResponseType<GetStatisticsPerUnitResponse>>
See
Inherited from
LineBotClientBase.getStatisticsPerUnitWithHttpInfo
getWebhookEndpoint()
getWebhookEndpoint():
Promise<GetWebhookEndpointResponse>
Defined in: lib/line-bot-client.generated.ts:1787
Get webhook endpoint information
Returns
Promise<GetWebhookEndpointResponse>
See
Inherited from
LineBotClientBase.getWebhookEndpoint
getWebhookEndpointWithHttpInfo()
getWebhookEndpointWithHttpInfo():
Promise<ApiResponseType<GetWebhookEndpointResponse>>
Defined in: lib/line-bot-client.generated.ts:1797
Get webhook endpoint information. This method includes HttpInfo object to return additional information.
Returns
Promise<ApiResponseType<GetWebhookEndpointResponse>>
See
Inherited from
LineBotClientBase.getWebhookEndpointWithHttpInfo
issueLinkToken()
issueLinkToken(
userId):Promise<IssueLinkTokenResponse>
Defined in: lib/line-bot-client.generated.ts:1809
Issue link token
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>
See
Inherited from
LineBotClientBase.issueLinkToken
issueLinkTokenWithHttpInfo()
issueLinkTokenWithHttpInfo(
userId):Promise<ApiResponseType<IssueLinkTokenResponse>>
Defined in: lib/line-bot-client.generated.ts:1822
Issue link token. This method includes HttpInfo object to return additional information.
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>>
See
Inherited from
LineBotClientBase.issueLinkTokenWithHttpInfo
leaveGroup()
leaveGroup(
groupId):Promise<MessageAPIResponseBase>
Defined in: lib/line-bot-client.generated.ts:1834
Leave group chat
Parameters
groupId
string
Group ID
Returns
Promise<MessageAPIResponseBase>
See
Inherited from
LineBotClientBase.leaveGroup
leaveGroupWithHttpInfo()
leaveGroupWithHttpInfo(
groupId):Promise<ApiResponseType<MessageAPIResponseBase>>
Defined in: lib/line-bot-client.generated.ts:1847
Leave group chat. This method includes HttpInfo object to return additional information.
Parameters
groupId
string
Group ID
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Inherited from
LineBotClientBase.leaveGroupWithHttpInfo
leaveRoom()
leaveRoom(
roomId):Promise<MessageAPIResponseBase>
Defined in: lib/line-bot-client.generated.ts:1859
Leave multi-person chat
Parameters
roomId
string
Room ID
Returns
Promise<MessageAPIResponseBase>
See
Inherited from
LineBotClientBase.leaveRoom
leaveRoomWithHttpInfo()
leaveRoomWithHttpInfo(
roomId):Promise<ApiResponseType<MessageAPIResponseBase>>
Defined in: lib/line-bot-client.generated.ts:1872
Leave multi-person chat. This method includes HttpInfo object to return additional information.
Parameters
roomId
string
Room ID
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Inherited from
LineBotClientBase.leaveRoomWithHttpInfo
linkRichMenuIdToUser()
linkRichMenuIdToUser(
userId,richMenuId):Promise<MessageAPIResponseBase>
Defined in: lib/line-bot-client.generated.ts:1885
Link rich menu to user.
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>
See
Inherited from
LineBotClientBase.linkRichMenuIdToUser
linkRichMenuIdToUsers()
linkRichMenuIdToUsers(
richMenuBulkLinkRequest):Promise<MessageAPIResponseBase>
Defined in: lib/line-bot-client.generated.ts:1916
Link rich menu to multiple users
Parameters
richMenuBulkLinkRequest
Returns
Promise<MessageAPIResponseBase>
See
Inherited from
LineBotClientBase.linkRichMenuIdToUsers
linkRichMenuIdToUsersWithHttpInfo()
linkRichMenuIdToUsersWithHttpInfo(
richMenuBulkLinkRequest):Promise<ApiResponseType<MessageAPIResponseBase>>
Defined in: lib/line-bot-client.generated.ts:1931
Link rich menu to multiple users. This method includes HttpInfo object to return additional information.
Parameters
richMenuBulkLinkRequest
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Inherited from
LineBotClientBase.linkRichMenuIdToUsersWithHttpInfo
linkRichMenuIdToUserWithHttpInfo()
linkRichMenuIdToUserWithHttpInfo(
userId,richMenuId):Promise<ApiResponseType<MessageAPIResponseBase>>
Defined in: lib/line-bot-client.generated.ts:1900
Link rich menu to user.. This method includes HttpInfo object to return additional information.
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>>
See
Inherited from
LineBotClientBase.linkRichMenuIdToUserWithHttpInfo
listCoupon()
listCoupon(
status?,start?,limit?):Promise<MessagingApiPagerCouponListResponse>
Defined in: lib/line-bot-client.generated.ts:1947
Get a paginated list of coupons.
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>
See
Inherited from
LineBotClientBase.listCoupon
listCouponWithHttpInfo()
listCouponWithHttpInfo(
status?,start?,limit?):Promise<ApiResponseType<MessagingApiPagerCouponListResponse>>
Defined in: lib/line-bot-client.generated.ts:1964
Get a paginated list of coupons.. This method includes HttpInfo object to return additional information.
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>>
See
Inherited from
LineBotClientBase.listCouponWithHttpInfo
markMessagesAsRead()
markMessagesAsRead(
markMessagesAsReadRequest):Promise<MessageAPIResponseBase>
Defined in: lib/line-bot-client.generated.ts:1984
Mark messages from users as read
Parameters
markMessagesAsReadRequest
Returns
Promise<MessageAPIResponseBase>
See
Inherited from
LineBotClientBase.markMessagesAsRead
markMessagesAsReadByToken()
markMessagesAsReadByToken(
markMessagesAsReadByTokenRequest):Promise<MessageAPIResponseBase>
Defined in: lib/line-bot-client.generated.ts:2013
Mark messages from users as read by token
Parameters
markMessagesAsReadByTokenRequest
MarkMessagesAsReadByTokenRequest
Returns
Promise<MessageAPIResponseBase>
See
Inherited from
LineBotClientBase.markMessagesAsReadByToken
markMessagesAsReadByTokenWithHttpInfo()
markMessagesAsReadByTokenWithHttpInfo(
markMessagesAsReadByTokenRequest):Promise<ApiResponseType<MessageAPIResponseBase>>
Defined in: lib/line-bot-client.generated.ts:2028
Mark messages from users as read by token. This method includes HttpInfo object to return additional information.
Parameters
markMessagesAsReadByTokenRequest
MarkMessagesAsReadByTokenRequest
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Inherited from
LineBotClientBase.markMessagesAsReadByTokenWithHttpInfo
markMessagesAsReadWithHttpInfo()
markMessagesAsReadWithHttpInfo(
markMessagesAsReadRequest):Promise<ApiResponseType<MessageAPIResponseBase>>
Defined in: lib/line-bot-client.generated.ts:1999
Mark messages from users as read. This method includes HttpInfo object to return additional information.
Parameters
markMessagesAsReadRequest
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Inherited from
LineBotClientBase.markMessagesAsReadWithHttpInfo
missionStickerV3()
missionStickerV3(
missionStickerRequest):Promise<MessageAPIResponseBase>
Defined in: lib/line-bot-client.generated.ts:2964
Sends a mission sticker.
Parameters
missionStickerRequest
Returns
Promise<MessageAPIResponseBase>
See
Inherited from
LineBotClientBase.missionStickerV3
missionStickerV3WithHttpInfo()
missionStickerV3WithHttpInfo(
missionStickerRequest):Promise<ApiResponseType<MessageAPIResponseBase>>
Defined in: lib/line-bot-client.generated.ts:2977
Sends a mission sticker.. This method includes HttpInfo object to return additional information.
Parameters
missionStickerRequest
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Inherited from
LineBotClientBase.missionStickerV3WithHttpInfo
multicast()
multicast(
multicastRequest,xLineRetryKey?):Promise<object>
Defined in: lib/line-bot-client.generated.ts:2043
An API that efficiently sends the same message to multiple user IDs. You can't send messages to group chats or multi-person chats.
Parameters
multicastRequest
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>
See
Inherited from
LineBotClientBase.multicast
multicastWithHttpInfo()
multicastWithHttpInfo(
multicastRequest,xLineRetryKey?):Promise<ApiResponseType<object>>
Defined in: lib/line-bot-client.generated.ts:2058
An API that efficiently sends the same message to multiple user IDs. You can't send messages to group chats or multi-person chats.. This method includes HttpInfo object to return additional information.
Parameters
multicastRequest
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<ApiResponseType<object>>
See
Inherited from
LineBotClientBase.multicastWithHttpInfo
narrowcast()
narrowcast(
narrowcastRequest,xLineRetryKey?):Promise<object>
Defined in: lib/line-bot-client.generated.ts:2075
Send narrowcast message
Parameters
narrowcastRequest
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>
See
Inherited from
LineBotClientBase.narrowcast
narrowcastWithHttpInfo()
narrowcastWithHttpInfo(
narrowcastRequest,xLineRetryKey?):Promise<ApiResponseType<object>>
Defined in: lib/line-bot-client.generated.ts:2093
Send narrowcast message. This method includes HttpInfo object to return additional information.
Parameters
narrowcastRequest
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<ApiResponseType<object>>
See
Inherited from
LineBotClientBase.narrowcastWithHttpInfo
pushMessage()
pushMessage(
pushMessageRequest,xLineRetryKey?):Promise<PushMessageResponse>
Defined in: lib/line-bot-client.generated.ts:2110
Sends a message to a user, group chat, or multi-person chat at any time.
Parameters
pushMessageRequest
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<PushMessageResponse>
See
Inherited from
LineBotClientBase.pushMessage
pushMessagesByPhone()
pushMessagesByPhone(
pnpMessagesRequest,xLineDeliveryTag?):Promise<MessageAPIResponseBase>
Defined in: lib/line-bot-client.generated.ts:2145
Send LINE notification message
Parameters
pnpMessagesRequest
xLineDeliveryTag?
string
String returned in the delivery.data property of the delivery completion event via Webhook.
Returns
Promise<MessageAPIResponseBase>
See
Inherited from
LineBotClientBase.pushMessagesByPhone
pushMessagesByPhoneWithHttpInfo()
pushMessagesByPhoneWithHttpInfo(
pnpMessagesRequest,xLineDeliveryTag?):Promise<ApiResponseType<MessageAPIResponseBase>>
Defined in: lib/line-bot-client.generated.ts:2163
Send LINE notification message. This method includes HttpInfo object to return additional information.
Parameters
pnpMessagesRequest
xLineDeliveryTag?
string
String returned in the delivery.data property of the delivery completion event via Webhook.
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Inherited from
LineBotClientBase.pushMessagesByPhoneWithHttpInfo
pushMessageWithHttpInfo()
pushMessageWithHttpInfo(
pushMessageRequest,xLineRetryKey?):Promise<ApiResponseType<PushMessageResponse>>
Defined in: lib/line-bot-client.generated.ts:2128
Sends a message to a user, group chat, or multi-person chat at any time.. This method includes HttpInfo object to return additional information.
Parameters
pushMessageRequest
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<ApiResponseType<PushMessageResponse>>
See
Inherited from
LineBotClientBase.pushMessageWithHttpInfo
releaseChatControl()
releaseChatControl(
chatId):Promise<MessageAPIResponseBase>
Defined in: lib/line-bot-client.generated.ts:2856
To return the initiative (Chat Control) of Active Channel to Primary Channel, call the Release Control API.
Parameters
chatId
string
The userId, roomId, or groupId
Returns
Promise<MessageAPIResponseBase>
See
Inherited from
LineBotClientBase.releaseChatControl
releaseChatControlWithHttpInfo()
releaseChatControlWithHttpInfo(
chatId):Promise<ApiResponseType<MessageAPIResponseBase>>
Defined in: lib/line-bot-client.generated.ts:2869
To return the initiative (Chat Control) of Active Channel to Primary Channel, call the Release Control API. . This method includes HttpInfo object to return additional information.
Parameters
chatId
string
The userId, roomId, or groupId
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Inherited from
LineBotClientBase.releaseChatControlWithHttpInfo
replyMessage()
replyMessage(
replyMessageRequest):Promise<ReplyMessageResponse>
Defined in: lib/line-bot-client.generated.ts:2179
Send reply message
Parameters
replyMessageRequest
Returns
Promise<ReplyMessageResponse>
See
Inherited from
LineBotClientBase.replyMessage
replyMessageWithHttpInfo()
replyMessageWithHttpInfo(
replyMessageRequest):Promise<ApiResponseType<ReplyMessageResponse>>
Defined in: lib/line-bot-client.generated.ts:2192
Send reply message. This method includes HttpInfo object to return additional information.
Parameters
replyMessageRequest
Returns
Promise<ApiResponseType<ReplyMessageResponse>>
See
Inherited from
LineBotClientBase.replyMessageWithHttpInfo
richMenuBatch()
richMenuBatch(
richMenuBatchRequest):Promise<MessageAPIResponseBase>
Defined in: lib/line-bot-client.generated.ts:2206
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
Parameters
richMenuBatchRequest
Returns
Promise<MessageAPIResponseBase>
See
Inherited from
LineBotClientBase.richMenuBatch
richMenuBatchWithHttpInfo()
richMenuBatchWithHttpInfo(
richMenuBatchRequest):Promise<ApiResponseType<MessageAPIResponseBase>>
Defined in: lib/line-bot-client.generated.ts:2219
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 . This method includes HttpInfo object to return additional information.
Parameters
richMenuBatchRequest
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Inherited from
LineBotClientBase.richMenuBatchWithHttpInfo
setDefaultRichMenu()
setDefaultRichMenu(
richMenuId):Promise<MessageAPIResponseBase>
Defined in: lib/line-bot-client.generated.ts:2233
Set default rich menu
Parameters
richMenuId
string
ID of a rich menu
Returns
Promise<MessageAPIResponseBase>
See
Inherited from
LineBotClientBase.setDefaultRichMenu
setDefaultRichMenuWithHttpInfo()
setDefaultRichMenuWithHttpInfo(
richMenuId):Promise<ApiResponseType<MessageAPIResponseBase>>
Defined in: lib/line-bot-client.generated.ts:2246
Set default rich menu. This method includes HttpInfo object to return additional information.
Parameters
richMenuId
string
ID of a rich menu
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Inherited from
LineBotClientBase.setDefaultRichMenuWithHttpInfo
setRichMenuImage()
setRichMenuImage(
richMenuId,body?):Promise<MessageAPIResponseBase>
Defined in: lib/line-bot-client.generated.ts:2734
Upload rich menu image
Parameters
richMenuId
string
The ID of the rich menu to attach the image to
body?
Blob
Returns
Promise<MessageAPIResponseBase>
See
Inherited from
LineBotClientBase.setRichMenuImage
setRichMenuImageWithHttpInfo()
setRichMenuImageWithHttpInfo(
richMenuId,body?):Promise<ApiResponseType<MessageAPIResponseBase>>
Defined in: lib/line-bot-client.generated.ts:2749
Upload rich menu image. This method includes HttpInfo object to return additional information.
Parameters
richMenuId
string
The ID of the rich menu to attach the image to
body?
Blob
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Inherited from
LineBotClientBase.setRichMenuImageWithHttpInfo
setWebhookEndpoint()
setWebhookEndpoint(
setWebhookEndpointRequest):Promise<MessageAPIResponseBase>
Defined in: lib/line-bot-client.generated.ts:2258
Set webhook endpoint URL
Parameters
setWebhookEndpointRequest
Returns
Promise<MessageAPIResponseBase>
See
Inherited from
LineBotClientBase.setWebhookEndpoint
setWebhookEndpointWithHttpInfo()
setWebhookEndpointWithHttpInfo(
setWebhookEndpointRequest):Promise<ApiResponseType<MessageAPIResponseBase>>
Defined in: lib/line-bot-client.generated.ts:2273
Set webhook endpoint URL. This method includes HttpInfo object to return additional information.
Parameters
setWebhookEndpointRequest
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Inherited from
LineBotClientBase.setWebhookEndpointWithHttpInfo
showLoadingAnimation()
showLoadingAnimation(
showLoadingAnimationRequest):Promise<object>
Defined in: lib/line-bot-client.generated.ts:2287
Display a loading animation in one-on-one chats between users and LINE Official Accounts.
Parameters
showLoadingAnimationRequest
Returns
Promise<object>
See
Inherited from
LineBotClientBase.showLoadingAnimation
showLoadingAnimationWithHttpInfo()
showLoadingAnimationWithHttpInfo(
showLoadingAnimationRequest):Promise<ApiResponseType<object>>
Defined in: lib/line-bot-client.generated.ts:2302
Display a loading animation in one-on-one chats between users and LINE Official Accounts.. This method includes HttpInfo object to return additional information.
Parameters
showLoadingAnimationRequest
Returns
Promise<ApiResponseType<object>>
See
Inherited from
LineBotClientBase.showLoadingAnimationWithHttpInfo
testWebhookEndpoint()
testWebhookEndpoint(
testWebhookEndpointRequest?):Promise<TestWebhookEndpointResponse>
Defined in: lib/line-bot-client.generated.ts:2316
Test webhook endpoint
Parameters
testWebhookEndpointRequest?
Returns
Promise<TestWebhookEndpointResponse>
See
Inherited from
LineBotClientBase.testWebhookEndpoint
testWebhookEndpointWithHttpInfo()
testWebhookEndpointWithHttpInfo(
testWebhookEndpointRequest?):Promise<ApiResponseType<TestWebhookEndpointResponse>>
Defined in: lib/line-bot-client.generated.ts:2331
Test webhook endpoint. This method includes HttpInfo object to return additional information.
Parameters
testWebhookEndpointRequest?
Returns
Promise<ApiResponseType<TestWebhookEndpointResponse>>
See
Inherited from
LineBotClientBase.testWebhookEndpointWithHttpInfo
unlinkRichMenuIdFromUser()
unlinkRichMenuIdFromUser(
userId):Promise<MessageAPIResponseBase>
Defined in: lib/line-bot-client.generated.ts:2345
Unlink rich menu from user
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>
See
Inherited from
LineBotClientBase.unlinkRichMenuIdFromUser
unlinkRichMenuIdFromUsers()
unlinkRichMenuIdFromUsers(
richMenuBulkUnlinkRequest):Promise<MessageAPIResponseBase>
Defined in: lib/line-bot-client.generated.ts:2372
Unlink rich menus from multiple users
Parameters
richMenuBulkUnlinkRequest
Returns
Promise<MessageAPIResponseBase>
See
Inherited from
LineBotClientBase.unlinkRichMenuIdFromUsers
unlinkRichMenuIdFromUsersWithHttpInfo()
unlinkRichMenuIdFromUsersWithHttpInfo(
richMenuBulkUnlinkRequest):Promise<ApiResponseType<MessageAPIResponseBase>>
Defined in: lib/line-bot-client.generated.ts:2387
Unlink rich menus from multiple users. This method includes HttpInfo object to return additional information.
Parameters
richMenuBulkUnlinkRequest
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Inherited from
LineBotClientBase.unlinkRichMenuIdFromUsersWithHttpInfo
unlinkRichMenuIdFromUserWithHttpInfo()
unlinkRichMenuIdFromUserWithHttpInfo(
userId):Promise<ApiResponseType<MessageAPIResponseBase>>
Defined in: lib/line-bot-client.generated.ts:2358
Unlink rich menu from user. This method includes HttpInfo object to return additional information.
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>>
See
Inherited from
LineBotClientBase.unlinkRichMenuIdFromUserWithHttpInfo
updateAudienceGroupDescription()
updateAudienceGroupDescription(
audienceGroupId,updateAudienceGroupDescriptionRequest):Promise<MessageAPIResponseBase>
Defined in: lib/line-bot-client.generated.ts:629
Renames an existing audience.
Parameters
audienceGroupId
number
The audience ID.
updateAudienceGroupDescriptionRequest
UpdateAudienceGroupDescriptionRequest
Returns
Promise<MessageAPIResponseBase>
See
Inherited from
LineBotClientBase.updateAudienceGroupDescription
updateAudienceGroupDescriptionWithHttpInfo()
updateAudienceGroupDescriptionWithHttpInfo(
audienceGroupId,updateAudienceGroupDescriptionRequest):Promise<ApiResponseType<MessageAPIResponseBase>>
Defined in: lib/line-bot-client.generated.ts:647
Renames an existing audience.. This method includes HttpInfo object to return additional information.
Parameters
audienceGroupId
number
The audience ID.
updateAudienceGroupDescriptionRequest
UpdateAudienceGroupDescriptionRequest
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Inherited from
LineBotClientBase.updateAudienceGroupDescriptionWithHttpInfo
updateLIFFApp()
updateLIFFApp(
liffId,updateLiffAppRequest):Promise<MessageAPIResponseBase>
Defined in: lib/line-bot-client.generated.ts:271
Update LIFF app settings
Parameters
liffId
string
ID of the LIFF app to be updated
updateLiffAppRequest
Returns
Promise<MessageAPIResponseBase>
See
Update LIFF app from a channel Documentation
Inherited from
LineBotClientBase.updateLIFFApp
updateLIFFAppWithHttpInfo()
updateLIFFAppWithHttpInfo(
liffId,updateLiffAppRequest):Promise<ApiResponseType<MessageAPIResponseBase>>
Defined in: lib/line-bot-client.generated.ts:287
Update LIFF app settings. This method includes HttpInfo object to return additional information.
Parameters
liffId
string
ID of the LIFF app to be updated
updateLiffAppRequest
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Update LIFF app from a channel Documentation
Inherited from
LineBotClientBase.updateLIFFAppWithHttpInfo
updateRichMenuAlias()
updateRichMenuAlias(
richMenuAliasId,updateRichMenuAliasRequest):Promise<MessageAPIResponseBase>
Defined in: lib/line-bot-client.generated.ts:2402
Update rich menu alias
Parameters
richMenuAliasId
string
The rich menu alias ID you want to update.
updateRichMenuAliasRequest
Returns
Promise<MessageAPIResponseBase>
See
Inherited from
LineBotClientBase.updateRichMenuAlias
updateRichMenuAliasWithHttpInfo()
updateRichMenuAliasWithHttpInfo(
richMenuAliasId,updateRichMenuAliasRequest):Promise<ApiResponseType<MessageAPIResponseBase>>
Defined in: lib/line-bot-client.generated.ts:2420
Update rich menu alias. This method includes HttpInfo object to return additional information.
Parameters
richMenuAliasId
string
The rich menu alias ID you want to update.
updateRichMenuAliasRequest
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Inherited from
LineBotClientBase.updateRichMenuAliasWithHttpInfo
validateBroadcast()
validateBroadcast(
validateMessageRequest):Promise<MessageAPIResponseBase>
Defined in: lib/line-bot-client.generated.ts:2436
Validate message objects of a broadcast message
Parameters
validateMessageRequest
Returns
Promise<MessageAPIResponseBase>
See
Inherited from
LineBotClientBase.validateBroadcast
validateBroadcastWithHttpInfo()
validateBroadcastWithHttpInfo(
validateMessageRequest):Promise<ApiResponseType<MessageAPIResponseBase>>
Defined in: lib/line-bot-client.generated.ts:2449
Validate message objects of a broadcast message. This method includes HttpInfo object to return additional information.
Parameters
validateMessageRequest
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Inherited from
LineBotClientBase.validateBroadcastWithHttpInfo
validateMulticast()
validateMulticast(
validateMessageRequest):Promise<MessageAPIResponseBase>
Defined in: lib/line-bot-client.generated.ts:2463
Validate message objects of a multicast message
Parameters
validateMessageRequest
Returns
Promise<MessageAPIResponseBase>
See
Inherited from
LineBotClientBase.validateMulticast
validateMulticastWithHttpInfo()
validateMulticastWithHttpInfo(
validateMessageRequest):Promise<ApiResponseType<MessageAPIResponseBase>>
Defined in: lib/line-bot-client.generated.ts:2476
Validate message objects of a multicast message. This method includes HttpInfo object to return additional information.
Parameters
validateMessageRequest
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Inherited from
LineBotClientBase.validateMulticastWithHttpInfo
validateNarrowcast()
validateNarrowcast(
validateMessageRequest):Promise<MessageAPIResponseBase>
Defined in: lib/line-bot-client.generated.ts:2490
Validate message objects of a narrowcast message
Parameters
validateMessageRequest
Returns
Promise<MessageAPIResponseBase>
See
Inherited from
LineBotClientBase.validateNarrowcast
validateNarrowcastWithHttpInfo()
validateNarrowcastWithHttpInfo(
validateMessageRequest):Promise<ApiResponseType<MessageAPIResponseBase>>
Defined in: lib/line-bot-client.generated.ts:2503
Validate message objects of a narrowcast message. This method includes HttpInfo object to return additional information.
Parameters
validateMessageRequest
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Inherited from
LineBotClientBase.validateNarrowcastWithHttpInfo
validatePush()
validatePush(
validateMessageRequest):Promise<MessageAPIResponseBase>
Defined in: lib/line-bot-client.generated.ts:2517
Validate message objects of a push message
Parameters
validateMessageRequest
Returns
Promise<MessageAPIResponseBase>
See
Inherited from
LineBotClientBase.validatePush
validatePushWithHttpInfo()
validatePushWithHttpInfo(
validateMessageRequest):Promise<ApiResponseType<MessageAPIResponseBase>>
Defined in: lib/line-bot-client.generated.ts:2530
Validate message objects of a push message. This method includes HttpInfo object to return additional information.
Parameters
validateMessageRequest
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Inherited from
LineBotClientBase.validatePushWithHttpInfo
validateReply()
validateReply(
validateMessageRequest):Promise<MessageAPIResponseBase>
Defined in: lib/line-bot-client.generated.ts:2544
Validate message objects of a reply message
Parameters
validateMessageRequest
Returns
Promise<MessageAPIResponseBase>
See
Inherited from
LineBotClientBase.validateReply
validateReplyWithHttpInfo()
validateReplyWithHttpInfo(
validateMessageRequest):Promise<ApiResponseType<MessageAPIResponseBase>>
Defined in: lib/line-bot-client.generated.ts:2557
Validate message objects of a reply message. This method includes HttpInfo object to return additional information.
Parameters
validateMessageRequest
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Inherited from
LineBotClientBase.validateReplyWithHttpInfo
validateRichMenuBatchRequest()
validateRichMenuBatchRequest(
richMenuBatchRequest):Promise<MessageAPIResponseBase>
Defined in: lib/line-bot-client.generated.ts:2571
Validate a request body of the Replace or unlink the linked rich menus in batches endpoint.
Parameters
richMenuBatchRequest
Returns
Promise<MessageAPIResponseBase>
See
Inherited from
LineBotClientBase.validateRichMenuBatchRequest
validateRichMenuBatchRequestWithHttpInfo()
validateRichMenuBatchRequestWithHttpInfo(
richMenuBatchRequest):Promise<ApiResponseType<MessageAPIResponseBase>>
Defined in: lib/line-bot-client.generated.ts:2586
Validate a request body of the Replace or unlink the linked rich menus in batches endpoint.. This method includes HttpInfo object to return additional information.
Parameters
richMenuBatchRequest
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Inherited from
LineBotClientBase.validateRichMenuBatchRequestWithHttpInfo
validateRichMenuObject()
validateRichMenuObject(
richMenuRequest):Promise<MessageAPIResponseBase>
Defined in: lib/line-bot-client.generated.ts:2600
Validate rich menu object
Parameters
richMenuRequest
Returns
Promise<MessageAPIResponseBase>
See
Inherited from
LineBotClientBase.validateRichMenuObject
validateRichMenuObjectWithHttpInfo()
validateRichMenuObjectWithHttpInfo(
richMenuRequest):Promise<ApiResponseType<MessageAPIResponseBase>>
Defined in: lib/line-bot-client.generated.ts:2613
Validate rich menu object. This method includes HttpInfo object to return additional information.
Parameters
richMenuRequest
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Inherited from
LineBotClientBase.validateRichMenuObjectWithHttpInfo
fromChannelAccessToken()
staticfromChannelAccessToken(config):LineBotClient
Defined in: lib/line-bot-client.ts:92
Parameters
config
LineBotClientChannelAccessTokenConfig
Returns
LineBotClient