Appearance
@line/bot-sdk / Exports / messagingApi / MessagingApiClient
Class: MessagingApiClient
messagingApi.MessagingApiClient
Table of contents
Constructors
Methods
- audienceMatch
- audienceMatchWithHttpInfo
- broadcast
- broadcastWithHttpInfo
- cancelDefaultRichMenu
- cancelDefaultRichMenuWithHttpInfo
- createRichMenu
- createRichMenuAlias
- createRichMenuAliasWithHttpInfo
- createRichMenuWithHttpInfo
- deleteRichMenu
- deleteRichMenuAlias
- deleteRichMenuAliasWithHttpInfo
- deleteRichMenuWithHttpInfo
- getAdPhoneMessageStatistics
- getAdPhoneMessageStatisticsWithHttpInfo
- getAggregationUnitNameList
- getAggregationUnitNameListWithHttpInfo
- getAggregationUnitUsage
- getAggregationUnitUsageWithHttpInfo
- getBotInfo
- getBotInfoWithHttpInfo
- getDefaultRichMenuId
- getDefaultRichMenuIdWithHttpInfo
- getFollowers
- getFollowersWithHttpInfo
- getGroupMemberCount
- getGroupMemberCountWithHttpInfo
- getGroupMemberProfile
- getGroupMemberProfileWithHttpInfo
- getGroupMembersIds
- getGroupMembersIdsWithHttpInfo
- getGroupSummary
- getGroupSummaryWithHttpInfo
- getMembershipList
- getMembershipListWithHttpInfo
- getMembershipSubscription
- getMembershipSubscriptionWithHttpInfo
- getMessageQuota
- getMessageQuotaConsumption
- getMessageQuotaConsumptionWithHttpInfo
- getMessageQuotaWithHttpInfo
- getNarrowcastProgress
- getNarrowcastProgressWithHttpInfo
- getNumberOfSentBroadcastMessages
- getNumberOfSentBroadcastMessagesWithHttpInfo
- getNumberOfSentMulticastMessages
- getNumberOfSentMulticastMessagesWithHttpInfo
- getNumberOfSentPushMessages
- getNumberOfSentPushMessagesWithHttpInfo
- getNumberOfSentReplyMessages
- getNumberOfSentReplyMessagesWithHttpInfo
- getPNPMessageStatistics
- getPNPMessageStatisticsWithHttpInfo
- getProfile
- getProfileWithHttpInfo
- getRichMenu
- getRichMenuAlias
- getRichMenuAliasList
- getRichMenuAliasListWithHttpInfo
- getRichMenuAliasWithHttpInfo
- getRichMenuBatchProgress
- getRichMenuBatchProgressWithHttpInfo
- getRichMenuIdOfUser
- getRichMenuIdOfUserWithHttpInfo
- getRichMenuList
- getRichMenuListWithHttpInfo
- getRichMenuWithHttpInfo
- getRoomMemberCount
- getRoomMemberCountWithHttpInfo
- getRoomMemberProfile
- getRoomMemberProfileWithHttpInfo
- getRoomMembersIds
- getRoomMembersIdsWithHttpInfo
- getWebhookEndpoint
- getWebhookEndpointWithHttpInfo
- issueLinkToken
- issueLinkTokenWithHttpInfo
- leaveGroup
- leaveGroupWithHttpInfo
- leaveRoom
- leaveRoomWithHttpInfo
- linkRichMenuIdToUser
- linkRichMenuIdToUserWithHttpInfo
- linkRichMenuIdToUsers
- linkRichMenuIdToUsersWithHttpInfo
- markMessagesAsRead
- markMessagesAsReadWithHttpInfo
- multicast
- multicastWithHttpInfo
- narrowcast
- narrowcastWithHttpInfo
- pushMessage
- pushMessageWithHttpInfo
- pushMessagesByPhone
- pushMessagesByPhoneWithHttpInfo
- replyMessage
- replyMessageWithHttpInfo
- richMenuBatch
- richMenuBatchWithHttpInfo
- setDefaultRichMenu
- setDefaultRichMenuWithHttpInfo
- setWebhookEndpoint
- setWebhookEndpointWithHttpInfo
- showLoadingAnimation
- showLoadingAnimationWithHttpInfo
- testWebhookEndpoint
- testWebhookEndpointWithHttpInfo
- unlinkRichMenuIdFromUser
- unlinkRichMenuIdFromUserWithHttpInfo
- unlinkRichMenuIdFromUsers
- unlinkRichMenuIdFromUsersWithHttpInfo
- updateRichMenuAlias
- updateRichMenuAliasWithHttpInfo
- validateBroadcast
- validateBroadcastWithHttpInfo
- validateMulticast
- validateMulticastWithHttpInfo
- validateNarrowcast
- validateNarrowcastWithHttpInfo
- validatePush
- validatePushWithHttpInfo
- validateReply
- validateReplyWithHttpInfo
- validateRichMenuBatchRequest
- validateRichMenuBatchRequestWithHttpInfo
- validateRichMenuObject
- validateRichMenuObjectWithHttpInfo
Constructors
constructor
• new MessagingApiClient(config): MessagingApiClient
Parameters
| Name | Type |
|---|---|
config | httpClientConfig |
Returns
Defined in
lib/messaging-api/api/messagingApiClient.ts:83
Methods
audienceMatch
▸ audienceMatch(audienceMatchMessagesRequest): Promise<MessageAPIResponseBase>
Send a message using phone number
Parameters
| Name | Type |
|---|---|
audienceMatchMessagesRequest | AudienceMatchMessagesRequest |
Returns
Promise<MessageAPIResponseBase>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:112
audienceMatchWithHttpInfo
▸ audienceMatchWithHttpInfo(audienceMatchMessagesRequest): Promise<ApiResponseType<MessageAPIResponseBase>>
Send a message using phone number. This method includes HttpInfo object to return additional information.
Parameters
| Name | Type |
|---|---|
audienceMatchMessagesRequest | AudienceMatchMessagesRequest |
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:126
broadcast
▸ broadcast(broadcastRequest, xLineRetryKey?): Promise<object>
Sends a message to multiple users at any time.
Parameters
| Name | Type | Description |
|---|---|---|
broadcastRequest | BroadcastRequest | |
xLineRetryKey? | string | Retry key. Specifies the UUID in hexadecimal format (e.g., 123e4567-e89b-12d3-a456-426614174000) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key. |
Returns
Promise<object>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:141
broadcastWithHttpInfo
▸ broadcastWithHttpInfo(broadcastRequest, xLineRetryKey?): Promise<ApiResponseType<object>>
Sends a message to multiple users at any time.. This method includes HttpInfo object to return additional information.
Parameters
| Name | Type | Description |
|---|---|---|
broadcastRequest | BroadcastRequest | |
xLineRetryKey? | string | Retry key. Specifies the UUID in hexadecimal format (e.g., 123e4567-e89b-12d3-a456-426614174000) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key. |
Returns
Promise<ApiResponseType<object>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:157
cancelDefaultRichMenu
▸ cancelDefaultRichMenu(): Promise<MessageAPIResponseBase>
Cancel default rich menu
Returns
Promise<MessageAPIResponseBase>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:180
cancelDefaultRichMenuWithHttpInfo
▸ cancelDefaultRichMenuWithHttpInfo(): Promise<ApiResponseType<MessageAPIResponseBase>>
Cancel default rich menu. This method includes HttpInfo object to return additional information.
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:190
createRichMenu
▸ createRichMenu(richMenuRequest): Promise<RichMenuIdResponse>
Create rich menu
Parameters
| Name | Type |
|---|---|
richMenuRequest | RichMenuRequest |
Returns
Promise<RichMenuIdResponse>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:202
createRichMenuAlias
▸ createRichMenuAlias(createRichMenuAliasRequest): Promise<MessageAPIResponseBase>
Create rich menu alias
Parameters
| Name | Type |
|---|---|
createRichMenuAliasRequest | CreateRichMenuAliasRequest |
Returns
Promise<MessageAPIResponseBase>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:229
createRichMenuAliasWithHttpInfo
▸ createRichMenuAliasWithHttpInfo(createRichMenuAliasRequest): Promise<ApiResponseType<MessageAPIResponseBase>>
Create rich menu alias. This method includes HttpInfo object to return additional information.
Parameters
| Name | Type |
|---|---|
createRichMenuAliasRequest | CreateRichMenuAliasRequest |
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:244
createRichMenuWithHttpInfo
▸ createRichMenuWithHttpInfo(richMenuRequest): Promise<ApiResponseType<RichMenuIdResponse>>
Create rich menu. This method includes HttpInfo object to return additional information.
Parameters
| Name | Type |
|---|---|
richMenuRequest | RichMenuRequest |
Returns
Promise<ApiResponseType<RichMenuIdResponse>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:215
deleteRichMenu
▸ deleteRichMenu(richMenuId): Promise<MessageAPIResponseBase>
Deletes a rich menu.
Parameters
| Name | Type | Description |
|---|---|---|
richMenuId | string | ID of a rich menu |
Returns
Promise<MessageAPIResponseBase>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:258
deleteRichMenuAlias
▸ deleteRichMenuAlias(richMenuAliasId): Promise<MessageAPIResponseBase>
Delete rich menu alias
Parameters
| Name | Type | Description |
|---|---|---|
richMenuAliasId | string | Rich menu alias ID that you want to delete. |
Returns
Promise<MessageAPIResponseBase>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:288
deleteRichMenuAliasWithHttpInfo
▸ deleteRichMenuAliasWithHttpInfo(richMenuAliasId): Promise<ApiResponseType<MessageAPIResponseBase>>
Delete rich menu alias. This method includes HttpInfo object to return additional information.
Parameters
| Name | Type | Description |
|---|---|---|
richMenuAliasId | string | Rich menu alias ID that you want to delete. |
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:301
deleteRichMenuWithHttpInfo
▸ deleteRichMenuWithHttpInfo(richMenuId): Promise<ApiResponseType<MessageAPIResponseBase>>
Deletes a rich menu.. This method includes HttpInfo object to return additional information.
Parameters
| Name | Type | Description |
|---|---|---|
richMenuId | string | ID of a rich menu |
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:271
getAdPhoneMessageStatistics
▸ getAdPhoneMessageStatistics(date): Promise<NumberOfMessagesResponse>
Get result of message delivery using phone number
Parameters
| Name | Type | Description |
|---|---|---|
date | string | Date the message was sent Format: yyyyMMdd (e.g. 20190831) Time Zone: UTC+9 |
Returns
Promise<NumberOfMessagesResponse>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:318
getAdPhoneMessageStatisticsWithHttpInfo
▸ getAdPhoneMessageStatisticsWithHttpInfo(date): Promise<ApiResponseType<NumberOfMessagesResponse>>
Get result of message delivery using phone number. This method includes HttpInfo object to return additional information.
Parameters
| Name | Type | Description |
|---|---|---|
date | string | Date the message was sent Format: yyyyMMdd (e.g. 20190831) Time Zone: UTC+9 |
Returns
Promise<ApiResponseType<NumberOfMessagesResponse>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:331
getAggregationUnitNameList
▸ getAggregationUnitNameList(limit?, start?): Promise<GetAggregationUnitNameListResponse>
Get name list of units used this month
Parameters
| Name | Type | Description |
|---|---|---|
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:356
getAggregationUnitNameListWithHttpInfo
▸ getAggregationUnitNameListWithHttpInfo(limit?, start?): Promise<ApiResponseType<GetAggregationUnitNameListResponse>>
Get name list of units used this month. This method includes HttpInfo object to return additional information.
Parameters
| Name | Type | Description |
|---|---|---|
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:372
getAggregationUnitUsage
▸ getAggregationUnitUsage(): Promise<GetAggregationUnitUsageResponse>
Get number of units used this month
Returns
Promise<GetAggregationUnitUsageResponse>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:397
getAggregationUnitUsageWithHttpInfo
▸ getAggregationUnitUsageWithHttpInfo(): Promise<ApiResponseType<GetAggregationUnitUsageResponse>>
Get number of units used this month. This method includes HttpInfo object to return additional information.
Returns
Promise<ApiResponseType<GetAggregationUnitUsageResponse>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:407
getBotInfo
▸ getBotInfo(): Promise<BotInfoResponse>
Get bot info
Returns
Promise<BotInfoResponse>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:418
getBotInfoWithHttpInfo
▸ getBotInfoWithHttpInfo(): Promise<ApiResponseType<BotInfoResponse>>
Get bot info. This method includes HttpInfo object to return additional information.
Returns
Promise<ApiResponseType<BotInfoResponse>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:428
getDefaultRichMenuId
▸ getDefaultRichMenuId(): Promise<RichMenuIdResponse>
Gets the ID of the default rich menu set with the Messaging API.
Returns
Promise<RichMenuIdResponse>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:439
getDefaultRichMenuIdWithHttpInfo
▸ getDefaultRichMenuIdWithHttpInfo(): Promise<ApiResponseType<RichMenuIdResponse>>
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:449
getFollowers
▸ getFollowers(start?, limit?): Promise<GetFollowersResponse>
Get a list of users who added your LINE Official Account as a friend
Parameters
| Name | Type | Description |
|---|---|---|
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:462
getFollowersWithHttpInfo
▸ getFollowersWithHttpInfo(start?, limit?): Promise<ApiResponseType<GetFollowersResponse>>
Get a list of users who added your LINE Official Account as a friend. This method includes HttpInfo object to return additional information.
Parameters
| Name | Type | Description |
|---|---|---|
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:477
getGroupMemberCount
▸ getGroupMemberCount(groupId): Promise<GroupMemberCountResponse>
Get number of users in a group chat
Parameters
| Name | Type | Description |
|---|---|---|
groupId | string | Group ID |
Returns
Promise<GroupMemberCountResponse>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:500
getGroupMemberCountWithHttpInfo
▸ getGroupMemberCountWithHttpInfo(groupId): Promise<ApiResponseType<GroupMemberCountResponse>>
Get number of users in a group chat. This method includes HttpInfo object to return additional information.
Parameters
| Name | Type | Description |
|---|---|---|
groupId | string | Group ID |
Returns
Promise<ApiResponseType<GroupMemberCountResponse>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:513
getGroupMemberProfile
▸ getGroupMemberProfile(groupId, userId): Promise<GroupUserProfileResponse>
Get group chat member profile
Parameters
| Name | Type | Description |
|---|---|---|
groupId | string | Group ID |
userId | string | User ID |
Returns
Promise<GroupUserProfileResponse>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:531
getGroupMemberProfileWithHttpInfo
▸ getGroupMemberProfileWithHttpInfo(groupId, userId): Promise<ApiResponseType<GroupUserProfileResponse>>
Get group chat member profile. This method includes HttpInfo object to return additional information.
Parameters
| Name | Type | Description |
|---|---|---|
groupId | string | Group ID |
userId | string | User ID |
Returns
Promise<ApiResponseType<GroupUserProfileResponse>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:546
getGroupMembersIds
▸ getGroupMembersIds(groupId, start?): Promise<MembersIdsResponse>
Get group chat member user IDs
Parameters
| Name | Type | Description |
|---|---|---|
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:566
getGroupMembersIdsWithHttpInfo
▸ getGroupMembersIdsWithHttpInfo(groupId, start?): Promise<ApiResponseType<MembersIdsResponse>>
Get group chat member user IDs. This method includes HttpInfo object to return additional information.
Parameters
| Name | Type | Description |
|---|---|---|
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:581
getGroupSummary
▸ getGroupSummary(groupId): Promise<GroupSummaryResponse>
Get group chat summary
Parameters
| Name | Type | Description |
|---|---|---|
groupId | string | Group ID |
Returns
Promise<GroupSummaryResponse>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:609
getGroupSummaryWithHttpInfo
▸ getGroupSummaryWithHttpInfo(groupId): Promise<ApiResponseType<GroupSummaryResponse>>
Get group chat summary. This method includes HttpInfo object to return additional information.
Parameters
| Name | Type | Description |
|---|---|---|
groupId | string | Group ID |
Returns
Promise<ApiResponseType<GroupSummaryResponse>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:620
getMembershipList
▸ getMembershipList(): Promise<MembershipListResponse>
Get a list of memberships.
Returns
Promise<MembershipListResponse>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:633
getMembershipListWithHttpInfo
▸ getMembershipListWithHttpInfo(): Promise<ApiResponseType<MembershipListResponse>>
Get a list of memberships.. This method includes HttpInfo object to return additional information.
Returns
Promise<ApiResponseType<MembershipListResponse>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:643
getMembershipSubscription
▸ getMembershipSubscription(userId): Promise<GetMembershipSubscriptionResponse>
Get a user's membership subscription.
Parameters
| Name | Type | Description |
|---|---|---|
userId | string | User ID |
Returns
Promise<GetMembershipSubscriptionResponse>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:655
getMembershipSubscriptionWithHttpInfo
▸ getMembershipSubscriptionWithHttpInfo(userId): Promise<ApiResponseType<GetMembershipSubscriptionResponse>>
Get a user's membership subscription.. This method includes HttpInfo object to return additional information.
Parameters
| Name | Type | Description |
|---|---|---|
userId | string | User ID |
Returns
Promise<ApiResponseType<GetMembershipSubscriptionResponse>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:668
getMessageQuota
▸ getMessageQuota(): Promise<MessageQuotaResponse>
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:684
getMessageQuotaConsumption
▸ getMessageQuotaConsumption(): Promise<QuotaConsumptionResponse>
Gets the number of messages sent in the current month.
Returns
Promise<QuotaConsumptionResponse>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:705
getMessageQuotaConsumptionWithHttpInfo
▸ getMessageQuotaConsumptionWithHttpInfo(): Promise<ApiResponseType<QuotaConsumptionResponse>>
Gets the number of messages sent in the current month.. This method includes HttpInfo object to return additional information.
Returns
Promise<ApiResponseType<QuotaConsumptionResponse>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:715
getMessageQuotaWithHttpInfo
▸ getMessageQuotaWithHttpInfo(): Promise<ApiResponseType<MessageQuotaResponse>>
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:694
getNarrowcastProgress
▸ getNarrowcastProgress(requestId): Promise<NarrowcastProgressResponse>
Gets the status of a narrowcast message.
Parameters
| Name | Type | Description |
|---|---|---|
requestId | string | The narrowcast message's request ID. Each Messaging API request has a request ID. |
Returns
Promise<NarrowcastProgressResponse>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:727
getNarrowcastProgressWithHttpInfo
▸ getNarrowcastProgressWithHttpInfo(requestId): Promise<ApiResponseType<NarrowcastProgressResponse>>
Gets the status of a narrowcast message.. This method includes HttpInfo object to return additional information.
Parameters
| Name | Type | Description |
|---|---|---|
requestId | string | The narrowcast message's request ID. Each Messaging API request has a request ID. |
Returns
Promise<ApiResponseType<NarrowcastProgressResponse>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:740
getNumberOfSentBroadcastMessages
▸ getNumberOfSentBroadcastMessages(date): Promise<NumberOfMessagesResponse>
Get number of sent broadcast messages
Parameters
| Name | Type | Description |
|---|---|---|
date | string | Date the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9 |
Returns
Promise<NumberOfMessagesResponse>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:764
getNumberOfSentBroadcastMessagesWithHttpInfo
▸ getNumberOfSentBroadcastMessagesWithHttpInfo(date): Promise<ApiResponseType<NumberOfMessagesResponse>>
Get number of sent broadcast messages. This method includes HttpInfo object to return additional information.
Parameters
| Name | Type | Description |
|---|---|---|
date | string | Date the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9 |
Returns
Promise<ApiResponseType<NumberOfMessagesResponse>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:777
getNumberOfSentMulticastMessages
▸ getNumberOfSentMulticastMessages(date): Promise<NumberOfMessagesResponse>
Get number of sent multicast messages
Parameters
| Name | Type | Description |
|---|---|---|
date | string | Date the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9 |
Returns
Promise<NumberOfMessagesResponse>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:801
getNumberOfSentMulticastMessagesWithHttpInfo
▸ getNumberOfSentMulticastMessagesWithHttpInfo(date): Promise<ApiResponseType<NumberOfMessagesResponse>>
Get number of sent multicast messages. This method includes HttpInfo object to return additional information.
Parameters
| Name | Type | Description |
|---|---|---|
date | string | Date the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9 |
Returns
Promise<ApiResponseType<NumberOfMessagesResponse>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:814
getNumberOfSentPushMessages
▸ getNumberOfSentPushMessages(date): Promise<NumberOfMessagesResponse>
Get number of sent push messages
Parameters
| Name | Type | Description |
|---|---|---|
date | string | Date the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9 |
Returns
Promise<NumberOfMessagesResponse>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:838
getNumberOfSentPushMessagesWithHttpInfo
▸ getNumberOfSentPushMessagesWithHttpInfo(date): Promise<ApiResponseType<NumberOfMessagesResponse>>
Get number of sent push messages. This method includes HttpInfo object to return additional information.
Parameters
| Name | Type | Description |
|---|---|---|
date | string | Date the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9 |
Returns
Promise<ApiResponseType<NumberOfMessagesResponse>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:851
getNumberOfSentReplyMessages
▸ getNumberOfSentReplyMessages(date): Promise<NumberOfMessagesResponse>
Get number of sent reply messages
Parameters
| Name | Type | Description |
|---|---|---|
date | string | Date the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9 |
Returns
Promise<NumberOfMessagesResponse>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:875
getNumberOfSentReplyMessagesWithHttpInfo
▸ getNumberOfSentReplyMessagesWithHttpInfo(date): Promise<ApiResponseType<NumberOfMessagesResponse>>
Get number of sent reply messages. This method includes HttpInfo object to return additional information.
Parameters
| Name | Type | Description |
|---|---|---|
date | string | Date the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9 |
Returns
Promise<ApiResponseType<NumberOfMessagesResponse>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:888
getPNPMessageStatistics
▸ getPNPMessageStatistics(date): Promise<NumberOfMessagesResponse>
Get number of sent LINE notification messages
Parameters
| Name | Type | Description |
|---|---|---|
date | string | Date the message was sent Format: yyyyMMdd (Example:20211231) Time zone: UTC+9 |
Returns
Promise<NumberOfMessagesResponse>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:912
getPNPMessageStatisticsWithHttpInfo
▸ getPNPMessageStatisticsWithHttpInfo(date): Promise<ApiResponseType<NumberOfMessagesResponse>>
Get number of sent LINE notification messages . This method includes HttpInfo object to return additional information.
Parameters
| Name | Type | Description |
|---|---|---|
date | string | Date the message was sent Format: yyyyMMdd (Example:20211231) Time zone: UTC+9 |
Returns
Promise<ApiResponseType<NumberOfMessagesResponse>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:925
getProfile
▸ getProfile(userId): Promise<UserProfileResponse>
Get profile
Parameters
| Name | Type | Description |
|---|---|---|
userId | string | User ID |
Returns
Promise<UserProfileResponse>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:949
getProfileWithHttpInfo
▸ getProfileWithHttpInfo(userId): Promise<ApiResponseType<UserProfileResponse>>
Get profile. This method includes HttpInfo object to return additional information.
Parameters
| Name | Type | Description |
|---|---|---|
userId | string | User ID |
Returns
Promise<ApiResponseType<UserProfileResponse>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:960
getRichMenu
▸ getRichMenu(richMenuId): Promise<RichMenuResponse>
Gets a rich menu via a rich menu ID.
Parameters
| Name | Type | Description |
|---|---|---|
richMenuId | string | ID of a rich menu |
Returns
Promise<RichMenuResponse>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:974
getRichMenuAlias
▸ getRichMenuAlias(richMenuAliasId): Promise<RichMenuAliasResponse>
Get rich menu alias information
Parameters
| Name | Type | Description |
|---|---|---|
richMenuAliasId | string | The rich menu alias ID whose information you want to obtain. |
Returns
Promise<RichMenuAliasResponse>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1002
getRichMenuAliasList
▸ getRichMenuAliasList(): Promise<RichMenuAliasListResponse>
Get list of rich menu alias
Returns
Promise<RichMenuAliasListResponse>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1031
getRichMenuAliasListWithHttpInfo
▸ getRichMenuAliasListWithHttpInfo(): Promise<ApiResponseType<RichMenuAliasListResponse>>
Get list of rich menu alias. This method includes HttpInfo object to return additional information.
Returns
Promise<ApiResponseType<RichMenuAliasListResponse>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1041
getRichMenuAliasWithHttpInfo
▸ getRichMenuAliasWithHttpInfo(richMenuAliasId): Promise<ApiResponseType<RichMenuAliasResponse>>
Get rich menu alias information. This method includes HttpInfo object to return additional information.
Parameters
| Name | Type | Description |
|---|---|---|
richMenuAliasId | string | The rich menu alias ID whose information you want to obtain. |
Returns
Promise<ApiResponseType<RichMenuAliasResponse>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1015
getRichMenuBatchProgress
▸ getRichMenuBatchProgress(requestId): Promise<RichMenuBatchProgressResponse>
Get the status of Replace or unlink a linked rich menus in batches.
Parameters
| Name | Type | Description |
|---|---|---|
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:1053
getRichMenuBatchProgressWithHttpInfo
▸ getRichMenuBatchProgressWithHttpInfo(requestId): Promise<ApiResponseType<RichMenuBatchProgressResponse>>
Get the status of Replace or unlink a linked rich menus in batches.. This method includes HttpInfo object to return additional information.
Parameters
| Name | Type | Description |
|---|---|---|
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:1066
getRichMenuIdOfUser
▸ getRichMenuIdOfUser(userId): Promise<RichMenuIdResponse>
Get rich menu ID of user
Parameters
| Name | Type | Description |
|---|---|---|
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:1090
getRichMenuIdOfUserWithHttpInfo
▸ getRichMenuIdOfUserWithHttpInfo(userId): Promise<ApiResponseType<RichMenuIdResponse>>
Get rich menu ID of user. This method includes HttpInfo object to return additional information.
Parameters
| Name | Type | Description |
|---|---|---|
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:1103
getRichMenuList
▸ getRichMenuList(): Promise<RichMenuListResponse>
Get rich menu list
Returns
Promise<RichMenuListResponse>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1116
getRichMenuListWithHttpInfo
▸ getRichMenuListWithHttpInfo(): Promise<ApiResponseType<RichMenuListResponse>>
Get rich menu list. This method includes HttpInfo object to return additional information.
Returns
Promise<ApiResponseType<RichMenuListResponse>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1126
getRichMenuWithHttpInfo
▸ getRichMenuWithHttpInfo(richMenuId): Promise<ApiResponseType<RichMenuResponse>>
Gets a rich menu via a rich menu ID.. This method includes HttpInfo object to return additional information.
Parameters
| Name | Type | Description |
|---|---|---|
richMenuId | string | ID of a rich menu |
Returns
Promise<ApiResponseType<RichMenuResponse>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:985
getRoomMemberCount
▸ getRoomMemberCount(roomId): Promise<RoomMemberCountResponse>
Get number of users in a multi-person chat
Parameters
| Name | Type | Description |
|---|---|---|
roomId | string | Room ID |
Returns
Promise<RoomMemberCountResponse>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1138
getRoomMemberCountWithHttpInfo
▸ getRoomMemberCountWithHttpInfo(roomId): Promise<ApiResponseType<RoomMemberCountResponse>>
Get number of users in a multi-person chat. This method includes HttpInfo object to return additional information.
Parameters
| Name | Type | Description |
|---|---|---|
roomId | string | Room ID |
Returns
Promise<ApiResponseType<RoomMemberCountResponse>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1151
getRoomMemberProfile
▸ getRoomMemberProfile(roomId, userId): Promise<RoomUserProfileResponse>
Get multi-person chat member profile
Parameters
| Name | Type | Description |
|---|---|---|
roomId | string | Room ID |
userId | string | User ID |
Returns
Promise<RoomUserProfileResponse>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1166
getRoomMemberProfileWithHttpInfo
▸ getRoomMemberProfileWithHttpInfo(roomId, userId): Promise<ApiResponseType<RoomUserProfileResponse>>
Get multi-person chat member profile. This method includes HttpInfo object to return additional information.
Parameters
| Name | Type | Description |
|---|---|---|
roomId | string | Room ID |
userId | string | User ID |
Returns
Promise<ApiResponseType<RoomUserProfileResponse>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1181
getRoomMembersIds
▸ getRoomMembersIds(roomId, start?): Promise<MembersIdsResponse>
Get multi-person chat member user IDs
Parameters
| Name | Type | Description |
|---|---|---|
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:1201
getRoomMembersIdsWithHttpInfo
▸ getRoomMembersIdsWithHttpInfo(roomId, start?): Promise<ApiResponseType<MembersIdsResponse>>
Get multi-person chat member user IDs. This method includes HttpInfo object to return additional information.
Parameters
| Name | Type | Description |
|---|---|---|
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:1216
getWebhookEndpoint
▸ getWebhookEndpoint(): Promise<GetWebhookEndpointResponse>
Get webhook endpoint information
Returns
Promise<GetWebhookEndpointResponse>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1240
getWebhookEndpointWithHttpInfo
▸ getWebhookEndpointWithHttpInfo(): Promise<ApiResponseType<GetWebhookEndpointResponse>>
Get webhook endpoint information. This method includes HttpInfo object to return additional information.
Returns
Promise<ApiResponseType<GetWebhookEndpointResponse>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1250
issueLinkToken
▸ issueLinkToken(userId): Promise<IssueLinkTokenResponse>
Issue link token
Parameters
| Name | Type | Description |
|---|---|---|
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:1262
issueLinkTokenWithHttpInfo
▸ issueLinkTokenWithHttpInfo(userId): Promise<ApiResponseType<IssueLinkTokenResponse>>
Issue link token. This method includes HttpInfo object to return additional information.
Parameters
| Name | Type | Description |
|---|---|---|
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:1273
leaveGroup
▸ leaveGroup(groupId): Promise<MessageAPIResponseBase>
Leave group chat
Parameters
| Name | Type | Description |
|---|---|---|
groupId | string | Group ID |
Returns
Promise<MessageAPIResponseBase>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1287
leaveGroupWithHttpInfo
▸ leaveGroupWithHttpInfo(groupId): Promise<ApiResponseType<MessageAPIResponseBase>>
Leave group chat. This method includes HttpInfo object to return additional information.
Parameters
| Name | Type | Description |
|---|---|---|
groupId | string | Group ID |
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1300
leaveRoom
▸ leaveRoom(roomId): Promise<MessageAPIResponseBase>
Leave multi-person chat
Parameters
| Name | Type | Description |
|---|---|---|
roomId | string | Room ID |
Returns
Promise<MessageAPIResponseBase>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1314
leaveRoomWithHttpInfo
▸ leaveRoomWithHttpInfo(roomId): Promise<ApiResponseType<MessageAPIResponseBase>>
Leave multi-person chat. This method includes HttpInfo object to return additional information.
Parameters
| Name | Type | Description |
|---|---|---|
roomId | string | Room ID |
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1327
linkRichMenuIdToUser
▸ linkRichMenuIdToUser(userId, richMenuId): Promise<MessageAPIResponseBase>
Link rich menu to user.
Parameters
| Name | Type | Description |
|---|---|---|
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:1342
linkRichMenuIdToUserWithHttpInfo
▸ linkRichMenuIdToUserWithHttpInfo(userId, richMenuId): Promise<ApiResponseType<MessageAPIResponseBase>>
Link rich menu to user.. This method includes HttpInfo object to return additional information.
Parameters
| Name | Type | Description |
|---|---|---|
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:1358
linkRichMenuIdToUsers
▸ linkRichMenuIdToUsers(richMenuBulkLinkRequest): Promise<MessageAPIResponseBase>
Link rich menu to multiple users
Parameters
| Name | Type |
|---|---|
richMenuBulkLinkRequest | RichMenuBulkLinkRequest |
Returns
Promise<MessageAPIResponseBase>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1377
linkRichMenuIdToUsersWithHttpInfo
▸ linkRichMenuIdToUsersWithHttpInfo(richMenuBulkLinkRequest): Promise<ApiResponseType<MessageAPIResponseBase>>
Link rich menu to multiple users. This method includes HttpInfo object to return additional information.
Parameters
| Name | Type |
|---|---|
richMenuBulkLinkRequest | RichMenuBulkLinkRequest |
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1392
markMessagesAsRead
▸ markMessagesAsRead(markMessagesAsReadRequest): Promise<MessageAPIResponseBase>
Mark messages from users as read
Parameters
| Name | Type |
|---|---|
markMessagesAsReadRequest | MarkMessagesAsReadRequest |
Returns
Promise<MessageAPIResponseBase>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1409
markMessagesAsReadWithHttpInfo
▸ markMessagesAsReadWithHttpInfo(markMessagesAsReadRequest): Promise<ApiResponseType<MessageAPIResponseBase>>
Mark messages from users as read. This method includes HttpInfo object to return additional information.
Parameters
| Name | Type |
|---|---|
markMessagesAsReadRequest | MarkMessagesAsReadRequest |
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1424
multicast
▸ multicast(multicastRequest, xLineRetryKey?): Promise<object>
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
| Name | Type | Description |
|---|---|---|
multicastRequest | 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
Defined in
lib/messaging-api/api/messagingApiClient.ts:1442
multicastWithHttpInfo
▸ multicastWithHttpInfo(multicastRequest, xLineRetryKey?): Promise<ApiResponseType<object>>
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
| Name | Type | Description |
|---|---|---|
multicastRequest | 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
Defined in
lib/messaging-api/api/messagingApiClient.ts:1458
narrowcast
▸ narrowcast(narrowcastRequest, xLineRetryKey?): Promise<object>
Send narrowcast message
Parameters
| Name | Type | Description |
|---|---|---|
narrowcastRequest | 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
Defined in
lib/messaging-api/api/messagingApiClient.ts:1483
narrowcastWithHttpInfo
▸ narrowcastWithHttpInfo(narrowcastRequest, xLineRetryKey?): Promise<ApiResponseType<object>>
Send narrowcast message. This method includes HttpInfo object to return additional information.
Parameters
| Name | Type | Description |
|---|---|---|
narrowcastRequest | 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
Defined in
lib/messaging-api/api/messagingApiClient.ts:1499
pushMessage
▸ pushMessage(pushMessageRequest, xLineRetryKey?): Promise<PushMessageResponse>
Sends a message to a user, group chat, or multi-person chat at any time.
Parameters
| Name | Type | Description |
|---|---|---|
pushMessageRequest | 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
Defined in
lib/messaging-api/api/messagingApiClient.ts:1524
pushMessageWithHttpInfo
▸ pushMessageWithHttpInfo(pushMessageRequest, xLineRetryKey?): Promise<ApiResponseType<PushMessageResponse>>
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
| Name | Type | Description |
|---|---|---|
pushMessageRequest | 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
Defined in
lib/messaging-api/api/messagingApiClient.ts:1541
pushMessagesByPhone
▸ pushMessagesByPhone(pnpMessagesRequest, xLineDeliveryTag?): Promise<MessageAPIResponseBase>
Send LINE notification message
Parameters
| Name | Type | Description |
|---|---|---|
pnpMessagesRequest | PnpMessagesRequest | |
xLineDeliveryTag? | string | String returned in the delivery.data property of the delivery completion event via Webhook. |
Returns
Promise<MessageAPIResponseBase>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1566
pushMessagesByPhoneWithHttpInfo
▸ pushMessagesByPhoneWithHttpInfo(pnpMessagesRequest, xLineDeliveryTag?): Promise<ApiResponseType<MessageAPIResponseBase>>
Send LINE notification message. This method includes HttpInfo object to return additional information.
Parameters
| Name | Type | Description |
|---|---|---|
pnpMessagesRequest | PnpMessagesRequest | |
xLineDeliveryTag? | string | String returned in the delivery.data property of the delivery completion event via Webhook. |
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1586
replyMessage
▸ replyMessage(replyMessageRequest): Promise<ReplyMessageResponse>
Send reply message
Parameters
| Name | Type |
|---|---|
replyMessageRequest | ReplyMessageRequest |
Returns
Promise<ReplyMessageResponse>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1612
replyMessageWithHttpInfo
▸ replyMessageWithHttpInfo(replyMessageRequest): Promise<ApiResponseType<ReplyMessageResponse>>
Send reply message. This method includes HttpInfo object to return additional information.
Parameters
| Name | Type |
|---|---|
replyMessageRequest | ReplyMessageRequest |
Returns
Promise<ApiResponseType<ReplyMessageResponse>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1625
richMenuBatch
▸ richMenuBatch(richMenuBatchRequest): Promise<MessageAPIResponseBase>
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
| Name | Type |
|---|---|
richMenuBatchRequest | RichMenuBatchRequest |
Returns
Promise<MessageAPIResponseBase>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1639
richMenuBatchWithHttpInfo
▸ richMenuBatchWithHttpInfo(richMenuBatchRequest): Promise<ApiResponseType<MessageAPIResponseBase>>
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
| Name | Type |
|---|---|
richMenuBatchRequest | RichMenuBatchRequest |
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1652
setDefaultRichMenu
▸ setDefaultRichMenu(richMenuId): Promise<MessageAPIResponseBase>
Set default rich menu
Parameters
| Name | Type | Description |
|---|---|---|
richMenuId | string | ID of a rich menu |
Returns
Promise<MessageAPIResponseBase>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1666
setDefaultRichMenuWithHttpInfo
▸ setDefaultRichMenuWithHttpInfo(richMenuId): Promise<ApiResponseType<MessageAPIResponseBase>>
Set default rich menu. This method includes HttpInfo object to return additional information.
Parameters
| Name | Type | Description |
|---|---|---|
richMenuId | string | ID of a rich menu |
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1679
setWebhookEndpoint
▸ setWebhookEndpoint(setWebhookEndpointRequest): Promise<MessageAPIResponseBase>
Set webhook endpoint URL
Parameters
| Name | Type |
|---|---|
setWebhookEndpointRequest | SetWebhookEndpointRequest |
Returns
Promise<MessageAPIResponseBase>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1696
setWebhookEndpointWithHttpInfo
▸ setWebhookEndpointWithHttpInfo(setWebhookEndpointRequest): Promise<ApiResponseType<MessageAPIResponseBase>>
Set webhook endpoint URL. This method includes HttpInfo object to return additional information.
Parameters
| Name | Type |
|---|---|
setWebhookEndpointRequest | SetWebhookEndpointRequest |
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1711
showLoadingAnimation
▸ showLoadingAnimation(showLoadingAnimationRequest): Promise<object>
Display a loading animation in one-on-one chats between users and LINE Official Accounts.
Parameters
| Name | Type |
|---|---|
showLoadingAnimationRequest | ShowLoadingAnimationRequest |
Returns
Promise<object>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1728
showLoadingAnimationWithHttpInfo
▸ showLoadingAnimationWithHttpInfo(showLoadingAnimationRequest): Promise<ApiResponseType<object>>
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
| Name | Type |
|---|---|
showLoadingAnimationRequest | ShowLoadingAnimationRequest |
Returns
Promise<ApiResponseType<object>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1743
testWebhookEndpoint
▸ testWebhookEndpoint(testWebhookEndpointRequest?): Promise<TestWebhookEndpointResponse>
Test webhook endpoint
Parameters
| Name | Type |
|---|---|
testWebhookEndpointRequest? | TestWebhookEndpointRequest |
Returns
Promise<TestWebhookEndpointResponse>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1760
testWebhookEndpointWithHttpInfo
▸ testWebhookEndpointWithHttpInfo(testWebhookEndpointRequest?): Promise<ApiResponseType<TestWebhookEndpointResponse>>
Test webhook endpoint. This method includes HttpInfo object to return additional information.
Parameters
| Name | Type |
|---|---|
testWebhookEndpointRequest? | TestWebhookEndpointRequest |
Returns
Promise<ApiResponseType<TestWebhookEndpointResponse>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1775
unlinkRichMenuIdFromUser
▸ unlinkRichMenuIdFromUser(userId): Promise<MessageAPIResponseBase>
Unlink rich menu from user
Parameters
| Name | Type | Description |
|---|---|---|
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:1792
unlinkRichMenuIdFromUserWithHttpInfo
▸ unlinkRichMenuIdFromUserWithHttpInfo(userId): Promise<ApiResponseType<MessageAPIResponseBase>>
Unlink rich menu from user. This method includes HttpInfo object to return additional information.
Parameters
| Name | Type | Description |
|---|---|---|
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:1805
unlinkRichMenuIdFromUsers
▸ unlinkRichMenuIdFromUsers(richMenuBulkUnlinkRequest): Promise<MessageAPIResponseBase>
Unlink rich menus from multiple users
Parameters
| Name | Type |
|---|---|
richMenuBulkUnlinkRequest | RichMenuBulkUnlinkRequest |
Returns
Promise<MessageAPIResponseBase>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1819
unlinkRichMenuIdFromUsersWithHttpInfo
▸ unlinkRichMenuIdFromUsersWithHttpInfo(richMenuBulkUnlinkRequest): Promise<ApiResponseType<MessageAPIResponseBase>>
Unlink rich menus from multiple users. This method includes HttpInfo object to return additional information.
Parameters
| Name | Type |
|---|---|
richMenuBulkUnlinkRequest | RichMenuBulkUnlinkRequest |
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1836
updateRichMenuAlias
▸ updateRichMenuAlias(richMenuAliasId, updateRichMenuAliasRequest): Promise<MessageAPIResponseBase>
Update rich menu alias
Parameters
| Name | Type | Description |
|---|---|---|
richMenuAliasId | string | The rich menu alias ID you want to update. |
updateRichMenuAliasRequest | UpdateRichMenuAliasRequest |
Returns
Promise<MessageAPIResponseBase>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1854
updateRichMenuAliasWithHttpInfo
▸ updateRichMenuAliasWithHttpInfo(richMenuAliasId, updateRichMenuAliasRequest): Promise<ApiResponseType<MessageAPIResponseBase>>
Update rich menu alias. This method includes HttpInfo object to return additional information.
Parameters
| Name | Type | Description |
|---|---|---|
richMenuAliasId | string | The rich menu alias ID you want to update. |
updateRichMenuAliasRequest | UpdateRichMenuAliasRequest |
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1874
validateBroadcast
▸ validateBroadcast(validateMessageRequest): Promise<MessageAPIResponseBase>
Validate message objects of a broadcast message
Parameters
| Name | Type |
|---|---|
validateMessageRequest | ValidateMessageRequest |
Returns
Promise<MessageAPIResponseBase>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1895
validateBroadcastWithHttpInfo
▸ validateBroadcastWithHttpInfo(validateMessageRequest): Promise<ApiResponseType<MessageAPIResponseBase>>
Validate message objects of a broadcast message. This method includes HttpInfo object to return additional information.
Parameters
| Name | Type |
|---|---|
validateMessageRequest | ValidateMessageRequest |
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1909
validateMulticast
▸ validateMulticast(validateMessageRequest): Promise<MessageAPIResponseBase>
Validate message objects of a multicast message
Parameters
| Name | Type |
|---|---|
validateMessageRequest | ValidateMessageRequest |
Returns
Promise<MessageAPIResponseBase>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1926
validateMulticastWithHttpInfo
▸ validateMulticastWithHttpInfo(validateMessageRequest): Promise<ApiResponseType<MessageAPIResponseBase>>
Validate message objects of a multicast message. This method includes HttpInfo object to return additional information.
Parameters
| Name | Type |
|---|---|
validateMessageRequest | ValidateMessageRequest |
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1940
validateNarrowcast
▸ validateNarrowcast(validateMessageRequest): Promise<MessageAPIResponseBase>
Validate message objects of a narrowcast message
Parameters
| Name | Type |
|---|---|
validateMessageRequest | ValidateMessageRequest |
Returns
Promise<MessageAPIResponseBase>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1957
validateNarrowcastWithHttpInfo
▸ validateNarrowcastWithHttpInfo(validateMessageRequest): Promise<ApiResponseType<MessageAPIResponseBase>>
Validate message objects of a narrowcast message. This method includes HttpInfo object to return additional information.
Parameters
| Name | Type |
|---|---|
validateMessageRequest | ValidateMessageRequest |
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1971
validatePush
▸ validatePush(validateMessageRequest): Promise<MessageAPIResponseBase>
Validate message objects of a push message
Parameters
| Name | Type |
|---|---|
validateMessageRequest | ValidateMessageRequest |
Returns
Promise<MessageAPIResponseBase>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1988
validatePushWithHttpInfo
▸ validatePushWithHttpInfo(validateMessageRequest): Promise<ApiResponseType<MessageAPIResponseBase>>
Validate message objects of a push message. This method includes HttpInfo object to return additional information.
Parameters
| Name | Type |
|---|---|
validateMessageRequest | ValidateMessageRequest |
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:2001
validateReply
▸ validateReply(validateMessageRequest): Promise<MessageAPIResponseBase>
Validate message objects of a reply message
Parameters
| Name | Type |
|---|---|
validateMessageRequest | ValidateMessageRequest |
Returns
Promise<MessageAPIResponseBase>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:2018
validateReplyWithHttpInfo
▸ validateReplyWithHttpInfo(validateMessageRequest): Promise<ApiResponseType<MessageAPIResponseBase>>
Validate message objects of a reply message. This method includes HttpInfo object to return additional information.
Parameters
| Name | Type |
|---|---|
validateMessageRequest | ValidateMessageRequest |
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:2031
validateRichMenuBatchRequest
▸ validateRichMenuBatchRequest(richMenuBatchRequest): Promise<MessageAPIResponseBase>
Validate a request body of the Replace or unlink the linked rich menus in batches endpoint.
Parameters
| Name | Type |
|---|---|
richMenuBatchRequest | RichMenuBatchRequest |
Returns
Promise<MessageAPIResponseBase>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:2048
validateRichMenuBatchRequestWithHttpInfo
▸ validateRichMenuBatchRequestWithHttpInfo(richMenuBatchRequest): Promise<ApiResponseType<MessageAPIResponseBase>>
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
| Name | Type |
|---|---|
richMenuBatchRequest | RichMenuBatchRequest |
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:2063
validateRichMenuObject
▸ validateRichMenuObject(richMenuRequest): Promise<MessageAPIResponseBase>
Validate rich menu object
Parameters
| Name | Type |
|---|---|
richMenuRequest | RichMenuRequest |
Returns
Promise<MessageAPIResponseBase>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:2080
validateRichMenuObjectWithHttpInfo
▸ validateRichMenuObjectWithHttpInfo(richMenuRequest): Promise<ApiResponseType<MessageAPIResponseBase>>
Validate rich menu object. This method includes HttpInfo object to return additional information.
Parameters
| Name | Type |
|---|---|
richMenuRequest | RichMenuRequest |
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See