LINE.Bot.MessagingApi (line_bot_sdk v0.1.0)

Copy Markdown

API calls for all endpoints tagged MessagingApi.

Summary

Functions

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

Get number of units used this month

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

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 LINE notification messages

Gets a rich menu via a rich menu ID.

Get the status of Replace or unlink a linked rich menus in batches.

Get number of users in a multi-person chat

Get webhook endpoint information

An API that efficiently sends the same message to multiple user IDs. You can't send messages to group chats or multi-person chats.

Create a new MessagingApi client.

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

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

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

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.

Functions

broadcast(client, broadcast_request, optional_args \\ [], client_opts \\ [])

Sends a message to multiple users at any time.

Parameters

  • client (Req.Request.t/0): Client to make request with
  • broadcast_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 to Req.request

Returns

  • {:ok, map()} on success
  • {:error, Req.Response.t} on failure

cancel_default_rich_menu(client, client_opts \\ [])

Cancel default rich menu

Parameters

Returns

  • {:ok, nil} on success
  • {:error, Req.Response.t} on failure

close_coupon(client, coupon_id, client_opts \\ [])

Close coupon

Parameters

Returns

  • {:ok, nil} on success
  • {:error, Req.Response.t} on failure

create_coupon(client, optional_args \\ [], client_opts \\ [])

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

Parameters

  • client (Req.Request.t/0): Client to make request with
  • optional_args (keyword): Optional parameters
    • :body (t:CouponCreateRequest/0):
  • client_opts (keyword/0): Options to pass to Req.request

Returns

  • {:ok, LINE.Bot.Model.CouponCreateResponse.t} on success
  • {:error, Req.Response.t} on failure

create_rich_menu(client, rich_menu_request, client_opts \\ [])

Create rich menu

Parameters

  • client (Req.Request.t/0): Client to make request with
  • rich_menu_request (t:RichMenuRequest/0):
  • client_opts (keyword/0): Options to pass to Req.request

Returns

  • {:ok, LINE.Bot.Model.RichMenuIdResponse.t} on success
  • {:error, Req.Response.t} on failure

create_rich_menu_alias(client, create_rich_menu_alias_request, client_opts \\ [])

Create rich menu alias

Parameters

  • client (Req.Request.t/0): Client to make request with
  • create_rich_menu_alias_request (t:CreateRichMenuAliasRequest/0):
  • client_opts (keyword/0): Options to pass to Req.request

Returns

  • {:ok, nil} on success
  • {:error, Req.Response.t} on failure

delete_rich_menu(client, rich_menu_id, client_opts \\ [])

Deletes a rich menu.

Parameters

Returns

  • {:ok, nil} on success
  • {:error, Req.Response.t} on failure

delete_rich_menu_alias(client, rich_menu_alias_id, client_opts \\ [])

Delete rich menu alias

Parameters

  • client (Req.Request.t/0): Client to make request with
  • rich_menu_alias_id (String.t/0): Rich menu alias ID that you want to delete.
  • client_opts (keyword/0): Options to pass to Req.request

Returns

  • {:ok, nil} on success
  • {:error, Req.Response.t} on failure

get_aggregation_unit_name_list(client, optional_args \\ [], client_opts \\ [])

Get name list of units used this month

Parameters

  • client (Req.Request.t/0): Client to make request with
  • optional_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 to Req.request

Returns

  • {:ok, LINE.Bot.Model.GetAggregationUnitNameListResponse.t} on success
  • {:error, Req.Response.t} on failure

get_aggregation_unit_usage(client, client_opts \\ [])

Get number of units used this month

Parameters

Returns

  • {:ok, LINE.Bot.Model.GetAggregationUnitUsageResponse.t} on success
  • {:error, Req.Response.t} on failure

get_bot_info(client, client_opts \\ [])

Get bot info

Parameters

Returns

  • {:ok, LINE.Bot.Model.BotInfoResponse.t} on success
  • {:error, Req.Response.t} on failure

get_coupon_detail(client, coupon_id, client_opts \\ [])

Get coupon detail

Parameters

Returns

  • {:ok, LINE.Bot.Model.CouponResponse.t} on success
  • {:error, Req.Response.t} on failure

get_default_rich_menu_id(client, client_opts \\ [])

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

Parameters

Returns

  • {:ok, LINE.Bot.Model.RichMenuIdResponse.t} on success
  • {:error, Req.Response.t} on failure

get_followers(client, optional_args \\ [], client_opts \\ [])

Get a list of users who added your LINE Official Account as a friend

Parameters

  • client (Req.Request.t/0): Client to make request with
  • optional_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 to Req.request

Returns

  • {:ok, LINE.Bot.Model.GetFollowersResponse.t} on success
  • {:error, Req.Response.t} on failure

get_group_member_count(client, group_id, client_opts \\ [])

Get number of users in a group chat

Parameters

Returns

  • {:ok, LINE.Bot.Model.GroupMemberCountResponse.t} on success
  • {:error, Req.Response.t} on failure

get_group_member_profile(client, group_id, user_id, client_opts \\ [])

Get group chat member profile

Parameters

Returns

  • {:ok, LINE.Bot.Model.GroupUserProfileResponse.t} on success
  • {:error, Req.Response.t} on failure

get_group_members_ids(client, group_id, optional_args \\ [], client_opts \\ [])

Get group chat member user IDs

Parameters

  • client (Req.Request.t/0): Client to make request with
  • group_id (String.t/0): Group ID
  • optional_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 for the members of the group.
  • client_opts (keyword/0): Options to pass to Req.request

Returns

  • {:ok, LINE.Bot.Model.MembersIdsResponse.t} on success
  • {:error, Req.Response.t} on failure

get_group_summary(client, group_id, client_opts \\ [])

Get group chat summary

Parameters

Returns

  • {:ok, LINE.Bot.Model.GroupSummaryResponse.t} on success
  • {:error, Req.Response.t} on failure

get_joined_membership_users(client, membership_id, optional_args \\ [], client_opts \\ [])

Get a list of user IDs who joined the membership.

Parameters

  • client (Req.Request.t/0): Client to make request with
  • membership_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 to Req.request

Returns

  • {:ok, LINE.Bot.Model.GetJoinedMembershipUsersResponse.t} on success
  • {:error, Req.Response.t} on failure

get_membership_list(client, client_opts \\ [])

Get a list of memberships.

Parameters

Returns

  • {:ok, LINE.Bot.Model.MembershipListResponse.t} on success
  • {:error, Req.Response.t} on failure

get_membership_subscription(client, user_id, client_opts \\ [])

Get a user's membership subscription.

Parameters

Returns

  • {:ok, LINE.Bot.Model.GetMembershipSubscriptionResponse.t} on success
  • {:error, Req.Response.t} on failure

get_message_quota(client, client_opts \\ [])

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

Returns

  • {:ok, LINE.Bot.Model.MessageQuotaResponse.t} on success
  • {:error, Req.Response.t} on failure

get_message_quota_consumption(client, client_opts \\ [])

Gets the number of messages sent in the current month.

Parameters

Returns

  • {:ok, LINE.Bot.Model.QuotaConsumptionResponse.t} on success
  • {:error, Req.Response.t} on failure

get_narrowcast_progress(client, request_id, client_opts \\ [])

Gets the status of a narrowcast message.

Parameters

  • client (Req.Request.t/0): Client to make request with
  • request_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 to Req.request

Returns

  • {:ok, LINE.Bot.Model.NarrowcastProgressResponse.t} on success
  • {:error, Req.Response.t} on failure

get_number_of_sent_broadcast_messages(client, date, client_opts \\ [])

Get number of sent broadcast messages

Parameters

  • client (Req.Request.t/0): Client to make request with
  • date (String.t/0): Date the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9
  • client_opts (keyword/0): Options to pass to Req.request

Returns

  • {:ok, LINE.Bot.Model.NumberOfMessagesResponse.t} on success
  • {:error, Req.Response.t} on failure

get_number_of_sent_multicast_messages(client, date, client_opts \\ [])

Get number of sent multicast messages

Parameters

  • client (Req.Request.t/0): Client to make request with
  • date (String.t/0): Date the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9
  • client_opts (keyword/0): Options to pass to Req.request

Returns

  • {:ok, LINE.Bot.Model.NumberOfMessagesResponse.t} on success
  • {:error, Req.Response.t} on failure

get_number_of_sent_push_messages(client, date, client_opts \\ [])

Get number of sent push messages

Parameters

  • client (Req.Request.t/0): Client to make request with
  • date (String.t/0): Date the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9
  • client_opts (keyword/0): Options to pass to Req.request

Returns

  • {:ok, LINE.Bot.Model.NumberOfMessagesResponse.t} on success
  • {:error, Req.Response.t} on failure

get_number_of_sent_reply_messages(client, date, client_opts \\ [])

Get number of sent reply messages

Parameters

  • client (Req.Request.t/0): Client to make request with
  • date (String.t/0): Date the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9
  • client_opts (keyword/0): Options to pass to Req.request

Returns

  • {:ok, LINE.Bot.Model.NumberOfMessagesResponse.t} on success
  • {:error, Req.Response.t} on failure

get_pnp_message_statistics(client, date, client_opts \\ [])

Get number of sent LINE notification messages

Parameters

  • client (Req.Request.t/0): Client to make request with
  • date (String.t/0): Date the message was sent Format: yyyyMMdd (Example:20211231) Time zone: UTC+9
  • client_opts (keyword/0): Options to pass to Req.request

Returns

  • {:ok, LINE.Bot.Model.NumberOfMessagesResponse.t} on success
  • {:error, Req.Response.t} on failure

get_profile(client, user_id, client_opts \\ [])

Get profile

Parameters

Returns

  • {:ok, LINE.Bot.Model.UserProfileResponse.t} on success
  • {:error, Req.Response.t} on failure

get_rich_menu(client, rich_menu_id, client_opts \\ [])

Gets a rich menu via a rich menu ID.

Parameters

Returns

  • {:ok, LINE.Bot.Model.RichMenuResponse.t} on success
  • {:error, Req.Response.t} on failure

get_rich_menu_alias(client, rich_menu_alias_id, client_opts \\ [])

Get rich menu alias information

Parameters

  • client (Req.Request.t/0): Client to make request with
  • rich_menu_alias_id (String.t/0): The rich menu alias ID whose information you want to obtain.
  • client_opts (keyword/0): Options to pass to Req.request

Returns

  • {:ok, LINE.Bot.Model.RichMenuAliasResponse.t} on success
  • {:error, Req.Response.t} on failure

get_rich_menu_alias_list(client, client_opts \\ [])

Get list of rich menu alias

Parameters

Returns

  • {:ok, LINE.Bot.Model.RichMenuAliasListResponse.t} on success
  • {:error, Req.Response.t} on failure

get_rich_menu_batch_progress(client, request_id, client_opts \\ [])

Get the status of Replace or unlink a linked rich menus in batches.

Parameters

  • client (Req.Request.t/0): Client to make request with
  • request_id (String.t/0): A request ID used to batch control the rich menu linked to the user. Each Messaging API request has a request ID.
  • client_opts (keyword/0): Options to pass to Req.request

Returns

  • {:ok, LINE.Bot.Model.RichMenuBatchProgressResponse.t} on success
  • {:error, Req.Response.t} on failure

get_rich_menu_id_of_user(client, user_id, client_opts \\ [])

Get rich menu ID of user

Parameters

  • client (Req.Request.t/0): Client to make request with
  • user_id (String.t/0): User ID. Found in the source object of webhook event objects. Do not use the LINE ID used in LINE.
  • client_opts (keyword/0): Options to pass to Req.request

Returns

  • {:ok, LINE.Bot.Model.RichMenuIdResponse.t} on success
  • {:error, Req.Response.t} on failure

get_rich_menu_list(client, client_opts \\ [])

Get rich menu list

Parameters

Returns

  • {:ok, LINE.Bot.Model.RichMenuListResponse.t} on success
  • {:error, Req.Response.t} on failure

get_room_member_count(client, room_id, client_opts \\ [])

Get number of users in a multi-person chat

Parameters

Returns

  • {:ok, LINE.Bot.Model.RoomMemberCountResponse.t} on success
  • {:error, Req.Response.t} on failure

get_room_member_profile(client, room_id, user_id, client_opts \\ [])

Get multi-person chat member profile

Parameters

Returns

  • {:ok, LINE.Bot.Model.RoomUserProfileResponse.t} on success
  • {:error, Req.Response.t} on failure

get_room_members_ids(client, room_id, optional_args \\ [], client_opts \\ [])

Get multi-person chat member user IDs

Parameters

  • client (Req.Request.t/0): Client to make request with
  • room_id (String.t/0): Room ID
  • optional_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 for the members of the group.
  • client_opts (keyword/0): Options to pass to Req.request

Returns

  • {:ok, LINE.Bot.Model.MembersIdsResponse.t} on success
  • {:error, Req.Response.t} on failure

get_webhook_endpoint(client, client_opts \\ [])

Get webhook endpoint information

Parameters

Returns

  • {:ok, LINE.Bot.Model.GetWebhookEndpointResponse.t} on success
  • {:error, Req.Response.t} on failure

leave_group(client, group_id, client_opts \\ [])

Leave group chat

Parameters

Returns

  • {:ok, nil} on success
  • {:error, Req.Response.t} on failure

leave_room(client, room_id, client_opts \\ [])

Leave multi-person chat

Parameters

Returns

  • {:ok, nil} on success
  • {:error, Req.Response.t} on failure

list_coupon(client, optional_args \\ [], client_opts \\ [])

Get a paginated list of coupons.

Parameters

  • client (Req.Request.t/0): Client to make request with
  • optional_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 to Req.request

Returns

  • {:ok, LINE.Bot.Model.MessagingApiPagerCouponListResponse.t} on success
  • {:error, Req.Response.t} on failure

mark_messages_as_read(client, mark_messages_as_read_request, client_opts \\ [])

Mark messages from users as read

Parameters

  • client (Req.Request.t/0): Client to make request with
  • mark_messages_as_read_request (t:MarkMessagesAsReadRequest/0):
  • client_opts (keyword/0): Options to pass to Req.request

Returns

  • {:ok, nil} on success
  • {:error, Req.Response.t} on failure

mark_messages_as_read_by_token(client, mark_messages_as_read_by_token_request, client_opts \\ [])

Mark messages from users as read by token

Parameters

  • client (Req.Request.t/0): Client to make request with
  • mark_messages_as_read_by_token_request (t:MarkMessagesAsReadByTokenRequest/0):
  • client_opts (keyword/0): Options to pass to Req.request

Returns

  • {:ok, nil} on success
  • {:error, Req.Response.t} on failure

multicast(client, multicast_request, optional_args \\ [], client_opts \\ [])

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 with
  • multicast_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 to Req.request

Returns

  • {:ok, map()} on success
  • {:error, Req.Response.t} on failure

narrowcast(client, narrowcast_request, optional_args \\ [], client_opts \\ [])

Send narrowcast message

Parameters

  • client (Req.Request.t/0): Client to make request with
  • narrowcast_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 to Req.request

Returns

  • {:ok, map()} on success
  • {:error, Req.Response.t} on failure

new(options \\ [])

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 (see Req.new/1)

push_message(client, push_message_request, optional_args \\ [], client_opts \\ [])

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 with
  • push_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 to Req.request

Returns

  • {:ok, LINE.Bot.Model.PushMessageResponse.t} on success
  • {:error, Req.Response.t} on failure

push_messages_by_phone(client, pnp_messages_request, optional_args \\ [], client_opts \\ [])

Send LINE notification message

Parameters

  • client (Req.Request.t/0): Client to make request with
  • pnp_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 to Req.request

Returns

  • {:ok, nil} on success
  • {:error, Req.Response.t} on failure

reply_message(client, reply_message_request, client_opts \\ [])

Send reply message

Parameters

  • client (Req.Request.t/0): Client to make request with
  • reply_message_request (t:ReplyMessageRequest/0):
  • client_opts (keyword/0): Options to pass to Req.request

Returns

  • {:ok, LINE.Bot.Model.ReplyMessageResponse.t} on success
  • {:error, Req.Response.t} on failure

rich_menu_batch(client, rich_menu_batch_request, client_opts \\ [])

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

  • client (Req.Request.t/0): Client to make request with
  • rich_menu_batch_request (t:RichMenuBatchRequest/0):
  • client_opts (keyword/0): Options to pass to Req.request

Returns

  • {:ok, nil} on success
  • {:error, Req.Response.t} on failure

set_default_rich_menu(client, rich_menu_id, client_opts \\ [])

Set default rich menu

Parameters

Returns

  • {:ok, nil} on success
  • {:error, Req.Response.t} on failure

set_webhook_endpoint(client, set_webhook_endpoint_request, client_opts \\ [])

Set webhook endpoint URL

Parameters

  • client (Req.Request.t/0): Client to make request with
  • set_webhook_endpoint_request (t:SetWebhookEndpointRequest/0):
  • client_opts (keyword/0): Options to pass to Req.request

Returns

  • {:ok, nil} on success
  • {:error, Req.Response.t} on failure

show_loading_animation(client, show_loading_animation_request, client_opts \\ [])

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 with
  • show_loading_animation_request (t:ShowLoadingAnimationRequest/0):
  • client_opts (keyword/0): Options to pass to Req.request

Returns

  • {:ok, map()} on success
  • {:error, Req.Response.t} on failure

test_webhook_endpoint(client, optional_args \\ [], client_opts \\ [])

Test webhook endpoint

Parameters

  • client (Req.Request.t/0): Client to make request with
  • optional_args (keyword): Optional parameters
    • :body (t:TestWebhookEndpointRequest/0):
  • client_opts (keyword/0): Options to pass to Req.request

Returns

  • {:ok, LINE.Bot.Model.TestWebhookEndpointResponse.t} on success
  • {:error, Req.Response.t} on failure

update_rich_menu_alias(client, rich_menu_alias_id, update_rich_menu_alias_request, client_opts \\ [])

Update rich menu alias

Parameters

  • client (Req.Request.t/0): Client to make request with
  • rich_menu_alias_id (String.t/0): The rich menu alias ID you want to update.
  • update_rich_menu_alias_request (t:UpdateRichMenuAliasRequest/0):
  • client_opts (keyword/0): Options to pass to Req.request

Returns

  • {:ok, nil} on success
  • {:error, Req.Response.t} on failure

validate_broadcast(client, validate_message_request, client_opts \\ [])

Validate message objects of a broadcast message

Parameters

  • client (Req.Request.t/0): Client to make request with
  • validate_message_request (t:ValidateMessageRequest/0):
  • client_opts (keyword/0): Options to pass to Req.request

Returns

  • {:ok, nil} on success
  • {:error, Req.Response.t} on failure

validate_multicast(client, validate_message_request, client_opts \\ [])

Validate message objects of a multicast message

Parameters

  • client (Req.Request.t/0): Client to make request with
  • validate_message_request (t:ValidateMessageRequest/0):
  • client_opts (keyword/0): Options to pass to Req.request

Returns

  • {:ok, nil} on success
  • {:error, Req.Response.t} on failure

validate_narrowcast(client, validate_message_request, client_opts \\ [])

Validate message objects of a narrowcast message

Parameters

  • client (Req.Request.t/0): Client to make request with
  • validate_message_request (t:ValidateMessageRequest/0):
  • client_opts (keyword/0): Options to pass to Req.request

Returns

  • {:ok, nil} on success
  • {:error, Req.Response.t} on failure

validate_push(client, validate_message_request, client_opts \\ [])

Validate message objects of a push message

Parameters

  • client (Req.Request.t/0): Client to make request with
  • validate_message_request (t:ValidateMessageRequest/0):
  • client_opts (keyword/0): Options to pass to Req.request

Returns

  • {:ok, nil} on success
  • {:error, Req.Response.t} on failure

validate_reply(client, validate_message_request, client_opts \\ [])

Validate message objects of a reply message

Parameters

  • client (Req.Request.t/0): Client to make request with
  • validate_message_request (t:ValidateMessageRequest/0):
  • client_opts (keyword/0): Options to pass to Req.request

Returns

  • {:ok, nil} on success
  • {:error, Req.Response.t} on failure

validate_rich_menu_batch_request(client, rich_menu_batch_request, client_opts \\ [])

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

Parameters

  • client (Req.Request.t/0): Client to make request with
  • rich_menu_batch_request (t:RichMenuBatchRequest/0):
  • client_opts (keyword/0): Options to pass to Req.request

Returns

  • {:ok, nil} on success
  • {:error, Req.Response.t} on failure

validate_rich_menu_object(client, rich_menu_request, client_opts \\ [])

Validate rich menu object

Parameters

  • client (Req.Request.t/0): Client to make request with
  • rich_menu_request (t:RichMenuRequest/0):
  • client_opts (keyword/0): Options to pass to Req.request

Returns

  • {:ok, nil} on success
  • {:error, Req.Response.t} on failure