{ "opencollection": "1.0.0", "info": { "name": "Business Messaging API", "version": "1" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Send Message API", "type": "folder" }, "items": [ { "info": { "name": "Send message", "type": "http" }, "http": { "method": "POST", "url": "https://chatapps.8x8.com/api/v1/subaccounts/:subAccountId/messages", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "This endpoint is used to send Messaging Apps messages individually (1 request per message).\nIt is ideal to send single personalized messages for use-cases like notifications or alerting for example.\n\n**For WhatsApp:**\nWhen sending a 'text' type message, we will try to match it with registered WhatsApp templates under your account\nIf matching is successful, the message will be submitted as a template to WhatsApp, if not as a normal message\n\nTo bypass the template matching and send template only, " }, { "info": { "name": "Send message batch", "type": "http" }, "http": { "method": "POST", "url": "https://chatapps.8x8.com/api/v1/subaccounts/:subAccountId/messages/batch", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "* This endpoint is used to send Messaging Apps messages by batches (1 request for multiple messages) with personalized contents/properties. \n* It is ideal to send any kind of massive personalized announcement. \n* Using this API, it is possible to send up to 1,000 messages per request." }, { "info": { "name": "Send Line Notification message", "type": "http" }, "http": { "method": "POST", "url": "https://chatapps.8x8.com/api/v1/subaccounts/:subAccountId/lon", "params": [ { "name": "subAccountId", "value": "", "type": "path", "description": "You must replace *{subAccountId}* with the subaccountid that you want to use. By default this is generated once you signed up with a new account at [https://connect.8x8.com](https://connect.8x8.com)." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "This endpoint is used to send Messaging Apps messages individually (1 request per message).\nIt is ideal to send single personalized messages for use-cases like notifications or alerting for example." }, { "info": { "name": "Send Line Notification message batch", "type": "http" }, "http": { "method": "POST", "url": "https://chatapps.8x8.com/api/v1/subaccounts/:subAccountId/lon/batch", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "* This endpoint is used to send Messaging Apps messages by batches (1 request for multiple messages) with personalized contents/properties. \n* It is ideal to send any kind of massive personalized announcement. \n* Using this API, it is possible to send up to 1,000 messages per request." }, { "info": { "name": "Cancel the scheduled message", "type": "http" }, "http": { "method": "DELETE", "url": "https://chatapps.8x8.com/api/v1/subaccounts/:subAccountId/messages/:umid", "params": [ { "name": "umid", "value": "", "type": "path", "description": "Unique message Id, generated by 8x8 API." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "This resource can be used to cancel a scheduled message that has not been sent yet using the *unique message identifier* (`UMID`) of the message.\n\n### URL\nYou need to specify the *sub-account id* and the *umid* of the message in place of `{subAccountId}` and `{umid}` respectively. \n`umid` is the unique identifier you received when you submitted the message to the API.\n" }, { "info": { "name": "Cancel batch of scheduled message", "type": "http" }, "http": { "method": "DELETE", "url": "https://chatapps.8x8.com/api/v1/subaccounts/:subAccountId/messages/batch/:batchId", "params": [ { "name": "batchId", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "- Sending a DELETE request on this this endpoint allows to **cancel a batch of scheduled messages** that has not been sent yet.\n- This method should be used to cancel a batch of scheduled messages sent by previously submitting a POST request to either the \"many\" or \"many compact\" endpoint.\n- To cancel a batch of scheduled messages, use its *batchId* to target it.\n\n### URL\n* In the original POST request used to schedule the batch of messages, you used a specific subaccountid and the API responde" } ] }, { "info": { "name": "Send Message Event API", "type": "folder" }, "items": [ { "info": { "name": "Send Typing Indicator", "type": "http" }, "http": { "method": "POST", "url": "https://chatapps.8x8.com/api/v1/subaccounts/:subAccountId/events", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "This endpoint is used to send typing indicators to messaging channels. This allows brands to provide real-time feedback to end users, showing that a response is being composed.\nThe `umid` parameter should reference the unique message ID of an inbound message that you are responding to.\n\n**Important:** Typing indicators can only be sent for inbound messages received within the last 2 hours." }, { "info": { "name": "Mark message as read", "type": "http" }, "http": { "method": "POST", "url": "https://chatapps.8x8.com/api/v1/subaccounts/:subAccountId/messages/:umid/read", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "This endpoint is used to indicate to end users that a message has been read by the respective brand or official account. \n\nCurrent channel support: \n- WhatsApp Business account (two blue ticks on customers message). \n" } ] }, { "info": { "name": "Management API", "type": "folder" }, "items": [ { "info": { "name": "Get WhatsApp templates", "type": "http" }, "http": { "method": "GET", "url": "https://chatapps.8x8.com/api/v1/accounts/:accountId/channels/:channelId/templates", "params": [ { "name": "channelId", "value": "", "type": "path", "description": "Channel identifier" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "This endpoint is used to get your registered WhatsApp message template and their approval status. \n\nWhatsApp Message Templates are message formats for common reusable messages a business may want to send. \nBusinesses must use Message Templates for sending notifications to customers.\nAny message sent outside the 24h customer service window, needs to be a template message, to be delivered. \nAdvertising, marketing, or promotional messages are not permitted." }, { "info": { "name": "Add WhatsApp template", "type": "http" }, "http": { "method": "POST", "url": "https://chatapps.8x8.com/api/v1/accounts/:accountId/channels/:channelId/templates", "params": [ { "name": "channelId", "value": "", "type": "path", "description": "Channel identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "This endpoint is used to register new WhatsApp message template.\n\nPlease note that special html entities should be unescaped.\n\nWhatsApp Message Templates are message formats for common reusable messages a business may want to send. \nBusinesses must use Message Templates for sending notifications to customers.\nAny message sent outside the 24h customer service window, needs to be a template message, to be delivered. \nAdvertising, marketing, or promotional messages are not permitted." }, { "info": { "name": "Remove WhatsApp template", "type": "http" }, "http": { "method": "DELETE", "url": "https://chatapps.8x8.com/api/v1/accounts/:accountId/channels/:channelId/templates/:templateName", "params": [ { "name": "accountId", "value": "", "type": "path" }, { "name": "channelId", "value": "", "type": "path" }, { "name": "templateName", "value": "", "type": "path" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "This endpoint is used to remove an existing WhatsApp message template.\n\nWhatsApp Message Templates are message formats for common reusable messages a business may want to send. \nBusinesses must use Message Templates for sending notifications to customers.\nAny message sent outside the 24h customer service window, needs to be a template message, to be delivered. \nAdvertising, marketing, or promotional messages are not permitted." }, { "info": { "name": "Get Call Permission Status", "type": "http" }, "http": { "method": "GET", "url": "https://chatapps.8x8.com/api/v1/whatsapp/subaccounts/:subAccountId/channels/:channelId/callPermissions", "params": [ { "name": "subAccountId", "value": "", "type": "path", "description": "Sub-account identifier" }, { "name": "channelId", "value": "", "type": "path", "description": "Channel identifier" }, { "name": "destination", "value": "+6500000000", "type": "query", "description": "Destination phone number to check call permission status (E.164 format)" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "This endpoint is used to check the status of call permission for a specific destination on WhatsApp. It returns whether the business is allowed to initiate voice calls to the specified phone number." }, { "info": { "name": "Submit WhatsApp Direct Send Sample", "type": "http" }, "http": { "method": "POST", "url": "https://chatapps.8x8.com/api/v1/whatsapp/subaccounts/:subAccountId/channels/:channelId/directSend/sample", "params": [ { "name": "subAccountId", "value": "", "type": "path", "description": "Sub-account identifier" }, { "name": "channelId", "value": "", "type": "path", "description": "Channel identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "This endpoint is used to submit a sample of a WhatsApp Direct Send message to Meta for review and classification.\n\nDirect Send auto-creates WhatsApp templates on the fly and matches incoming messages against them. Submitting sample messages will ensure that the messages you send through Direct Send are accurately classified and transformed into templates that are useful for your use cases.\n\nThe response indicates whether the sample was processed successfully and the category Meta assigned to it." }, { "info": { "name": "Get WhatsApp Flows", "type": "http" }, "http": { "method": "GET", "url": "https://chatapps.8x8.com/api/v1/accounts/:accountId/channels/:channelId/flows", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "You must replace *{accountId}* with the accountid that you want to use." }, { "name": "channelId", "value": "", "type": "path", "description": "Channel identifier" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of flows to return" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "This endpoint is used to retrieve the list of WhatsApp Flows and their status for the channel." }, { "info": { "name": "Create WhatsApp Flow", "type": "http" }, "http": { "method": "POST", "url": "https://chatapps.8x8.com/api/v1/accounts/:accountId/channels/:channelId/flows", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "You must replace *{accountId}* with the accountid that you want to use." }, { "name": "channelId", "value": "", "type": "path", "description": "Channel identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "This endpoint is used to create a new WhatsApp Flow.\n\nWhatsApp Flows are interactive experiences that businesses can use to collect information from customers through WhatsApp conversations. Flows provide a structured way to guide users through multi-step processes like booking appointments, collecting feedback, or processing orders." }, { "info": { "name": "Get WhatsApp Flow details", "type": "http" }, "http": { "method": "GET", "url": "https://chatapps.8x8.com/api/v1/accounts/:accountId/channels/:channelId/flows/:flowId", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "You must replace *{accountId}* with the accountid that you want to use." }, { "name": "channelId", "value": "", "type": "path", "description": "Channel identifier" }, { "name": "flowId", "value": "", "type": "path", "description": "Flow identifier" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "This endpoint is used to retrieve details of a specific WhatsApp Flow.\n\nWhatsApp Flows are interactive experiences that businesses can use to collect information from customers through WhatsApp conversations. This endpoint returns comprehensive information about a flow including its current status, validation errors, and flow JSON URL." }, { "info": { "name": "Update WhatsApp Flow", "type": "http" }, "http": { "method": "PUT", "url": "https://chatapps.8x8.com/api/v1/accounts/:accountId/channels/:channelId/flows/:flowId", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "You must replace *{accountId}* with the accountid that you want to use." }, { "name": "channelId", "value": "", "type": "path", "description": "Channel identifier" }, { "name": "flowId", "value": "", "type": "path", "description": "Flow identifier" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "This endpoint is used to update an existing WhatsApp Flow. The flow must be in draft state.\n\nWhatsApp Flows are interactive experiences that businesses can use to collect information from customers through WhatsApp conversations. This endpoint allows you to update flow properties including name, categories, flow JSON definition, endpoint URI, and application ID.\n\nAt least one property must be present in the request body." }, { "info": { "name": "Delete WhatsApp Flow", "type": "http" }, "http": { "method": "DELETE", "url": "https://chatapps.8x8.com/api/v1/accounts/:accountId/channels/:channelId/flows/:flowId", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "You must replace *{accountId}* with the accountid that you want to use." }, { "name": "channelId", "value": "", "type": "path", "description": "Channel identifier" }, { "name": "flowId", "value": "", "type": "path", "description": "Flow identifier" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "This endpoint is used to delete a WhatsApp Flow.\n\nOnly flows that are not published can be deleted. If a flow has been published, it cannot be deleted and the API will return an error. This operation is permanent and cannot be undone." }, { "info": { "name": "Preview WhatsApp Flow", "type": "http" }, "http": { "method": "GET", "url": "https://chatapps.8x8.com/api/v1/accounts/:accountId/channels/:channelId/flows/:flowId/preview", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "You must replace *{accountId}* with the accountid that you want to use." }, { "name": "channelId", "value": "", "type": "path", "description": "Channel identifier" }, { "name": "flowId", "value": "", "type": "path", "description": "Flow identifier" }, { "name": "refresh", "value": "", "type": "query", "description": "Set to `true` to force Meta to regenerate the preview. Defaults to `false`." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "This endpoint is used to generate a preview URL for a WhatsApp Flow.\n\nThe preview allows you to visualize and interact with your flow before publishing it. You can force regeneration of the preview by setting the `refresh` query parameter to `true`.\n\nFor interactive previews with custom parameters, you can add query parameters to the generated preview URL. For a list of supported query parameters, refer to the 'Visualizing and interacting with your Flow using the Web Preview' section of the [Wha" }, { "info": { "name": "Publish WhatsApp Flow", "type": "http" }, "http": { "method": "POST", "url": "https://chatapps.8x8.com/api/v1/accounts/:accountId/channels/:channelId/flows/:flowId/publish", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "You must replace *{accountId}* with the accountid that you want to use." }, { "name": "channelId", "value": "", "type": "path", "description": "Channel identifier" }, { "name": "flowId", "value": "", "type": "path", "description": "Flow identifier" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "This endpoint is used to publish a WhatsApp Flow.\n\nPublishing a flow makes it available for use in WhatsApp conversations. Once published, the flow can be sent to customers through WhatsApp messages(Template message and Interactive messages). A flow must be in DRAFT status and pass all validations before it can be published." }, { "info": { "name": "Deprecate WhatsApp Flow", "type": "http" }, "http": { "method": "POST", "url": "https://chatapps.8x8.com/api/v1/accounts/:accountId/channels/:channelId/flows/:flowId/deprecate", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "You must replace *{accountId}* with the accountid that you want to use." }, { "name": "channelId", "value": "", "type": "path", "description": "Channel identifier" }, { "name": "flowId", "value": "", "type": "path", "description": "Flow identifier" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "This endpoint is used to deprecate a WhatsApp Flow.\n\nDeprecating a flow marks it as no longer recommended for use, but keeps it accessible for existing integrations. This allows you to phase out a flow gracefully without breaking active implementations. Once deprecated, the flow status will be updated to reflect its deprecated state." } ] }, { "info": { "name": "Reporting API", "type": "folder" }, "items": [ { "info": { "name": "Start log export job", "type": "http" }, "http": { "method": "POST", "url": "https://chatapps.8x8.com/api/v1/subaccounts/:subAccountId/messages/exports", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "* Sending a **POST** request on this endpoint allows to **request an Messaging Apps logs file**.\n\n## URL\n\nThe 8x8 Messaging Apps `subAccountId` needs to be provided in the URL as shown below:\n`https://chatapps.8x8.com/api/v1/subaccounts/{subAccountID}/messages/exports`\n\n*You must replace `{subAccountId}` in the URL above with the subaccountid that you want to use.*" }, { "info": { "name": "Get log export job result", "type": "http" }, "http": { "method": "GET", "url": "https://chatapps.8x8.com/api/v1/subaccounts/:subAccountId/messages/exports/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "Export job identifier" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "* Sending a **GET** request on this endpoint allows to **check the status of an Messaging Apps Logs export job** and to **get a download link** if its generation has succeeded.\n\n \n\n## URL\n\nTo define which SMS logs export you want to retrieve, you need to enter the Job ID generated by XXXXX in the path as well as the 8x8 SMS subaccountid you used in the previous request.\n`https://chatapps.8x8.com/api/v1/subaccounts/{subAccountID}/messages/exports/{jobId}`\n\n*You must replace `{jobID}` and `{subA" }, { "info": { "name": "Cancel the log export job ", "type": "http" }, "http": { "method": "DELETE", "url": "https://chatapps.8x8.com/api/v1/subaccounts/:subAccountId/messages/exports/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "Export job identifier" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "* Sending a **DELETE** request on this endpoint allows to **cancel a Messaging Apps Logs export job**.\n\n \n\n## URL\n\nTo define which SMS logs export you want to retrieve, you need to enter the Job ID generated by XXXXX in the path as well as the 8x8 SMS subaccountid you used in the previous request.\n`https://chatapps.8x8.com/api/v1/subaccounts/{subAccountID}/messages/exports/{jobId}`\n\n*You must replace `{jobID}` and `{subAccountId}` in the URL above with the jobID and subaccountid from the start" }, { "info": { "name": "Retrieve message details", "type": "http" }, "http": { "method": "GET", "url": "https://chatapps.8x8.com/api/v1/subaccounts/:subAccountId/messages/:umid", "params": [ { "name": "umid", "value": "", "type": "path", "description": "Unique message Id, generated by 8x8 API." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "This resource can be used to query message details like delivery status using the UMID of the message. You need to specify the sub account id and the umid of the message in place of *{subAccountId}* and *{umid}* respectively. *umid* is the unique identifier (in the form of a uuid) you received when you submitted the message to the api.\n\n### API Rate Limiting\nTo protect the platform from being overloaded and maintain a high quality of service to all customers, we enforce API rate limits for this " }, { "info": { "name": "Get message usage", "type": "http" }, "http": { "method": "GET", "url": "https://chatapps.8x8.com/api/v1/accounts/:accountId/usage/messages", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "You must replace *{accountId}* with the account ID that you want to use." }, { "name": "billingPeriod", "value": "", "type": "query", "description": "The billing month to query, in `YYYY-MM` format (e.g. `2026-03`). Must be a closed billing period from February 2026 or later. Maximum lookback is 6 months." }, { "name": "channel", "value": "", "type": "query", "description": "Filter results by messaging channel. Currently, only `whatsapp` is supported. Defaults to `whatsapp` if omitted." }, { "name": "groupBy", "value": "", "type": "query", "description": "Comma-separated list of dimensions to group results by. When omitted, a single aggregated total is returned. `pricing` is included when `groupBy` contains `channel`, `businessAccountId`, `pricingCategory`, and `country`.\n\nAvailable values: `subAccountId`, `channel`, `businessAccountId`, `pricingCategory`, `country`." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Returns monthly per-message usage totals for the specified billing period. Results can be filtered and grouped by subaccount, business account, channel, pricing category, and destination country.\n\nCurrently, only WhatsApp is supported.\n\n**Constraints:**\n- Data is available from **February 2026** onwards\n- Only **closed billing periods** can be queried\n- Maximum lookback: **6 months**\n\n**Grouping behavior:**\n- If `groupBy` is omitted, a single aggregated total is returned\n- `pricing` is included " } ] }, { "info": { "name": "Webhook Configuration API", "type": "folder" }, "items": [ { "info": { "name": "Get all Webhooks for Account", "type": "http" }, "http": { "method": "GET", "url": "https://chatapps.8x8.com/api/v1/accounts/:accountId/webhooks", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "You must replace *{accountId}* with the accountid that you want to use." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Sending a GET request on this endpoint allows to **retrieve a list of all the webhooks or a specific webhook configured for an account**." }, { "info": { "name": "Create or Replace webhooks", "type": "http" }, "http": { "method": "POST", "url": "https://chatapps.8x8.com/api/v1/accounts/:accountId/webhooks", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "You must replace *{accountId}* with the accountid that you want to use." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Sending a POST request on this endpoint allows to **add a new webhook for an account or modify the configuration of an existing one** . \n\nWebhooks can be given an account-wide and/or a type-wide scope using the \\* character \n\nFor example: if a webhook is created with subAccount=\\* , this webhook will receive events across all the subaccounts of an account." }, { "info": { "name": "Delete webhooks", "type": "http" }, "http": { "method": "DELETE", "url": "https://chatapps.8x8.com/api/v1/accounts/:accountId/webhooks", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "You must replace *{accountId}* with the accountid that you want to use." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Sending a DELETE request on this endpoint allows to **remove a configured webhook for an account or a subaccount** ." } ] }, { "info": { "name": "File Upload API", "type": "folder" }, "items": [ { "info": { "name": "Upload file", "type": "http" }, "http": { "method": "POST", "url": "https://chatapps.8x8.com/api/v1/subaccounts/:subAccountId/files", "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" } ] } }, "docs": "Upload file" }, { "info": { "name": "Download file", "type": "http" }, "http": { "method": "GET", "url": "https://chatapps.8x8.com/files/:filename", "params": [ { "name": "filename", "value": "", "type": "path", "description": "File name with extension" }, { "name": "token", "value": "", "type": "query", "description": "File token" } ] }, "docs": "Download file" } ] } ], "bundled": true }