LINE Messaging API
This document describes LINE Messaging API.
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
This document describes LINE Messaging API.
Endpoints 75
messaging-api
- GETgetWebhookEndpoint
/v2/bot/channel/webhook/endpointGet webhook endpoint information - PUTsetWebhookEndpoint
/v2/bot/channel/webhook/endpointSet webhook endpoint URL - POSTtestWebhookEndpoint
/v2/bot/channel/webhook/testTest webhook endpoint - POSTreplyMessage
/v2/bot/message/replySend reply message - POSTpushMessage
/v2/bot/message/pushSends a message to a user, group chat, or multi-person chat at any time. - POSTmulticast
/v2/bot/message/multicastAn API that efficiently sends the same message to multiple user IDs. You can't send messages to group chats or multi-person chats. - POSTnarrowcast
/v2/bot/message/narrowcastSend narrowcast message - GETgetNarrowcastProgress
/v2/bot/message/progress/narrowcast?requestId=stringGets the status of a narrowcast message. - POSTbroadcast
/v2/bot/message/broadcastSends a message to multiple users at any time. - GETgetMessageQuota
/v2/bot/message/quotaGets the target limit for sending messages in the current month. The total number of the free messages and the additional messages is returned. - GETgetMessageQuotaConsumption
/v2/bot/message/quota/consumptionGets the number of messages sent in the current month. - GETgetNumberOfSentReplyMessages
/v2/bot/message/delivery/reply?date=stringGet number of sent reply messages - GETgetNumberOfSentPushMessages
/v2/bot/message/delivery/push?date=stringGet number of sent push messages - GETgetNumberOfSentMulticastMessages
/v2/bot/message/delivery/multicast?date=stringGet number of sent multicast messages - GETgetNumberOfSentBroadcastMessages
/v2/bot/message/delivery/broadcast?date=stringGet number of sent broadcast messages - POSTvalidateReply
/v2/bot/message/validate/replyValidate message objects of a reply message - POSTvalidatePush
/v2/bot/message/validate/pushValidate message objects of a push message - POSTvalidateMulticast
/v2/bot/message/validate/multicastValidate message objects of a multicast message - POSTvalidateNarrowcast
/v2/bot/message/validate/narrowcastValidate message objects of a narrowcast message - POSTvalidateBroadcast
/v2/bot/message/validate/broadcastValidate message objects of a broadcast message - GETgetAggregationUnitUsage
/v2/bot/message/aggregation/infoGet number of units used this month - GETgetAggregationUnitNameList
/v2/bot/message/aggregation/listGet name list of units used this month - GETgetProfile
/v2/bot/profile/:userIdGet profile - GETgetFollowers
/v2/bot/followers/idsGet a list of users who added your LINE Official Account as a friend - GETgetBotInfo
/v2/bot/infoGet bot info - GETgetGroupMemberProfile
/v2/bot/group/:groupId/member/:userIdGet group chat member profile - GETgetRoomMemberProfile
/v2/bot/room/:roomId/member/:userIdGet multi-person chat member profile - GETgetGroupMembersIds
/v2/bot/group/:groupId/members/idsGet group chat member user IDs - GETgetRoomMembersIds
/v2/bot/room/:roomId/members/idsGet multi-person chat member user IDs - POSTleaveGroup
/v2/bot/group/:groupId/leaveLeave group chat - POSTleaveRoom
/v2/bot/room/:roomId/leaveLeave multi-person chat - GETgetGroupSummary
/v2/bot/group/:groupId/summaryGet group chat summary - GETgetGroupMemberCount
/v2/bot/group/:groupId/members/countGet number of users in a group chat - GETgetRoomMemberCount
/v2/bot/room/:roomId/members/countGet number of users in a multi-person chat - POSTcreateRichMenu
/v2/bot/richmenuCreate rich menu - POSTvalidateRichMenuObject
/v2/bot/richmenu/validateValidate rich menu object - GETgetRichMenu
/v2/bot/richmenu/:richMenuIdGets a rich menu via a rich menu ID. - DELETEdeleteRichMenu
/v2/bot/richmenu/:richMenuIdDeletes a rich menu. - GETgetRichMenuList
/v2/bot/richmenu/listGet rich menu list - POSTsetDefaultRichMenu
/v2/bot/user/all/richmenu/:richMenuIdSet default rich menu - GETgetDefaultRichMenuId
/v2/bot/user/all/richmenuGets the ID of the default rich menu set with the Messaging API. - DELETEcancelDefaultRichMenu
/v2/bot/user/all/richmenuCancel default rich menu - POSTcreateRichMenuAlias
/v2/bot/richmenu/aliasCreate rich menu alias - GETgetRichMenuAlias
/v2/bot/richmenu/alias/:richMenuAliasIdGet rich menu alias information - POSTupdateRichMenuAlias
/v2/bot/richmenu/alias/:richMenuAliasIdUpdate rich menu alias - DELETEdeleteRichMenuAlias
/v2/bot/richmenu/alias/:richMenuAliasIdDelete rich menu alias - GETgetRichMenuAliasList
/v2/bot/richmenu/alias/listGet list of rich menu alias - GETgetRichMenuIdOfUser
/v2/bot/user/:userId/richmenuGet rich menu ID of user - DELETEunlinkRichMenuIdFromUser
/v2/bot/user/:userId/richmenuUnlink rich menu from user - POSTlinkRichMenuIdToUser
/v2/bot/user/:userId/richmenu/:richMenuIdLink rich menu to user. - POSTlinkRichMenuIdToUsers
/v2/bot/richmenu/bulk/linkLink rich menu to multiple users - POSTunlinkRichMenuIdFromUsers
/v2/bot/richmenu/bulk/unlinkUnlink rich menus from multiple users - POSTrichMenuBatch
/v2/bot/richmenu/batchYou 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… - POSTvalidateRichMenuBatchRequest
/v2/bot/richmenu/validate/batchValidate a request body of the Replace or unlink the linked rich menus in batches endpoint. - GETgetRichMenuBatchProgress
/v2/bot/richmenu/progress/batch?requestId=stringGet the status of Replace or unlink a linked rich menus in batches. - POSTissueLinkToken
/v2/bot/user/:userId/linkTokenIssue link token - POSTmarkMessagesAsRead
/v2/bot/message/markAsReadMark messages from users as read - POSTpushMessagesByPhone
/bot/pnp/pushSend LINE notification message - POSTpushTemplatedMessagesByPhone
/v2/bot/message/pnp/templated/pushSend LINE notification message (template) - GETgetPNPMessageStatistics
/v2/bot/message/delivery/pnp?date=stringGet number of sent LINE notification messages - GETgetPNPTemplatedMessageStatistics
/v2/bot/message/delivery/pnp/templated?date=stringGet number of sent LINE notification messages (template) - GETgetMembershipSubscription
/v2/bot/membership/subscription/:userIdGet a user's membership subscription. - GETgetMembershipList
/v2/bot/membership/listGet a list of memberships. - GETgetJoinedMembershipUsers
/v2/bot/membership/:membershipId/users/idsGet a list of user IDs who joined the membership. - GETlistCoupon
/v2/bot/couponGet a paginated list of coupons. - POSTcreateCoupon
/v2/bot/couponCreate a new coupon. Define coupon details such as type, title, and validity period. - GETgetCouponDetail
/v2/bot/coupon/:couponIdGet coupon detail - PUTcloseCoupon
/v2/bot/coupon/:couponId/closeClose coupon - POSTshowLoadingAnimation
/v2/bot/chat/loading/startDisplay a loading animation in one-on-one chats between users and LINE Official Accounts. - POSTmarkMessagesAsReadByToken
/v2/bot/chat/markAsReadMark messages from users as read by token
messaging-api-blob
- GETgetMessageContent
https://api-data.line.me/v2/bot/message/:messageId/contentDownload image, video, and audio data sent from users. - GETgetMessageContentPreview
https://api-data.line.me/v2/bot/message/:messageId/content/previewGet a preview image of the image or video - GETgetMessageContentTranscodingByMessageId
https://api-data.line.me/v2/bot/message/:messageId/content/transcodingVerify the preparation status of a video or audio for getting - GETgetRichMenuImage
https://api-data.line.me/v2/bot/richmenu/:richMenuId/contentDownload rich menu image. - POSTsetRichMenuImage
https://api-data.line.me/v2/bot/richmenu/:richMenuId/contentUpload rich menu image
API details
- Base URL
https://api.line.me- Authentication
- A bearer token in the Authorization header
- Operations
- 75 operations on 67 pathsGET 38POST 31DELETE 4PUT 2
- Main resources
- messaging-api 70messaging-api-blob 5
- Response formats
application/json*/*- Description format
- OpenAPI 3.0.0, API version
0.0.1 - Links
- OpenAPI document
- Listed from
- LINE's published OpenAPI description (line/line-openapi) (Apache-2.0)
How to test the LINE Messaging API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the LINE Messaging API collection, without the publisher's secrets.
- Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “getWebhookEndpoint” (GET /v2/bot/channel/webhook/endpoint), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the LINE Messaging API?
This document describes LINE Messaging API. It is listed under Communication and has 75 endpoints.
Who publishes the LINE Messaging API?
It is listed from Line's public API description (an OpenAPI document), not published by Line on Swastik Codes. Anyone who controls line.biz can claim the profile by adding a DNS TXT record.
What is the base URL of the LINE Messaging API?
Requests go to https://api.line.me. Endpoint paths are added to this base URL.
How do I authenticate with the LINE Messaging API?
With A bearer token in the Authorization header.
How many endpoints does the LINE Messaging API have?
75 operations on 67 paths (38 GET, 31 POST, 4 DELETE, 2 PUT). The largest groups are messaging-api, messaging-api-blob.
Is forking the LINE Messaging API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.