LINE. Bot. MessagingApi
(line_bot_sdk v0.1.0)
Copy Markdown
API calls for all endpoints tagged MessagingApi.
Summary
Functions
Sends a message to multiple users at any time.
Cancel default rich menu
Close coupon
Create a new coupon. Define coupon details such as type, title, and validity period.
Create rich menu
Create rich menu alias
Deletes a rich menu.
Delete rich menu alias
Get name list of units used this month
Get number of units used this month
Get bot info
Get coupon detail
Gets the ID of the default rich menu set with the Messaging API.
Get a list of users who added your LINE Official Account as a friend
Get number of users in a group chat
Get group chat member profile
Get group chat member user IDs
Get group chat summary
Get a list of user IDs who joined the membership.
Get a list of memberships.
Get a user's membership subscription.
Gets the target limit for sending messages in the current month. The total number of the free messages and the additional messages is returned.
Gets the number of messages sent in the current month.
Gets the status of a narrowcast message.
Get number of sent broadcast messages
Get number of sent multicast messages
Get number of sent push messages
Get number of sent reply messages
Get number of sent LINE notification messages
Get profile
Gets a rich menu via a rich menu ID.
Get rich menu alias information
Get list of rich menu alias
Get the status of Replace or unlink a linked rich menus in batches.
Get rich menu ID of user
Get rich menu list
Get number of users in a multi-person chat
Get multi-person chat member profile
Get multi-person chat member user IDs
Get webhook endpoint information
Issue link token
Leave group chat
Leave multi-person chat
Link rich menu to user.
Link rich menu to multiple users
Get a paginated list of coupons.
Mark messages from users as read
Mark messages from users as read by token
An API that efficiently sends the same message to multiple user IDs. You can't send messages to group chats or multi-person chats.
Send narrowcast message
Create a new MessagingApi client.
Sends a message to a user, group chat, or multi-person chat at any time.
Send LINE notification message
Send reply message
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
Set default rich menu
Set webhook endpoint URL
Display a loading animation in one-on-one chats between users and LINE Official Accounts.
Test webhook endpoint
Unlink rich menu from user
Unlink rich menus from multiple users
Update rich menu alias
Validate message objects of a broadcast message
Validate message objects of a multicast message
Validate message objects of a narrowcast message
Validate message objects of a push message
Validate message objects of a reply message
Validate a request body of the Replace or unlink the linked rich menus in batches endpoint.
Validate rich menu object
Functions
Sends a message to multiple users at any time.
Parameters
client(Req.Request.t/0): Client to make request withbroadcast_request(t:BroadcastRequest/0):optional_args(keyword): Optional parameters:x_line_retry_key(String.t/0): 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.
client_opts(keyword/0): Options to pass toReq.request
Returns
{:ok, map()}on success{:error, Req.Response.t}on failure
Close coupon
Parameters
client(Req.Request.t/0): Client to make request withcoupon_id(String.t/0):client_opts(keyword/0): Options to pass toReq.request
Returns
{:ok, nil}on success{:error, Req.Response.t}on failure
Create a new coupon. Define coupon details such as type, title, and validity period.
Parameters
client(Req.Request.t/0): Client to make request withoptional_args(keyword): Optional parameters:body(t:CouponCreateRequest/0):
client_opts(keyword/0): Options to pass toReq.request
Returns
{:ok, LINE.Bot.Model.CouponCreateResponse.t}on success{:error, Req.Response.t}on failure
Get name list of units used this month
Parameters
client(Req.Request.t/0): Client to make request withoptional_args(keyword): Optional parameters:limit(String.t/0): The maximum number of aggregation units you can get per request.:start(String.t/0): 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.
client_opts(keyword/0): Options to pass toReq.request
Returns
{:ok, LINE.Bot.Model.GetAggregationUnitNameListResponse.t}on success{:error, Req.Response.t}on failure
Get number of units used this month
Parameters
client(Req.Request.t/0): Client to make request withclient_opts(keyword/0): Options to pass toReq.request
Returns
{:ok, LINE.Bot.Model.GetAggregationUnitUsageResponse.t}on success{:error, Req.Response.t}on failure
Get bot info
Parameters
client(Req.Request.t/0): Client to make request withclient_opts(keyword/0): Options to pass toReq.request
Returns
{:ok, LINE.Bot.Model.BotInfoResponse.t}on success{:error, Req.Response.t}on failure
Get coupon detail
Parameters
client(Req.Request.t/0): Client to make request withcoupon_id(String.t/0):client_opts(keyword/0): Options to pass toReq.request
Returns
{:ok, LINE.Bot.Model.CouponResponse.t}on success{:error, Req.Response.t}on failure
Get a list of users who added your LINE Official Account as a friend
Parameters
client(Req.Request.t/0): Client to make request withoptional_args(keyword): Optional parameters:start(String.t/0): 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(integer()/0): The maximum number of user IDs to retrieve in a single request.
client_opts(keyword/0): Options to pass toReq.request
Returns
{:ok, LINE.Bot.Model.GetFollowersResponse.t}on success{:error, Req.Response.t}on failure
Get number of users in a group chat
Parameters
client(Req.Request.t/0): Client to make request withgroup_id(String.t/0): Group IDclient_opts(keyword/0): Options to pass toReq.request
Returns
{:ok, LINE.Bot.Model.GroupMemberCountResponse.t}on success{:error, Req.Response.t}on failure
Get group chat member profile
Parameters
client(Req.Request.t/0): Client to make request withgroup_id(String.t/0): Group IDuser_id(String.t/0): User IDclient_opts(keyword/0): Options to pass toReq.request
Returns
{:ok, LINE.Bot.Model.GroupUserProfileResponse.t}on success{:error, Req.Response.t}on failure
Get group chat member user IDs
Parameters
client(Req.Request.t/0): Client to make request withgroup_id(String.t/0): Group IDoptional_args(keyword): Optional parameters:start(String.t/0): Value of the continuation token found in thenextproperty 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.
client_opts(keyword/0): Options to pass toReq.request
Returns
{:ok, LINE.Bot.Model.MembersIdsResponse.t}on success{:error, Req.Response.t}on failure
Get group chat summary
Parameters
client(Req.Request.t/0): Client to make request withgroup_id(String.t/0): Group IDclient_opts(keyword/0): Options to pass toReq.request
Returns
{:ok, LINE.Bot.Model.GroupSummaryResponse.t}on success{:error, Req.Response.t}on failure
Get a list of user IDs who joined the membership.
Parameters
client(Req.Request.t/0): Client to make request withmembership_id(integer()/0): Membership plan ID.optional_args(keyword): Optional parameters:start(String.t/0): 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(integer()/0): 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.
client_opts(keyword/0): Options to pass toReq.request
Returns
{:ok, LINE.Bot.Model.GetJoinedMembershipUsersResponse.t}on success{:error, Req.Response.t}on failure
Get a list of memberships.
Parameters
client(Req.Request.t/0): Client to make request withclient_opts(keyword/0): Options to pass toReq.request
Returns
{:ok, LINE.Bot.Model.MembershipListResponse.t}on success{:error, Req.Response.t}on failure
Get a user's membership subscription.
Parameters
client(Req.Request.t/0): Client to make request withuser_id(String.t/0): User IDclient_opts(keyword/0): Options to pass toReq.request
Returns
{:ok, LINE.Bot.Model.GetMembershipSubscriptionResponse.t}on success{:error, Req.Response.t}on failure
Gets the target limit for sending messages in the current month. The total number of the free messages and the additional messages is returned.
Parameters
client(Req.Request.t/0): Client to make request withclient_opts(keyword/0): Options to pass toReq.request
Returns
{:ok, LINE.Bot.Model.MessageQuotaResponse.t}on success{:error, Req.Response.t}on failure
Gets the number of messages sent in the current month.
Parameters
client(Req.Request.t/0): Client to make request withclient_opts(keyword/0): Options to pass toReq.request
Returns
{:ok, LINE.Bot.Model.QuotaConsumptionResponse.t}on success{:error, Req.Response.t}on failure
Gets the status of a narrowcast message.
Parameters
client(Req.Request.t/0): Client to make request withrequest_id(String.t/0): The narrowcast message's request ID. Each Messaging API request has a request ID.client_opts(keyword/0): Options to pass toReq.request
Returns
{:ok, LINE.Bot.Model.NarrowcastProgressResponse.t}on success{:error, Req.Response.t}on failure
Get number of sent broadcast messages
Parameters
client(Req.Request.t/0): Client to make request withdate(String.t/0): Date the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9client_opts(keyword/0): Options to pass toReq.request
Returns
{:ok, LINE.Bot.Model.NumberOfMessagesResponse.t}on success{:error, Req.Response.t}on failure
Get number of sent multicast messages
Parameters
client(Req.Request.t/0): Client to make request withdate(String.t/0): Date the messages were sent Format:yyyyMMdd(e.g.20191231) Timezone: UTC+9client_opts(keyword/0): Options to pass toReq.request
Returns
{:ok, LINE.Bot.Model.NumberOfMessagesResponse.t}on success{:error, Req.Response.t}on failure
Get number of sent push messages
Parameters
client(Req.Request.t/0): Client to make request withdate(String.t/0): Date the messages were sent Format:yyyyMMdd(e.g.20191231) Timezone: UTC+9client_opts(keyword/0): Options to pass toReq.request
Returns
{:ok, LINE.Bot.Model.NumberOfMessagesResponse.t}on success{:error, Req.Response.t}on failure
Get number of sent reply messages
Parameters
client(Req.Request.t/0): Client to make request withdate(String.t/0): Date the messages were sent Format:yyyyMMdd(e.g.20191231) Timezone: UTC+9client_opts(keyword/0): Options to pass toReq.request
Returns
{:ok, LINE.Bot.Model.NumberOfMessagesResponse.t}on success{:error, Req.Response.t}on failure
Get number of sent LINE notification messages
Parameters
client(Req.Request.t/0): Client to make request withdate(String.t/0): Date the message was sent Format:yyyyMMdd(Example:20211231) Time zone: UTC+9client_opts(keyword/0): Options to pass toReq.request
Returns
{:ok, LINE.Bot.Model.NumberOfMessagesResponse.t}on success{:error, Req.Response.t}on failure
Get profile
Parameters
client(Req.Request.t/0): Client to make request withuser_id(String.t/0): User IDclient_opts(keyword/0): Options to pass toReq.request
Returns
{:ok, LINE.Bot.Model.UserProfileResponse.t}on success{:error, Req.Response.t}on failure
Get number of users in a multi-person chat
Parameters
client(Req.Request.t/0): Client to make request withroom_id(String.t/0): Room IDclient_opts(keyword/0): Options to pass toReq.request
Returns
{:ok, LINE.Bot.Model.RoomMemberCountResponse.t}on success{:error, Req.Response.t}on failure
Get multi-person chat member profile
Parameters
client(Req.Request.t/0): Client to make request withroom_id(String.t/0): Room IDuser_id(String.t/0): User IDclient_opts(keyword/0): Options to pass toReq.request
Returns
{:ok, LINE.Bot.Model.RoomUserProfileResponse.t}on success{:error, Req.Response.t}on failure
Get multi-person chat member user IDs
Parameters
client(Req.Request.t/0): Client to make request withroom_id(String.t/0): Room IDoptional_args(keyword): Optional parameters:start(String.t/0): Value of the continuation token found in thenextproperty 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.
client_opts(keyword/0): Options to pass toReq.request
Returns
{:ok, LINE.Bot.Model.MembersIdsResponse.t}on success{:error, Req.Response.t}on failure
Get webhook endpoint information
Parameters
client(Req.Request.t/0): Client to make request withclient_opts(keyword/0): Options to pass toReq.request
Returns
{:ok, LINE.Bot.Model.GetWebhookEndpointResponse.t}on success{:error, Req.Response.t}on failure
Issue link token
Parameters
client(Req.Request.t/0): Client to make request withuser_id(String.t/0): User ID for the LINE account to be linked. Found in thesourceobject of account link event objects. Do not use the LINE ID used in LINE.client_opts(keyword/0): Options to pass toReq.request
Returns
{:ok, LINE.Bot.Model.IssueLinkTokenResponse.t}on success{:error, Req.Response.t}on failure
Leave group chat
Parameters
client(Req.Request.t/0): Client to make request withgroup_id(String.t/0): Group IDclient_opts(keyword/0): Options to pass toReq.request
Returns
{:ok, nil}on success{:error, Req.Response.t}on failure
Leave multi-person chat
Parameters
client(Req.Request.t/0): Client to make request withroom_id(String.t/0): Room IDclient_opts(keyword/0): Options to pass toReq.request
Returns
{:ok, nil}on success{:error, Req.Response.t}on failure
Get a paginated list of coupons.
Parameters
client(Req.Request.t/0): Client to make request withoptional_args(keyword): Optional parameters:status(t:[String.t]/0): Filter coupons by their status.:start(String.t/0): Pagination token to retrieve the next page of results.:limit(integer()/0): Maximum number of coupons to return per request.
client_opts(keyword/0): Options to pass toReq.request
Returns
{:ok, LINE.Bot.Model.MessagingApiPagerCouponListResponse.t}on success{:error, Req.Response.t}on failure
Mark messages from users as read
Parameters
client(Req.Request.t/0): Client to make request withmark_messages_as_read_request(t:MarkMessagesAsReadRequest/0):client_opts(keyword/0): Options to pass toReq.request
Returns
{:ok, nil}on success{:error, Req.Response.t}on failure
Mark messages from users as read by token
Parameters
client(Req.Request.t/0): Client to make request withmark_messages_as_read_by_token_request(t:MarkMessagesAsReadByTokenRequest/0):client_opts(keyword/0): Options to pass toReq.request
Returns
{:ok, nil}on success{:error, Req.Response.t}on failure
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
client(Req.Request.t/0): Client to make request withmulticast_request(t:MulticastRequest/0):optional_args(keyword): Optional parameters:x_line_retry_key(String.t/0): 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.
client_opts(keyword/0): Options to pass toReq.request
Returns
{:ok, map()}on success{:error, Req.Response.t}on failure
Send narrowcast message
Parameters
client(Req.Request.t/0): Client to make request withnarrowcast_request(t:NarrowcastRequest/0):optional_args(keyword): Optional parameters:x_line_retry_key(String.t/0): 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.
client_opts(keyword/0): Options to pass toReq.request
Returns
{:ok, map()}on success{:error, Req.Response.t}on failure
Create a new MessagingApi client.
Options
:base_url- base URL for requests (default:"https://api.line.me"):channel_token(required) - channel access token for Bearer authorization:plug- plug to use for testing (seeReq.new/1)
Sends a message to a user, group chat, or multi-person chat at any time.
Parameters
client(Req.Request.t/0): Client to make request withpush_message_request(t:PushMessageRequest/0):optional_args(keyword): Optional parameters:x_line_retry_key(String.t/0): 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.
client_opts(keyword/0): Options to pass toReq.request
Returns
{:ok, LINE.Bot.Model.PushMessageResponse.t}on success{:error, Req.Response.t}on failure
Send LINE notification message
Parameters
client(Req.Request.t/0): Client to make request withpnp_messages_request(t:PnpMessagesRequest/0):optional_args(keyword): Optional parameters:x_line_delivery_tag(String.t/0): String returned in the delivery.data property of the delivery completion event via Webhook.
client_opts(keyword/0): Options to pass toReq.request
Returns
{:ok, nil}on success{:error, Req.Response.t}on failure
Send reply message
Parameters
client(Req.Request.t/0): Client to make request withreply_message_request(t:ReplyMessageRequest/0):client_opts(keyword/0): Options to pass toReq.request
Returns
{:ok, LINE.Bot.Model.ReplyMessageResponse.t}on success{:error, Req.Response.t}on failure
Set webhook endpoint URL
Parameters
client(Req.Request.t/0): Client to make request withset_webhook_endpoint_request(t:SetWebhookEndpointRequest/0):client_opts(keyword/0): Options to pass toReq.request
Returns
{:ok, nil}on success{:error, Req.Response.t}on failure
Display a loading animation in one-on-one chats between users and LINE Official Accounts.
Parameters
client(Req.Request.t/0): Client to make request withshow_loading_animation_request(t:ShowLoadingAnimationRequest/0):client_opts(keyword/0): Options to pass toReq.request
Returns
{:ok, map()}on success{:error, Req.Response.t}on failure
Test webhook endpoint
Parameters
client(Req.Request.t/0): Client to make request withoptional_args(keyword): Optional parameters:body(t:TestWebhookEndpointRequest/0):
client_opts(keyword/0): Options to pass toReq.request
Returns
{:ok, LINE.Bot.Model.TestWebhookEndpointResponse.t}on success{:error, Req.Response.t}on failure
Validate message objects of a broadcast message
Parameters
client(Req.Request.t/0): Client to make request withvalidate_message_request(t:ValidateMessageRequest/0):client_opts(keyword/0): Options to pass toReq.request
Returns
{:ok, nil}on success{:error, Req.Response.t}on failure
Validate message objects of a multicast message
Parameters
client(Req.Request.t/0): Client to make request withvalidate_message_request(t:ValidateMessageRequest/0):client_opts(keyword/0): Options to pass toReq.request
Returns
{:ok, nil}on success{:error, Req.Response.t}on failure
Validate message objects of a narrowcast message
Parameters
client(Req.Request.t/0): Client to make request withvalidate_message_request(t:ValidateMessageRequest/0):client_opts(keyword/0): Options to pass toReq.request
Returns
{:ok, nil}on success{:error, Req.Response.t}on failure
Validate message objects of a push message
Parameters
client(Req.Request.t/0): Client to make request withvalidate_message_request(t:ValidateMessageRequest/0):client_opts(keyword/0): Options to pass toReq.request
Returns
{:ok, nil}on success{:error, Req.Response.t}on failure
Validate message objects of a reply message
Parameters
client(Req.Request.t/0): Client to make request withvalidate_message_request(t:ValidateMessageRequest/0):client_opts(keyword/0): Options to pass toReq.request
Returns
{:ok, nil}on success{:error, Req.Response.t}on failure