# Common specifications
Common specifications for Messaging API, such as the domain name of endpoints, response when a request succeeds or fails, and rate limit.
# Messaging API reference
domain-name
rate-limits
rate-limits-scpoe
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.
Endpoints
request-headers
request-body
response
signature-validation
get-content
get-content-request-headers
get-content-path-parameters
get-content-response
# 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
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-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-request-headers
get-webhook-endpoint-information-response
test-webhook-endpoint
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
issue-channel-access-token-v2.1-request-headers
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-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-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-playground
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.
Endpoints
POST/v2/bot/message/reply
POST/v2/bot/message/push
POST/v2/bot/message/multicast
POST/v2/bot/message/narrowcast
GET/v2/bot/message/progress/narrowcast
POST/v2/bot/message/broadcast
GET/v2/bot/message/quota
GET/v2/bot/message/quota/consumption
GET/v2/bot/message/delivery/reply
GET/v2/bot/message/delivery/push
GET/v2/bot/message/delivery/multicast
GET/v2/bot/message/delivery/broadcast
send-reply-message
send-reply-message-reply-token
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-conditions
send-push-message-request-headers
send-push-message-request-body
send-push-message-response
send-push-message-error-response
send-multicast-message
send-multicast-message-conditions
send-multicast-request-headers
send-multicast-request-body
send-multicast-response
send-multicast-message-error-response
send-narrowcast-message
send-narrowcast-request-headers
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-request-headers
get-narrowcast-progress-status-query-parameters
get-narrowcast-progress-status-response
get-narrowcast-progress-status-error-response
send-broadcast-message
send-broadcast-request-headers
send-broadcast-request-body
send-broadcast-response
send-broadcast-message-error-response
get-quota
get-quota-playground
get-quota-request-headers
get-quota-response
get-consumption
get-number-of-sent-messages-playground
get-number-of-sent-messages-request-headers
get-number-of-sent-messages-response
get-number-of-reply-messages
get-number-of-reply-messages-playground
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-playground
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-playground
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-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.
Endpoints
POST/v2/bot/audienceGroup/upload
POST/v2/bot/audienceGroup/upload/byFile
PUT/v2/bot/audienceGroup/upload
PUT/v2/bot/audienceGroup/upload/byFile
POST/v2/bot/audienceGroup/click
POST/v2/bot/audienceGroup/imp
PUT/v2/bot/audienceGroup/{audienceGroupId}/updateDescription
PUT/v2/bot/audienceGroup/{audienceGroupId}/activate
DELETE/v2/bot/audienceGroup/{audienceGroupId}
GET/v2/bot/audienceGroup/{audienceGroupId}
GET/v2/bot/audienceGroup/list
GET/v2/bot/audienceGroup/authorityLevel
PUT/v2/bot/audienceGroup/authorityLevel
create-upload-audience-group
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-request-headers
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-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-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-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-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-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-request-headers
activate-audience-group-path-parameters
activate-audience-group-response
activate-audience-group-error-response
delete-audience-group
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-request-headers
get-audience-group-path-parameters
get-audience-group-response
get-audience-group-error-response
get-audience-groups
get-audience-groups-request-headers
get-audience-groups-query-parameters
get-audience-groups-response
get-audience-groups-error-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-request-headers
get-insight-message-delivery-query-parameters
get-insight-message-delivery-response
get-number-of-followers
get-insight-followers-request-headers
get-insight-followers-query-parameters
get-insight-followers-response
get-demographic
get-insight-demographic-request-headers
get-insight-demographic-response
get-message-event
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-playground
get-profile-request-headers
get-profile-path-parameters
get-profile-response
get-profile-error-response
get-follower-ids
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.
Endpoints
get-bot-info
get-bot-info-request-headers
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.
get-group-summary
get-group-summary-request-headers
get-group-summary-path-parameters
get-group-id-response
get-members-group-count
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-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-request-headers
get-group-member-profile-path-parameters
get-group-member-profile-response
leave-group
leave-group-request-headers
leave-group-path-parameters
leave-group-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.
get-members-room-count
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-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-request-headers
get-room-member-profile-path-parameters
get-room-member-profile-response
leave-room
leave-room-request-headers
leave-room-path-parameters
leave-room-response
# Rich menu
Customizable menu that is displayed on your LINE Official Account's chat screen. For more information, see Using rich menus.
Endpoints
POST/v2/bot/richmenu
POST/v2/bot/richmenu/validate
POST/v2/bot/richmenu/{richMenuId}/content
GET/v2/bot/richmenu/{richMenuId}/content
GET/v2/bot/richmenu/list
GET/v2/bot/richmenu/{richMenuId}
DELETE/v2/bot/richmenu/{richMenuId}
POST/v2/bot/user/all/richmenu/{richMenuId}
GET/v2/bot/user/all/richmenu
DELETE/v2/bot/user/all/richmenu
POST/v2/bot/user/{userId}/richmenu/{richMenuId}
POST/v2/bot/richmenu
POST/v2/bot/richmenu/alias
DELETE/v2/bot/richmenu/alias/{richMenuAliasId}
POST/v2/bot/richmenu/alias/{richMenuAliasId}
GET/v2/bot/richmenu/alias/{richMenuAliasId}
GET/v2/bot/richmenu/alias/list
GET/v2/bot/user/{userId}/richmenu
DELETE/v2/bot/user/{userId}/richmenu
POST/v2/bot/richmenu/bulk/unlink
# Account link
You can link the service account provided by the provider (corporate and developer) with the account of the LINE user.
Endpoints
issue-link-token
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
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
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
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.
postback-action
message-action
uri-action
datetime-picker-action
date-and-time-format
camera-action
camera-roll-action
location-action
# Rich menu structure
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