Social — entry 017 of 39
Line
LINE's developer platform covers OAuth 2.0-based LINE Login for social sign-in alongside the Messaging API, which uses per-channel access tokens (rather than user OAuth) to let official accounts send and receive text, stickers, images, and Flex Messages through api.line.me. The Messaging API is free to start, with paid plans unlocked once an account's monthly free message allowance is exceeded.
AuthenticationOAuthRequires an OAuth flow; expect app registration.
HTTPSSupportedTraffic is encrypted in transit.
CORSEnabledCallable directly from browser JavaScript.
PricingFreemiumA usable free tier exists, with paid plans for more volume.
FormatsJSONResponses can be requested as JSON.
GreatAPIs Score
Score74
Authentication8/25OAuth flow required
Pricing17/20Freemium tier available
Docs20/20Machine-readable spec file bundled
Formats9/15Single response format
Freshness20/20Verified within 6 months
Embed this badge
<a href="https://greatapis.com/api/line/"><img src="https://greatapis.com/badge/line.svg" alt="Scored 74 on greatapis.com"></a>Auth quickstart
- Register an app / run the OAuth flow to obtain a bearer token.
- Send it as an Authorization header
Authorization: Bearer <token>
Stored keyNo key stored
Your key is stored only in this browser (localStorage) and sent directly to the API — never to greatapis.
Endpoints
messaging-api68
POST/bot/pnp/push
Parameters
| Name | In | Required | Type |
|---|---|---|---|
X-Line-Delivery-Tag | header | no | string |
Request body
application/json — PnpMessagesRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | — |
422 | Unprocessable Entity | ErrorResponse |
GET/v2/bot/channel/webhook/endpoint
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | GetWebhookEndpointResponse |
PUT/v2/bot/channel/webhook/endpoint
Request body
application/json — SetWebhookEndpointRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | — |
POST/v2/bot/channel/webhook/test
Request body
application/json — TestWebhookEndpointRequest
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | TestWebhookEndpointResponse |
POST/v2/bot/chat/loading/start
Request body
application/json — ShowLoadingAnimationRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
202 | Accepted | ShowLoadingAnimationResponse |
400 | An invalid chat ID is specified, or the loadingSeconds value is invalid. | ErrorResponse |
POST/v2/bot/chat/markAsRead
Request body
application/json — MarkMessagesAsReadByTokenRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | — |
400 | An invalid markAsReadToken is specified. Tokens must be used by the bot that received them via Webhook. | ErrorResponse |
GET/v2/bot/coupon
Parameters
| Name | In | Required | Type |
|---|---|---|---|
status | query | no | array |
start | query | no | string |
limit | query | no | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | MessagingApiPagerCouponListResponse |
400 | Bad Request | ErrorResponse |
POST/v2/bot/coupon
Request body
application/json — CouponCreateRequest
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | CouponCreateResponse |
400 | Bad Request | ErrorResponse |
GET/v2/bot/coupon/{couponId}
Parameters
| Name | In | Required | Type |
|---|---|---|---|
couponId | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | CouponResponse |
400 | Bad Request | ErrorResponse |
404 | Not Found | ErrorResponse |
PUT/v2/bot/coupon/{couponId}/close
Parameters
| Name | In | Required | Type |
|---|---|---|---|
couponId | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | — |
400 | Bad Request | ErrorResponse |
404 | Not Found | ErrorResponse |
410 | Gone | ErrorResponse |
GET/v2/bot/followers/ids
Parameters
| Name | In | Required | Type |
|---|---|---|---|
start | query | no | string |
limit | query | no | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | GetFollowersResponse |
POST/v2/bot/group/{groupId}/leave
Parameters
| Name | In | Required | Type |
|---|---|---|---|
groupId | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | — |
400 | Bad Request | ErrorResponse |
404 | Not Found | ErrorResponse |
GET/v2/bot/group/{groupId}/member/{userId}
Parameters
| Name | In | Required | Type |
|---|---|---|---|
groupId | path | yes | string |
userId | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | GroupUserProfileResponse |
GET/v2/bot/group/{groupId}/members/count
Parameters
| Name | In | Required | Type |
|---|---|---|---|
groupId | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | GroupMemberCountResponse |
GET/v2/bot/group/{groupId}/members/ids
Parameters
| Name | In | Required | Type |
|---|---|---|---|
groupId | path | yes | string |
start | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | MembersIdsResponse |
GET/v2/bot/group/{groupId}/summary
Parameters
| Name | In | Required | Type |
|---|---|---|---|
groupId | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | GroupSummaryResponse |
GET/v2/bot/info
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | BotInfoResponse |
GET/v2/bot/membership/list
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | MembershipListResponse |
404 | Unable to get information about the memberships. | ErrorResponse |
GET/v2/bot/membership/subscription/{userId}
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | GetMembershipSubscriptionResponse |
400 | An invalid user ID is specified. | ErrorResponse |
404 | Unable to get information about the membership to which the user subscribes. | ErrorResponse |
GET/v2/bot/membership/{membershipId}/users/ids
Parameters
| Name | In | Required | Type |
|---|---|---|---|
start | query | no | string |
limit | query | no | integer |
membershipId | path | yes | integer |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | GetJoinedMembershipUsersResponse |
400 | `start` is incorrect or expired, or `limit` is under 1 or over 1000. | ErrorResponse |
404 | Membership ID is not owned by the bot or does not exist. | ErrorResponse |
GET/v2/bot/message/aggregation/info
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | GetAggregationUnitUsageResponse |
GET/v2/bot/message/aggregation/list
Parameters
| Name | In | Required | Type |
|---|---|---|---|
limit | query | no | string |
start | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | GetAggregationUnitNameListResponse |
POST/v2/bot/message/broadcast
Parameters
| Name | In | Required | Type |
|---|---|---|---|
X-Line-Retry-Key | header | no | string |
Request body
application/json — BroadcastRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | BroadcastResponse |
400 | Bad Request | ErrorResponse |
403 | Forbidden | ErrorResponse |
409 | Conflict | ErrorResponse |
429 | Too Many Requests | ErrorResponse |
GET/v2/bot/message/delivery/broadcast
Parameters
| Name | In | Required | Type |
|---|---|---|---|
date | query | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | NumberOfMessagesResponse |
GET/v2/bot/message/delivery/multicast
Parameters
| Name | In | Required | Type |
|---|---|---|---|
date | query | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | NumberOfMessagesResponse |
GET/v2/bot/message/delivery/pnp
Parameters
| Name | In | Required | Type |
|---|---|---|---|
date | query | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | NumberOfMessagesResponse |
GET/v2/bot/message/delivery/push
Parameters
| Name | In | Required | Type |
|---|---|---|---|
date | query | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | NumberOfMessagesResponse |
GET/v2/bot/message/delivery/reply
Parameters
| Name | In | Required | Type |
|---|---|---|---|
date | query | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | NumberOfMessagesResponse |
POST/v2/bot/message/markAsRead
Request body
application/json — MarkMessagesAsReadRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | — |
POST/v2/bot/message/multicast
Parameters
| Name | In | Required | Type |
|---|---|---|---|
X-Line-Retry-Key | header | no | string |
Request body
application/json — MulticastRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | MulticastResponse |
400 | Bad Request | ErrorResponse |
403 | Forbidden | ErrorResponse |
409 | Conflict | ErrorResponse |
429 | Too Many Requests | ErrorResponse |
POST/v2/bot/message/narrowcast
Parameters
| Name | In | Required | Type |
|---|---|---|---|
X-Line-Retry-Key | header | no | string |
Request body
application/json — NarrowcastRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
202 | Accepted | NarrowcastResponse |
400 | Bad Request | ErrorResponse |
403 | Forbidden | ErrorResponse |
409 | Conflict | ErrorResponse |
429 | Too Many Requests | ErrorResponse |
GET/v2/bot/message/progress/narrowcast
Parameters
| Name | In | Required | Type |
|---|---|---|---|
requestId | query | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | NarrowcastProgressResponse |
POST/v2/bot/message/push
Parameters
| Name | In | Required | Type |
|---|---|---|---|
X-Line-Retry-Key | header | no | string |
Request body
application/json — PushMessageRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | PushMessageResponse |
400 | Bad Request | ErrorResponse |
403 | Forbidden | ErrorResponse |
409 | Conflict | ErrorResponse |
429 | Too Many Requests | ErrorResponse |
GET/v2/bot/message/quota
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | MessageQuotaResponse |
GET/v2/bot/message/quota/consumption
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | QuotaConsumptionResponse |
POST/v2/bot/message/reply
Request body
application/json — ReplyMessageRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | ReplyMessageResponse |
400 | Bad request | ErrorResponse |
429 | Too Many Requests | ErrorResponse |
POST/v2/bot/message/validate/broadcast
Request body
application/json — ValidateMessageRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | — |
POST/v2/bot/message/validate/multicast
Request body
application/json — ValidateMessageRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | — |
POST/v2/bot/message/validate/narrowcast
Request body
application/json — ValidateMessageRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | — |
POST/v2/bot/message/validate/push
Request body
application/json — ValidateMessageRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | — |
POST/v2/bot/message/validate/reply
Request body
application/json — ValidateMessageRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | — |
GET/v2/bot/profile/{userId}
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | UserProfileResponse |
POST/v2/bot/richmenu
Request body
application/json — RichMenuRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | RichMenuIdResponse |
POST/v2/bot/richmenu/alias
Request body
application/json — CreateRichMenuAliasRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | — |
400 | Bad Request | ErrorResponse |
GET/v2/bot/richmenu/alias/list
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | RichMenuAliasListResponse |
GET/v2/bot/richmenu/alias/{richMenuAliasId}
Parameters
| Name | In | Required | Type |
|---|---|---|---|
richMenuAliasId | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | RichMenuAliasResponse |
POST/v2/bot/richmenu/alias/{richMenuAliasId}
Parameters
| Name | In | Required | Type |
|---|---|---|---|
richMenuAliasId | path | yes | string |
Request body
application/json — UpdateRichMenuAliasRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | — |
400 | Bad Request | ErrorResponse |
DELETE/v2/bot/richmenu/alias/{richMenuAliasId}
Parameters
| Name | In | Required | Type |
|---|---|---|---|
richMenuAliasId | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | — |
400 | Bad Request | ErrorResponse |
POST/v2/bot/richmenu/batch
Request body
application/json — RichMenuBatchRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
202 | Accepted | — |
POST/v2/bot/richmenu/bulk/link
Request body
application/json — RichMenuBulkLinkRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
202 | Accepted | — |
POST/v2/bot/richmenu/bulk/unlink
Request body
application/json — RichMenuBulkUnlinkRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
202 | Accepted | — |
GET/v2/bot/richmenu/list
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | RichMenuListResponse |
GET/v2/bot/richmenu/progress/batch
Parameters
| Name | In | Required | Type |
|---|---|---|---|
requestId | query | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | RichMenuBatchProgressResponse |
POST/v2/bot/richmenu/validate
Request body
application/json — RichMenuRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | — |
POST/v2/bot/richmenu/validate/batch
Request body
application/json — RichMenuBatchRequest (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | — |
GET/v2/bot/richmenu/{richMenuId}
Parameters
| Name | In | Required | Type |
|---|---|---|---|
richMenuId | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | RichMenuResponse |
DELETE/v2/bot/richmenu/{richMenuId}
Parameters
| Name | In | Required | Type |
|---|---|---|---|
richMenuId | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | — |
POST/v2/bot/room/{roomId}/leave
Parameters
| Name | In | Required | Type |
|---|---|---|---|
roomId | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | — |
GET/v2/bot/room/{roomId}/member/{userId}
Parameters
| Name | In | Required | Type |
|---|---|---|---|
roomId | path | yes | string |
userId | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | RoomUserProfileResponse |
GET/v2/bot/room/{roomId}/members/count
Parameters
| Name | In | Required | Type |
|---|---|---|---|
roomId | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | RoomMemberCountResponse |
GET/v2/bot/room/{roomId}/members/ids
Parameters
| Name | In | Required | Type |
|---|---|---|---|
roomId | path | yes | string |
start | query | no | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | MembersIdsResponse |
GET/v2/bot/user/all/richmenu
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | RichMenuIdResponse |
DELETE/v2/bot/user/all/richmenu
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | — |
POST/v2/bot/user/all/richmenu/{richMenuId}
Parameters
| Name | In | Required | Type |
|---|---|---|---|
richMenuId | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | — |
POST/v2/bot/user/{userId}/linkToken
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | IssueLinkTokenResponse |
GET/v2/bot/user/{userId}/richmenu
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | RichMenuIdResponse |
DELETE/v2/bot/user/{userId}/richmenu
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | — |
POST/v2/bot/user/{userId}/richmenu/{richMenuId}
Parameters
| Name | In | Required | Type |
|---|---|---|---|
userId | path | yes | string |
richMenuId | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | — |
messaging-api-blob5
GET/v2/bot/message/{messageId}/content
Parameters
| Name | In | Required | Type |
|---|---|---|---|
messageId | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | — |
GET/v2/bot/message/{messageId}/content/preview
Parameters
| Name | In | Required | Type |
|---|---|---|---|
messageId | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | — |
GET/v2/bot/message/{messageId}/content/transcoding
Parameters
| Name | In | Required | Type |
|---|---|---|---|
messageId | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | GetMessageContentTranscodingResponse |
GET/v2/bot/richmenu/{richMenuId}/content
Parameters
| Name | In | Required | Type |
|---|---|---|---|
richMenuId | path | yes | string |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | — |
POST/v2/bot/richmenu/{richMenuId}/content
Parameters
| Name | In | Required | Type |
|---|---|---|---|
richMenuId | path | yes | string |
Request body
*/* (required)
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | — |
Try it
Developer reference
Base URL
https://api.line.meRate limit
LINE tiers Messaging API limits per endpoint per channel (developers.line.biz/en/reference/messaging-api/#rate-limits): push, reply, and profile-lookup endpoints allow 2,000 requests/second, multicast messages are capped at 200 requests/second, and broadcast messages are limited to 60 requests/hour; exceeding a tier returns HTTP 429.
Key endpoints
- POST/v2/bot/message/push
- POST/v2/bot/message/reply
- POST/v2/bot/message/broadcast
- POST/v2/bot/message/multicast
- GET/v2/bot/profile/{userId}