Messaging API reference

# Common specifications

Common specifications for Messaging API, such as the domain name of endpoints, response when a request succeeds or fails, and rate limit.

domain-name rate-limits limit-on-the-number-of-concurrent-operations status-codes response-headers error-responses error-messages error-details-message error-handling-methods

# Webhooks

When an event occurs, such as when a user adds your LINE Official Account as a friend or sends a message, the LINE Platform sends an HTTPS POST request to the webhook URL (bot server).

The webhook URL is configured for each channel in the LINE Developers Console.

request-headers request-body response signature-validation

# Webhook Event Objects

These are JSON objects containing events generated by the LINE platform.

common-properties source-user source-group source-room message-event wh-text wh-image wh-video wh-audio wh-file wh-location wh-sticker unsend-event follow-event unfollow-event join-event leave-event member-joined-event member-left-event postback-event postback-params-object postback-params-object-for-richmenu-switch-action video-viewing-complete beacon-event beacon-event-types account-link-event link-object device-link-event device-unlink-event scenario-result-event things-result-resultcode

# Webhook settings

You can configure, test, and get information on channel webhook endpoints.

set-webhook-endpoint-url set-webhook-endpoint-url-http-request set-webhook-endpoint-url-request-headers set-webhook-endpoint-url-request-body set-webhook-endpoint-url-response set-webhook-endpoint-url-error-response get-webhook-endpoint-information get-webhook-endpoint-information-http-request get-webhook-endpoint-information-request-headers get-webhook-endpoint-information-response test-webhook-endpoint test-webhook-endpoint-http-request test-webhook-endpoint-request-headers test-webhook-endpoint-request-body test-webhook-endpoint-response test-webhook-endpoint-error-response

# Channel access token

You can issue, get, or revoke the channel access token required when calling the Messaging API from the app.

issue-channel-access-token-v2-1 verfiy-channel-access-token-v2-1 verfiy-channel-access-token-v2-1-http-request verfiy-channel-access-token-v2-1-query-parameters verfiy-channel-access-token-v2-1-response verfiy-channel-access-token-v2-1-error-response get-all-valid-channel-access-token-key-ids-v2-1 revoke-channel-access-token-v2-1 issue-shortlived-channel-access-token issue-channel-access-token-http-request issue-channel-access-token-request-headers issue-channel-access-token-request-body issue-channel-access-token-response issue-channel-access-token-error-response verfiy-channel-access-token verfiy-channel-access-token-http-request verfiy-channel-access-token-request-headers verfiy-channel-access-token-request-body verfiy-channel-access-token-response verfiy-channel-access-token-error-response revoke-longlived-or-shortlived-channel-access-token revoke-channel-access-token-http-request revoke-channel-access-token-request-headers revoke-channel-access-token-request-body revoke-channel-access-token-response revoke-channel-access-token-error-response

# Message

You can send a message and obtain information about the sent message.

send-reply-message send-reply-message-http-request send-reply-message-request-headers send-reply-message-request-body send-reply-message-response send-reply-message-error-response send-push-message send-push-message-http-request send-push-message-request-headers send-push-message-request-body send-push-message-response send-push-message-error-response send-multicast-message send-multicast-http-request send-multicast-request-headers send-multicast-request-body send-multicast-response send-narrowcast-message send-narrowcast-http-request send-narrowcast-request-headers send-narrowcast-request-body narrowcast-recipient narrowcast-demographic-filter send-narrowcast-response send-narrowcast-error-response get-narrowcast-progress-status get-narrowcast-progress-status-http-request get-narrowcast-progress-status-request-headers get-narrowcast-progress-status-query-parameters get-narrowcast-progress-status-response get-narrowcast-progress-status-error-response send-broadcast-message send-broadcast-http-request send-broadcast-request-headers send-broadcast-request-body send-broadcast-response get-content get-content-http-request get-content-request-headers get-content-path-parameters get-content-response get-quota get-quota-http-request get-quota-request-headers get-quota-response get-consumption get-number-of-sent-messages-http-request get-number-of-sent-messages-request-headers get-number-of-sent-messages-response get-number-of-reply-messages get-number-of-reply-messages-http-request get-number-of-reply-messages-request-headers get-number-of-reply-messages-query-parameters get-number-of-reply-messages-response get-number-of-push-messages get-number-of-push-messages-http-request get-number-of-push-messages-request-headers get-number-of-push-messages-query-parameters get-number-of-push-messages-response get-number-of-multicast-messages get-number-of-multicast-messages-http-request get-number-of-multicast-messages-request-headers get-number-of-multicast-messages-query-parameters get-number-of-multicast-messages-response get-number-of-broadcast-messages get-number-of-broadcast-messages-http-request get-number-of-broadcast-messages-request-headers get-number-of-broadcast-messages-query-parameters get-number-of-broadcast-messages-response retry-api-request retry-api-request-request-headers retry-api-request-response

# Managing Audience

You can create, update, activate, or delete an audience. Specify the audience when sending narrowcast messages.

create-upload-audience-group create-upload-audience-group-http-request create-upload-audience-group-request-headers create-upload-audience-group-request-body create-upload-audience-group-response create-upload-audience-group-error-response create-upload-audience-group-by-file create-upload-audience-group-by-file-http-request create-upload-audience-group-by-file-request-headers create-upload-audience-group-by-file-response create-upload-audience-group-by-file-error-response update-upload-audience-group update-upload-audience-group-http-request update-upload-audience-group-request-headers update-upload-audience-group-request-body update-upload-audience-group-response update-upload-audience-group-error-response update-upload-audience-group-by-file update-upload-audience-group-by-file-http-request update-upload-audience-group-by-file-request-headers update-upload-audience-group-by-file-request-body update-upload-audience-group-by-file-response update-upload-audience-group-by-file-error-response create-click-audience-group create-click-audience-group-http-request create-click-audience-group-request-headers create-click-audience-group-request-body create-click-audience-group-response create-click-audience-group-error-response create-imp-audience-group create-imp-audience-group-http-request create-imp-audience-group-request-headers create-imp-audience-group-request-body create-imp-audience-group-response create-imp-audience-group-error-response set-description-audience-group set-description-audience-group-http-request set-description-audience-group-request-headers set-description-audience-group-path-parameters set-description-audience-group-request-body set-description-audience-group-response set-description-audience-group-error-response activate-audience-group activate-audience-group-http-request activate-audience-group-request-headers activate-audience-group-path-parameters activate-audience-group-response activate-audience-group-error-response delete-audience-group delete-audience-group-http-request delete-audience-group-request-headers delete-audience-group-path-parameters delete-audience-group-response delete-audience-group-error-response get-audience-group get-audience-group-http-request get-audience-group-request-headers get-audience-group-path-parameters get-audience-group-response get-audience-group-error-response get-audience-groups get-audience-groups-http-request get-audience-groups-request-headers get-audience-groups-query-parameters get-audience-groups-response get-audience-groups-error-response get-authority-level get-authority-level-http-request get-authority-level-request-headers get-authority-level-response change-authority-level change-authority-level-http-request change-authority-level-request-headers change-authority-level-request-body change-authority-level-response

# Insight

You can obtain information on the number of messages sent from the LINE Official Account, number of friends, and other statistical data.

get-number-of-delivery-messages get-insight-message-delivery-http-request get-insight-message-delivery-request-headers get-insight-message-delivery-query-parameters get-insight-message-delivery-response get-number-of-followers get-insight-followers-http-request get-insight-followers-request-headers get-insight-followers-query-parameters get-insight-followers-response get-demographic get-insight-demographic-http-request get-insight-demographic-request-headers get-insight-demographic-response get-message-event get-insight-message-event-http-request get-insight-message-event-request-headers get-insight-message-event-query-parameters get-insight-message-event-response

# Users

You can get information of users who have added your LINE Official Account as a friend.

Accessing your own user ID

You can access your user ID under the Basic settings tab of your channel on the LINE Developers Console. For more information on permissions per role, see Channel roles in Managing roles. There is no API available for retrieving your own user ID.

get-profile get-profile-http-request get-profile-request-headers get-profile-path-parameters get-profile-response get-profile-error-response get-follower-ids get-follower-ids-http-request get-follower-ids-request-headers get-follower-ids-query-parameters get-follower-ids-response get-follower-ids-error-response

# Bot

You can obtain basic information on the LINE Official Account's bots.

get-bot-info get-bot-info-http-request get-bot-info-request-headers get-bot-info-response

# Group

You can obtain information on the LINE official account's groups and members of the groups.

get-group-summary get-group-summary-http-request get-group-summary-request-headers get-group-summary-path-parameters get-group-id-response get-members-group-count get-members-in-group-count-http-request get-members-in-group-count-request-headers get-members-in-group-count-path-parameters get-count-members-in-group-response get-group-member-user-ids get-group-member-ids-http-request get-group-member-ids-request-headers get-group-member-ids-path-parameters get-group-member-ids-query-parameters get-group-member-user-ids-response get-group-member-profile get-group-member-profile-http-request get-group-member-profile-request-headers get-group-member-profile-path-parameters get-group-member-profile-response leave-group leave-group-http-request leave-group-request-headers leave-group-path-parameters leave-group-response

# Chat Room

You can obtain information about the LINE Official Account's chat rooms and their members.

get-members-room-count get-members-in-room-count-http-request get-members-in-room-count-request-headers get-members-in-room-count-path-parameters get-count-members-in-room-response get-room-member-user-ids get-room-member-ids-http-request get-room-member-ids-request-headers get-room-member-ids-path-parameters get-room-member-ids-query-parameters get-room-member-user-ids-response get-room-member-profile get-room-member-profile-http-request get-room-member-profile-request-headers get-room-member-profile-path-parameters get-room-member-profile-response leave-room leave-room-http-request leave-room-request-headers leave-room-path-parameters leave-room-response

Customizable menu that is displayed on your LINE Official Account's chat screen. For more information, see Using rich menus.

# Account link

You can link the service account provided by the provider (corporate and developer) with the account of the LINE user.

issue-link-token issue-link-token-http-request issue-link-token-request-headers issue-link-token-path-parameters issue-link-token-response

# Message objects

JSON object which contains the contents of the message you send.

message-common-properties quick-reply items-object quick-reply-button-object icon-nickname-switch text-message sticker-message image-message video-message audio-message location-message imagemap-message base-url imagemap-action-objects imagemap-uri-action-object imagemap-message-action-object imagemap-area-object template-messages buttons confirm carousel column-object-for-carousel image-carousel column-object-for-image-carousel flex-message operating-environment container bubble style-setting-objects bubble-style block-style f-carousel flex-component box button f-image drawing-area icon f-text span separator filler

# Action objects

These are types of actions for your bot to take when a user taps a button or an image in a message.

Postback action
Message action
URI action
Datetime picker action
Camera action
Camera roll action
Location action
Richmenu Switch Action

postback-action message-action uri-action datetime-picker-action camera-action camera-roll-action location-action richmenu-switch-action

Rich menus consist of either of these objects.

Rich menu object without the rich menu ID. Use this object when you create a rich menu.
Rich menu response object with the rich menu ID. This object is returned when you get a rich menu or get a list of rich menus.

Area objects and action objects are included in these objects.

size-object area-object bounds-object

# Messaging API reference