Appearance
@line/bot-sdk • Docs
@line/bot-sdk / messagingApi / MessagingApiClient
Class: MessagingApiClient
Constructors
new MessagingApiClient()
new MessagingApiClient(
config):MessagingApiClient
Parameters
• 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
• 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
• 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
• 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:143
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
• 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:159
cancelDefaultRichMenu()
cancelDefaultRichMenu():
Promise<MessageAPIResponseBase>
Cancel default rich menu
Returns
Promise<MessageAPIResponseBase>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:184
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:194
createRichMenu()
createRichMenu(
richMenuRequest):Promise<RichMenuIdResponse>
Create rich menu
Parameters
• richMenuRequest: RichMenuRequest
Returns
Promise<RichMenuIdResponse>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:208
createRichMenuAlias()
createRichMenuAlias(
createRichMenuAliasRequest):Promise<MessageAPIResponseBase>
Create rich menu alias
Parameters
• createRichMenuAliasRequest: CreateRichMenuAliasRequest
Returns
Promise<MessageAPIResponseBase>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:237
createRichMenuAliasWithHttpInfo()
createRichMenuAliasWithHttpInfo(
createRichMenuAliasRequest):Promise<ApiResponseType<MessageAPIResponseBase>>
Create rich menu alias. This method includes HttpInfo object to return additional information.
Parameters
• createRichMenuAliasRequest: CreateRichMenuAliasRequest
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:252
createRichMenuWithHttpInfo()
createRichMenuWithHttpInfo(
richMenuRequest):Promise<ApiResponseType<RichMenuIdResponse>>
Create rich menu. This method includes HttpInfo object to return additional information.
Parameters
• richMenuRequest: RichMenuRequest
Returns
Promise<ApiResponseType<RichMenuIdResponse>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:221
deleteRichMenu()
deleteRichMenu(
richMenuId):Promise<MessageAPIResponseBase>
Deletes a rich menu.
Parameters
• richMenuId: string
ID of a rich menu
Returns
Promise<MessageAPIResponseBase>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:268
deleteRichMenuAlias()
deleteRichMenuAlias(
richMenuAliasId):Promise<MessageAPIResponseBase>
Delete rich menu alias
Parameters
• richMenuAliasId: string
Rich menu alias ID that you want to delete.
Returns
Promise<MessageAPIResponseBase>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:300
deleteRichMenuAliasWithHttpInfo()
deleteRichMenuAliasWithHttpInfo(
richMenuAliasId):Promise<ApiResponseType<MessageAPIResponseBase>>
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:313
deleteRichMenuWithHttpInfo()
deleteRichMenuWithHttpInfo(
richMenuId):Promise<ApiResponseType<MessageAPIResponseBase>>
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:281
getAdPhoneMessageStatistics()
getAdPhoneMessageStatistics(
date):Promise<NumberOfMessagesResponse>
Get result of message delivery using phone number
Parameters
• 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:332
getAdPhoneMessageStatisticsWithHttpInfo()
getAdPhoneMessageStatisticsWithHttpInfo(
date):Promise<ApiResponseType<NumberOfMessagesResponse>>
Get result of message delivery using phone number. This method includes HttpInfo object to return additional information.
Parameters
• 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:345
getAggregationUnitNameList()
getAggregationUnitNameList(
limit?,start?):Promise<GetAggregationUnitNameListResponse>
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:372
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
• 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:388
getAggregationUnitUsage()
getAggregationUnitUsage():
Promise<GetAggregationUnitUsageResponse>
Get number of units used this month
Returns
Promise<GetAggregationUnitUsageResponse>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:415
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:425
getBotInfo()
getBotInfo():
Promise<BotInfoResponse>
Get bot info
Returns
Promise<BotInfoResponse>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:438
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:448
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:461
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:471
getFollowers()
getFollowers(
start?,limit?):Promise<GetFollowersResponse>
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:486
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
• 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:501
getGroupMemberCount()
getGroupMemberCount(
groupId):Promise<GroupMemberCountResponse>
Get number of users in a group chat
Parameters
• groupId: string
Group ID
Returns
Promise<GroupMemberCountResponse>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:526
getGroupMemberCountWithHttpInfo()
getGroupMemberCountWithHttpInfo(
groupId):Promise<ApiResponseType<GroupMemberCountResponse>>
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:539
getGroupMemberProfile()
getGroupMemberProfile(
groupId,userId):Promise<GroupUserProfileResponse>
Get group chat member profile
Parameters
• groupId: string
Group ID
• userId: string
User ID
Returns
Promise<GroupUserProfileResponse>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:559
getGroupMemberProfileWithHttpInfo()
getGroupMemberProfileWithHttpInfo(
groupId,userId):Promise<ApiResponseType<GroupUserProfileResponse>>
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:574
getGroupMembersIds()
getGroupMembersIds(
groupId,start?):Promise<MembersIdsResponse>
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:596
getGroupMembersIdsWithHttpInfo()
getGroupMembersIdsWithHttpInfo(
groupId,start?):Promise<ApiResponseType<MembersIdsResponse>>
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:611
getGroupSummary()
getGroupSummary(
groupId):Promise<GroupSummaryResponse>
Get group chat summary
Parameters
• groupId: string
Group ID
Returns
Promise<GroupSummaryResponse>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:641
getGroupSummaryWithHttpInfo()
getGroupSummaryWithHttpInfo(
groupId):Promise<ApiResponseType<GroupSummaryResponse>>
Get group chat summary. This method includes HttpInfo object to return additional information.
Parameters
• groupId: string
Group ID
Returns
Promise<ApiResponseType<GroupSummaryResponse>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:652
getMembershipList()
getMembershipList():
Promise<MembershipListResponse>
Get a list of memberships.
Returns
Promise<MembershipListResponse>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:667
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:677
getMembershipSubscription()
getMembershipSubscription(
userId):Promise<GetMembershipSubscriptionResponse>
Get a user's membership subscription.
Parameters
• userId: string
User ID
Returns
Promise<GetMembershipSubscriptionResponse>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:691
getMembershipSubscriptionWithHttpInfo()
getMembershipSubscriptionWithHttpInfo(
userId):Promise<ApiResponseType<GetMembershipSubscriptionResponse>>
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:704
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:722
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:745
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:755
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:732
getNarrowcastProgress()
getNarrowcastProgress(
requestId):Promise<NarrowcastProgressResponse>
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:769
getNarrowcastProgressWithHttpInfo()
getNarrowcastProgressWithHttpInfo(
requestId):Promise<ApiResponseType<NarrowcastProgressResponse>>
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:782
getNumberOfSentBroadcastMessages()
getNumberOfSentBroadcastMessages(
date):Promise<NumberOfMessagesResponse>
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:808
getNumberOfSentBroadcastMessagesWithHttpInfo()
getNumberOfSentBroadcastMessagesWithHttpInfo(
date):Promise<ApiResponseType<NumberOfMessagesResponse>>
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:821
getNumberOfSentMulticastMessages()
getNumberOfSentMulticastMessages(
date):Promise<NumberOfMessagesResponse>
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:847
getNumberOfSentMulticastMessagesWithHttpInfo()
getNumberOfSentMulticastMessagesWithHttpInfo(
date):Promise<ApiResponseType<NumberOfMessagesResponse>>
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:860
getNumberOfSentPushMessages()
getNumberOfSentPushMessages(
date):Promise<NumberOfMessagesResponse>
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:886
getNumberOfSentPushMessagesWithHttpInfo()
getNumberOfSentPushMessagesWithHttpInfo(
date):Promise<ApiResponseType<NumberOfMessagesResponse>>
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:899
getNumberOfSentReplyMessages()
getNumberOfSentReplyMessages(
date):Promise<NumberOfMessagesResponse>
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:925
getNumberOfSentReplyMessagesWithHttpInfo()
getNumberOfSentReplyMessagesWithHttpInfo(
date):Promise<ApiResponseType<NumberOfMessagesResponse>>
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:938
getPNPMessageStatistics()
getPNPMessageStatistics(
date):Promise<NumberOfMessagesResponse>
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:964
getPNPMessageStatisticsWithHttpInfo()
getPNPMessageStatisticsWithHttpInfo(
date):Promise<ApiResponseType<NumberOfMessagesResponse>>
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:977
getProfile()
getProfile(
userId):Promise<UserProfileResponse>
Get profile
Parameters
• userId: string
User ID
Returns
Promise<UserProfileResponse>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1003
getProfileWithHttpInfo()
getProfileWithHttpInfo(
userId):Promise<ApiResponseType<UserProfileResponse>>
Get profile. This method includes HttpInfo object to return additional information.
Parameters
• userId: string
User ID
Returns
Promise<ApiResponseType<UserProfileResponse>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1014
getRichMenu()
getRichMenu(
richMenuId):Promise<RichMenuResponse>
Gets a rich menu via a rich menu ID.
Parameters
• richMenuId: string
ID of a rich menu
Returns
Promise<RichMenuResponse>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1030
getRichMenuAlias()
getRichMenuAlias(
richMenuAliasId):Promise<RichMenuAliasResponse>
Get rich menu alias information
Parameters
• 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:1060
getRichMenuAliasList()
getRichMenuAliasList():
Promise<RichMenuAliasListResponse>
Get list of rich menu alias
Returns
Promise<RichMenuAliasListResponse>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1091
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:1101
getRichMenuAliasWithHttpInfo()
getRichMenuAliasWithHttpInfo(
richMenuAliasId):Promise<ApiResponseType<RichMenuAliasResponse>>
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:1073
getRichMenuBatchProgress()
getRichMenuBatchProgress(
requestId):Promise<RichMenuBatchProgressResponse>
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:1115
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
• 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:1128
getRichMenuIdOfUser()
getRichMenuIdOfUser(
userId):Promise<RichMenuIdResponse>
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:1154
getRichMenuIdOfUserWithHttpInfo()
getRichMenuIdOfUserWithHttpInfo(
userId):Promise<ApiResponseType<RichMenuIdResponse>>
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:1167
getRichMenuList()
getRichMenuList():
Promise<RichMenuListResponse>
Get rich menu list
Returns
Promise<RichMenuListResponse>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1182
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:1192
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
• richMenuId: string
ID of a rich menu
Returns
Promise<ApiResponseType<RichMenuResponse>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1041
getRoomMemberCount()
getRoomMemberCount(
roomId):Promise<RoomMemberCountResponse>
Get number of users in a multi-person chat
Parameters
• roomId: string
Room ID
Returns
Promise<RoomMemberCountResponse>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1206
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
• roomId: string
Room ID
Returns
Promise<ApiResponseType<RoomMemberCountResponse>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1219
getRoomMemberProfile()
getRoomMemberProfile(
roomId,userId):Promise<RoomUserProfileResponse>
Get multi-person chat member profile
Parameters
• roomId: string
Room ID
• userId: string
User ID
Returns
Promise<RoomUserProfileResponse>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1236
getRoomMemberProfileWithHttpInfo()
getRoomMemberProfileWithHttpInfo(
roomId,userId):Promise<ApiResponseType<RoomUserProfileResponse>>
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:1251
getRoomMembersIds()
getRoomMembersIds(
roomId,start?):Promise<MembersIdsResponse>
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:1273
getRoomMembersIdsWithHttpInfo()
getRoomMembersIdsWithHttpInfo(
roomId,start?):Promise<ApiResponseType<MembersIdsResponse>>
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:1288
getWebhookEndpoint()
getWebhookEndpoint():
Promise<GetWebhookEndpointResponse>
Get webhook endpoint information
Returns
Promise<GetWebhookEndpointResponse>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1314
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:1324
issueLinkToken()
issueLinkToken(
userId):Promise<IssueLinkTokenResponse>
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:1338
issueLinkTokenWithHttpInfo()
issueLinkTokenWithHttpInfo(
userId):Promise<ApiResponseType<IssueLinkTokenResponse>>
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:1349
leaveGroup()
leaveGroup(
groupId):Promise<MessageAPIResponseBase>
Leave group chat
Parameters
• groupId: string
Group ID
Returns
Promise<MessageAPIResponseBase>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1365
leaveGroupWithHttpInfo()
leaveGroupWithHttpInfo(
groupId):Promise<ApiResponseType<MessageAPIResponseBase>>
Leave group chat. This method includes HttpInfo object to return additional information.
Parameters
• groupId: string
Group ID
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1378
leaveRoom()
leaveRoom(
roomId):Promise<MessageAPIResponseBase>
Leave multi-person chat
Parameters
• roomId: string
Room ID
Returns
Promise<MessageAPIResponseBase>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1394
leaveRoomWithHttpInfo()
leaveRoomWithHttpInfo(
roomId):Promise<ApiResponseType<MessageAPIResponseBase>>
Leave multi-person chat. This method includes HttpInfo object to return additional information.
Parameters
• roomId: string
Room ID
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1407
linkRichMenuIdToUser()
linkRichMenuIdToUser(
userId,richMenuId):Promise<MessageAPIResponseBase>
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:1424
linkRichMenuIdToUsers()
linkRichMenuIdToUsers(
richMenuBulkLinkRequest):Promise<MessageAPIResponseBase>
Link rich menu to multiple users
Parameters
• richMenuBulkLinkRequest: RichMenuBulkLinkRequest
Returns
Promise<MessageAPIResponseBase>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1461
linkRichMenuIdToUsersWithHttpInfo()
linkRichMenuIdToUsersWithHttpInfo(
richMenuBulkLinkRequest):Promise<ApiResponseType<MessageAPIResponseBase>>
Link rich menu to multiple users. This method includes HttpInfo object to return additional information.
Parameters
• richMenuBulkLinkRequest: RichMenuBulkLinkRequest
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1476
linkRichMenuIdToUserWithHttpInfo()
linkRichMenuIdToUserWithHttpInfo(
userId,richMenuId):Promise<ApiResponseType<MessageAPIResponseBase>>
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:1440
markMessagesAsRead()
markMessagesAsRead(
markMessagesAsReadRequest):Promise<MessageAPIResponseBase>
Mark messages from users as read
Parameters
• markMessagesAsReadRequest: MarkMessagesAsReadRequest
Returns
Promise<MessageAPIResponseBase>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1495
markMessagesAsReadWithHttpInfo()
markMessagesAsReadWithHttpInfo(
markMessagesAsReadRequest):Promise<ApiResponseType<MessageAPIResponseBase>>
Mark messages from users as read. This method includes HttpInfo object to return additional information.
Parameters
• markMessagesAsReadRequest: MarkMessagesAsReadRequest
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1510
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
• 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:1530
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
• 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:1546
narrowcast()
narrowcast(
narrowcastRequest,xLineRetryKey?):Promise<object>
Send narrowcast message
Parameters
• 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:1573
narrowcastWithHttpInfo()
narrowcastWithHttpInfo(
narrowcastRequest,xLineRetryKey?):Promise<ApiResponseType<object>>
Send narrowcast message. This method includes HttpInfo object to return additional information.
Parameters
• 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:1589
pushMessage()
pushMessage(
pushMessageRequest,xLineRetryKey?):Promise<PushMessageResponse>
Sends a message to a user, group chat, or multi-person chat at any time.
Parameters
• 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:1616
pushMessagesByPhone()
pushMessagesByPhone(
pnpMessagesRequest,xLineDeliveryTag?):Promise<MessageAPIResponseBase>
Send LINE notification message
Parameters
• 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:1660
pushMessagesByPhoneWithHttpInfo()
pushMessagesByPhoneWithHttpInfo(
pnpMessagesRequest,xLineDeliveryTag?):Promise<ApiResponseType<MessageAPIResponseBase>>
Send LINE notification message. This method includes HttpInfo object to return additional information.
Parameters
• 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:1680
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
• 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:1633
replyMessage()
replyMessage(
replyMessageRequest):Promise<ReplyMessageResponse>
Send reply message
Parameters
• replyMessageRequest: ReplyMessageRequest
Returns
Promise<ReplyMessageResponse>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1708
replyMessageWithHttpInfo()
replyMessageWithHttpInfo(
replyMessageRequest):Promise<ApiResponseType<ReplyMessageResponse>>
Send reply message. This method includes HttpInfo object to return additional information.
Parameters
• replyMessageRequest: ReplyMessageRequest
Returns
Promise<ApiResponseType<ReplyMessageResponse>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1721
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
• richMenuBatchRequest: RichMenuBatchRequest
Returns
Promise<MessageAPIResponseBase>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1737
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
• richMenuBatchRequest: RichMenuBatchRequest
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1750
setDefaultRichMenu()
setDefaultRichMenu(
richMenuId):Promise<MessageAPIResponseBase>
Set default rich menu
Parameters
• richMenuId: string
ID of a rich menu
Returns
Promise<MessageAPIResponseBase>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1766
setDefaultRichMenuWithHttpInfo()
setDefaultRichMenuWithHttpInfo(
richMenuId):Promise<ApiResponseType<MessageAPIResponseBase>>
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:1779
setWebhookEndpoint()
setWebhookEndpoint(
setWebhookEndpointRequest):Promise<MessageAPIResponseBase>
Set webhook endpoint URL
Parameters
• setWebhookEndpointRequest: SetWebhookEndpointRequest
Returns
Promise<MessageAPIResponseBase>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1798
setWebhookEndpointWithHttpInfo()
setWebhookEndpointWithHttpInfo(
setWebhookEndpointRequest):Promise<ApiResponseType<MessageAPIResponseBase>>
Set webhook endpoint URL. This method includes HttpInfo object to return additional information.
Parameters
• setWebhookEndpointRequest: SetWebhookEndpointRequest
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1813
showLoadingAnimation()
showLoadingAnimation(
showLoadingAnimationRequest):Promise<object>
Display a loading animation in one-on-one chats between users and LINE Official Accounts.
Parameters
• showLoadingAnimationRequest: ShowLoadingAnimationRequest
Returns
Promise<object>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1832
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
• showLoadingAnimationRequest: ShowLoadingAnimationRequest
Returns
Promise<ApiResponseType<object>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1847
testWebhookEndpoint()
testWebhookEndpoint(
testWebhookEndpointRequest?):Promise<TestWebhookEndpointResponse>
Test webhook endpoint
Parameters
• testWebhookEndpointRequest?: TestWebhookEndpointRequest
Returns
Promise<TestWebhookEndpointResponse>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1866
testWebhookEndpointWithHttpInfo()
testWebhookEndpointWithHttpInfo(
testWebhookEndpointRequest?):Promise<ApiResponseType<TestWebhookEndpointResponse>>
Test webhook endpoint. This method includes HttpInfo object to return additional information.
Parameters
• testWebhookEndpointRequest?: TestWebhookEndpointRequest
Returns
Promise<ApiResponseType<TestWebhookEndpointResponse>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1881
unlinkRichMenuIdFromUser()
unlinkRichMenuIdFromUser(
userId):Promise<MessageAPIResponseBase>
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:1900
unlinkRichMenuIdFromUsers()
unlinkRichMenuIdFromUsers(
richMenuBulkUnlinkRequest):Promise<MessageAPIResponseBase>
Unlink rich menus from multiple users
Parameters
• richMenuBulkUnlinkRequest: RichMenuBulkUnlinkRequest
Returns
Promise<MessageAPIResponseBase>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1929
unlinkRichMenuIdFromUsersWithHttpInfo()
unlinkRichMenuIdFromUsersWithHttpInfo(
richMenuBulkUnlinkRequest):Promise<ApiResponseType<MessageAPIResponseBase>>
Unlink rich menus from multiple users. This method includes HttpInfo object to return additional information.
Parameters
• richMenuBulkUnlinkRequest: RichMenuBulkUnlinkRequest
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1946
unlinkRichMenuIdFromUserWithHttpInfo()
unlinkRichMenuIdFromUserWithHttpInfo(
userId):Promise<ApiResponseType<MessageAPIResponseBase>>
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
Defined in
lib/messaging-api/api/messagingApiClient.ts:1913
updateRichMenuAlias()
updateRichMenuAlias(
richMenuAliasId,updateRichMenuAliasRequest):Promise<MessageAPIResponseBase>
Update rich menu alias
Parameters
• 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:1966
updateRichMenuAliasWithHttpInfo()
updateRichMenuAliasWithHttpInfo(
richMenuAliasId,updateRichMenuAliasRequest):Promise<ApiResponseType<MessageAPIResponseBase>>
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: UpdateRichMenuAliasRequest
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:1986
validateBroadcast()
validateBroadcast(
validateMessageRequest):Promise<MessageAPIResponseBase>
Validate message objects of a broadcast message
Parameters
• validateMessageRequest: ValidateMessageRequest
Returns
Promise<MessageAPIResponseBase>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:2009
validateBroadcastWithHttpInfo()
validateBroadcastWithHttpInfo(
validateMessageRequest):Promise<ApiResponseType<MessageAPIResponseBase>>
Validate message objects of a broadcast message. This method includes HttpInfo object to return additional information.
Parameters
• validateMessageRequest: ValidateMessageRequest
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:2023
validateMulticast()
validateMulticast(
validateMessageRequest):Promise<MessageAPIResponseBase>
Validate message objects of a multicast message
Parameters
• validateMessageRequest: ValidateMessageRequest
Returns
Promise<MessageAPIResponseBase>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:2042
validateMulticastWithHttpInfo()
validateMulticastWithHttpInfo(
validateMessageRequest):Promise<ApiResponseType<MessageAPIResponseBase>>
Validate message objects of a multicast message. This method includes HttpInfo object to return additional information.
Parameters
• validateMessageRequest: ValidateMessageRequest
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:2056
validateNarrowcast()
validateNarrowcast(
validateMessageRequest):Promise<MessageAPIResponseBase>
Validate message objects of a narrowcast message
Parameters
• validateMessageRequest: ValidateMessageRequest
Returns
Promise<MessageAPIResponseBase>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:2075
validateNarrowcastWithHttpInfo()
validateNarrowcastWithHttpInfo(
validateMessageRequest):Promise<ApiResponseType<MessageAPIResponseBase>>
Validate message objects of a narrowcast message. This method includes HttpInfo object to return additional information.
Parameters
• validateMessageRequest: ValidateMessageRequest
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:2089
validatePush()
validatePush(
validateMessageRequest):Promise<MessageAPIResponseBase>
Validate message objects of a push message
Parameters
• validateMessageRequest: ValidateMessageRequest
Returns
Promise<MessageAPIResponseBase>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:2108
validatePushWithHttpInfo()
validatePushWithHttpInfo(
validateMessageRequest):Promise<ApiResponseType<MessageAPIResponseBase>>
Validate message objects of a push message. This method includes HttpInfo object to return additional information.
Parameters
• validateMessageRequest: ValidateMessageRequest
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:2121
validateReply()
validateReply(
validateMessageRequest):Promise<MessageAPIResponseBase>
Validate message objects of a reply message
Parameters
• validateMessageRequest: ValidateMessageRequest
Returns
Promise<MessageAPIResponseBase>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:2140
validateReplyWithHttpInfo()
validateReplyWithHttpInfo(
validateMessageRequest):Promise<ApiResponseType<MessageAPIResponseBase>>
Validate message objects of a reply message. This method includes HttpInfo object to return additional information.
Parameters
• validateMessageRequest: ValidateMessageRequest
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:2153
validateRichMenuBatchRequest()
validateRichMenuBatchRequest(
richMenuBatchRequest):Promise<MessageAPIResponseBase>
Validate a request body of the Replace or unlink the linked rich menus in batches endpoint.
Parameters
• richMenuBatchRequest: RichMenuBatchRequest
Returns
Promise<MessageAPIResponseBase>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:2172
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
• richMenuBatchRequest: RichMenuBatchRequest
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:2187
validateRichMenuObject()
validateRichMenuObject(
richMenuRequest):Promise<MessageAPIResponseBase>
Validate rich menu object
Parameters
• richMenuRequest: RichMenuRequest
Returns
Promise<MessageAPIResponseBase>
See
Defined in
lib/messaging-api/api/messagingApiClient.ts:2206
validateRichMenuObjectWithHttpInfo()
validateRichMenuObjectWithHttpInfo(
richMenuRequest):Promise<ApiResponseType<MessageAPIResponseBase>>
Validate rich menu object. This method includes HttpInfo object to return additional information.
Parameters
• richMenuRequest: RichMenuRequest
Returns
Promise<ApiResponseType<MessageAPIResponseBase>>