Class: MessagingApiClient

broadcastWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:122

Sends a message to multiple users at any time.. This method includes HttpInfo object to return additional information.

Parameters

broadcastRequest

BroadcastRequest

xLineRetryKey?

string

Returns

Promise<ApiResponseType<object>>

See

cancelDefaultRichMenu()

cancelDefaultRichMenu(): Promise<MessageAPIResponseBase>

Defined in: lib/messaging-api/api/messagingApiClient.ts:147

Cancel default rich menu

Returns

Promise<MessageAPIResponseBase>

See

cancelDefaultRichMenuWithHttpInfo()

cancelDefaultRichMenuWithHttpInfo(): Promise<ApiResponseType<MessageAPIResponseBase>>

Defined in: lib/messaging-api/api/messagingApiClient.ts:157

Cancel default rich menu. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

closeCoupon()

closeCoupon(couponId): Promise<MessageAPIResponseBase>

Defined in: lib/messaging-api/api/messagingApiClient.ts:171

Close coupon

Parameters

couponId

string

Returns

Promise<MessageAPIResponseBase>

See

closeCouponWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:184

Close coupon. This method includes HttpInfo object to return additional information.

Parameters

couponId

string

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

createCoupon()

createCoupon(couponCreateRequest?): Promise<CouponCreateResponse>

Defined in: lib/messaging-api/api/messagingApiClient.ts:200

Create a new coupon. Define coupon details such as type, title, and validity period.

Parameters

createCouponWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:213

Create a new coupon. Define coupon details such as type, title, and validity period.. This method includes HttpInfo object to return additional information.

Parameters

couponCreateRequest?

CouponCreateRequest

Returns

Promise<ApiResponseType<CouponCreateResponse>>

See

createRichMenu()

createRichMenu(richMenuRequest): Promise<RichMenuIdResponse>

Defined in: lib/messaging-api/api/messagingApiClient.ts:229

Create rich menu

Parameters

richMenuRequest

Returns

Promise<RichMenuIdResponse>

See

CreateRichMenuAliasRequest

createRichMenuAlias()

createRichMenuAlias(createRichMenuAliasRequest): Promise<MessageAPIResponseBase>

Defined in: lib/messaging-api/api/messagingApiClient.ts:258

Create rich menu alias

Parameters

createRichMenuAliasRequest

Returns

Promise<MessageAPIResponseBase>

See

CreateRichMenuAliasRequest

createRichMenuAliasWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:273

Create rich menu alias. This method includes HttpInfo object to return additional information.

Parameters

createRichMenuAliasRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

createRichMenuWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:242

Create rich menu. This method includes HttpInfo object to return additional information.

Parameters

richMenuRequest

Returns

Promise<ApiResponseType<RichMenuIdResponse>>

See

deleteRichMenu()

deleteRichMenu(richMenuId): Promise<MessageAPIResponseBase>

Defined in: lib/messaging-api/api/messagingApiClient.ts:289

Deletes a rich menu.

Parameters

richMenuId

string

ID of a rich menu

Returns

Promise<MessageAPIResponseBase>

See

deleteRichMenuAlias()

deleteRichMenuAlias(richMenuAliasId): Promise<MessageAPIResponseBase>

Defined in: lib/messaging-api/api/messagingApiClient.ts:321

Delete rich menu alias

Parameters

richMenuAliasId

string

Rich menu alias ID that you want to delete.

Returns

Promise<MessageAPIResponseBase>

See

deleteRichMenuAliasWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:334

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

deleteRichMenuWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:302

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

getAggregationUnitNameList()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:354

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

getAggregationUnitNameListWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:370

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

Returns

Promise<ApiResponseType<GetAggregationUnitNameListResponse>>

See

getAggregationUnitUsage()

getAggregationUnitUsage(): Promise<GetAggregationUnitUsageResponse>

Defined in: lib/messaging-api/api/messagingApiClient.ts:397

Get number of units used this month

Returns

Promise<GetAggregationUnitUsageResponse>

See

getAggregationUnitUsageWithHttpInfo()

getAggregationUnitUsageWithHttpInfo(): Promise<ApiResponseType<GetAggregationUnitUsageResponse>>

Defined in: lib/messaging-api/api/messagingApiClient.ts:407

Get number of units used this month. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<GetAggregationUnitUsageResponse>>

See

getBotInfo()

getBotInfo(): Promise<BotInfoResponse>

Defined in: lib/messaging-api/api/messagingApiClient.ts:420

Get bot info

Returns

Promise<BotInfoResponse>

See

getBotInfoWithHttpInfo()

getBotInfoWithHttpInfo(): Promise<ApiResponseType<BotInfoResponse>>

Defined in: lib/messaging-api/api/messagingApiClient.ts:430

Get bot info. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<BotInfoResponse>>

See

getCouponDetail()

getCouponDetail(couponId): Promise<CouponResponse>

Defined in: lib/messaging-api/api/messagingApiClient.ts:444

Get coupon detail

Parameters

couponId

string

Returns

Promise<CouponResponse>

See

getCouponDetailWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:455

Get coupon detail. This method includes HttpInfo object to return additional information.

Parameters

couponId

string

Returns

Promise<ApiResponseType<CouponResponse>>

See

getDefaultRichMenuId()

getDefaultRichMenuId(): Promise<RichMenuIdResponse>

Defined in: lib/messaging-api/api/messagingApiClient.ts:470

Gets the ID of the default rich menu set with the Messaging API.

Returns

Promise<RichMenuIdResponse>

See

getDefaultRichMenuIdWithHttpInfo()

getDefaultRichMenuIdWithHttpInfo(): Promise<ApiResponseType<RichMenuIdResponse>>

Defined in: lib/messaging-api/api/messagingApiClient.ts:480

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

getFollowers()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:495

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

getFollowersWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:510

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

getGroupMemberCount()

getGroupMemberCount(groupId): Promise<GroupMemberCountResponse>

Defined in: lib/messaging-api/api/messagingApiClient.ts:535

Get number of users in a group chat

Parameters

groupId

string

Group ID

Returns

Promise<GroupMemberCountResponse>

See

getGroupMemberCountWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:548

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

getGroupMemberProfile()

getGroupMemberProfile(groupId, userId): Promise<GroupUserProfileResponse>

Defined in: lib/messaging-api/api/messagingApiClient.ts:568

Get group chat member profile

Parameters

groupId

string

Group ID

userId

string

User ID

Returns

Promise<GroupUserProfileResponse>

See

getGroupMemberProfileWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:583

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

getGroupMembersIds()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:605

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

getGroupMembersIdsWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:620

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

getGroupSummary()

getGroupSummary(groupId): Promise<GroupSummaryResponse>

Defined in: lib/messaging-api/api/messagingApiClient.ts:650

Get group chat summary

Parameters

groupId

string

Group ID

Returns

Promise<GroupSummaryResponse>

See

getGroupSummaryWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:661

Get group chat summary. This method includes HttpInfo object to return additional information.

Parameters

groupId

string

Group ID

Returns

Promise<ApiResponseType<GroupSummaryResponse>>

See

getJoinedMembershipUsers()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:679

Get a list of user IDs who joined the membership.

Parameters

membershipId

number

Membership plan ID.

start?

string

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

limit?

number

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

Returns

Promise<GetJoinedMembershipUsersResponse>

See

getJoinedMembershipUsersWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:702

Get a list of user IDs who joined the membership.. This method includes HttpInfo object to return additional information.

Parameters

membershipId

number

Membership plan ID.

start?

string

limit?

number

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

Returns

Promise<ApiResponseType<GetJoinedMembershipUsersResponse>>

See

getMembershipList()

getMembershipList(): Promise<MembershipListResponse>

Defined in: lib/messaging-api/api/messagingApiClient.ts:733

Get a list of memberships.

Returns

Promise<MembershipListResponse>

See

getMembershipListWithHttpInfo()

getMembershipListWithHttpInfo(): Promise<ApiResponseType<MembershipListResponse>>

Defined in: lib/messaging-api/api/messagingApiClient.ts:743

Get a list of memberships.. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<MembershipListResponse>>

See

getMembershipSubscription()

getMembershipSubscription(userId): Promise<GetMembershipSubscriptionResponse>

Defined in: lib/messaging-api/api/messagingApiClient.ts:757

Get a user's membership subscription.

Parameters

userId

string

User ID

Returns

Promise<GetMembershipSubscriptionResponse>

See

getMembershipSubscriptionWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:770

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

getMessageQuota()

getMessageQuota(): Promise<MessageQuotaResponse>

Defined in: lib/messaging-api/api/messagingApiClient.ts:788

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

getMessageQuotaConsumption()

getMessageQuotaConsumption(): Promise<QuotaConsumptionResponse>

Defined in: lib/messaging-api/api/messagingApiClient.ts:811

Gets the number of messages sent in the current month.

Returns

Promise<QuotaConsumptionResponse>

See

getMessageQuotaConsumptionWithHttpInfo()

getMessageQuotaConsumptionWithHttpInfo(): Promise<ApiResponseType<QuotaConsumptionResponse>>

Defined in: lib/messaging-api/api/messagingApiClient.ts:821

Gets the number of messages sent in the current month.. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<QuotaConsumptionResponse>>

See

getMessageQuotaWithHttpInfo()

getMessageQuotaWithHttpInfo(): Promise<ApiResponseType<MessageQuotaResponse>>

Defined in: lib/messaging-api/api/messagingApiClient.ts:798

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

getNarrowcastProgress()

getNarrowcastProgress(requestId): Promise<NarrowcastProgressResponse>

Defined in: lib/messaging-api/api/messagingApiClient.ts:835

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

getNarrowcastProgressWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:848

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

getNumberOfSentBroadcastMessages()

getNumberOfSentBroadcastMessages(date): Promise<NumberOfMessagesResponse>

Defined in: lib/messaging-api/api/messagingApiClient.ts:874

Get number of sent broadcast messages

Parameters

date

string

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

Returns

See

getNumberOfSentBroadcastMessagesWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:887

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

getNumberOfSentMulticastMessages()

getNumberOfSentMulticastMessages(date): Promise<NumberOfMessagesResponse>

Defined in: lib/messaging-api/api/messagingApiClient.ts:913

Get number of sent multicast messages

Parameters

date

string

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

Returns

See

getNumberOfSentMulticastMessagesWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:926

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

getNumberOfSentPushMessages()

getNumberOfSentPushMessages(date): Promise<NumberOfMessagesResponse>

Defined in: lib/messaging-api/api/messagingApiClient.ts:952

Get number of sent push messages

Parameters

date

string

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

Returns

See

getNumberOfSentPushMessagesWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:965

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

getNumberOfSentReplyMessages()

getNumberOfSentReplyMessages(date): Promise<NumberOfMessagesResponse>

Defined in: lib/messaging-api/api/messagingApiClient.ts:991

Get number of sent reply messages

Parameters

date

string

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

Returns

See

getNumberOfSentReplyMessagesWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:1004

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

getPNPMessageStatistics()

getPNPMessageStatistics(date): Promise<NumberOfMessagesResponse>

Defined in: lib/messaging-api/api/messagingApiClient.ts:1030

Get number of sent LINE notification messages

Parameters

date

string

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

Returns

See

getPNPMessageStatisticsWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:1043

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

getProfile()

getProfile(userId): Promise<UserProfileResponse>

Defined in: lib/messaging-api/api/messagingApiClient.ts:1069

Get profile

Parameters

userId

string

User ID

Returns

Promise<UserProfileResponse>

See

getProfileWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:1080

Get profile. This method includes HttpInfo object to return additional information.

Parameters

userId

string

User ID

Returns

Promise<ApiResponseType<UserProfileResponse>>

See

getRichMenu()

getRichMenu(richMenuId): Promise<RichMenuResponse>

Defined in: lib/messaging-api/api/messagingApiClient.ts:1096

Gets a rich menu via a rich menu ID.

Parameters

richMenuId

string

ID of a rich menu

Returns

Promise<RichMenuResponse>

See

getRichMenuAlias()

getRichMenuAlias(richMenuAliasId): Promise<RichMenuAliasResponse>

Defined in: lib/messaging-api/api/messagingApiClient.ts:1126

Get rich menu alias information

Parameters

richMenuAliasId

string

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

Returns

Promise<RichMenuAliasResponse>

See

getRichMenuAliasList()

getRichMenuAliasList(): Promise<RichMenuAliasListResponse>

Defined in: lib/messaging-api/api/messagingApiClient.ts:1157

Get list of rich menu alias

Returns

Promise<RichMenuAliasListResponse>

See

getRichMenuAliasListWithHttpInfo()

getRichMenuAliasListWithHttpInfo(): Promise<ApiResponseType<RichMenuAliasListResponse>>

Defined in: lib/messaging-api/api/messagingApiClient.ts:1167

Get list of rich menu alias. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<RichMenuAliasListResponse>>

See

getRichMenuAliasWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:1139

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

getRichMenuBatchProgress()

getRichMenuBatchProgress(requestId): Promise<RichMenuBatchProgressResponse>

Defined in: lib/messaging-api/api/messagingApiClient.ts:1181

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

getRichMenuBatchProgressWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:1194

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

getRichMenuIdOfUser()

getRichMenuIdOfUser(userId): Promise<RichMenuIdResponse>

Defined in: lib/messaging-api/api/messagingApiClient.ts:1220

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

getRichMenuIdOfUserWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:1233

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

getRichMenuList()

getRichMenuList(): Promise<RichMenuListResponse>

Defined in: lib/messaging-api/api/messagingApiClient.ts:1248

Get rich menu list

Returns

Promise<RichMenuListResponse>

See

getRichMenuListWithHttpInfo()

getRichMenuListWithHttpInfo(): Promise<ApiResponseType<RichMenuListResponse>>

Defined in: lib/messaging-api/api/messagingApiClient.ts:1258

Get rich menu list. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<RichMenuListResponse>>

See

getRichMenuWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:1107

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

getRoomMemberCount()

getRoomMemberCount(roomId): Promise<RoomMemberCountResponse>

Defined in: lib/messaging-api/api/messagingApiClient.ts:1272

Get number of users in a multi-person chat

Parameters

roomId

string

Room ID

Returns

Promise<RoomMemberCountResponse>

See

getRoomMemberCountWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:1285

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

getRoomMemberProfile()

getRoomMemberProfile(roomId, userId): Promise<RoomUserProfileResponse>

Defined in: lib/messaging-api/api/messagingApiClient.ts:1302

Get multi-person chat member profile

Parameters

roomId

string

Room ID

userId

string

User ID

Returns

Promise<RoomUserProfileResponse>

See

getRoomMemberProfileWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:1317

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

getRoomMembersIds()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:1339

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

getRoomMembersIdsWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:1354

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

getWebhookEndpoint()

getWebhookEndpoint(): Promise<GetWebhookEndpointResponse>

Defined in: lib/messaging-api/api/messagingApiClient.ts:1380

Get webhook endpoint information

Returns

Promise<GetWebhookEndpointResponse>

See

getWebhookEndpointWithHttpInfo()

getWebhookEndpointWithHttpInfo(): Promise<ApiResponseType<GetWebhookEndpointResponse>>

Defined in: lib/messaging-api/api/messagingApiClient.ts:1390

Get webhook endpoint information. This method includes HttpInfo object to return additional information.

Returns

Promise<ApiResponseType<GetWebhookEndpointResponse>>

See

issueLinkToken()

issueLinkToken(userId): Promise<IssueLinkTokenResponse>

Defined in: lib/messaging-api/api/messagingApiClient.ts:1404

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

issueLinkTokenWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:1415

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

leaveGroup()

leaveGroup(groupId): Promise<MessageAPIResponseBase>

Defined in: lib/messaging-api/api/messagingApiClient.ts:1431

Leave group chat

Parameters

groupId

string

Group ID

Returns

Promise<MessageAPIResponseBase>

See

leaveGroupWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:1444

Leave group chat. This method includes HttpInfo object to return additional information.

Parameters

groupId

string

Group ID

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

leaveRoom()

leaveRoom(roomId): Promise<MessageAPIResponseBase>

Defined in: lib/messaging-api/api/messagingApiClient.ts:1460

Leave multi-person chat

Parameters

roomId

string

Room ID

Returns

Promise<MessageAPIResponseBase>

See

leaveRoomWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:1473

Leave multi-person chat. This method includes HttpInfo object to return additional information.

Parameters

roomId

string

Room ID

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

linkRichMenuIdToUser()

linkRichMenuIdToUser(userId, richMenuId): Promise<MessageAPIResponseBase>

Defined in: lib/messaging-api/api/messagingApiClient.ts:1490

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

RichMenuBulkLinkRequest

linkRichMenuIdToUsers()

linkRichMenuIdToUsers(richMenuBulkLinkRequest): Promise<MessageAPIResponseBase>

Defined in: lib/messaging-api/api/messagingApiClient.ts:1527

Link rich menu to multiple users

Parameters

richMenuBulkLinkRequest

Returns

Promise<MessageAPIResponseBase>

See

RichMenuBulkLinkRequest

linkRichMenuIdToUsersWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:1542

Link rich menu to multiple users. This method includes HttpInfo object to return additional information.

Parameters

richMenuBulkLinkRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

linkRichMenuIdToUserWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:1506

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

listCoupon()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:1563

Get a paginated list of coupons.

Parameters

status?

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

Filter coupons by their status.

start?

string

Pagination token to retrieve the next page of results.

limit?

number

Maximum number of coupons to return per request.

Returns

Promise<MessagingApiPagerCouponListResponse>

See

listCouponWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:1580

Get a paginated list of coupons.. This method includes HttpInfo object to return additional information.

Parameters

status?

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

Filter coupons by their status.

start?

string

Pagination token to retrieve the next page of results.

limit?

number

Maximum number of coupons to return per request.

Returns

Promise<ApiResponseType<MessagingApiPagerCouponListResponse>>

See

MarkMessagesAsReadRequest

markMessagesAsRead()

markMessagesAsRead(markMessagesAsReadRequest): Promise<MessageAPIResponseBase>

Defined in: lib/messaging-api/api/messagingApiClient.ts:1607

Mark messages from users as read

Parameters

markMessagesAsReadRequest

Returns

Promise<MessageAPIResponseBase>

See

MarkMessagesAsReadRequest

markMessagesAsReadWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:1622

Mark messages from users as read. This method includes HttpInfo object to return additional information.

Parameters

markMessagesAsReadRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

multicast()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:1642

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

Returns

Promise<object>

See

multicastWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:1658

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

Returns

Promise<ApiResponseType<object>>

See

narrowcast()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:1685

Send narrowcast message

Parameters

narrowcastRequest

NarrowcastRequest

xLineRetryKey?

string

Returns

Promise<object>

See

narrowcastWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:1701

Send narrowcast message. This method includes HttpInfo object to return additional information.

Parameters

narrowcastRequest

NarrowcastRequest

xLineRetryKey?

string

Returns

Promise<ApiResponseType<object>>

See

pushMessage()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:1728

Sends a message to a user, group chat, or multi-person chat at any time.

Parameters

pushMessageRequest

PushMessageRequest

xLineRetryKey?

string

Returns

Promise<PushMessageResponse>

See

pushMessagesByPhone()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:1772

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

pushMessagesByPhoneWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:1792

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

pushMessageWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:1745

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

Returns

Promise<ApiResponseType<PushMessageResponse>>

See

replyMessage()

replyMessage(replyMessageRequest): Promise<ReplyMessageResponse>

Defined in: lib/messaging-api/api/messagingApiClient.ts:1820

Send reply message

Parameters

replyMessageRequest

ReplyMessageRequest

Returns

Promise<ReplyMessageResponse>

See

replyMessageWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:1833

Send reply message. This method includes HttpInfo object to return additional information.

Parameters

replyMessageRequest

ReplyMessageRequest

Returns

Promise<ApiResponseType<ReplyMessageResponse>>

See

richMenuBatch()

richMenuBatch(richMenuBatchRequest): Promise<MessageAPIResponseBase>

Defined in: lib/messaging-api/api/messagingApiClient.ts:1849

You can use this endpoint to batch control the rich menu linked to the users using the endpoint such as Link rich menu to user. The following operations are available: 1. Replace a rich menu with another rich menu for all users linked to a specific rich menu 2. Unlink a rich menu for all users linked to a specific rich menu 3. Unlink a rich menu for all users linked the rich menu

Parameters

richMenuBatchRequest

Returns

Promise<MessageAPIResponseBase>

See

richMenuBatchWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:1862

Parameters

richMenuBatchRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

setDefaultRichMenu()

setDefaultRichMenu(richMenuId): Promise<MessageAPIResponseBase>

Defined in: lib/messaging-api/api/messagingApiClient.ts:1878

Set default rich menu

Parameters

richMenuId

string

ID of a rich menu

Returns

Promise<MessageAPIResponseBase>

See

setDefaultRichMenuWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:1891

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

SetWebhookEndpointRequest

setWebhookEndpoint()

setWebhookEndpoint(setWebhookEndpointRequest): Promise<MessageAPIResponseBase>

Defined in: lib/messaging-api/api/messagingApiClient.ts:1910

Set webhook endpoint URL

Parameters

setWebhookEndpointRequest

Returns

Promise<MessageAPIResponseBase>

See

SetWebhookEndpointRequest

setWebhookEndpointWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:1925

Set webhook endpoint URL. This method includes HttpInfo object to return additional information.

Parameters

setWebhookEndpointRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

ShowLoadingAnimationRequest

showLoadingAnimation()

showLoadingAnimation(showLoadingAnimationRequest): Promise<object>

Defined in: lib/messaging-api/api/messagingApiClient.ts:1944

Display a loading animation in one-on-one chats between users and LINE Official Accounts.

Parameters

showLoadingAnimationRequest

Returns

Promise<object>

See

ShowLoadingAnimationRequest

showLoadingAnimationWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:1959

Display a loading animation in one-on-one chats between users and LINE Official Accounts.. This method includes HttpInfo object to return additional information.

Parameters

showLoadingAnimationRequest

Returns

Promise<ApiResponseType<object>>

See

TestWebhookEndpointRequest

testWebhookEndpoint()

testWebhookEndpoint(testWebhookEndpointRequest?): Promise<TestWebhookEndpointResponse>

Defined in: lib/messaging-api/api/messagingApiClient.ts:1978

Test webhook endpoint

Parameters

testWebhookEndpointRequest?

Returns

Promise<TestWebhookEndpointResponse>

See

TestWebhookEndpointRequest

testWebhookEndpointWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:1993

Test webhook endpoint. This method includes HttpInfo object to return additional information.

Parameters

testWebhookEndpointRequest?

Returns

Promise<ApiResponseType<TestWebhookEndpointResponse>>

See

unlinkRichMenuIdFromUser()

unlinkRichMenuIdFromUser(userId): Promise<MessageAPIResponseBase>

Defined in: lib/messaging-api/api/messagingApiClient.ts:2012

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

RichMenuBulkUnlinkRequest

unlinkRichMenuIdFromUsers()

unlinkRichMenuIdFromUsers(richMenuBulkUnlinkRequest): Promise<MessageAPIResponseBase>

Defined in: lib/messaging-api/api/messagingApiClient.ts:2041

Unlink rich menus from multiple users

Parameters

richMenuBulkUnlinkRequest

Returns

Promise<MessageAPIResponseBase>

See

RichMenuBulkUnlinkRequest

unlinkRichMenuIdFromUsersWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:2058

Unlink rich menus from multiple users. This method includes HttpInfo object to return additional information.

Parameters

richMenuBulkUnlinkRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

unlinkRichMenuIdFromUserWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:2025

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

UpdateRichMenuAliasRequest

updateRichMenuAlias()

updateRichMenuAlias(richMenuAliasId, updateRichMenuAliasRequest): Promise<MessageAPIResponseBase>

Defined in: lib/messaging-api/api/messagingApiClient.ts:2078

Update rich menu alias

Parameters

richMenuAliasId

string

The rich menu alias ID you want to update.

updateRichMenuAliasRequest

Returns

Promise<MessageAPIResponseBase>

See

UpdateRichMenuAliasRequest

updateRichMenuAliasWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:2098

Update rich menu alias. This method includes HttpInfo object to return additional information.

Parameters

richMenuAliasId

string

The rich menu alias ID you want to update.

updateRichMenuAliasRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

validateBroadcast()

validateBroadcast(validateMessageRequest): Promise<MessageAPIResponseBase>

Defined in: lib/messaging-api/api/messagingApiClient.ts:2121

Validate message objects of a broadcast message

Parameters

validateMessageRequest

Returns

Promise<MessageAPIResponseBase>

See

validateBroadcastWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:2135

Validate message objects of a broadcast message. This method includes HttpInfo object to return additional information.

Parameters

validateMessageRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

validateMulticast()

validateMulticast(validateMessageRequest): Promise<MessageAPIResponseBase>

Defined in: lib/messaging-api/api/messagingApiClient.ts:2154

Validate message objects of a multicast message

Parameters

validateMessageRequest

Returns

Promise<MessageAPIResponseBase>

See

validateMulticastWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:2168

Validate message objects of a multicast message. This method includes HttpInfo object to return additional information.

Parameters

validateMessageRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

validateNarrowcast()

validateNarrowcast(validateMessageRequest): Promise<MessageAPIResponseBase>

Defined in: lib/messaging-api/api/messagingApiClient.ts:2187

Validate message objects of a narrowcast message

Parameters

validateMessageRequest

Returns

Promise<MessageAPIResponseBase>

See

validateNarrowcastWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:2201

Validate message objects of a narrowcast message. This method includes HttpInfo object to return additional information.

Parameters

validateMessageRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

validatePush()

validatePush(validateMessageRequest): Promise<MessageAPIResponseBase>

Defined in: lib/messaging-api/api/messagingApiClient.ts:2220

Validate message objects of a push message

Parameters

validateMessageRequest

Returns

Promise<MessageAPIResponseBase>

See

validatePushWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:2233

Validate message objects of a push message. This method includes HttpInfo object to return additional information.

Parameters

validateMessageRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

validateReply()

validateReply(validateMessageRequest): Promise<MessageAPIResponseBase>

Defined in: lib/messaging-api/api/messagingApiClient.ts:2252

Validate message objects of a reply message

Parameters

validateMessageRequest

Returns

Promise<MessageAPIResponseBase>

See

validateReplyWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:2265

Validate message objects of a reply message. This method includes HttpInfo object to return additional information.

Parameters

validateMessageRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

validateRichMenuBatchRequest()

validateRichMenuBatchRequest(richMenuBatchRequest): Promise<MessageAPIResponseBase>

Defined in: lib/messaging-api/api/messagingApiClient.ts:2284

Validate a request body of the Replace or unlink the linked rich menus in batches endpoint.

Parameters

richMenuBatchRequest

Returns

Promise<MessageAPIResponseBase>

See

validateRichMenuBatchRequestWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:2299

Validate a request body of the Replace or unlink the linked rich menus in batches endpoint.. This method includes HttpInfo object to return additional information.

Parameters

richMenuBatchRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See

validateRichMenuObject()

validateRichMenuObject(richMenuRequest): Promise<MessageAPIResponseBase>

Defined in: lib/messaging-api/api/messagingApiClient.ts:2318

Validate rich menu object

Parameters

richMenuRequest

Returns

Promise<MessageAPIResponseBase>

See

validateRichMenuObjectWithHttpInfo()

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

Defined in: lib/messaging-api/api/messagingApiClient.ts:2332

Validate rich menu object. This method includes HttpInfo object to return additional information.

Parameters

richMenuRequest

Returns

Promise<ApiResponseType<MessageAPIResponseBase>>

See