Messaging API reference
Show all
Common specifications Common specifications for Messaging API, such as the domain name of endpoints, response when a request succeeds or fails, and rate limit.
Show
domain-name
rate-limits
rate-limits-scpoe
limit-on-the-number-of-concurrent-operations
status-codes
error-responses
error-messages
error-details-message
error-handling-methods
other-common-specifications
url-encoding
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 .
Show
request-body
response
signature-validation
Webhook Event Objects These are JSON objects containing events generated by the LINE platform.
Show
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
video-viewing-complete
beacon-event
beacon-event-types
account-link-event
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.
Show
set-webhook-endpoint-url
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-response
get-webhook-endpoint-information-error-response
test-webhook-endpoint
test-webhook-endpoint-request-body
test-webhook-endpoint-response
test-webhook-endpoint-error-response
Getting content You can get the content that a user has sent to your LINE Official Account by using the message IDs received via the webhook .
Show
get-content
get-content-path-parameters
get-content-response
get-content-error-response
verify-video-or-audio-preparation-status
verify-video-or-audio-preparation-status-path-parameters
verify-video-or-audio-preparation-status-response
verify-video-or-audio-preparation-status-error-response
get-image-or-video-preview
get-content-preview-path-parameters
get-content-preview-response
get-content-preview-error-response
Channel access token You can issue, get, or revoke the channel access token required when calling the Messaging API from the app.
Show
issue-channel-access-token-v2-1
issue-channel-access-token-v2.1-request-body
issue-channel-access-token-v2.1-response
issue-channel-access-token-v2.1-error-response
verfiy-channel-access-token-v2-1
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
get-all-issued-channel-access-token-key-ids-v2.1-query-parameter
get-all-issued-channel-access-token-key-ids-v2.1-response
get-all-issued-channel-access-token-key-ids-v2.1-error-response
revoke-channel-access-token-v2-1
revoke-channel-access-token-v2.1-request-body
revoke-channel-access-token-v2.1-response
revoke-channel-access-token-v2.1-error-response
issue-shortlived-channel-access-token
issue-channel-access-token-playground
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-request-body
verfiy-channel-access-token-response
verfiy-channel-access-token-error-response
revoke-longlived-or-shortlived-channel-access-token
revoke-channel-access-token-playground
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.
Show
send-reply-message
send-reply-message-reply-token
send-reply-message-request-body
send-reply-message-response
send-reply-message-error-response
send-push-message
send-push-message-conditions
send-push-message-request-body
send-push-message-response
send-push-message-error-response
send-multicast-message
send-multicast-message-conditions
send-multicast-request-body
send-multicast-response
send-multicast-message-error-response
send-narrowcast-message
send-narrowcast-message-conditions
send-narrowcast-message-restrictions
send-narrowcast-message-cautions
send-narrowcast-request-body
narrowcast-recipient
narrowcast-recipient-audience-objects
narrowcast-recipient-redelivery-object
narrowcast-recipient-logical-operator-objects
narrowcast-demographic-filter
narrowcast-demographic-filter-gender
narrowcast-demographic-filter-age
narrowcast-demographic-filter-operating-system
narrowcast-demographic-filter-region
narrowcast-demographic-filter-friendship-duration
narrowcast-demographic-filter-logical-operator-objects
send-narrowcast-response
send-narrowcast-error-response
get-narrowcast-progress-status
get-narrowcast-progress-status-query-parameters
get-narrowcast-progress-status-response
get-narrowcast-progress-status-error-response
send-broadcast-message
send-broadcast-request-body
send-broadcast-response
send-broadcast-message-error-response
get-quota
get-quota-playground
get-quota-response
get-consumption
get-number-of-sent-messages-playground
get-number-of-sent-messages-response
get-number-of-reply-messages
get-number-of-reply-messages-playground
get-number-of-reply-messages-query-parameters
get-number-of-reply-messages-response
get-number-of-push-messages
get-number-of-push-messages-playground
get-number-of-push-messages-query-parameters
get-number-of-push-messages-response
get-number-of-multicast-messages
get-number-of-multicast-messages-playground
get-number-of-multicast-messages-query-parameters
get-number-of-multicast-messages-response
get-number-of-broadcast-messages
get-number-of-broadcast-messages-query-parameters
get-number-of-broadcast-messages-response
validate-message-objects-of-reply-message
validate-message-objects-of-reply-message-request-body
validate-message-objects-of-reply-message-response
validate-message-objects-of-reply-message-error-response
validate-message-objects-of-push-message
validate-message-objects-of-push-message-request-body
validate-message-objects-of-push-message-response
validate-message-objects-of-push-message-error-response
validate-message-objects-of-multicast-message
validate-message-objects-of-multicast-message-request-body
validate-message-objects-of-multicast-message-response
validate-message-objects-of-multicast-message-error-response
validate-message-objects-of-narrowcast-message
validate-message-objects-of-narrowcast-message-request-body
validate-message-objects-of-narrowcast-message-response
validate-message-objects-of-narrowcast-message-error-response
validate-message-objects-of-broadcast-message
validate-message-objects-of-broadcast-message-request-body
validate-message-objects-of-broadcast-message-response
validate-message-objects-of-broadcast-message-error-response
get-number-of-units-used-this-month
get-number-of-units-used-this-month-response
get-name-list-of-units-used-this-month
get-name-list-of-units-used-this-month-query-parameters
get-name-list-of-units-used-this-month-response
retry-api-request
retry-api-request-response
Managing Audience You can create, update, activate, or delete an audience. Specify the audience when sending narrowcast messages.
Show
create-upload-audience-group
create-upload-audience-group-conditions
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-conditions
create-upload-audience-group-by-file-request-body
create-upload-audience-group-by-file-response
create-upload-audience-group-by-file-error-response
update-upload-audience-group
update-upload-audience-group-conditions
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-conditions
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-request-body
create-click-audience-group-response
create-click-audience-group-error-response
create-imp-audience-group
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-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-path-parameters
activate-audience-group-response
activate-audience-group-error-response
delete-audience-group
delete-audience-group-path-parameters
delete-audience-group-response
delete-audience-group-error-response
get-audience-group
get-audience-group-path-parameters
get-audience-group-response
get-audience-group-error-response
get-audience-groups
get-audience-groups-query-parameters
get-audience-groups-response
get-audience-groups-error-response
get-authority-level
get-authority-level-response
change-authority-level
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.
Show
get-number-of-delivery-messages
get-insight-message-delivery-query-parameters
get-insight-message-delivery-response
get-number-of-followers
get-insight-followers-query-parameters
get-insight-followers-response
get-demographic
get-insight-demographic-response
get-message-event
get-insight-message-event-query-parameters
get-insight-message-event-response
get-statistics-per-unit
get-statistics-per-unit-query-parameters
get-statistics-per-unit-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 in the LINE Developers Console, see Channel roles in Managing roles . There is no API available for retrieving your own user ID.
Show
get-profile
get-profile-playground
get-profile-path-parameters
get-profile-response
get-profile-error-response
get-follower-ids
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.
Show
get-bot-info
get-bot-info-response
Group chats You can obtain information about the group chats and their members that the LINE Official Account is a member of.
Show
get-group-summary
get-group-summary-path-parameters
get-group-summary-response
get-group-summary-error-response
get-members-group-count
get-members-in-group-count-path-parameters
get-count-members-in-group-response
get-count-members-in-group-error-response
get-group-member-user-ids
get-group-member-ids-path-parameters
get-group-member-ids-query-parameters
get-group-member-user-ids-response
get-group-member-user-ids-error-response
get-group-member-profile
get-group-member-profile-path-parameters
get-group-member-profile-response
get-group-member-profile-error-response
leave-group
leave-group-path-parameters
leave-group-response
leave-group-error-response
Multi-person chats You can obtain information about the multi-person chats and their members that the LINE Official Account is a member of.
Show
get-members-room-count
get-members-in-room-count-path-parameters
get-count-members-in-room-response
get-room-member-user-ids
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-path-parameters
get-room-member-profile-response
leave-room
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 .
Show
create-rich-menu-request-body
validate-rich-menu-object-request-body
create-rich-menu-alias-request-body
update-rich-menu-alias-request-body
bulk-link-rich-menu-request-body
bulk-unlink-rich-menu-request-body
Account link You can link the service account provided by the provider (corporate and developer) with the account of the LINE user.
Show
issue-link-token
issue-link-token-path-parameters
issue-link-token-response
Message objects JSON object which contains the contents of the message you send.
Validating message objects
By using the following endpoints, you can validate message objects:
Show
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
common-properties-of-template-message-objects
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
f-video
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.
Show
postback-action
message-action
uri-action
datetime-picker-action
date-and-time-format
camera-action
camera-roll-action
location-action
size-object
area-object
bounds-object