# 8x8 Developer Portal > APIs, SDKs, guides, and integration resources for the 8x8 platform This file contains links to documentation sections following the llmstxt.org standard. ## Table of Contents - [Contact Center Data Augmentation API](https://developer.8x8.com/actions-events/docs/8x8-contact-center-data-augmentation-api): The Data Augmentation API allows you to enrich interaction data with custom variables collected from web forms, IVR systems, CRM data, or any exter... - [API Key](https://developer.8x8.com/actions-events/docs/api-key): You can obtain an API key using your [8x8 Admin Console](https://admin.8x8.com/) implementation. - [Button theming](https://developer.8x8.com/actions-events/docs/button-theming): You can change both the primary and secondary colours on the chat widget, either globally across each of the parts of the widget — invitation/form/... - [Authentication](https://developer.8x8.com/actions-events/docs/cc-campaigns/authentication): :::warning BETA - [Add Records](https://developer.8x8.com/actions-events/docs/cc-campaigns/endpoints/add-records): :::warning BETA - [Modify Campaign](https://developer.8x8.com/actions-events/docs/cc-campaigns/endpoints/modify-campaign): :::warning BETA - [Endpoints](https://developer.8x8.com/actions-events/docs/cc-campaigns/endpoints): :::warning BETA - [Field Reference](https://developer.8x8.com/actions-events/docs/cc-campaigns/field-reference): :::warning BETA - [Getting Started](https://developer.8x8.com/actions-events/docs/cc-campaigns/getting-started): :::warning BETA - [Overview](https://developer.8x8.com/actions-events/docs/cc-campaigns/overview): :::warning BETA - [Campaign State Machine](https://developer.8x8.com/actions-events/docs/cc-campaigns/state-machine): :::warning BETA - [Troubleshooting](https://developer.8x8.com/actions-events/docs/cc-campaigns/troubleshooting): :::warning BETA - [CC Manage Phone Calls](https://developer.8x8.com/actions-events/docs/cc-manage-phone-calls): CC Phone Call APIs leverage the credentials from the Integration >> API Token area in Configuration Manager. - [CC Managing Agent Status](https://developer.8x8.com/actions-events/docs/cc-managing-agent-status): This guide describes how to manage agent status via API - [CC Managing Campaign Records](https://developer.8x8.com/actions-events/docs/cc-managing-campaign-records): > ⚠️ **Beta customers — use the new Contact Center Campaigns API** - [CC Managing Campaign Status](https://developer.8x8.com/actions-events/docs/cc-managing-campaign-status): > ⚠️ **Beta customers — use the new Contact Center Campaigns API** - [Channel](https://developer.8x8.com/actions-events/docs/channel): After creating a webhook you can then create a channel. The channel contains a webhook that passes the outbound messages and notifications. - [API Key](https://developer.8x8.com/actions-events/docs/chat-api-key): You can now get an API key via the 8x8 [Admin Console.](https://admin.8x8.com) - [Chat Gateway](https://developer.8x8.com/actions-events/docs/chat-gateway): The 8x8 Contact Center Chat Gateway enables you to provide chat services with your chat app and chatbot. - [Chat Language](https://developer.8x8.com/actions-events/docs/chat-language): Using the webchat, you may have a customer that is comforable speaking in their own language, so we offer realtime translation on this chat, you ca... - [Things you should know](https://developer.8x8.com/actions-events/docs/chat-things-you-should-know): Here are some things you should know about interacting with the Chat API: - [Workflow - Connecting 3rd party channel](https://developer.8x8.com/actions-events/docs/chat-workflow): To use the Chat Gateway you must have the following: - [Content Security Policy](https://developer.8x8.com/actions-events/docs/content-security-policy): CSP directives a customer's website needs to embed the 8x8 WebChat v2 widget. - [Conversation](https://developer.8x8.com/actions-events/docs/conversation): After you have created: - [Customer information](https://developer.8x8.com/actions-events/docs/customer-information): Using this option, customer specific information can be sent from a website, into the webchat widget, which can then be forwarded onto an agent, bu... - [Dark mode example](https://developer.8x8.com/actions-events/docs/dark-mode-example): Here, is a full script example, of where the colours have been configured so it shows in dark mode - [End chat](https://developer.8x8.com/actions-events/docs/end-chat): There are scenarios where you may need to programmatically end a webchat session from your website. For example, when a customer navigates away fro... - [Event callbacks](https://developer.8x8.com/actions-events/docs/event-callbacks): The webchat widget emits lifecycle events as the chat progresses through different stages. Using the `setProxy()` method, you can register callback... - [Getting Started with 8x8 Chat](https://developer.8x8.com/actions-events/docs/getting-started-chapi): Chapi is what we call our Chat API. It allows you to send and fetch messages from an 8x8 Work chat room. - [Glossary of theming items](https://developer.8x8.com/actions-events/docs/glossary-of-theming-items): | Chat Theme Property | Example value | Description | - [Introduction](https://developer.8x8.com/actions-events/docs/introduction): Welcome to the XCaaS Actions & Events Developer hub. You'll find comprehensive guides and documentation to help you start working with XCaaS Action... - [Invitation quick replies](https://developer.8x8.com/actions-events/docs/invitation-quick-replies): When using the chat invitation, you can configure quick reply suggestions that are displayed to the customer. These are predefined response options... - [Key Elements](https://developer.8x8.com/actions-events/docs/key-elements): Before getting started using the Chat Gateway, we recommend familiarizing yourself with the concepts and chat elements that you will be working wit... - [Streaming API Overview (Legacy)](https://developer.8x8.com/actions-events/docs/legacy-streaming-api-overview): Generally the Streaming API should be considered only when alternate approaches are not capable of meeting the needs. For general analytic, non rea... - [Notification sound](https://developer.8x8.com/actions-events/docs/notification-sound): By default, the webchat widget plays a sound when a new message arrives. Using the `setNotificationSoundToggle()` method, you can control whether t... - [Reset customer information](https://developer.8x8.com/actions-events/docs/reset-customer-information): If you have previously set customer information using `setCustomerInfo()`, you may need to clear it. For example, when a different customer logs in... - [Set chat variables](https://developer.8x8.com/actions-events/docs/set-chat-variables): Variables can be sent into the widget for a number of reasons. The first is so they can be used to update data in the 8x8 Native CRM, for example s... - [Authentication](https://developer.8x8.com/actions-events/docs/streaming/authentication): The 8x8 Event Streaming service supports two types of authentication credentials, depending on how you obtain them and which 8x8 system you're using. - [Connection Guide](https://developer.8x8.com/actions-events/docs/streaming/connection): Connect to the 8x8 Event Streaming service using WebSocket. - [Event Lifecycle](https://developer.8x8.com/actions-events/docs/streaming/event-lifecycle): Understanding how events flow through an interaction's lifecycle helps you build robust integrations and accurately track interaction progress. - [Event Reference](https://developer.8x8.com/actions-events/docs/streaming/event-reference): This page provides a complete catalog of all event types available in the 8x8 Event Streaming service, organized by category, along with detailed J... - [Browser Client Example](https://developer.8x8.com/actions-events/docs/streaming/examples/browser): Web-based tool for testing, debugging, and monitoring 8x8 Event Streams in real-time. - [Go Client Example](https://developer.8x8.com/actions-events/docs/streaming/examples/golang): This page provides a complete Go implementation for connecting to the 8x8 Event Streaming service. - [Java Client Example](https://developer.8x8.com/actions-events/docs/streaming/examples/java): This page provides a complete Java implementation for connecting to the 8x8 Event Streaming service. - [Node.js Client Example](https://developer.8x8.com/actions-events/docs/streaming/examples/nodejs): This page provides a complete Node.js implementation for connecting to the 8x8 Event Streaming service. - [Python Client Example](https://developer.8x8.com/actions-events/docs/streaming/examples/python): This page provides a complete Python implementation for connecting to the 8x8 Event Streaming service. - [Field Reference](https://developer.8x8.com/actions-events/docs/streaming/field-reference): This page provides detailed documentation for all fields that appear in event payloads, including field value codes, transformations, and the compr... - [Getting Started](https://developer.8x8.com/actions-events/docs/streaming/getting-started): Required: - [Message Format](https://developer.8x8.com/actions-events/docs/streaming/message-format): Structure of messages received from the 8x8 Event Streaming service. - [Migration Guide](https://developer.8x8.com/actions-events/docs/streaming/migration): This guide helps you transition from the legacy Streaming API (SAPI) to the new Apache Pulsar-based Event Streaming service. - [Overview](https://developer.8x8.com/actions-events/docs/streaming/overview): 8x8 Event Streaming provides a real-time stream of events from your 8x8 platform. - [Troubleshooting](https://developer.8x8.com/actions-events/docs/streaming/troubleshooting): Common issues when connecting to the 8x8 Event Streaming service. - [Theming](https://developer.8x8.com/actions-events/docs/theming): After configuring your web flow, you may want to be able to change the configuration of your invitation, form, window, while you can do this within... - [Trigger webchat](https://developer.8x8.com/actions-events/docs/trigger-webchat): There are occasions, where you might want to trigger the webchat yourself. - [Troubleshooting](https://developer.8x8.com/actions-events/docs/troubleshooting): You can access the **Event Log** in **[Configuration Manager](https://docs.8x8.com/8x8WebHelp/VCC/configuration-manager-general/content/cfgoverview... - [Validating Webhook Events](https://developer.8x8.com/actions-events/docs/validating-webhook-events): The Webhook events HTTP **`POST`** requests have custom headers containing the digital signature of the event that enable you to establish: - [Introduction and Use Cases](https://developer.8x8.com/actions-events/docs/webchat-api-introduction): The webchat API, also known as Embedded Chat API, allows configuration via the webchat script that meet some of the following use cases. All method... - [Webchat script](https://developer.8x8.com/actions-events/docs/webchat-script): Once you have created the webchat script, when you select the code, it will look like this, which is what will be added to the website for it to work - [Webhooks](https://developer.8x8.com/actions-events/docs/webhooks-2): Before you can set up your Chat channel, you must first create a Webhook. Whenever an agent adds a message to a conversation that you create using ... - [Webhooks Events Reference](https://developer.8x8.com/actions-events/docs/webhooks-events-reference): Webhook events are how 8x8 notifies bots or integrations when something happens in a conversation, such as when an agent sends a message, a member ... - [8x8 Contact Center Call API Reference](https://developer.8x8.com/actions-events/reference/8-x-8-contact-center-call-api-reference.info): The 8x8 Contact Center Call API facilitates contact center management of agent calls. Using the Call API you can designate a specific agent to eith... - [8x8 Contact Center Chat API V2](https://developer.8x8.com/actions-events/reference/8-x-8-contact-center-chat-api-v-2.info): Integration with the 8x8 Contact Center (CC) Chat API enables you to: - [8x8 Contact Center Dynamic Campaigns](https://developer.8x8.com/actions-events/reference/8-x-8-contact-center-dynamic-campaigns.info): The 8x8 Contact Center Dynamic Campaigns API: - [Add records to campaign](https://developer.8x8.com/actions-events/reference/add-records.api): Add one or more records (1-100) to a dynamic campaign. Records are validated, CRM data is queried, and phone numbers are checked against DNC lists.... - [Ammends the transaction codes for both an interaction and the associated agent.](https://developer.8x8.com/actions-events/reference/add-transaction-codes.api): Ammends the transaction codes for both an interaction and the associated agent. - [Add an attachment.](https://developer.8x8.com/actions-events/reference/addconversationattachments.api): Add an attachment that you can later use as a reference when adding a message to the conversation. - [Add a new customer to an existing campaign](https://developer.8x8.com/actions-events/reference/addcustomer.api): Add a new customer to an existing campaign **Note: the campaign must be have dynamic campaign enabled to leverage this feature** - [The change status for an existing campaign.](https://developer.8x8.com/actions-events/reference/changecampaignstatus.api): The change status for an existing campaign. **Note: the campaign must be have dynamic campaign enabled to leverage this feature** - [Chapi - Chat API](https://developer.8x8.com/actions-events/reference/chapi-chat-api.info): 8x8 Work Chat API - [Contact Center Agent Status API](https://developer.8x8.com/actions-events/reference/contact-center-agent-status-api.info): The 8x8 Contact Center Get/Set Agent Status API enables you to set an agent's status or availability in your contact center. You can set the status... - [Contact Center Campaigns API](https://developer.8x8.com/actions-events/reference/contact-center-campaigns-api.info): Use the Campaign Management API to control the lifecycle of outbound campaigns and dynamically inject records for dialling from your own systems. - [Contact Center Chat Gateway](https://developer.8x8.com/actions-events/reference/contact-center-chat-gateway.info): Integration with the 8x8 Contact Center (CC) Chat API - [Creates a new access token that can be used for API access.](https://developer.8x8.com/actions-events/reference/createaccesstoken.api): Creates a new access token that can be used for API access. - [Creates a new conversation.](https://developer.8x8.com/actions-events/reference/createcctransaction-1.api): Creates a new transaction in the Contact Center and returns a conversation Id as an identifier that can be used later on to send messages to agent ... - [Creates a new conversation.](https://developer.8x8.com/actions-events/reference/createcctransaction.api): Creates a new transaction in the Contact Center and returns a conversation Id as an identifier that can be used later on to send messages to agent ... - [Creates a channel.](https://developer.8x8.com/actions-events/reference/createchatapichannel-1.api): Create a new channel for a customer. - [Creates a channel.](https://developer.8x8.com/actions-events/reference/createchatapichannel.api): Create a new channel for a customer. - [Creates a post agent assignment for a conversation.](https://developer.8x8.com/actions-events/reference/createpostagentassignment.api): Creates a post-agent assignment for a conversation. This endpoint allows the conversation to be handed back to the bot after an agent finishes thei... - [Creates a new customer webhook.](https://developer.8x8.com/actions-events/reference/createwebhook-1.api): Creates a new customer webhook. - [Creates a new customer webhook.](https://developer.8x8.com/actions-events/reference/createwebhook.api): Creates a new customer webhook. - [Customers leaves conversation.](https://developer.8x8.com/actions-events/reference/customerparticipantleavecctransaction.api): When customers leave a conversation. It translates to a current interaction that is being terminated by the customer. - [Ends a phone call based on the interactionId.](https://developer.8x8.com/actions-events/reference/delete-phone-interaction.api): Ends a phone call based on the interactionId. - [Delete ChatAPI channel by Id.](https://developer.8x8.com/actions-events/reference/deletechatapichannelbyid-1.api): Deletes ChatAPI channel by the provided Id. - [Delete ChatAPI channel by Id.](https://developer.8x8.com/actions-events/reference/deletechatapichannelbyid.api): Deletes ChatAPI channel by the provided Id. - [This method deletes customers from an existing campaign.](https://developer.8x8.com/actions-events/reference/deletecustomer.api): This method deletes a customer from an existing campaign. You can delete new, queued, or scheduled customers. You should not delete customers that ... - [Deletes the webhook by Id.](https://developer.8x8.com/actions-events/reference/deletewebhookbyid-1.api): Deletes the webhook by Id. - [Deletes the webhook by Id.](https://developer.8x8.com/actions-events/reference/deletewebhookbyid.api): Deletes the webhook by Id. - [Download attachment.](https://developer.8x8.com/actions-events/reference/downloadattachmentforchatapiconversation.api): Download attachment contents. - [Obtain the status for tenant agents. Agents can be filtered by group. Pagination is currently not available.](https://developer.8x8.com/actions-events/reference/getagentsstatus.api): Obtain the status for tenant agents. Agents can be filtered by group. Pagination is currently not available. - [Obtains the status for a specific agent.](https://developer.8x8.com/actions-events/reference/getagentstatus.api): Obtains the status for a specific agent. - [Retrieves the list of conversation message cards.](https://developer.8x8.com/actions-events/reference/getcardsforcctransaction.api): Retrieves list of conversation message cards. Either Adaptive Cards or Quick Replies. - [Returns all conversations belonging to the customer.](https://developer.8x8.com/actions-events/reference/getccinteractions.api): Returns a list of all conversations belonging to the customer that comply with the provided filters. - [Retrieves conversation details.](https://developer.8x8.com/actions-events/reference/getcctransaction-1.api): Retrieves conversation details. - [Retrieves conversation details.](https://developer.8x8.com/actions-events/reference/getcctransaction.api): Retrieves conversation details. - [Returns all conversations belonging to the customer.](https://developer.8x8.com/actions-events/reference/getcctransactions-1.api): Returns a list of all conversations belonging to the customer that comply with the provided filters. - [Returns all conversations belonging to the customer.](https://developer.8x8.com/actions-events/reference/getcctransactions.api): Returns a list of all conversations belonging to the customer that comply with the provided filters. - [Get ChatAPI channel by Id.](https://developer.8x8.com/actions-events/reference/getchatapichannel-1.api): Retrieves ChatAPI channel by Id. - [Get ChatAPI channel by Id.](https://developer.8x8.com/actions-events/reference/getchatapichannel.api): Retrieves ChatAPI channel by Id. - [Retrieves all customer Chat API channels.](https://developer.8x8.com/actions-events/reference/getchatapichannels-1.api): Retrieves all customer Chat API channels based on the provided access token information. - [Retrieves all customer Chat API channels.](https://developer.8x8.com/actions-events/reference/getchatapichannels.api): Retrieves all customer Chat API channels based on the provided access token information. - [Get an attachment from Conversation.](https://developer.8x8.com/actions-events/reference/getconversationattachment.api): Get an attachment from conversation along with their details. - [Get attachments in Conversation.](https://developer.8x8.com/actions-events/reference/getconversationattachments.api): Get all attachments added to the conversation along with their details. - [Returns the public JWK.](https://developer.8x8.com/actions-events/reference/getjwkpublickey-1.api): Returns the public JWK that can be used to validate the message signature. - [Returns the public JWK.](https://developer.8x8.com/actions-events/reference/getjwkpublickey.api): Returns the public JWK that can be used to validate the message signature. - [Retrieves the conversation messages.](https://developer.8x8.com/actions-events/reference/getmessagebyidforcctransaction.api): Retrieves the conversation messages that took place during the lifespan of the conversation. - [Retrieves the conversation messages.](https://developer.8x8.com/actions-events/reference/getmessagesforcctransaction-1.api): Retrieves the conversation messages that took place during the lifespan of the conversation. - [Retrieves the conversation messages.](https://developer.8x8.com/actions-events/reference/getmessagesforcctransaction.api): Retrieves the conversation messages that took place during the lifepan of the conversation. - [Fetches messages for a room. Defaults to `CHAPI sandbox` room.](https://developer.8x8.com/actions-events/reference/getmessagesusingget-1.api): Fetches a list of messages from the room. - [Retrieve the conversation participants.](https://developer.8x8.com/actions-events/reference/getparticipantsforcctransaction-1.api): Retrieves all the participants that joined during the lifespan of the conversation. - [Retrieve the conversation participants.](https://developer.8x8.com/actions-events/reference/getparticipantsforcctransaction.api): Retrieves all the participants that joined during the lifespan of the conversation. - [Get webhook by Id.](https://developer.8x8.com/actions-events/reference/getwebhookbyid-1.api): Retrieves the webhook by the provided Id. - [Get webhook by Id.](https://developer.8x8.com/actions-events/reference/getwebhookbyid.api): Retrieves the webhook by the provided Id. - [Retrieves all customer webhooks based on the associated token information.](https://developer.8x8.com/actions-events/reference/getwebhooks-1.api): Retrieves all customer webhooks based on the associated token information. - [Retrieves all customer webhooks based on the associated token information.](https://developer.8x8.com/actions-events/reference/getwebhooks.api): Retrieves all customer webhooks based on the associated token information. - [Hangs up the call for an agent. If the call is a conference or call was transferred it will not hang up for the other participants.](https://developer.8x8.com/actions-events/reference/hangup-agent-handling-interaction.api): Hangs up the call for an agent. If the call is a conference or call was transferred it will not hang up for the other participants. - [Frees up a telephone line for the specified agent in preparation for the next call.](https://developer.8x8.com/actions-events/reference/hangup-agent-line.api): Frees up a telephone line for the specified agent in preparation for the next call. - [Frees up the agent lines in preparation to take the next call.](https://developer.8x8.com/actions-events/reference/hangup-agent-lines.api): Frees up the agent lines in preparation to take the next call. - [Modify campaign state](https://developer.8x8.com/actions-events/reference/modify-campaign.api): Change campaign state. State transitions are validated and must follow allowed state machine rules. - [Patch a conversation details.](https://developer.8x8.com/actions-events/reference/patchcctransaction.api): Patch a conversation details. - [Creates an agent assigned outbound phone interaction for calling the desired number.](https://developer.8x8.com/actions-events/reference/place-phone-call.api): Creates an agent assigned outbound phone interaction for calling the desired number. - [Update a conversation details.](https://developer.8x8.com/actions-events/reference/putcctransaction.api): Update a conversation details. - [Send a message.](https://developer.8x8.com/actions-events/reference/sendmessagetocctransaction-1.api): Send a message to a conversation represented by the provided ID. - [Send a message.](https://developer.8x8.com/actions-events/reference/sendmessagetocctransaction.api): Send a message to a conversation represented by the provided ID. - [Send a message to a public chat room.](https://developer.8x8.com/actions-events/reference/sendmessageusingpost.api): This will send a message to a room. If the room does not exist Chapi will create the room, then send the message to it. This endpoint is unable to ... - [Sends a read receipt for a conversation.](https://developer.8x8.com/actions-events/reference/sendreadreceipt.api): Sends a read receipt to the Chalet room associated with the given conversation, indicating that all messages up to the given timestamp have been re... - [Sends a thinking indicator for a conversation.](https://developer.8x8.com/actions-events/reference/sendthinkingindicator.api): Sends a thinking indicator notification to the Chalet backplane room-update resource, signaling that the bot is processing. The request body is opt... - [Creates a typing indicator for a conversation.](https://developer.8x8.com/actions-events/reference/sendtypingindicator.api): Sends a typing indicator to the Chalet room associated with the given conversation. Requires an authorType of either 'user' or 'bot' to determine ... - [The bulk operation for setting the status for multiple agents.](https://developer.8x8.com/actions-events/reference/setagentsstatuses.api): Setting the status for multiple agents at the same time. - [Sets the agent status for a specific agent.](https://developer.8x8.com/actions-events/reference/setagentstatus.api): Sets the agent status for a specific agent. - [Sends the adaptive card action execute.](https://developer.8x8.com/actions-events/reference/updatecardactionexecute.api): Updates the adaptive card action execute flag and sends the activity notification. - [Sends the adaptive card action submit.](https://developer.8x8.com/actions-events/reference/updatecardactionsubmit.api): Updates the adaptive card action submit flag and sends the activity notification. - [Update ChatAPI channel by Id.](https://developer.8x8.com/actions-events/reference/updatechatapichannel-1.api): Update ChatAPI channel by Id. - [Update ChatAPI channel by Id.](https://developer.8x8.com/actions-events/reference/updatechatapichannel.api): Update ChatAPI channel by Id. - [Updates the full webhook resource by Id.](https://developer.8x8.com/actions-events/reference/updatewebhook-1.api): Updates the full webhook resource by Id. - [Updates the full webhook resource by Id.](https://developer.8x8.com/actions-events/reference/updatewebhook.api): Updates the full webhook resource by Id. - [User leaves conversation.](https://developer.8x8.com/actions-events/reference/userparticipantleavecctransaction.api): When user leave a conversation. It translates to a current interaction that is being terminated by the user. - [The endpoint used to validate that the webhook is working and reachable.](https://developer.8x8.com/actions-events/reference/verifywebhook-1.api): Validates the webhook URL endpoint from the connectivity point-of-view by sending a hello message and a 2xx success status code. - [The endpoint used to validate that the webhook is working and reachable.](https://developer.8x8.com/actions-events/reference/verifywebhook.api): Validates the webhook URL endpont from the connectivity point-of-view by sending a hello message and a 2xx success status code. - [Clarified API versioning header guidance](https://developer.8x8.com/administration/_changelog/2026-07-01-versioning-header-guidance): Clarified the [API Versioning](/administration/docs/suite-common#api-versioning) guidance for the - [Targeted ring group membership updates](https://developer.8x8.com/administration/_changelog/2026-07-03-ring-group-membership-updates): The Ring Group Management API adds a new endpoint for targeted membership changes: - [Administration API Changelog](https://developer.8x8.com/administration/changelog): Change history for the Administration API Suite. - [API Change Policy](https://developer.8x8.com/administration/docs/api-change-policy): **Last Updated:** December 23, 2025 - [Administration API Reference](https://developer.8x8.com/administration/docs/api-reference-overview): :::warning BETA - Limited Access - [Contact Object Structure](https://developer.8x8.com/administration/docs/contact-object-structure-guide): This section is dedicated to the Contact object structure, which is a central element in contact management. This guide will help you understand th... - [Contact Management](https://developer.8x8.com/administration/docs/create-contact): Our Contact API allows you to add new contacts into the system. This section guides you through the steps to create a contact. Before you start, ma... - [Introduction](https://developer.8x8.com/administration/docs/overview): :::warning BETA - Limited Access - [Phone Number Management API Guide](https://developer.8x8.com/administration/docs/phone-number-management-api-guide): import TabbedExternalCodeSample from '@site/docusaurus/components/TabbedExternalCodeSample'; - [Ring Group Management API Guide](https://developer.8x8.com/administration/docs/ring-group-management-api-guide): **API Version**: 1.0 | **Last Updated**: July 1, 2026 | **Part of**: [Administration API Suite](./suite-common.mdx) - [Contact Search](https://developer.8x8.com/administration/docs/search-contacts): Customers who need to find specific contact information in our Contact Database can utilize the following endpoint. This is particularly useful for... - [Site Management API Guide](https://developer.8x8.com/administration/docs/site-management-api-guide): import TabbedExternalCodeSample from '@site/docusaurus/components/TabbedExternalCodeSample'; - [Administration API Essentials](https://developer.8x8.com/administration/docs/suite-common): **Version**: 1.0 | **Last Updated**: January 16, 2026 | **Applies to**: All Administration API Suite APIs - [User Management API Guide](https://developer.8x8.com/administration/docs/user-management-api-guide): **API Version**: 1.0 | **Last Updated**: January 15, 2026 | **Part of**: [Administration API Suite](./suite-common.mdx) - [8x8 Administration - Address Management API](https://developer.8x8.com/administration/reference/8-x-8-administration-address-management-api.info): Address management API providing endpoints to create, retrieve, list, and delete addresses. - [8x8 Administration - Operations API](https://developer.8x8.com/administration/reference/8-x-8-administration-operations-api.info): Operation management API providing endpoints to retrieve and track the status of asynchronous operations. Operations are created automatically when... - [8x8 Administration - Phone Number Management API](https://developer.8x8.com/administration/reference/8-x-8-administration-phone-number-management-api.info): Phone number management API providing endpoints to list and retrieve phone numbers. - [8x8 Administration - Ring Group Management API](https://developer.8x8.com/administration/reference/8-x-8-administration-ring-group-management-api.info): Ring group management API providing endpoints to create, retrieve, list, update, and delete ring groups. - [8x8 Administration - Site Management API](https://developer.8x8.com/administration/reference/8-x-8-administration-site-management-api.info): Site management API providing endpoints to create, retrieve, list, update, and delete sites. Sites represent physical or logical locations within a... - [8x8 Administration - User Management API](https://developer.8x8.com/administration/reference/8-x-8-administration-user-management-api.info): User management API providing endpoints to create, retrieve, list, update, and delete users. - [Create address](https://developer.8x8.com/administration/reference/create-address.api): Create a new address - [Create a ring group](https://developer.8x8.com/administration/reference/create-ring-group.api): Creates a new ring group asynchronously. Returns an operation object to track the creation progress. - [Create a new site](https://developer.8x8.com/administration/reference/create-site.api): Creates a new site. Returns an Operation object that can be polled to track the creation progress. - [Create user](https://developer.8x8.com/administration/reference/create-user.api): Create a new user. - [Delete address](https://developer.8x8.com/administration/reference/delete-address.api): Delete a specific address by its ID - [Delete a ring group](https://developer.8x8.com/administration/reference/delete-ring-group.api): Deletes an existing ring group asynchronously. Returns an operation object to track the deletion progress. - [Delete site](https://developer.8x8.com/administration/reference/delete-site.api): Deletes an existing site. Returns an Operation object that can be polled to track the deletion progress. - [Delete user](https://developer.8x8.com/administration/reference/delete-user.api): Delete a specific user by their ID. - [Get address by ID](https://developer.8x8.com/administration/reference/get-address.api): Retrieve a specific address by its ID - [Get operation by ID](https://developer.8x8.com/administration/reference/get-operation.api): Retrieves the current status and details of an asynchronous operation. - [Get phone number by ID](https://developer.8x8.com/administration/reference/get-phone-number.api): Retrieve a specific phone number by its value. - [Get ring group by ID](https://developer.8x8.com/administration/reference/get-ring-group.api): Retrieves a specific ring group by its unique identifier. - [Get site by ID](https://developer.8x8.com/administration/reference/get-site.api): Retrieve a specific site by its ID - [Get user by ID](https://developer.8x8.com/administration/reference/get-user.api): Retrieve a specific user by their ID - [List addresses](https://developer.8x8.com/administration/reference/list-addresses.api): List addresses with optional filtering, sorting, and pagination. - [List phone numbers](https://developer.8x8.com/administration/reference/list-phone-numbers.api): List phone numbers with optional filtering, sorting, and infinite scroll pagination. - [List ring groups](https://developer.8x8.com/administration/reference/list-ring-groups.api): List ring groups with optional filtering, sorting, and pagination. - [List sites](https://developer.8x8.com/administration/reference/list-sites.api): List sites with optional filtering, sorting, and pagination. - [List users](https://developer.8x8.com/administration/reference/list-users.api): List users with optional filtering, sorting, and infinite scroll pagination. - [Update ring group members](https://developer.8x8.com/administration/reference/update-ring-group-members.api): Atomically applies an add/update/remove delta to a ring group's member list. - [Update a ring group](https://developer.8x8.com/administration/reference/update-ring-group.api): Updates an existing ring group asynchronously. Returns an operation object to track the update progress. - [Update site](https://developer.8x8.com/administration/reference/update-site.api): Updates an existing site. Returns an Operation object that can be polled to track the update progress. - [Update user](https://developer.8x8.com/administration/reference/update-user.api): Update an existing user by their ID. - [Audit Records](https://developer.8x8.com/analytics/docs/audit-records): As an administrator, you may need to access the audits across some 8x8 services. - [CC Historical Analytics Detailed Report](https://developer.8x8.com/analytics/docs/cc-historical-analytics-detailed-report): The common `historical-metrics` endpoint has a limitation where the JSON `/data` response is limited to 10,000 records. The XLSX/CSV download avail... - [CC Historical Analytics Summary Report](https://developer.8x8.com/analytics/docs/cc-historical-analytics-summary-report): Customers looking to access data in JSON or CSV/XLSX from [CC Historical Analytics](/analytics/reference/cc-historical-report-create) can follow th... - [CC Realtime Statistics](https://developer.8x8.com/analytics/docs/cc-realtime-statistics): > 📘 **You will need a working API key to begin** - [Cloud Storage Service Bulk Download](https://developer.8x8.com/analytics/docs/cloud-storage-service-bulk-download): Customers looking to download content in bulk from [Cloud Storage Service](/analytics/reference/searchobject) can follow the this multi step proces... - [Cloud Storage Service Objects](https://developer.8x8.com/analytics/docs/cloud-storage-service-objects): Filtering by the date when objects where created or when objects were last updated can be done by using *createdTime* or *updatedTime* in the *filt... - [Customer 360](https://developer.8x8.com/analytics/docs/customer-360): The Customer 360 API provides unified access to a customer's interaction history and insights across all 8x8 contact center channels. - [Post Call Survey](https://developer.8x8.com/analytics/docs/customer-experience-post-call-survey): > 📘 **Post-call survey reporting has moved under the umbrella of Contact Center reporting.** - [[PILOT] End-to-End Journey API](https://developer.8x8.com/analytics/docs/end-to-end-journey-api): The Journey API provides a consolidated view of customer interactions belonging to the same journey. These interactions may happen on one or multip... - [How to get API Keys](https://developer.8x8.com/analytics/docs/how-to-get-api-keys): There are a number of different Authentication Methods across the suite of XCaaS APIs today. - [Introduction](https://developer.8x8.com/analytics/docs/introduction): Welcome to the XCaaS Analytics & Content Developer hub. You'll find comprehensive guides and documentation to help you start working with XCaaS Ana... - [OAuth Authentication for 8x8 XCaaS APIs](https://developer.8x8.com/analytics/docs/oauth-authentication-for-8x8-xcaas-apis): A number of 8x8 XCaaS APIs use OAuth authentication. For these APIs the initial step is to generate an `access_token` to be used in the subsequent ... - [Ring Group Member Summary](https://developer.8x8.com/analytics/docs/ring-group-member-summary): > 📘 Looking for live/real-time queue, agent or call-level data? See [Work Analytics — Overview](/analytics/docs/work-analytics-queue-agent-reports). - [Ring Group Summary](https://developer.8x8.com/analytics/docs/wa-ring-group-summary): > 📘 Looking for live/real-time queue, agent or call-level data? See [Work Analytics — Overview](/analytics/docs/work-analytics-queue-agent-reports). - [Active Calls](https://developer.8x8.com/analytics/docs/work-analytics-active-calls): The **Active Calls** view returns the calls that are **currently active (in progress)** for a PBX at the moment of the query — a real-time snapshot... - [Agent Activity](https://developer.8x8.com/analytics/docs/work-analytics-agent-activity): The **Agent Activity** report shows per-agent interaction handling across the PBX — how many interactions each agent accepted, missed or rejected, ... - [Aggregated & Detailed Calls](https://developer.8x8.com/analytics/docs/work-analytics-aggregated-calls): The **Calls** views return call-level analytics for a PBX — an aggregated, paged table of calls with their participants, outcome and handling durat... - [Call Detail Records](https://developer.8x8.com/analytics/docs/work-analytics-call-detail-records): > 📘 Looking for live/real-time queue, agent or call-level data? See [Work Analytics — Overview](/analytics/docs/work-analytics-queue-agent-reports). - [Call Legs](https://developer.8x8.com/analytics/docs/work-analytics-call-legs): > 📘 Looking for live/real-time queue, agent or call-level data? See [Work Analytics — Overview](/analytics/docs/work-analytics-queue-agent-reports). - [Call Queues](https://developer.8x8.com/analytics/docs/work-analytics-call-queues): The **Call Queues** report shows how each call queue is performing — how many interactions entered, were accepted, abandoned or diverted, the timin... - [Call Detail Record and Call Legs](https://developer.8x8.com/analytics/docs/work-analytics-cdr-report): > 🚧 **Updated Endpoints Available** - [Company Summary](https://developer.8x8.com/analytics/docs/work-analytics-company-summary): > 📘 Looking for live/real-time queue, agent or call-level data? See [Work Analytics — Overview](/analytics/docs/work-analytics-queue-agent-reports). - [Extension Summary](https://developer.8x8.com/analytics/docs/work-analytics-extension-summary): > 📘 Looking for live/real-time queue, agent or call-level data? See [Work Analytics — Overview](/analytics/docs/work-analytics-queue-agent-reports). - [Queue Agent Activity](https://developer.8x8.com/analytics/docs/work-analytics-queue-agent-activity): The **Queue Agent Activity** report breaks agent interaction handling down **per call queue** — the same agent-level metrics as Agent Activity, but... - [Work Analytics — Overview](https://developer.8x8.com/analytics/docs/work-analytics-queue-agent-reports): The Work Analytics v2 reporting API powers the Call Queue, Agent Activity, Ring Group and call-level reports shown in the 8x8 **Analytics for Work*... - [Ring Group Agent Activity](https://developer.8x8.com/analytics/docs/work-analytics-ring-group-agent-activity): The **Ring Group Agent Activity** report shows per-agent activity for the members of a ring group on a PBX — for each agent in the group, how long ... - [Ring Group & Ring Group Member Summaries](https://developer.8x8.com/analytics/docs/work-analytics-ring-group-summary): > 🚧 **Updated Endpoints Available** - [Unreturned Calls](https://developer.8x8.com/analytics/docs/work-analytics-unreturned-calls): The **Unreturned Calls** report surfaces calls into the PBX that were **not answered and have not been called back** — abandoned or missed callers ... - [8x8 Analytics for Contact Center Historical Metrics API](https://developer.8x8.com/analytics/reference/8-x-8-analytics-for-contact-center-historical-metrics-api.info): As a contact center supervisor, you may need to assess the performance of your agents. - [8x8 Analytics for Contact Center Real-time Metrics API](https://developer.8x8.com/analytics/reference/8-x-8-analytics-for-contact-center-real-time-metrics-api.info): The 8x8 Analytics for Contact Center Real-time Metrics API enables you to obtain the latest, real-time statistical data on queues and agents queue ... - [Get Aggregated Calls](https://developer.8x8.com/analytics/reference/aggregated-3.api): This endpoint returns the summary of calls for selected time period and pbx - [Retrieve all agents with all specified metrics within a tenant.](https://developer.8x8.com/analytics/reference/all-tenant-agents-metrics.api): Retrieve all agents with all specified metrics within a tenant. - [Audit Records API](https://developer.8x8.com/analytics/reference/audit-records-api.info): This API allows administrators to retrieve audit records in JSON format. - [Authentication](https://developer.8x8.com/analytics/reference/authentication-1.api): Generate Bearer token for use with subsequent requests - [(DEPRECATED) Call Detail Record Legs](https://developer.8x8.com/analytics/reference/call-detail-record-deprecated.api): [Call Detail Record Legs](/analytics/reference/call-detail-record-legs) and [Call Detail Records](/analytics/reference/call-detail-records) should ... - [Call Detail Record Legs](https://developer.8x8.com/analytics/reference/call-detail-record-legs.api): The Analytics for 8x8 Work Call Detail Record (CDR) Legs endpoint enables you to see the entire journey for a subject call from start to finish acr... - [Call Detail Records](https://developer.8x8.com/analytics/reference/call-detail-records.api): **Not currently Testable from here** The Analytics for 8x8 Work Call Detail Record (CDR) endpoint enables you to see the entire journey for a subje... - [Cancel a running bulk download job by zip file name.](https://developer.8x8.com/analytics/reference/cancelbulkdownload.api): This method cancels a running bulk download job by the zip file name. - [The Speech Analytics category count](https://developer.8x8.com/analytics/reference/categories-count.api): Retrieves the category count - [Create Detailed Report](https://developer.8x8.com/analytics/reference/cc-detailed-report-create.api): This endpoint initializes Detailed Report Access. For step-by-step instructions on using the Historical Metrics API refer to the [CC Historical Ana... - [Detailed Report Data](https://developer.8x8.com/analytics/reference/cc-detailed-report-data-by-id.api): This method returns the actual detailed report data. The returned report is paginated and the data is returned if the report has a DONE status. The... - [Report Format Details](https://developer.8x8.com/analytics/reference/cc-historical-analytics-report-type-by-type.api): This method obtains grouping, filtering, and metrics information about a specific report type. - [List Report Types](https://developer.8x8.com/analytics/reference/cc-historical-analytics-report-types.api): This method obtains the list of valid report-types, along with the options for grouping, filtering, or applying metrics that are specific for each ... - [Create Report](https://developer.8x8.com/analytics/reference/cc-historical-report-create.api): This endpoint initializes Report Access. For step-by-step instructions on using the Historical Metrics API refer to the [CC Historical Analytics Su... - [Report Data](https://developer.8x8.com/analytics/reference/cc-historical-report-data-by-id.api): This method returns the actual report data. The returned report is paginated and the data is returned if the report has a DONE status. The report p... - [Report Details](https://developer.8x8.com/analytics/reference/cc-historical-report-details-by-id.api): This method provides information associated with a previously created report request. It includes all the parameters specified in the request. The ... - [Report Download](https://developer.8x8.com/analytics/reference/cc-historical-report-download-by-id.api): This method returns report data as a downloadable file. Data can only be downloaded if the report has a DONE status. The first entry in the returne... - [Report Links](https://developer.8x8.com/analytics/reference/cc-historical-report-links-by-id.api): This method returns all available links related to a previously created report. A link to the Report Status is always included in the return. If th... - [Report Status](https://developer.8x8.com/analytics/reference/cc-historical-report-status-by-id.api): After a report is created, the status of the report can be checked periodically. The report can be either classified as IN_PROGRESS, DONE, or FAILED. - [Individual Agent Statistics by Group](https://developer.8x8.com/analytics/reference/cc-real-time-get-agent-metrics-by-group-by-id.api): This method retrieves real-time metrics for a specific agent in a group. The agent ID, agent name and a list of metric objects. A metric object co... - [Individual Agent Statistics by Queue](https://developer.8x8.com/analytics/reference/cc-real-time-get-agent-metrics-by-queue-by-id.api): This method retrieves real-time metrics for a specific agent in a queue. The agent ID, agent name and a list of metric objects. A metric object co... - [Agent Statistics by Group](https://developer.8x8.com/analytics/reference/cc-real-time-get-agents-metrics-by-group.api): This method retrieves real-time metrics for a list of agents in a selected group. By default, all agents from the given group will be returned. Th... - [Agent Statistics by Queue](https://developer.8x8.com/analytics/reference/cc-real-time-get-agents-metrics-by-queue.api): This method retrieves real-time metrics for a list of agents in a select queue. By default, all agents from the given queue will be returned. The ... - [Individual Group Statistics](https://developer.8x8.com/analytics/reference/cc-real-time-get-group-metrics-by-id.api): This method retrieves real-time metrics for a specific group. The response returns an object which contains the group ID, group name and a list of ... - [Group Statistics](https://developer.8x8.com/analytics/reference/cc-real-time-get-groups-metrics.api): This method retrieves real-time metrics for a list of groups. By default, the metrics for all groups are returned. The result can be filtered and p... - [Individual Queue Metrics](https://developer.8x8.com/analytics/reference/cc-real-time-get-queue-metrics-by-id.api): This method retrieves real-time metrics for a specific queue. The response returns an object which contains the queue ID, queue name and a list of ... - [Queue Statistics](https://developer.8x8.com/analytics/reference/cc-real-time-get-queues-metrics.api): This method retrieves real-time metrics for a list of queues. By default, the metrics for all queues are returned. The result can be filtered and p... - [Removes tasks from a download request.](https://developer.8x8.com/analytics/reference/cleardownloads.api): This method clears your task queue for bulk download requests. - [Cloud Storage Service Public API](https://developer.8x8.com/analytics/reference/cloud-storage-service-public-api.info): 8x8’s Cloud Storage Service (CSS) offers you a single point of access for Virtual Office PBX telephone, Virtual Contact Center call recordings, Vir... - [Company Summary](https://developer.8x8.com/analytics/reference/company-summary.api): With the Analytics for 8x8 Work Company Summary (/compsum) endpoint you can obtain summary information about call activity that occurred within you... - [Customer 360 API](https://developer.8x8.com/analytics/reference/customer-360-api.info): The Customer 360 API provides unified access to customer interaction history and insights across all 8x8 contact center channels. - [Deletes a single interaction.](https://developer.8x8.com/analytics/reference/delete-interaction.api): Removes the interaction and all associated metadata. This action cannot be undone. - [Deletes custom field data](https://developer.8x8.com/analytics/reference/deletes-the-custom-field.api): Updates or removes the custom field contained data for user customizable fields. Only the custom fields **1** to **15** are editable. - [Get Call Details](https://developer.8x8.com/analytics/reference/detailed.api): This endpoint returns the journey of a single interaction in the specified timeframe. - [Request bulk download by .zip filename.](https://developer.8x8.com/analytics/reference/downloadbulk.api): This method enables access to a single zipped file that was generated from a bulk download request and is ready for retrieval. - [Download content for the given metadata.](https://developer.8x8.com/analytics/reference/downloadmetadata.api): This method retrieves an object using the objectId specification for a given record. - [Download content for the given metadata.](https://developer.8x8.com/analytics/reference/downloadobject.api): This method retrieves an object using the **`objectId`** specification for a given record. - [Returns the status of a single bulk download job request by zip filename.](https://developer.8x8.com/analytics/reference/downloadstatus.api): This method returns the status of a single bulk download job request by zip filename. - [Returns the status of all bulk download job requests.](https://developer.8x8.com/analytics/reference/downloadstatuses.api): This method returns the status of all bulk download job requests. - [The evaluation details specified by ID.](https://developer.8x8.com/analytics/reference/evaluation-details.api): Retrieves a single evaluation which consists of the template section and answered questions. - [The evaluation count](https://developer.8x8.com/analytics/reference/evaluations-count.api): Retrieves the evaluation count - [Evaluation collection](https://developer.8x8.com/analytics/reference/evaluations.api): Retrieves evaluations collection - [(DEPRECATED) Extension Summary v1](https://developer.8x8.com/analytics/reference/extension-summary-deprecated.api): [Extension Summary V2](/analytics/reference/extension-summary-v-2) should be used. This endpoint is deprecated. - [Extension Summary v2](https://developer.8x8.com/analytics/reference/extension-summary-v-2.api): The Extension Summary (/extsum) report provides a detailed summary of call activity for any user’s extension in your enterprise’s phone system. Whe... - [Get Active Calls](https://developer.8x8.com/analytics/reference/get-active-calls.api): Returns the calls that are currently active (in progress) for the given PBX at the moment of the query. This is a real-time snapshot, so no date-ra... - [Get Agent Activity Metrics](https://developer.8x8.com/analytics/reference/get-agent-activity.api): This endpoint returns the agent activity metrics for the selected pbx, grouped by agent. The response can be further filtered by a list of queues, ... - [Get Agent Activity Metrics per Queues](https://developer.8x8.com/analytics/reference/get-agent-queue-activity.api): This endpoint returns the agent activity metrics for the selected pbx, grouped by queue and agent. The response can be further filtered by a list o... - [Get audit records.](https://developer.8x8.com/analytics/reference/get-audit-records.api): Retrieve audit records in JSON format - [Get interaction insights](https://developer.8x8.com/analytics/reference/get-interactions-insight.api): Retrieves interaction insights for a tenant, including interactions list and speech analytics. - [Returns the list of agents for the given pbx.](https://developer.8x8.com/analytics/reference/get-pbx-agents.api): Returns the list of agents for the given pbx. - [Returns the list of queues for the given pbx.](https://developer.8x8.com/analytics/reference/get-pbx-queues.api): Returns the list of queues for the given pbx. - [Returns the list of queues for the given pbx and site.](https://developer.8x8.com/analytics/reference/get-pbx-site-queues.api): Returns the list of queues for the given pbx and site. - [Returns the list of sites of a pbx](https://developer.8x8.com/analytics/reference/get-pbx-sites.api): Returns a list of sites of a pbx. - [Returns all pbxes of a customer](https://developer.8x8.com/analytics/reference/get-pbxes.api): This endpoint returns all the PBXes available for a customer - [Get Call Queue Metrics](https://developer.8x8.com/analytics/reference/get-queue-metrics.api): This endpoint returns the call queue metrics, for the selected PBX. The response can be further filtered by a list of queues, sites. If no date ran... - [Get Ring Group Agent Activity by Extension](https://developer.8x8.com/analytics/reference/get-ring-group-agent-activity-by-extension.api): Returns per-agent activity for the members of a ring group on the given PBX, identified by the ring group **extension** instead of its id. Behaves ... - [Get Ring Group Agent Activity](https://developer.8x8.com/analytics/reference/get-ring-group-agent-activity.api): Returns per-agent activity for the members of a ring group on the given PBX, identified by the ring group id. Each row reports an agent's extension... - [Get transcript summaries](https://developer.8x8.com/analytics/reference/get-transcript-summaries.api): Retrieves transcript summaries for one or more interaction IDs. - [Get Unreturned Call Callees](https://developer.8x8.com/analytics/reference/get-unreturned-callees.api): Returns the distinct callees (the parties that were called but not reached) that appear in the unreturned calls for the given PBX. Useful for popul... - [Get Unreturned Call Callers](https://developer.8x8.com/analytics/reference/get-unreturned-callers.api): Returns the distinct callers whose calls were not returned for the given PBX, optionally scoped to the callees they tried to reach. Useful for popu... - [Get Unreturned Calls](https://developer.8x8.com/analytics/reference/get-unreturned-calls.api): Returns unreturned calls for the given PBX, aggregated per caller — calls into the PBX that were not answered and have not been called back. Each r... - [Get Detailed Unreturned Calls](https://developer.8x8.com/analytics/reference/get-unreturned-detailed.api): Returns the individual unreturned call records for the given PBX and the requested caller addresses — the per-call drill-down behind the aggregated... - [Retrieve realtime metrics for all agents in multiple queues.](https://developer.8x8.com/analytics/reference/getagentsinqueue.api): Retrieve realtime metrics for all agents in multiple queues. - [Returns the content of a specified bucket.](https://developer.8x8.com/analytics/reference/getbucket.api): This method returns all of the contents contained within a specific bucket. - [Find an object by it's ID.](https://developer.8x8.com/analytics/reference/getobject.api): Use this method to retrieve an object by its ID. - [The requested interaction media file download](https://developer.8x8.com/analytics/reference/interaction-media-file.api): Retrieves audio, video, mixed audio (MP3), and video (MP4) - [This method queries a single interaction transcription record.](https://developer.8x8.com/analytics/reference/interaction-transcription.api): Retrieves available transcriptions for the selected interaction - [Interaction count.](https://developer.8x8.com/analytics/reference/interactions-count.api): This method retrieves the interactions count for the specified interaction type. Unless the interaction type is specified, all the interaction type... - [The Interaction collection](https://developer.8x8.com/analytics/reference/interactions.api): This method retrieves interaction collections. - [Query a single interaction attached label](https://developer.8x8.com/analytics/reference/labels.api): Retrieves the collection of labels attached to the interaction - [The Speech Analytics category list](https://developer.8x8.com/analytics/reference/list.api): Retrieves the category count - [Query the attached notes for a single interaction](https://developer.8x8.com/analytics/reference/notes.api): Retrieve the notes attached to an interaction - [Get Detailed Unreturned Calls (POST)](https://developer.8x8.com/analytics/reference/post-unreturned-detailed.api): Same result as `GET /calls/unreturned/detailed`, but the filters, time range, sorting and paging are supplied in a JSON request body instead of que... - [This method purges a single interaction.](https://developer.8x8.com/analytics/reference/purge-interaction.api): Removes the interaction and all associated metadata. **This action cannot be undone.** - [Quality Management and Speech Analytics API](https://developer.8x8.com/analytics/reference/quality-management-and-speech-analytics-api.info): The Quality Management and Speech Analytics (QMSA) API enables you to access raw resources such as interaction metadata, evaluation results, and us... - [Remove existing objects.](https://developer.8x8.com/analytics/reference/removecontent.api): This method enables you to bulk delete object metadata along with associated content. - [Ring Group Member Summary](https://developer.8x8.com/analytics/reference/ring-group-members-summary.api): **Not currently Testable from here** The Analytics for 8x8 Work Ring Group Memberssummarized performance metrics for individual members of a ring g... - [(DEPRECATED) Ring Group Summary](https://developer.8x8.com/analytics/reference/ring-group-summary-deprecated.api): [Ring Groups Summary](/analytics/reference/ring-group-summary) and [Ring Group Members Summary](/analytics/reference/ring-group-members-summary) sh... - [Ring Group Summary](https://developer.8x8.com/analytics/reference/ring-group-summary.api): The Analytics for 8x8 Work Ring Group Summary endpoint enables automated access to summarized call metrics for each ring group. See [Ring Group Sum... - [Search all buckets.](https://developer.8x8.com/analytics/reference/searchbucket.api): A bucket is a resource that is used to store data objects and their associated metadata. This method returns all content within existing buckets. - [The list of all objects that meet the filter rule criteria.](https://developer.8x8.com/analytics/reference/searchobject.api): **Tagging** - [Start bulk download.](https://developer.8x8.com/analytics/reference/startdownload.api): This method starts downloading multiple objects in bulk. The objects are zipped and transferred as one file. - [Query supervisor values](https://developer.8x8.com/analytics/reference/supervisors.api): Retrieves the user's supervisor collection - [The Speech Analytics topic count](https://developer.8x8.com/analytics/reference/topics-count.api): Retrieves the topics count within the specified category - [The Speech Analytics topics list](https://developer.8x8.com/analytics/reference/topics-list.api): Retrieve the categories count - [Queries a single interaction for matched topics](https://developer.8x8.com/analytics/reference/topics.api): Retrieves the list of detected topics within the transcriptions - [Trainer values.](https://developer.8x8.com/analytics/reference/trainers.api): Retrieves the user's trainer collection - [This method updates custom fields.](https://developer.8x8.com/analytics/reference/update-custom-field.api): This method either updates or removes the custom field contained data for user customizable fields. Only custom fields **1** to **15** can be edited. - [User details.](https://developer.8x8.com/analytics/reference/user-details.api): Retrieve user details - [Query user count](https://developer.8x8.com/analytics/reference/users-count.api): Retrieve the total number of users registered in the system. You can also count only the active users. - [Query user details](https://developer.8x8.com/analytics/reference/users.api): Retrieve the users collection - [Webpage redirect](https://developer.8x8.com/analytics/reference/webpage-redirect.api): Advanced customers can use this method to integrate systems. 8x8 recommends contacting your account representative for more details. - [Work Analytics Customer Data](https://developer.8x8.com/analytics/reference/work-analytics-customer-data.info): import ApiLogo from "@theme/ApiLogo"; - [Work Analytics Historical](https://developer.8x8.com/analytics/reference/work-analytics-historical.info): import ApiLogo from "@theme/ApiLogo"; - [Work Analytics](https://developer.8x8.com/analytics/reference/work-analytics.info): The Work Analytics API provides metrics related to call queues activity as well as agent activity on queues. - [CPaaS: Connect & Communication APIs](https://developer.8x8.com/connect/docs/8x8-cpaas-products): Comprehensive guide to 8x8 CPaaS communication platform products and services. - [Accessing and Viewing Your Customer List](https://developer.8x8.com/connect/docs/accessing-and-viewing-your-customer-list): The **Partner Hub** in 8x8 Connect is your centralised portal for monitoring your assigned end-customer (Customer) accounts. The interface is desig... - [Adding Sender ID Details](https://developer.8x8.com/connect/docs/adding-sender-id-details): **Adding Sender ID details** - [Adobe Campaigns](https://developer.8x8.com/connect/docs/adobe-campaigns): [Adobe Campaign](https://www.adobe.com/sea/experience-cloud/topics/campaign-management.html) allows you to launch, measure, and automate campaigns ... - [Analytics](https://developer.8x8.com/connect/docs/analytics): 8x8 Connect allows users to monitor their usage, metrics and access logs, throughout the product families: - [API Endpoint migration guide](https://developer.8x8.com/connect/docs/api-endpoint-migration-guide): import ApiChip from '@site/docusaurus/components/ApiChip'; - [API Error codes](https://developer.8x8.com/connect/docs/api-error-codes): > ℹ️ **Troubleshooting tip** - [API Rate Limiting](https://developer.8x8.com/connect/docs/api-rate-limiting): To protect the platform from being overloaded and maintain a high quality of service to all customers, 8x8 enforces API rate limits for its SMS API. - [Apple's Shortcuts](https://developer.8x8.com/connect/docs/apples-shortcuts): Previously known as Workflow, Apple’s new automation app, [Shortcuts](https://support.apple.com/en-au/HT209055), lets users create powerful workflo... - [Auth0](https://developer.8x8.com/connect/docs/auth0): [Auth0](https://auth0.com) is an identity management platform that let applications developers easily implement authentication and authorisation lo... - [Authentication - API Keys](https://developer.8x8.com/connect/docs/authentication): 8x8 APIs accepts an **ApiKey Bearer Token** authentication method. - [Automation Builder](https://developer.8x8.com/connect/docs/automation-builder): The Automation Builder consists of both an API platform which is covered in it's own section of our documentation and also a UI that is located in ... - [Billing](https://developer.8x8.com/connect/docs/billing): | Agent Billing Category | Definition ... - [Braze](https://developer.8x8.com/connect/docs/braze): [Braze](https://www.braze.com/) is a comprehensive customer engagement platform that powers relevant and memorable experiences between consumers an... - [Messaging Apps Fallback management](https://developer.8x8.com/connect/docs/chatapps-fallback-management): The 8x8 Messaging API enables you to define a fallback sequence, orchestrating message delivery across multiple channels such as WhatsApp, Viber, a... - [CleverTap - SMS Integration](https://developer.8x8.com/connect/docs/clevertap-sms-integration): Clevertap is a Mobile Marketing Platform with app marketing automation helping app marketers to retain user engagement. - [Clevertap - WhatsApp Integration](https://developer.8x8.com/connect/docs/clevertap-whatsapp-integration): Clevertap is a Mobile Marketing Platform with app marketing automation helping app marketers to retain user engagement. - [CleverTap](https://developer.8x8.com/connect/docs/clevertap): Clevertap is a Mobile Marketing Platform with app marketing automation helping app marketers to retain user engagement. Please see our pages in thi... - [Cognigy](https://developer.8x8.com/connect/docs/cognigy): Cognigy is a premier Conversational AI platform that empowers organizations to build and deploy advanced virtual agents, streamlining customer inte... - [Company Details Tab](https://developer.8x8.com/connect/docs/company-details-tab): **Accessing Company Details Tab** - [Overview](https://developer.8x8.com/connect/docs/connect-overview): ![1280](../images/cf1de9e-New_Project_8.png "New Project (8).png") - [Security (SSO)](https://developer.8x8.com/connect/docs/connect-security): This assumes that you already have an SSO application that will be used to configure your SSO. If you do not have one yet, you might want to check ... - [Contact Management](https://developer.8x8.com/connect/docs/contact-management): Contact Management is a feature inside Connect that allows you to manage your contacts in bulk whether you will use them to send messages or for Co... - [Context & Scripting](https://developer.8x8.com/connect/docs/context-scripting): > 🚧 **[BETA]** - [Agent Management](https://developer.8x8.com/connect/docs/converse/agents): The Agents module provides real-time visibility into agent availability, performance, and workload distribution. - [Contact Management](https://developer.8x8.com/connect/docs/converse/contacts): The Contacts module provides a unified customer database with interaction history across all communication channels. - [Conversations](https://developer.8x8.com/connect/docs/converse/conversations): The Conversations (Chats) module is the core workspace where agents engage with customers across WhatsApp, Email, and Facebook Messenger. - [Getting Started](https://developer.8x8.com/connect/docs/converse/getting-started): :::note - [Queue Management](https://developer.8x8.com/connect/docs/converse/queue): The Queue module controls how incoming conversations are distributed to available agents based on routing rules, priority, and agent availability. - [Reports & Statistics](https://developer.8x8.com/connect/docs/converse/reports): Converse provides comprehensive analytics across conversations, agent performance, queue efficiency, and customer satisfaction. - [Settings & Configuration](https://developer.8x8.com/connect/docs/converse/settings): The Settings module provides system-wide configuration for administrators to customize Converse for their organization's needs. - [User Roles & Permissions](https://developer.8x8.com/connect/docs/converse/user-roles): Converse provides role-based access control with two distinct user types, each with specific capabilities and access levels. - [Converse](https://developer.8x8.com/connect/docs/converse-overview): Converse is a unified conversational platform that enables omnichannel customer engagement across WhatsApp, Email, and Facebook Messenger. The plat... - [Create a group and add a contact to that group](https://developer.8x8.com/connect/docs/create-a-group-and-add-a-contact-to-that-group): > 👍 - [Creating a contact](https://developer.8x8.com/connect/docs/creating-a-contact): > 👍 - [Messaging Apps Delivery Receipt Error Codes](https://developer.8x8.com/connect/docs/delivery-error-codes): > ℹ️ **Troubleshooting tip** - [SMS Delivery Receipt Error Codes](https://developer.8x8.com/connect/docs/delivery-receipts-error-codes): > ℹ️ **Troubleshooting tip** - [Delivery receipts for Outbound Messaging Apps](https://developer.8x8.com/connect/docs/delivery-receipts-for-outbound-chatapps): import Tabs from '@theme/Tabs'; - [Delivery receipts for outbound SMS](https://developer.8x8.com/connect/docs/delivery-receipts-for-outbound-sms): Delivery Receipts (DR) are webhooks for delivery statuses: `POST` requests sent by 8x8 platform in `JSON` format to the delivery reports callback U... - [Details](https://developer.8x8.com/connect/docs/details): **Filling Up Details** - [Detrack - SMS Integration](https://developer.8x8.com/connect/docs/detrack): **Detrack** is a scalable, smart, and easy to use tracking service with automatic real-time notifications when orders are delivered. - [Developer Tools](https://developer.8x8.com/connect/docs/developer-tools): 8x8 Connect allows developers to manage their API Keys, Webhook endpoints, and IP Whitelisting easily through their respective pages. - [Documents & Details Dashboard](https://developer.8x8.com/connect/docs/documents-details-dashboard): **Accessing Documents & Details Dashboard** - [Adding Documents](https://developer.8x8.com/connect/docs/documents): **Attach Company Documents** - [Download Messaging Apps Logs](https://developer.8x8.com/connect/docs/download-chatapps-logs): Messaging Apps Reporting API allows you to retrieve your Messaging Apps activity with individual logs for each message sent/received for a given su... - [Drafts Tab](https://developer.8x8.com/connect/docs/drafts): **Sender ID Drafts Dashboard** - [Examples](https://developer.8x8.com/connect/docs/examples): > 🚧 **[BETA]** - [For Partner Admins: Managing Your Team](https://developer.8x8.com/connect/docs/for-partner-admins-managing-your-team): As a Partner Admin, you have full control over your team's access to customer accounts and specific features. This is managed through **Roles** and... - [Freshdesk](https://developer.8x8.com/connect/docs/freshdesk): [Freshdesk](https://freshdesk.com/eu/) is a customer support software providing automated helpdesk support for companies to effectively manage thei... - [Branches](https://developer.8x8.com/connect/docs/getting-started-with-automation-api-1): > 🚧 **[BETA]** - [Getting started with Automation API](https://developer.8x8.com/connect/docs/getting-started-with-automation-api): > 🚧 **[BETA]** - [Getting started with Contacts API](https://developer.8x8.com/connect/docs/getting-started-with-contacts-api): Our Contacts API will help you manage your contacts through our RESTful api endpoints. - [Getting started with Number Lookup API](https://developer.8x8.com/connect/docs/getting-started-with-number-lookup-api): This API allows customers to perform various levels of lookup on a given phone number to retrieve information ranging from: - [Getting started with SMS API](https://developer.8x8.com/connect/docs/getting-started-with-sms-api): The SMS API enables 8x8 customers to both send and receive SMS messages through a variety of use cases: - [Getting Started](https://developer.8x8.com/connect/docs/getting-started): In object-oriented programming, we use objects with attributes to organize our programs and build our applications. 8x8 SMS API uses the same organ... - [Constructing WhatsApp Template Send Requests](https://developer.8x8.com/connect/docs/guide-creating-whatsapp-template-request): Learn how to properly format and send WhatsApp template messages through the 8x8 API using both manual and automated approaches. This guide covers ... - [RCS](https://developer.8x8.com/connect/docs/guide-rcs): RCS Business Messaging (RBM) is designed to enable rich, interactive communication between businesses and consumers—all within the default messagin... - [WhatsApp Image Optimization](https://developer.8x8.com/connect/docs/guide-whatsapp-image-optimization): When sending WhatsApp messages with media content, the speed and reliability of your image delivery directly impacts message success rates. This gu... - [Zero-tap and One-tap WhatsApp Authentication Template](https://developer.8x8.com/connect/docs/guide-whatsapp-one-tap-or-zero-tap-authentication): WhatsApp authentication templates can be configured to provide a more seamless authentication experience on Android devices through Zero-tap (autom... - [WhatsApp Template Validity Period (TTL)](https://developer.8x8.com/connect/docs/guide-whatsapp-template-validity-period-ttl): WhatsApp allows you to define a specific validity period or delivery window, also known **Time-To-Live (TTL)**, for **Utility** and **Authenticatio... - [Hangup](https://developer.8x8.com/connect/docs/hangup): This action should be used to hang up the incoming call. - [iframe integration](https://developer.8x8.com/connect/docs/iframe-integration): In order to provide a seamless experience to Agents, the Agent portal can be embedded in another web application. - [Inbound Messaging Apps message](https://developer.8x8.com/connect/docs/inbound-chatapps-message): import Tabs from '@theme/Tabs'; - [Inbound SMS](https://developer.8x8.com/connect/docs/inbound-sms): 8x8 SMS API exposes a webhook mechanism to let you receive Inbound SMS (SMS sent to your virtual numbers) on a callback URL of your choice. - [Integrations Overview](https://developer.8x8.com/connect/docs/integrations-overview): | Integration | Link to Integration | - [IP address list](https://developer.8x8.com/connect/docs/ip-address-list): > 🚧 IP Address List - [LINE Account Provisioning and Onboarding](https://developer.8x8.com/connect/docs/line/account-provisioning-onboarding): This guide covers the complete path from "we want LINE" to "we are sending production messages". It sets out the three provisioning routes, what yo... - [The LINE Ecosystem and Account Model](https://developer.8x8.com/connect/docs/line/concepts-fundamentals): This page explains the LINE side of the account model: the console that sits above your account, what a LINE Official Account is and how one accoun... - [Getting Started with LINE over the 8x8 API](https://developer.8x8.com/connect/docs/line/getting-started): This guide takes a developer who has been handed working credentials from nothing to a first LINE message accepted by the platform. It starts with ... - [LINE Governance, Security and Compliance](https://developer.8x8.com/connect/docs/line/governance-security): LINE's Official Account Guidelines are unusually prescriptive, and enforcement is unilateral: LINE may refuse, suspend, or terminate an account and... - [The 8x8 LINE Channel](https://developer.8x8.com/connect/docs/line/line-hub): Welcome to the 8x8 integration for LINE. This documentation covers both LINE products available on the 8x8 Messaging Apps platform: the two-way **L... - [LINE Official Account: Behaviour, Messages, and Constraints](https://developer.8x8.com/connect/docs/line/loa-messaging): This is the working reference for two-way conversation messaging on the LINE Official Account channel, `line`. It covers how the channel addresses ... - [LINE Official Account Webhooks](https://developer.8x8.com/connect/docs/line/loa-webhook): Everything that arrives at your callback URL for the two-way LINE Official Account channel: inbound messages and delivery receipts. The `line` chan... - [LINE Official Notification Delivery Receipts](https://developer.8x8.com/connect/docs/line/lon-webhook): LINE Official Notification is outbound only, so the only webhook it produces is a delivery receipt. It is also the **only LINE product on 8x8 that ... - [LINE Message API Library](https://developer.8x8.com/connect/docs/line/message-api-library): import LineTextMsg from './images/line-text-message.png'; - [LINE Official Notification (LON)](https://developer.8x8.com/connect/docs/line/official-notification-lon): LINE Official Notification is a separate product from the LINE Official Account channel, not a message type within it. It has its own endpoint, its... - [LINE Reference and Resources](https://developer.8x8.com/connect/docs/line/reference-resources): A lookup companion for the LINE section. LINE and 8x8 use different words for overlapping objects, and the object LINE calls a user ID is the field... - [Supported Messaging Apps](https://developer.8x8.com/connect/docs/list-of-supported-chatapps-channels): | Channel | Channel type value | Accepted | Sent | Delivered | Read | - [Tutorial: Google Sheets and SMS](https://developer.8x8.com/connect/docs/make): * An 8x8 Connect account - [MakeCall](https://developer.8x8.com/connect/docs/makecall): This function should be used to connect the first call with another party. - [Make.com](https://developer.8x8.com/connect/docs/makecom-1): [Make.com](https://www.help.make.com/en/help/apps/communication/8x8) is a platform that allows you to automate workflows across various application... - [Message status reference](https://developer.8x8.com/connect/docs/message-status-references): 8x8 API uses the following universal object for describing the message state across different APIs. - [Getting started with Messaging API](https://developer.8x8.com/connect/docs/messaging-apps-api-get-started): Before you get started, please contact your account manager to ensure that your account has access to this product and that the following points ha... - [Messaging Apps Analytics](https://developer.8x8.com/connect/docs/messaging-apps): This section will cover the analytics for Messaging Apps which will feature a dashboard, reports and logs covering all Messaging Apps usage. - [MoEngage - SMS Integration](https://developer.8x8.com/connect/docs/moengage-sms-integration): 8x8 CPaaS (Communications Platform as a Service) offers a robust suite of APIs and tools for integrating voice, video, chat, WhatsApp (among other ... - [MoEngage - WhatsApp Integration](https://developer.8x8.com/connect/docs/moengage-whatsapp): [MoEngage](https://www.moengage.com/) allows you to launch, measure, and automate campaigns on WhatsApp, harmonizing all of your marketing channels... - [MoEngage](https://developer.8x8.com/connect/docs/moengage): [MoEngage](https://www.moengage.com/) has integrations for both 8x8's WhatsApp and SMS channels. Please see the subsections for further details: - [Number Lookup Error Codes](https://developer.8x8.com/connect/docs/number-lookup-error-codes): The 8x8 Number Lookup API uses the following **error codes:** - [Okta - Bring Your Own Telephony (BYOT) via Voice](https://developer.8x8.com/connect/docs/okta-bring-your-own-telephony-byot-via-voice-otp): This guide demonstrates how to implement voice-based One-Time Password (OTP) delivery for Okta authentication using 8x8's Voice API. This integrati... - [Okta - Bring Your Own Telephony (BYOT)](https://developer.8x8.com/connect/docs/okta-bring-your-own-telephony-byot): [Okta BYOT](https://support.okta.com/help/s/article/bring-your-own-telephony-required-for-sms-and-voice) enables organizations to use 8x8 for Multi... - [Okta - Bring Your Own Telephony (BYOT) via SMS](https://developer.8x8.com/connect/docs/okta): This guide will take you through how to integrate 8x8's SMS API into Okta as an authenticator method using an Okta [Inline Hook](https://developer.... - [Omni Shield](https://developer.8x8.com/connect/docs/omnishield-overview): Omni Shield is 8x8's solution to protect enterprises and their customers from fraudulent SMS activities, such as toll or international revenue shar... - [Oracle Responsys](https://developer.8x8.com/connect/docs/oracle-responsys): [Oracle Responsys](https://www.oracle.com/sg/marketingcloud/products/cross-channel-orchestration/#:~:text=Oracle%20Responsys&text=Oracle%20Responsy... - [Platform Deployment Regions](https://developer.8x8.com/connect/docs/platform-deployment-regions): At 8x8 CPaaS, we understand that data latency and residency compliance are critical to delivering top-notch cloud communications. Our infrastructur... - [Price object reference](https://developer.8x8.com/connect/docs/price-object-reference): 8x8 API uses the following universal object for describing the price across different APIs. - [Agent Profile & Storefront](https://developer.8x8.com/connect/docs/rcs/agent-profile): When a user opens a conversation with your RCS agent, they see a verified profile page — your agent's storefront. This is what establishes trust be... - [Billing](https://developer.8x8.com/connect/docs/rcs/billing): | Agent Billing Category | Definition ... - [Compliance](https://developer.8x8.com/connect/docs/rcs/compliance): Your agent must automatically respond to the following keywords with compliant messages. These are verified during carrier approval — missing or in... - [Message types and samples](https://developer.8x8.com/connect/docs/rcs/message-types): > **Please see [Messaging API](/connect/reference/send-message) for the full API reference.** - [RCS](https://developer.8x8.com/connect/docs/rcs/overview): RCS Business Messaging (RBM) is designed to enable rich, interactive communication between businesses and consumers—all within the default messagin... - [Agent Registration and Launch](https://developer.8x8.com/connect/docs/rcs/registration): Launching an RCS agent requires coordination between your brand, 8x8, Google, and mobile carriers. This guide outlines the end-to-end process, from... - [Recommendations for Securing your Traffic](https://developer.8x8.com/connect/docs/recommendations-for-securing-your-traffic): This page will cover both general recommendations to secure your 8x8 traffic from fraud as well as other types of security threats. Specifically fo... - [Recommendations for Securing your Traffic](https://developer.8x8.com/connect/docs/recommendations-to-mitigate-sms-fraud-attacks): This page will cover both general recommendations to secure your 8x8 traffic from fraud as well as other types of security threats. Specifically fo... - [Registration Module](https://developer.8x8.com/connect/docs/registration-module): **Sender ID Registration** - [Reviewing Submission](https://developer.8x8.com/connect/docs/reviewing-submission): **Sender ID Registration Review** - [Salesforce Flow Builder](https://developer.8x8.com/connect/docs/salesforce-flow-builder): These guides provide step-by-step instructions to integrate 8x8 Messaging APIs (e.g., WhatsApp, SMS, Viber) with Salesforce. The guides utilize Sal... - [Sending Messages in Salesforce Flow Builder](https://developer.8x8.com/connect/docs/salesforce-flowbuilder-8x8-messaging-integration): This guide will walk you through the entire process of connecting Salesforce to the 8x8 Business Messaging API (e.g. for WhatsApp) to send messages... - [Sending SMS in Salesforce Flow Builder](https://developer.8x8.com/connect/docs/salesforce-flowbuilder-8x8-sms-integration): This guide will walk you through the entire process of connecting Salesforce to the 8x8 SMS API to send messages directly from your Salesforce envi... - [Salesforce Chat Configuration Guide](https://developer.8x8.com/connect/docs/salesforce-live-agent): > ❗️ **Salesforce Chat Deprecation** - [Security](https://developer.8x8.com/connect/docs/security-1): We know that security is important to customers. We take the responsibility to ensure that the 8x8 Embeddable Communications and APIs platform is a... - [Security](https://developer.8x8.com/connect/docs/security): We know that security is important to customers. We take the responsibility to ensure that the 8x8 Embeddable Communications and APIs platform is a... - [Send SMS API](https://developer.8x8.com/connect/docs/send-sms-api-reference): To send a single SMS using the 8x8 SMS API you need to submit a `JSON` object to the URL - [Dashboard View](https://developer.8x8.com/connect/docs/sender-id-dashboard-view): **Linked View** - [Sender ID Dashboard](https://developer.8x8.com/connect/docs/sender-id-dashboard): **Finding your Sender ID Dashboard** - [Sender ID Self Registration Module](https://developer.8x8.com/connect/docs/sender-id-self-registration-module): * Sender ID Self Registration Module allows user to register their Alphanumeric Sender ID which is critical for sending of SMS - [Multi-channel Sender (MCS)](https://developer.8x8.com/connect/docs/sender): Multi-channel Sender(MCS) allows users to send single or bulk SMS, Chat Apps and Voice messages. It has a capacity to let you send a message to ove... - [Sending WhatsApp messages using MCS](https://developer.8x8.com/connect/docs/sending-chat-apps-using-mcs): **Here are the steps** - [Sending SMS using Multi-Channel Sender (MCS)](https://developer.8x8.com/connect/docs/sending-sms-using-mcs): ![The Multi-Channel Sender (MCS) campaign creation feature in Connect](../images/7380634a5af151f2e9291fa182ca17a1cdf09d0f5803a2195a0de7037218564b-i... - [Short URL Clicks](https://developer.8x8.com/connect/docs/short-url-clicks): 8x8 SMS API provides a webhook that notifies you whenever someone clicks a shortened URL in an SMS message sent from your sub-account. - [Signing LOA](https://developer.8x8.com/connect/docs/signing-loa): **LOA Signing** - [SMPP - Connection](https://developer.8x8.com/connect/docs/smpp-connection): 8x8 supports SMPP (Short Message Peer-to-Peer), a mature binary protocol widely used in carrier-grade SMS infrastructure. Unlike REST APIs, SMPP us... - [SMPP - Delivery receipts](https://developer.8x8.com/connect/docs/smpp-delivery-receipts): 8x8 sends delivery report information in the `short_message` field of a `deliver_sm` PDU. - [SMPP TLVs](https://developer.8x8.com/connect/docs/smpp-tlvs): 📘Optional Parameters are fields, which may be optionally included in an SMPP message. (SMPP v3.4 Spec, section 5.3). These fields contain 3 parts,... - [SMS Analytics](https://developer.8x8.com/connect/docs/sms-analytics): The dashboard will contain the information about the SMS that you have sent using 8x8. Below is a view of the entire dashboard page, in the followi... - [SMS Engage response webhook](https://developer.8x8.com/connect/docs/sms-engage-response-webhook): `POST` requests are sent by the 8x8 platform in `JSON` format to the webhook URL configured for your account. - [Submitted Sender ID Registrations](https://developer.8x8.com/connect/docs/submitter-sender-id-registrations): **Sender ID Registration Submission and Sender ID Dashboard** - [Supported Messaging Apps Content Types](https://developer.8x8.com/connect/docs/supported-chat-apps-content-type): This page describes the supported messaging apps content types, along with their character limits - [SMS Template Management](https://developer.8x8.com/connect/docs/template-management): Templates is a feature within 8x8's Platform that will allow you to create message templates for later use, this page specifically covers SMS templ... - [Templates](https://developer.8x8.com/connect/docs/templates): This section will cover how to manage templates within the 8x8 Connect Dashboard. There are primarily two types of templates: - [Time zone & Onboarding](https://developer.8x8.com/connect/docs/time-zone-onboarding): > 🚧 **[BETA]** - [Token example creation](https://developer.8x8.com/connect/docs/token-example-creation): The Token Creation API can be used to create a token or to create a room, here are few examples: - [Steps](https://developer.8x8.com/connect/docs/triggers-and-steps-library): **Steps** make up a **workflow definition**. Each step has a unique id that identifies it within that workflow definition. This page aims to define... - [Triggers & Steps](https://developer.8x8.com/connect/docs/triggers-steps): > 🚧 **[BETA]** - [Triggers](https://developer.8x8.com/connect/docs/triggers): **Triggers** are the initial entry point into your workflow definition. They define what event will start a workflow instance. - [Troubleshooting](https://developer.8x8.com/connect/docs/troubleshooting): Troubleshooting a workflow is currently done via the Automation Builder API. Specifically the API allows you to retrieve error logs related to a wo... - [Tutorial: Opt Out Keyword (SMS)](https://developer.8x8.com/connect/docs/tutorial-add-an-opt-out-keyword-sms): This tutorial will show you how to use Automation Builder to build an opt-out flow for SMS. - [Tutorial: Opt Out Keyword (Messaging Apps / WhatsApp)](https://developer.8x8.com/connect/docs/tutorial-add-an-opt-out-keyword-whatsapp): This tutorial will show you how to use Automation Builder to build an opt-out flow for WhatsApp using our Messaging Apps API. - [Tutorial: Building a SMS + ChatApps Reservation Menu](https://developer.8x8.com/connect/docs/tutorial-automation-builder-sms-chatapps-reservation-menu): This tutorial will show how to build a simple reservation menu with the Automation Builder UI. This simulates many common actions that a customer w... - [Batch SMS](https://developer.8x8.com/connect/docs/tutorial-batch-sms): 8x8 offers different API methods that allow you to send SMS programmatically. - [Tutorial: Building a WhatsApp + Google Calendar Chat Bot](https://developer.8x8.com/connect/docs/tutorial-building-a-whatsapp-google-calendar-chat-bot): This tutorial will show you how to build a WhatsApp + Google Calendar chat bot using 8x8 Automation Builder. The resulting chat bot will allow cust... - [Tutorial: Customer Survey via SMS](https://developer.8x8.com/connect/docs/tutorial-customer-survey-via-sms): In this tutorial, you'll learn how to create an SMS-based chatbot that prompts users with survey questions and sends their responses to Google Shee... - [Mobile Verification](https://developer.8x8.com/connect/docs/tutorial-mobile-verification): One of the most common use cases for SMS is about conveying a one-time password (OTP) to an end user's mobile phone. - [Tutorial: Opt Out Keyword (SMS) for Third-Party System](https://developer.8x8.com/connect/docs/tutorial-opt-out-keyword-messaging-apps-whatsapp-for-third-party-system): This tutorial will show you how to use Automation Builder to build an **opt-out flow** for SMS. - [Tutorial: Opt Out Keyword (SMS) for Third-Party System](https://developer.8x8.com/connect/docs/tutorial-opt-out-keyword-sms-for-third-party-system): This tutorial will show you how to use Automation Builder to build an **opt-out flow** for SMS. - [Single SMS](https://developer.8x8.com/connect/docs/tutorial-single-sms): 8x8 offers different API methods that allow you to send SMS programmatically. - [SMS Engage](https://developer.8x8.com/connect/docs/tutorial-sms-engage): 8x8 offers API methods that allow you to send SMS Engage programmatically. - [SMS Feedback API](https://developer.8x8.com/connect/docs/tutorial-sms-feedback-api): To ensure the efficient delivery of SMS verification codes to users' mobile devices, 8x8 provides our customers with the [Success Feedback API](/co... - [Tutorial: Customer Survey via WhatsApp](https://developer.8x8.com/connect/docs/tutorial-whatsapp-survey): In this tutorial, you'll learn how to create a WhatsApp chatbot that prompts users with survey questions and sends their responses to Google Sheets... - [LINE Official Notification](https://developer.8x8.com/connect/docs/usage-samples-line-official-notification): > 🚧 **LINE Official Notification requires your templates to be approved by LINE team before they can be sent. Reach out to [cpaas-support@8x8.com]... - [Line](https://developer.8x8.com/connect/docs/usage-samples-line): > 👍 **Please see [Messaging API](/connect/reference/send-message) for the full API reference.** - [Message types and samples](https://developer.8x8.com/connect/docs/usage-samples-rcs): > 👍 **Please see [Messaging API](/connect/reference/send-message) for the full API reference.** - [Usage samples](https://developer.8x8.com/connect/docs/usage-samples-whatsapp): > ❗️ **Customer Service Window** - [Zalo Notification Service (ZNS)](https://developer.8x8.com/connect/docs/usage-samples-zns): > ❗️ - [User management](https://developer.8x8.com/connect/docs/user-management): The user management feature allows you to manage users from adding, deleting, disabling and giving access to Connect menus and features. - [Guide: Verif8](https://developer.8x8.com/connect/docs/verif8): Verif8 is designed as a turnkey, self-service solution for sending One-Time Passwords (OTPs). It centralizes the entire OTP lifecycle - Sender ID m... - [Getting started with Verification API](https://developer.8x8.com/connect/docs/verification-api-get-started): The Verify API enables customers to implement 2FA (two-factor authentication) into their applications. It is often used to provide an extra layer o... - [Administrator Interface](https://developer.8x8.com/connect/docs/vi-administrator-interface): To access the administration panel for Video Interaction, log into 8x8 Connect. - [Agent Interface](https://developer.8x8.com/connect/docs/vi-agent-interface): To login, the agent can open the following URL: - [Customer Interface](https://developer.8x8.com/connect/docs/vi-customer-interface): When a customer is first invited by an agent to join a call, they will receive an SMS with a link to join a call. Upon clicking onto the link, it w... - [FAQ (Frequently Asked Questions)](https://developer.8x8.com/connect/docs/vi-frequently-asked-questions): This page contains Frequently Asked Questions regarding Video Interaction. - [Getting Started](https://developer.8x8.com/connect/docs/vi-gettingstarted): The Video Interaction product focuses on one-to-one video calls where an ‘Agent’ (employee of a company) is engaging with a ‘Guest’ (usually a cust... - [Introduction](https://developer.8x8.com/connect/docs/vi-introduction): 8x8 Video Interaction product is an enterprise tool designed to elevate customer engagement. It focuses on the one-to-one interactions through an o... - [Network Requirements](https://developer.8x8.com/connect/docs/vi-network-requirements): To run Video Interaction on your corporate network, please be sure the following points are covered by your IT team. - [Overview](https://developer.8x8.com/connect/docs/vi-overview): ![image](../images/449d08f-image.png) - [Account Onboarding](https://developer.8x8.com/connect/docs/viber/account-onboarding): Getting a Viber Business Account provisioned starts with your 8x8 account manager, not the API. This page lists everything 8x8 needs from you, what... - [Billing](https://developer.8x8.com/connect/docs/viber/billing): [Concepts & Fundamentals](/connect/docs/viber/concepts-fundamentals#message-categories) introduces Promotional, Transactional, and OTP as the three... - [Compliance Guidelines](https://developer.8x8.com/connect/docs/viber/compliance-guidelines): Viber requires businesses to follow content and sender guidelines on every message sent through a Viber Business Account, whatever the category. Th... - [Concepts & Fundamentals](https://developer.8x8.com/connect/docs/viber/concepts-fundamentals): Before you send a Viber message or register a template, it helps to understand how 8x8 structures a Viber account, how Viber classifies your traffi... - [Getting Started](https://developer.8x8.com/connect/docs/viber/getting-started): Once your Viber channel is provisioned, sending your first message takes an API key and one API call. This page covers authentication, the base URL... - [Promotional Message API Library](https://developer.8x8.com/connect/docs/viber/message-api-library): import PromotionalImg from './images/Promotional Viber Business Messages.png'; - [Sending Viber Messages over API](https://developer.8x8.com/connect/docs/viber/sending-viber-messages-api): API reference for sending Viber messages through the 8x8 Messaging Apps API. This page covers the endpoint, request envelope, response format, vali... - [Conversational Messaging](https://developer.8x8.com/connect/docs/viber/sessions): ![Conversational Viber Business Messages showing two-way customer support exchanges](./images/Conversational%20Viber%20Business%20Messages.png) - [Transactional Message API Library](https://developer.8x8.com/connect/docs/viber/template-message-api-library): import TransactionalImg from './images/Transactional Viber Business Messages.png'; - [The 8x8 Viber Business Messages Platform](https://developer.8x8.com/connect/docs/viber/viber-hub): ![Viber Business Message Categories: Transactional, Conversational, and Promotional](./images/Viber%20Business%20Message%20Categories.png) - [Webhooks and Delivery Receipts](https://developer.8x8.com/connect/docs/viber/webhooks-delivery-receipts): Viber sends three kinds of event to your webhook: inbound messages from customers, delivery receipts for messages you sent, and template status cha... - [Viber Templates Management](https://developer.8x8.com/connect/docs/viber-templates-management): Viber message templates allow you to create pre-approved message formats for sending transactional messages and OTPs to your customers via Viber. T... - [Video Interaction Analytics](https://developer.8x8.com/connect/docs/video-interaction-analytics): The Video Interaction Analytics are covered in the Video Interaction section [here](vi-administrator-interface). - [Voice API – Introduction](https://developer.8x8.com/connect/docs/voice/api-introduction): The 8x8 Voice API lets you programmatically **make and control calls** using **JSON callflows**. - [Number Masking Error Codes](https://developer.8x8.com/connect/docs/voice/error-codes/number-masking-error-codes): Number Masking error codes are reported in Number Masking-specific callbacks and session summaries when errors occur during call bridging sessions.... - [Voice Error Codes Reference](https://developer.8x8.com/connect/docs/voice/error-codes/voice-error-codes-reference): Quick reference for Voice Session Summary (VSS) webhook error codes. For detailed explanations and troubleshooting guidance, see the [Voice Error C... - [Voice Error Codes](https://developer.8x8.com/connect/docs/voice/error-codes/voice-error-codes): Voice error codes are reported in the **Voice Session Summary (VSS)** webhook when errors occur during call execution. Unlike [status codes](/conne... - [Voice Status Codes Reference](https://developer.8x8.com/connect/docs/voice/error-codes/voice-status-codes-reference): Quick reference for Voice API response status codes. For detailed explanations and troubleshooting guidance, see the [Voice Status Codes Guide](/co... - [Voice Status Codes and Status Messages](https://developer.8x8.com/connect/docs/voice/error-codes/voice-status-codes): Status codes and status messages are returned in the API response when you submit a callflow to the **Callflows API**. These codes indicate whether... - [Advanced IVR Guide](https://developer.8x8.com/connect/docs/voice/ivr/advanced-ivr): This tutorial will cover a more advanced IVR use case with a multi-level IVR tree. It extends upon the principles in the Simple IVR page, but build... - [IVR Call Action Handling](https://developer.8x8.com/connect/docs/voice/ivr/call-action-handling): To start your call flow you need to reply to the call action request with an HTTP 200 response code including a Call Action in the HTTP response bo... - [IVR - Introduction](https://developer.8x8.com/connect/docs/voice/ivr/ivr-introduction): 8x8 IVR is built on our programmable voice capabilities. 8x8 Interactive Voice Response Service is an automated telephone system that combines pre-... - [Session Summary (IVR)](https://developer.8x8.com/connect/docs/voice/ivr/session-summary-ivr): This webhook provides a comprehensive summary of an IVR session after it ends. The Voice Session Summary (VSS) is sent to your configured webhook e... - [Simple IVR Guide](https://developer.8x8.com/connect/docs/voice/ivr/simple-ivr): Below is a sample of a simple IVR call scenario. The Callflow below demonstrates an example scenario where a callback is placed to a customer seeki... - [Webhook Setup Guide for IVR](https://developer.8x8.com/connect/docs/voice/ivr/webhook-setup-guide-for-ivr): First you should have a URL endpoint configured in order to receive webhooks. Your endpoint will need to respond to the webhooks in order to trigge... - [Number Masking Call Action Handling](https://developer.8x8.com/connect/docs/voice/number-masking/call-action-handling): This method provides insights about call details and will be sent to your "Voice Call Action" (VCA) endpoint. Your "Voice Call Action" (VCA) endpoi... - [Getting started with Number Masking](https://developer.8x8.com/connect/docs/voice/number-masking/getting-started-with-number-masking): The Number masking service enables your users to connect in a phone call while keeping their phone numbers private. By implementing 8x8's Number Ma... - [How to implement 8x8 Number Masking?](https://developer.8x8.com/connect/docs/voice/number-masking/how-number-masking-protects-customer-privacy): Although a simple phone conversation is hardly cutting-edge technology, it is nevertheless necessary for business-to-customer communication in toda... - [Number Masking Call Recordings](https://developer.8x8.com/connect/docs/voice/number-masking/number-masking-call-recordings): Before you enable Call Recordings for Number Masking sessions it is required to set up the ["Recordings Push Configuration"](/connect/reference/cre... - [Call Status (Number Masking)](https://developer.8x8.com/connect/docs/voice/number-masking/number-masking-call-status): This method provides insights about call details and will be sent to your "Voice Call Summary" (VCS) endpoint. Your "Voice Call Summary" (VCS) endp... - [Session Summary (Number Masking)](https://developer.8x8.com/connect/docs/voice/number-masking/session-summary-number-masking): This method allows you to review the "Voice Session Summary" status and individual call legs. - [Virtual Number Updated Event](https://developer.8x8.com/connect/docs/voice/number-masking/virtual-number-updated): Notifies customers that a change in either Virtual Number or Virtual Number Health has occurred - [CPaaS Voice offerings](https://developer.8x8.com/connect/docs/voice/overview): The **[8x8 CPaaS Voice](https://www.8x8.com/products/apis)** offering provides building blocks to deliver voice experiences such as **[WhatsApp Bus... - [CPaaS Voice SIP Response Codes](https://developer.8x8.com/connect/docs/voice/sip-response-codes/sip-response-codes): SIP (Session Initiation Protocol) response codes are standardized three-digit codes defined in [RFC 3261](https://tools.ietf.org/html/rfc3261) that... - [Voice IP addresses](https://developer.8x8.com/connect/docs/voice/voice-ip-addresses): If you need to restrict inbound traffic to your webhook endpoints, whitelist the following outbound IP addresses. These are the source IPs used by ... - [Session Summary (Voice Messaging)](https://developer.8x8.com/connect/docs/voice/voice-messaging/session-status): This webhook provides a comprehensive summary of a Voice Messaging session after it ends. The Voice Session Summary (VSS) is sent to your configure... - [Voice messaging guide](https://developer.8x8.com/connect/docs/voice/voice-messaging/voice-messaging-guide): 8x8 offers different API methods that allow you to send **Voice Messages** programmatically. - [Android - Integrating the Voice SDK](https://developer.8x8.com/connect/docs/voice/voice-sdk/voice-sdk-android-integrating): * [Requirements](#requirements) - [Voice SDK API Specification - Android](https://developer.8x8.com/connect/docs/voice/voice-sdk/voice-sdk-api-specification-android): - [Voice SDK API Specification - iOS](https://developer.8x8.com/connect/docs/voice/voice-sdk/voice-sdk-api-specification-ios): - [iOS - Integrating the Voice SDK](https://developer.8x8.com/connect/docs/voice/voice-sdk/voice-sdk-ios-integrating): The following sections describe installation and setup of the Voice SDK: - [Voice SDK Overview](https://developer.8x8.com/connect/docs/voice/voice-sdk/voice-sdk-overview): The 8x8 Voice SDK helps you build engaging and dependable voice calling experiences into your mobile app by enabling the ability to make and receiv... - [Using the iOS Voice SDK](https://developer.8x8.com/connect/docs/voice/voice-sdk/voice-sdk-using-ios): * [Overview](#overview) - [Using the Android Voice SDK](https://developer.8x8.com/connect/docs/voice/voice-sdk/voice-sdk-using): * [Initialize the SDK](#initialize-the-sdk) - [Voice Call Action Webhook Guide](https://developer.8x8.com/connect/docs/voice/webhook-guides/voice-call-action-webhook-guide): The **Voice Call Action (VCA) webhook** is a callback mechanism that allows your application to receive real-time events during an active voice ses... - [Voice Session Summary (VSS) webhook](https://developer.8x8.com/connect/docs/voice/webhook-guides/voice-session-summary-webhook): The **Voice Session Summary (VSS)** webhook is sent **after a voice session ends**. It provides a single end-of-session record you can use for mon... - [Webhooks Overview](https://developer.8x8.com/connect/docs/voice/webhook-guides/webhooks-overview): 8x8 CPaaS Voice provides webhook types to notify your application about call events and outcomes. Configure these webhooks at the **subaccount** le... - [Business-initiated calling](https://developer.8x8.com/connect/docs/voice/whatsapp-business-calling/whatsapp-business-calling-business-initiated): Business-initiated calling allows your business to initiate voice calls to customers via WhatsApp. Unlike user-initiated calls where the customer s... - [WhatsApp Business Calling Overview](https://developer.8x8.com/connect/docs/voice/whatsapp-business-calling/whatsapp-business-calling-overview): WhatsApp Business Calling allows businesses and customers to connect via voice calls directly within the WhatsApp app. This feature provides a seam... - [Supported calling scenarios](https://developer.8x8.com/connect/docs/voice/whatsapp-business-calling/whatsapp-business-calling-scenarios): This guide describes the common **WhatsApp Business Calling** scenarios you can implement with **8x8 CPaaS**, using **SIP delivery** into your cont... - [User-initiated calling](https://developer.8x8.com/connect/docs/voice/whatsapp-business-calling/whatsapp-business-calling-user-initiated): **User-initiated calling** allows customers to call your business directly from WhatsApp by tapping a **call entry point** (for example, the call i... - [Webhook migration guide](https://developer.8x8.com/connect/docs/webhook-migration-guide): The Webhook configuration API is available for [SMS](/connect/reference/webhook-configuration-api-sms) and for [Chat Apps] ([/connect/reference/get... - [Webhook object structure](https://developer.8x8.com/connect/docs/webhook-object-structure): 8x8 platform sends webhooks for a different event using the following common structure for request body: - [Webhooks Configuration API](https://developer.8x8.com/connect/docs/webhooks-configuration-api): Webhooks Configuration API - [Advanced Capabilities](https://developer.8x8.com/connect/docs/whatsapp/advanced-capabilities): Beyond sending and receiving individual messages, the 8x8 platform enables you to build sophisticated, multi-step customer journeys and rich intera... - [Concepts & Fundamentals](https://developer.8x8.com/connect/docs/whatsapp/concepts-fundamentals): Before you send your first message, it's essential to understand the core concepts and rules of the WhatsApp Business Platform. These rules govern ... - [Constructing WhatsApp Template Send Requests](https://developer.8x8.com/connect/docs/whatsapp/constructing-whatsapp-template-send-requests): Learn how to properly format and send WhatsApp template messages through the 8x8 API using both manual and automated approaches. This guide covers ... - [Getting Started with WhatsApp](https://developer.8x8.com/connect/docs/whatsapp/getting-started): This guide provides the step-by-step process for activating your WhatsApp Business Platform account and connecting it to the 8x8 Connect portal. Th... - [Governance, Security & Compliance](https://developer.8x8.com/connect/docs/whatsapp/governance-security): This section covers the mandatory policies, security features, and compliance rules for using the 8x8 WhatsApp Business Platform. Adhering to these... - [WhatsApp Interactive Message API Library](https://developer.8x8.com/connect/docs/whatsapp/interactive-message-api-library): import TextMessageImg from './images/Text Message.webp'; - [Learning Paths](https://developer.8x8.com/connect/docs/whatsapp/learning-paths): This documentation is comprehensive, but not all sections are relevant to every role. Use these learning paths as a "fast track" to the sections th... - [Message Types & Templates](https://developer.8x8.com/connect/docs/whatsapp/message-types-templates): This section covers the most important component of business-initiated conversations: **Message Templates**. You will learn what they are, how they... - [Operations, Monitoring & Troubleshooting](https://developer.8x8.com/connect/docs/whatsapp/operations-monitoring): This section covers the tools and data you need to monitor your 8x8 WhatsApp solution, diagnose issues, and understand operational costs. Effective... - [Reference & Resources](https://developer.8x8.com/connect/docs/whatsapp/reference-resources): This section provides a consolidated list of key terms, API reference links, and other resources to help you successfully build and manage your 8x8... - [Scenarios & Tutorials](https://developer.8x8.com/connect/docs/whatsapp/scenarios-tutorials): This section provides practical, step-by-step scenarios for solving common business problems using the 8x8 WhatsApp solution. These guides combine ... - [WhatsApp Template Components Reference](https://developer.8x8.com/connect/docs/whatsapp/template-components-reference): This technical reference provides detailed specifications for all WhatsApp template components, including constraints, formatting rules, and API pa... - [WhatsApp Template Message API Library](https://developer.8x8.com/connect/docs/whatsapp/template-message-api-library): import ImageHeaderTemplate from './images/Image Header Template.webp'; - [Vertical Playbooks](https://developer.8x8.com/connect/docs/whatsapp/vertical-playbooks): These vertical playbooks provide deep, practical examples of how the 8x8 WhatsApp solution can be applied to solve specific industry challenges. Ea... - [WhatsApp Business-Scoped User IDs (BSUID)](https://developer.8x8.com/connect/docs/whatsapp/whatsapp-business-scoped-user-ids): WhatsApp is introducing optional end-user usernames that allow users to hide their phone numbers from the businesses they message. To ensure busine... - [WhatsApp Flows over 8x8 API](https://developer.8x8.com/connect/docs/whatsapp/whatsapp-flows-api): This API reference provides complete technical documentation for developers implementing WhatsApp Flows programmatically. - [WhatsApp Flow Best Practices & Governance](https://developer.8x8.com/connect/docs/whatsapp/whatsapp-flows-best-practices): Comprehensive guidelines for designing effective, secure, and compliant WhatsApp Flows. Follow these best practices to create Flows that deliver gr... - [WhatsApp Flow Component Reference](https://developer.8x8.com/connect/docs/whatsapp/whatsapp-flows-components): Complete technical reference for all UI components available in WhatsApp Flows. Use this guide when building Flow JSON definitions to understand co... - [Financial Services Flow Examples](https://developer.8x8.com/connect/docs/whatsapp/whatsapp-flows-examples-financial): ![Loan Application Flow](./images/loan-application.webp) - [Healthcare Flow Examples](https://developer.8x8.com/connect/docs/whatsapp/whatsapp-flows-examples-healthcare): ![Appointment Scheduling Flow](./images/appointment-scheduling.webp) - [Professional Services Flow Examples](https://developer.8x8.com/connect/docs/whatsapp/whatsapp-flows-examples-professional-services): ![Service Appointment Booking Flow](./images/service-appointment-booking.webp) - [Retail & eCommerce Flow Examples](https://developer.8x8.com/connect/docs/whatsapp/whatsapp-flows-examples-retail): ![Product Return & Exchange Flow](./images/product-return-exchange.webp) - [Sales & Marketing Flow Examples](https://developer.8x8.com/connect/docs/whatsapp/whatsapp-flows-examples-sales): ![CPaaS Lead Generation Flow](./images/lead-generation.webp) - [WhatsApp Flow Examples](https://developer.8x8.com/connect/docs/whatsapp/whatsapp-flows-examples): This library provides production-ready WhatsApp Flow implementations for common industry use cases. Each example includes the complete Flow JSON de... - [WhatsApp Flows in 8x8 Connect](https://developer.8x8.com/connect/docs/whatsapp/whatsapp-flows-ui-guide): This guide walks you through creating, testing, and deploying WhatsApp Flows using the visual, no-code interface in the 8x8 Connect portal. Perfect... - [WhatsApp Flows](https://developer.8x8.com/connect/docs/whatsapp/whatsapp-flows): ![WhatsApp Flows Landing Page](./images/whatsapp-flows-landing-page.webp) - [The 8x8 WhatsApp Business Platform](https://developer.8x8.com/connect/docs/whatsapp/whatsapp-hub): Welcome to the 8x8 Integration for the WhatsApp Business Platform! This documentation guides you through using 8x8's communication tools to connect... - [WhatsApp in 8x8 Connect](https://developer.8x8.com/connect/docs/whatsapp/whatsapp-in-8x8-connect): Beyond the API, the 8x8 Connect portal offers three powerful, ready-to-use solutions to manage your WhatsApp communications. This section provides ... - [WhatsApp Media Hosting & Management](https://developer.8x8.com/connect/docs/whatsapp/whatsapp-media-hosting): Ensure reliable and fast media delivery in your WhatsApp messages by leveraging the 8x8 media hosting service. When you upload media files through ... - [WhatsApp over 8x8 API](https://developer.8x8.com/connect/docs/whatsapp/whatsapp-over-8x8-api): This guide provides the technical foundation for integrating the 8x8 Messaging App API for WhatsApp into your applications, CRMs, and backend syste... - [WhatsApp SMS Fallback](https://developer.8x8.com/connect/docs/whatsapp/whatsapp-sms-fallback): Ensure your critical messages always reach customers by configuring SMS fallback for WhatsApp messages. When a WhatsApp message cannot be delivered... - [WhatsApp Webhooks Reference](https://developer.8x8.com/connect/docs/whatsapp/whatsapp-webhooks): Webhooks enable real-time, event-driven communication between the 8x8 platform and your application. When specific events occur (such as receiving ... - [WhatsApp Account Update Webhook](https://developer.8x8.com/connect/docs/whatsapp-account-update-webhook): **WhatsApp Account Update Webhooks** are notifications sent to you to inform about updates and changes to your WhatsApp Business Account (WABA). - [WhatsApp Automatic Events Webhook](https://developer.8x8.com/connect/docs/whatsapp-automatic-events-webhook): **WhatsApp Automatic Events Webhooks** are notifications sent to you when Meta detects a qualifying conversion event (a **purchase** or a **lead**)... - [WhatsApp Business-scoped user IDs](https://developer.8x8.com/connect/docs/whatsapp-business-scoped-user-ids): A **business-scoped user ID (BSUID)** is Meta's per-business identifier for a WhatsApp user. It can accompany — or, for username-only users, replac... - [WhatsApp Phone Number Quality Change Webhook](https://developer.8x8.com/connect/docs/whatsapp-phone-number-quality-change-webhook): **WhatsApp Phone Number Change Webhook** are notifications sent to you to inform about changes to your business phone number's [messaging limit](ht... - [WhatsApp Template Change Webhook](https://developer.8x8.com/connect/docs/whatsapp-template-change-webhook): **WhatsApp Template Change Webhook** are notifications sent to you to inform about any updates or modifications to your WhatsApp template. - [WhatsApp Templates Management](https://developer.8x8.com/connect/docs/whatsapp-templates-management): This page will cover the options available within 8x8 Connect to manage your WhatsApp templates. - [Workato](https://developer.8x8.com/connect/docs/workato): [Workato](https://www.workato.com/) is an integrations platform that helps you connect and create automated workflows that connect apps to complete... - [Tutorial: Google Sheets and SMS](https://developer.8x8.com/connect/docs/zapier-google-sheets-and-sms): * An 8x8 Connect account - [Zapier](https://developer.8x8.com/connect/docs/zapier): [Zapier](https://zapier.com/apps/8x8/integrations) is a service that helps you automate workflows between different apps automatically. - [Zendesk - Notifications Webhook](https://developer.8x8.com/connect/docs/zendesk-notifications-webhooks): Learn how to send Zendesk notifications via SMS or Messaging Apps from 8x8 - [Zendesk Support](https://developer.8x8.com/connect/docs/zendesk-support): [Zendesk](https://www.zendesk.com/) is a customer support system for tracking, prioritizing, and solving support tickets. - [8x8 Connect](https://developer.8x8.com/connect): import ConnectCards from '@site/docusaurus/components/ConnectCards'; - [Add a contact to a group](https://developer.8x8.com/connect/reference/add-contacts-to-group.api): Add a contact to a group - [Add Viber template](https://developer.8x8.com/connect/reference/add-viber-template.api): This endpoint is used to register a new Viber message template. - [Create or Replace webhooks](https://developer.8x8.com/connect/reference/add-webhooks-1.api): Sending a POST request on this endpoint allows to **add a new webhook for an account or modify the configuration of an existing one** . - [Create or Replace webhooks](https://developer.8x8.com/connect/reference/add-webhooks-2.api): Sending a POST request on this endpoint allows to **add a new webhook for an account or modify the configuration of an existing one** . - [Create or Replace webhooks](https://developer.8x8.com/connect/reference/add-webhooks.api): Sending a POST request on this endpoint allows to **add a new webhook for an account or modify the configuration of an existing one** . - [Add WhatsApp template](https://developer.8x8.com/connect/reference/add-whatsapp-template.api): This endpoint is used to register new WhatsApp message template. - [SMS Success Feedback](https://developer.8x8.com/connect/reference/api-sms-feedback.api): About SMS Feedback - [Automation API](https://developer.8x8.com/connect/reference/automation-api.info): API for managing workflows on 8x8 Automation - [Copy contacts between groups](https://developer.8x8.com/connect/reference/batch-copy-contacts.api): Copy contacts from ony group to another one. - [Batch delete contacts](https://developer.8x8.com/connect/reference/batch-delete-contacts.api): Use this endpoint to delete multiple/all contacts in batch. Provide `ids` or `msisdns` to remove specific contacts, or set `'all': true` to delete ... - [Batch delete groups](https://developer.8x8.com/connect/reference/batch-delete-groups.api): Batch delete groups - [Move contacts between groups](https://developer.8x8.com/connect/reference/batch-move-contacts.api): Move contacts from one group to another one. This operation will delete contacts in the original group. - [Batch create contacts](https://developer.8x8.com/connect/reference/batch-upload-contacts.api): Batch create contacts using file. The file can be either CSV or Excel. The CSV file can contain a header row (the mapping of the columns will be au... - [Blacklist msisdn for a specific account](https://developer.8x8.com/connect/reference/blacklist-msisdn.api): Blacklist msisdn for a specific account - [Business Messaging API](https://developer.8x8.com/connect/reference/business-messaging-api.info): This API is for sending messages in Messaging Apps like WhatsApp, Viber, RCS and Line. It also provides the ability to manage templates and export ... - [Detail call](https://developer.8x8.com/connect/reference/call-detail.api): This API endpoint enables information retrieval related to a specific past call. You need to use the Token API first to create an Authorization Tok... - [Call Logs](https://developer.8x8.com/connect/reference/call-log.api): This API endpoint allows to retrieve information related to past calls. You need to use the Token API first to create an Authorization Token. You c... - [Cancel the log export job ](https://developer.8x8.com/connect/reference/cancel-log-export-job-1.api): * Sending a **DELETE** request on this endpoint allows to **cancel a Messaging Apps Logs export job**. - [Cancel the log export job ](https://developer.8x8.com/connect/reference/cancel-log-export-job.api): * Sending a **DELETE** request on this endpoint allows to **cancel a SMS Logs export job**. - [Cancel batch of scheduled message](https://developer.8x8.com/connect/reference/cancel-many-chat-apps-messages.api): - Sending a DELETE request on this this endpoint allows to **cancel a batch of scheduled messages** that has not been sent yet. - [Cancel batch of scheduled SMS](https://developer.8x8.com/connect/reference/cancel-many-sms-messages.api): - Sending a DELETE request on this this endpoint allows to **cancel a batch of scheduled messages** that has not been sent yet. - [Cancel the scheduled message](https://developer.8x8.com/connect/reference/cancel-scheduled-message-1.api): 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. - [Cancel the scheduled SMS](https://developer.8x8.com/connect/reference/cancel-scheduled-message.api): 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. - [Cancel the log export job ](https://developer.8x8.com/connect/reference/cancel-voice-log-export-job.api): * Sending a **DELETE** request on this endpoint allows to **cancel a Logs export job**. - [Check Virtual Number](https://developer.8x8.com/connect/reference/check-virtual-number.api): Should the request be authenticated successfully and the specific number is assigned to your subaccount, the response will contain a Number object ... - [Validate verification](https://developer.8x8.com/connect/reference/code-validation-v-2.api): This method allows you to check the status of a verification request or to validate a code submitted by one of your user. - [Common models](https://developer.8x8.com/connect/reference/common-models.info): Common API models - [Configuration API](https://developer.8x8.com/connect/reference/configuration-api.info): The configuration API allows to manage account-wide and subaccount configurations such as the webhooks used for SMS and Chat-Apps inbound messages,... - [Search contacts](https://developer.8x8.com/connect/reference/contact-search.api): Search for contacts - [Contacts API](https://developer.8x8.com/connect/reference/contacts-api.info): Contacts API v1 - [Create a new recording push config](https://developer.8x8.com/connect/reference/create-a-new-recording-push-config.api): Create a new recording push config - [Create a new webhook](https://developer.8x8.com/connect/reference/create-a-new-webhook.api): Create a new webhook - [Create contact](https://developer.8x8.com/connect/reference/create-contact.api): Create a new contact - [Create a new workflow definition](https://developer.8x8.com/connect/reference/create-definition.api): Use this resource to create and activate a new workflow definition. - [Create a group](https://developer.8x8.com/connect/reference/create-group.api): Create a group - [Create WhatsApp Flow](https://developer.8x8.com/connect/reference/create-whatsapp-flow.api): This endpoint is used to create a new WhatsApp Flow. - [Delete a specific type of webhook](https://developer.8x8.com/connect/reference/delete-a-specific-type-of-webhook.api): Delete a specific type of webhook - [Remove contacts from a group](https://developer.8x8.com/connect/reference/delete-contacts-from-group.api): Delete contacts from group - [Delete workflow definition](https://developer.8x8.com/connect/reference/delete-definitions.api): Use this resource to delete workflow definitions. Specify the version of the definition to delete in the query parameter. If no version is specifie... - [Delete group](https://developer.8x8.com/connect/reference/delete-group.api): Delete group - [Remove Personally Identifiable Information (PII)](https://developer.8x8.com/connect/reference/delete-pii.api): Remove Personally Identifiable Information (PII) for particular message from 8x8 SMS database. - [Delete recording push config](https://developer.8x8.com/connect/reference/delete-recording-push-config.api): Delete recording push config - [Delete single contact](https://developer.8x8.com/connect/reference/delete-single-contact.api): Delete single contact by id - [Delete webhooks](https://developer.8x8.com/connect/reference/delete-webhooks-1.api): Sending a DELETE request on this endpoint allows to **remove a configured webhook for an account or a subaccount** . - [Delete webhooks](https://developer.8x8.com/connect/reference/delete-webhooks-2.api): Sending a DELETE request on this endpoint allows to **remove a configured webhook for an account or a subaccount** . - [Delete webhooks](https://developer.8x8.com/connect/reference/delete-webhooks.api): Sending a DELETE request on this endpoint allows to **remove a configured webhook for an account or a subaccount** . - [Delete WhatsApp Flow](https://developer.8x8.com/connect/reference/delete-whatsapp-flow.api): This endpoint is used to delete a WhatsApp Flow. - [Deprecate WhatsApp Flow](https://developer.8x8.com/connect/reference/deprecate-whatsapp-flow.api): This endpoint is used to deprecate a WhatsApp Flow. - [Download file](https://developer.8x8.com/connect/reference/download-file.api): Download file - [Get account balance](https://developer.8x8.com/connect/reference/get-account-balance.api): * Sending a **GET** request on this endpoint allows to **get account balance**. - [Retrieve a list of active workflow definitions.](https://developer.8x8.com/connect/reference/get-all-definitions.api): Use this resource to explore currently active definitions. Workflows are started based on these definitions when the trigger conditions are met. Us... - [Get batch information by id](https://developer.8x8.com/connect/reference/get-batch-by-id.api): Get batch information by id - [Get batch job list](https://developer.8x8.com/connect/reference/get-batch-job-list.api): Get batch job list - [Get Call Permission Status](https://developer.8x8.com/connect/reference/get-call-permission-status.api): 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 ... - [Retrieve message details](https://developer.8x8.com/connect/reference/get-chatapps-message-details.api): 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 t... - [Get contact information by id](https://developer.8x8.com/connect/reference/get-contact-by-id.api): Get contact information by contact id - [Retrieve a list of supported JavaScript functions](https://developer.8x8.com/connect/reference/get-functions.api): Automation supports scripting in inputs, outputs and select next steps using JavaScript (supports most features of ECMAScript 2023). On top of stan... - [Get group information by id](https://developer.8x8.com/connect/reference/get-group-by-id.api): Get group information by id - [Retrieve a list of errors for a workflow instance](https://developer.8x8.com/connect/reference/get-instance-errors.api): Use this resource to retrieve a list of runtime errors for a workflow instance. If the workflow definition is not working as expected, workflow err... - [Retrieve workflow instance status](https://developer.8x8.com/connect/reference/get-instance-status.api): Use this resource to view the status of a workflow instance. - [Get log export job result](https://developer.8x8.com/connect/reference/get-log-export-job-result-1.api): * 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 ... - [Get log export job result](https://developer.8x8.com/connect/reference/get-log-export-job-result.api): * Sending a **GET** request on this endpoint allows to **check the status of an SMS Logs export job** and to **get a download link** if its generat... - [Get message usage](https://developer.8x8.com/connect/reference/get-message-usage.api): Returns monthly per-message usage totals for the specified billing period. Results can be filtered and grouped by subaccount, business account, cha... - [Get SMS price list](https://developer.8x8.com/connect/reference/get-price-list.api): * Sending a **GET** request on this endpoint allows to **get prices** based on different criteria. - [Get recording push config for your account](https://developer.8x8.com/connect/reference/get-recording-push-config-information.api): Get recording push config for your account - [Get recording status](https://developer.8x8.com/connect/reference/get-recording-status-information.api): Get recording status - [Retrieve SMS details](https://developer.8x8.com/connect/reference/get-sms-message-details.api): This resource can be used to query message details like delivery status using the *unique message identifier* (`UMID`) of the message. - [Retrieve the version history of a workflow definition.](https://developer.8x8.com/connect/reference/get-specific-definition.api): Use this resource to explore different versions of a workflow definition. Results are ordered in the descending order of the version. - [Retrieve a list of supported time zones](https://developer.8x8.com/connect/reference/get-timezones.api): Use this resource to explore supported time zones. Time zones are used as parameters in some of our time related JavaScript helper functions like `... - [Retrieve a list of executed workflow counts by yearly](https://developer.8x8.com/connect/reference/get-usage-history.api): API which can be used to fetch usage historical data for Automation service - [Retrieve the allowed workflow counts and current usage](https://developer.8x8.com/connect/reference/get-usage.api): API which can be used to fetch usage and billing-related information for Automation service - [Get My Virtual Numbers](https://developer.8x8.com/connect/reference/get-virtual-numbers.api): The Number Health Service provides insights about the reachability/availability for the numbers assigned to your subaccount. - [Get log export job result](https://developer.8x8.com/connect/reference/get-voice-log-export-job-result.api): * Sending a **GET** request on this endpoint allows to **check the status of an Voice Logs export job** and to **get a download link** if its gener... - [Get speech profiles for your account](https://developer.8x8.com/connect/reference/get-voice-profile-information.api): Get speech profiles for your account - [Get all Webhooks for Account](https://developer.8x8.com/connect/reference/get-webhooks-1.api): Sending a GET request on this endpoint allows to **retrieve a list of all the webhooks or a specific webhook configured for an account**. - [Get all Webhooks for Account](https://developer.8x8.com/connect/reference/get-webhooks-2.api): Sending a GET request on this endpoint allows to **retrieve a list of all the webhooks or a specific webhook configured for an account**. - [Get webhook information for your account](https://developer.8x8.com/connect/reference/get-webhooks-information.api): Get webhook information for your account - [Get all Webhooks for Account](https://developer.8x8.com/connect/reference/get-webhooks.api): Sending a GET request on this endpoint allows to **retrieve a list of all the webhooks or a specific webhook configured for an account**. - [Get WhatsApp Flow details](https://developer.8x8.com/connect/reference/get-whatsapp-flow-details.api): This endpoint is used to retrieve details of a specific WhatsApp Flow. - [Get WhatsApp Flows](https://developer.8x8.com/connect/reference/get-whatsapp-flows.api): This endpoint is used to retrieve the list of WhatsApp Flows and their status for the channel. - [Get WhatsApp templates](https://developer.8x8.com/connect/reference/get-whatsapp-templates.api): This endpoint is used to get your registered WhatsApp message template and their approval status. - [Retrieve a list of workflow instances](https://developer.8x8.com/connect/reference/get-workflow-instances.api): Use this resource to explore workflows created based on a specific workflow definition. If the definition version is not specified, workflows for t... - [Trigger workflows using an external event](https://developer.8x8.com/connect/reference/http-request-trigger.api): Use this resource to trigger workflows from an external system. Inbound SMS and chat apps message triggers are managed by the automation service. H... - [Mark message as read](https://developer.8x8.com/connect/reference/mark-message-read.api): This endpoint is used to indicate to end users that a message has been read by the respective brand or official account. - [Get My Virtual Numbers](https://developer.8x8.com/connect/reference/number-health-service.api): The Number Health Service provides insights about the reachability/availability for the numbers assigned to your subaccount. - [Number Lookup API](https://developer.8x8.com/connect/reference/number-lookup-api.info): Number Lookup API allows customers to perform various levels of information lookup on a given phone number. - [Number Masking API](https://developer.8x8.com/connect/reference/number-masking-api.info): Welcome to our Number Masking documentation! - [OAS file for common models, don't remove, don't publish!](https://developer.8x8.com/connect/reference/oas-file-for-common-models-dont-remove-dont-publish.api): OAS file for common models, don't remove, don't publish! - [Update workflow instance status](https://developer.8x8.com/connect/reference/patch-workflow-instance.api): Use this resource to control the state of a workflow instance. For example, you can suspend a workflow to be resumed later or terminate a workflow ... - [Get phone number lookup data](https://developer.8x8.com/connect/reference/phone-number-lookup.api): * Sending a **GET** request on this endpoint allows retrieving information about a phone number - [Preview WhatsApp Flow](https://developer.8x8.com/connect/reference/preview-whatsapp-flow.api): This endpoint is used to generate a preview URL for a WhatsApp Flow. - [Publish WhatsApp Flow](https://developer.8x8.com/connect/reference/publish-whatsapp-flow.api): This endpoint is used to publish a WhatsApp Flow. - [Remove WhatsApp template](https://developer.8x8.com/connect/reference/remove-wa-template.api): This endpoint is used to remove an existing WhatsApp message template. - [Retrieve Image](https://developer.8x8.com/connect/reference/retrieve-image.api): This operation allows you to download an image from a conversation. - [Search for groups](https://developer.8x8.com/connect/reference/search-groups.api): Search for groups - [Send Callflow](https://developer.8x8.com/connect/reference/send-callflow.api): **Note:** For all API requests that include a `source` parameter, CLID whitelisting is mandatory. Please contact your account manager or email cpaa... - [Send Line Notification message](https://developer.8x8.com/connect/reference/send-lon-message.api): This endpoint is used to send Messaging Apps messages individually (1 request per message). - [Send Line Notification message batch](https://developer.8x8.com/connect/reference/send-lon-messages.api): * This endpoint is used to send Messaging Apps messages by batches (1 request for multiple messages) with personalized contents/properties. - [Send SMS batch](https://developer.8x8.com/connect/reference/send-many-sms.api): * Sending a POST request to this endpoint allows you to **send SMS by batches (1 request for multiple SMS) with shared or personalized contents/pro... - [Send message batch](https://developer.8x8.com/connect/reference/send-message-many.api): * This endpoint is used to send Messaging Apps messages by batches (1 request for multiple messages) with personalized contents/properties. - [Send message](https://developer.8x8.com/connect/reference/send-message.api): This endpoint is used to send Messaging Apps messages individually (1 request per message). - [Send SMS](https://developer.8x8.com/connect/reference/send-sms-single.api): * Sending a POST request on this endpoint allows to **send SMS individually (1 request per SMS)**. - [Send Typing Indicator](https://developer.8x8.com/connect/reference/send-typing-indicator.api): This endpoint is used to send typing indicators to messaging channels. This allows brands to provide real-time feedback to end users, showing that ... - [SMA coverage check](https://developer.8x8.com/connect/reference/sma-coverage-check.api): This method allows you to check if user's device is supported by Silent Mobile Authentication (SMA). Could be used to perform pre-check before init... - [SMS API](https://developer.8x8.com/connect/reference/sms-api.info): API to send SMS messages - [Start log export job](https://developer.8x8.com/connect/reference/start-log-export-job-1.api): * Sending a **POST** request on this endpoint allows to **request an Messaging Apps logs file**. - [Start SMS log export job](https://developer.8x8.com/connect/reference/start-log-export-job.api): * Sending a **POST** request on this endpoint allows to **request an SMS logs file**. - [Start log export job](https://developer.8x8.com/connect/reference/start-voice-log-export-job.api): * Sending a **POST** request on this endpoint allows to **request an Voice logs file**. - [Test workflow definition](https://developer.8x8.com/connect/reference/start-workflow-instance.api): Use this resource to test workflow definition by starting workflow instances. This endpoint is useful for testing your workflows without involving ... - [Submit WhatsApp Direct Send Sample](https://developer.8x8.com/connect/reference/submit-whatsapp-direct-send-sample.api): This endpoint is used to submit a sample of a WhatsApp Direct Send message to Meta for review and classification. - [Send SMS Engage surveys as batch](https://developer.8x8.com/connect/reference/survey-send-many.api): * Sending a POST request on this endpoint allows to **send SMS Engage surveys by batch (multiple messages per request)**. - [Send SMS Engage survey](https://developer.8x8.com/connect/reference/survey-send.api): About SMS Engage - [Token creation](https://developer.8x8.com/connect/reference/tokens.api): This API endpoint allows the creation of a bearer token. The API endpoint can also be used to create a new room, once a room is created, participan... - [Update contact information](https://developer.8x8.com/connect/reference/update-contact.api): Update contact information - [Update workflow definition](https://developer.8x8.com/connect/reference/update-existing-definition.api): Use this resource to update an existing workflow definition. Updating a workflow definition creates and registers a new version of the definition a... - [Update group information](https://developer.8x8.com/connect/reference/update-group.api): Update group information - [Update WhatsApp Flow](https://developer.8x8.com/connect/reference/update-whatsapp-flow.api): This endpoint is used to update an existing WhatsApp Flow. The flow must be in draft state. - [Upload file](https://developer.8x8.com/connect/reference/upload-file.api): Upload file - [Verification API](https://developer.8x8.com/connect/reference/verification-api.info): Verification API supports phone number verification through OTP delivery via SMS, WhatsApp, Viber, or voice call, and silent mobile authentication,... - [Initiate verification](https://developer.8x8.com/connect/reference/verify-request-v-2.api): This method allows you to: - [Video Interaction API](https://developer.8x8.com/connect/reference/video-interaction-api.info): This is the API to integrate 8x8 Video Interaction product. - [Voice API](https://developer.8x8.com/connect/reference/voice-api.info): Voice API documentation - [Migrate from version 1 to version 2](https://developer.8x8.com/contactcenter/changelog/migrate-from-version-1-to-version-2): If you used [Chat API V1](/contactcenter/docs/getting-started) you can still use it as [Chat API V2](/contactcenter/v2.0/docs) comes out, version 1... - [Welcome to contact center](https://developer.8x8.com/contactcenter/changelog/welcome-to-contact-center): Welcome to the developer hub and documentation for contact center! - [Changelog](https://developer.8x8.com/contactcenter/changelog): If you used [Chat API V1](/contactcenter/docs/getting-started) you can still use it as [Chat API V2](/contactcenter/v2.0/docs) comes out, version 1... - [API key](https://developer.8x8.com/contactcenter/docs/api-key): > ❗️ **PLEASE NOTE - This API is going to be deprecated on 30th September 2023, it will no longer work after this date. Please use our [Chat Gatewa... - [Contact Center Chat API](https://developer.8x8.com/contactcenter/docs/contact-center-chat): > ❗️ **PLEASE NOTE - This API is going to be deprecated on 30th September 2023, it will no longer work after this date. Please use our [Chat Gatewa... - [Conversation](https://developer.8x8.com/contactcenter/docs/conversation): > ❗️ **PLEASE NOTE - This API is going to be deprecated on 30th September 2023, it will no longer work after this date. Please use our [Chat Gatewa... - [Channel](https://developer.8x8.com/contactcenter/docs/create-a-chat-api-channel): > ❗️ **PLEASE NOTE - This API is going to be deprecated on 30th September 2023, it will no longer work after this date. Please use our [Chat Gatewa... - [Webhooks](https://developer.8x8.com/contactcenter/docs/create-a-webhook): > ❗️ **PLEASE NOTE - This API is going to be deprecated on 30th September 2023, it will no longer work after this date. Please use our [Chat Gatewa... - [Key Elements](https://developer.8x8.com/contactcenter/docs/key-elements-in-chat-api): > ❗️ **PLEASE NOTE - This API is going to be deprecated on 30th September 2023, it will no longer work after this date. Please use our [Chat Gatewa... - [Troubleshooting](https://developer.8x8.com/contactcenter/docs/troubleshooting): > ❗️ **PLEASE NOTE - This API is going to be deprecated on 30th September 2023, it will no longer work after this date. Please use our [Chat Gatewa... - [Validating webhook events](https://developer.8x8.com/contactcenter/docs/verify-webhook-callbacks): The Chat API HTTP **`POST`** requests have custom headers containing the digital signature of the event that enable you to establish: - [Webhook Events Reference](https://developer.8x8.com/contactcenter/docs/webhook-events-reference): Webhook events are how 8x8 notifies bots or integrations when an event occurs such as when an agent sends a message. - [Chat Workflow](https://developer.8x8.com/contactcenter/docs/workflow): > ❗️ **PLEASE NOTE - This API is going to be deprecated on 30th September 2023, it will no longer work after this date. Please use our [Chat Gatewa... - [8x8 Contact Center Chat API](https://developer.8x8.com/contactcenter/reference/8-x-8-contact-center-chat-api.info): Integration with the 8x8 Contact Center (CC) Chat API enables you to: - [Creates a new access token that can be used for API access.](https://developer.8x8.com/contactcenter/reference/createaccesstoken.api): Creates a new access token that can be used for API access. - [Creates a new conversation.](https://developer.8x8.com/contactcenter/reference/createcctransaction.api): Creates a new transaction in the Contact Center and returns a conversation Id as an identifier that can be used later on to send messages to agent ... - [Creates a channel.](https://developer.8x8.com/contactcenter/reference/createchatapichannel.api): Create a new channel for a customer. - [Creates a new customer webhook.](https://developer.8x8.com/contactcenter/reference/createwebhook.api): Creates a new customer webhook. - [Customers leaves conversation.](https://developer.8x8.com/contactcenter/reference/customerparticipantleavecctransaction.api): When customers leave a conversation. It translates to a current interaction that is being terminated by the customer. - [Delete ChatAPI channel by Id.](https://developer.8x8.com/contactcenter/reference/deletechatapichannelbyid.api): Deletes ChatAPI channel by the provided Id. - [Deletes the webhook by Id.](https://developer.8x8.com/contactcenter/reference/deletewebhookbyid.api): Deletes the webhook by Id. - [Retrieves conversation details.](https://developer.8x8.com/contactcenter/reference/getcctransaction.api): Retrieves conversation details. - [Returns all conversations belonging to the customer.](https://developer.8x8.com/contactcenter/reference/getcctransactions.api): Returns a list of all conversations belonging to the customer that comply with the provided filters. - [Get ChatAPI channel by Id.](https://developer.8x8.com/contactcenter/reference/getchatapichannel.api): Retrieves ChatAPI channel by Id. - [Retrieves all customer Chat API channels.](https://developer.8x8.com/contactcenter/reference/getchatapichannels.api): Retrieves all customer Chat API channels based on the provided access token information. - [Returns the public JWK.](https://developer.8x8.com/contactcenter/reference/getjwkpublickey.api): Returns the public JWK that can be used to validate the message signature. - [Retrieves the conversation messages.](https://developer.8x8.com/contactcenter/reference/getmessagesforcctransaction.api): Retrieves the conversation messages that took place during the lifepan of the conversation. - [Retrieve the conversation participants.](https://developer.8x8.com/contactcenter/reference/getparticipantsforcctransaction.api): Retrieves all the participants that joined during the lifespan of the conversation. - [Get webhook by Id.](https://developer.8x8.com/contactcenter/reference/getwebhookbyid.api): Retrieves the webhook by the provided Id. - [Retrieves all customer webhooks based on the associated token information.](https://developer.8x8.com/contactcenter/reference/getwebhooks.api): Retrieves all customer webhooks based on the associated token information. - [Send a message.](https://developer.8x8.com/contactcenter/reference/sendmessagetocctransaction.api): Send a message to a conversation represented by the provided ID. - [Update ChatAPI channel by Id.](https://developer.8x8.com/contactcenter/reference/updatechatapichannel.api): Update ChatAPI channel by Id. - [Updates the full webhook resource by Id.](https://developer.8x8.com/contactcenter/reference/updatewebhook.api): Updates the full webhook resource by Id. - [The endpoint used to validate that the webhook is working and reachable.](https://developer.8x8.com/contactcenter/reference/verifywebhook.api): Validates the webhook URL endpont from the connectivity point-of-view by sending a hello message and a 2xx success status code. - [Index](https://developer.8x8.com/actions-events/docs): import Hero, { Logo } from '@site/docusaurus/components/Hero'; - [14 December 2021 Release](https://developer.8x8.com/jaas/docs/14-december-2021-release): **New features** - [14 October 2021 Release](https://developer.8x8.com/jaas/docs/14-october-2021-release): **UX improvements** - [15 September 2021 Release](https://developer.8x8.com/jaas/docs/15-september-2021-release): **Improvements** - [16 December 2021 Release](https://developer.8x8.com/jaas/docs/16-december-2021-release): **Quality improvements** - [16 July 2021 Release](https://developer.8x8.com/jaas/docs/16-july-2021-release): **UX improvements** - [16 November 2021 Release](https://developer.8x8.com/jaas/docs/16-november-2021-release): **UX improvements** - [20 January 2022 Release](https://developer.8x8.com/jaas/docs/20-january-2022-release): **UX improvements** - [22 June 2021 Release](https://developer.8x8.com/jaas/docs/22-june-2021-release): **UX improvements** - [23 September 2021 Release](https://developer.8x8.com/jaas/docs/23-september-2021-release): **New Features** - [24 February 2022 Release](https://developer.8x8.com/jaas/docs/24-february-2022-release): **UX improvements** - [24 June 2021 Release](https://developer.8x8.com/jaas/docs/24-june-2021-release): * Cloud recording feature - [24 March 2022 Release](https://developer.8x8.com/jaas/docs/24-march-2022-release): **UX improvements** - [27 August 2021 Release](https://developer.8x8.com/jaas/docs/27-august-2021-release): **Fixes** - [27 July 2021 Release](https://developer.8x8.com/jaas/docs/27-july-2021-release): **UX improvements** - [6 April 2022 Release](https://developer.8x8.com/jaas/docs/6-april-2022-release): **Highlights** - [6 May 2022 Release](https://developer.8x8.com/jaas/docs/6-may-2022-release): **Highlights** - [9 September 2021 Release](https://developer.8x8.com/jaas/docs/9-september-2021-release): **Improvements** - [AI Services](https://developer.8x8.com/jaas/docs/ai-services): The **AI Services** page enables JaaS admins to configure the default Transcriber for their meetings. - [Backend integration tutorials & samples](https://developer.8x8.com/jaas/docs/api-key-backend): Please check below jwt generation samples for various programming languages: - [Generating and adding your JaaS API key](https://developer.8x8.com/jaas/docs/api-keys-generate-add): Your uploaded public key is used to authenticate generated JWT tokens using the Private Key of the specific key pair. When the Jitsi IFrame connect... - [The Jitsi JSON Web Token (JWT)](https://developer.8x8.com/jaas/docs/api-keys-jwt): For each user endpoint you enable for a meeting, you must generate a JWT token and sign it with a Private Key. - [Overview](https://developer.8x8.com/jaas/docs/api-keys-overview): The **API Keys** provide the means to generate the JWTs used for authenticating user endpoints when joining a meeting. JaaS only stores the Public ... - [Tutorial: Using Custom Buttons with the Iframe API](https://developer.8x8.com/jaas/docs/custom-buttons-iframe-api): In this tutorial, we will explore how to add custom buttons to the Jitsi Meet iframe to enhance user interaction during video conferencing. While J... - [How to manage UI buttons](https://developer.8x8.com/jaas/docs/customize-ui-buttons): UI buttons visibility is controlled through a *configOverwrite* property called **`toolbarButtons`** - [How to set default language](https://developer.8x8.com/jaas/docs/customize-ui-default-language): You can set the default language for the conference through the `lang` property. Please see below a snippet on how to set the UI language to German: - [Overview](https://developer.8x8.com/jaas/docs/customize-ui-overview): The meeting's UI can be customised through the *configOverwrite* and *interfaceConfigOverwrite* objects which are part of the **`JitsiMeetExternalA... - [Enabling with lib-jitsi-meet sdk](https://developer.8x8.com/jaas/docs/enabling-with-lib-jitsi-meet-sdk): JaaS clients using the low level lib-jitsi-meet sdk can enable rtcstats analytics and the associated analytics web hook by simply adding the follow... - [FAQ](https://developer.8x8.com/jaas/docs/faq): 8x8 Jitsi as a Service (JaaS) is an enterprise-ready video meeting platform that allows developers, organizations, and businesses to easily build a... - [Commands](https://developer.8x8.com/jaas/docs/iframe-api-commands): You can control the embedded Jitsi Meet conference by calling **`executeCommand`** on the **`JitsiMeetExternalAPI`** object. For a list of all supp... - [Events](https://developer.8x8.com/jaas/docs/iframe-api-events): The `JitsiMeetExternalAPI` object implements the [EventEmitter] API for emitting and listening for events. For more details and a list of all possi... - [Functions](https://developer.8x8.com/jaas/docs/iframe-api-functions): The Jitsi iFrame API functions allow controlling several in-meeting actions in the embedded conference from outside the iFrame. For a list of all f... - [Integration](https://developer.8x8.com/jaas/docs/iframe-api-integration): To enable the Jitsi Meet API in your application you must use the following JavaScript (JS) Jitsi Meet API library script and integrate it into you... - [Configuring the invite link](https://developer.8x8.com/jaas/docs/iframe-api-invite): The in-meeting controls offer your meeting users the option to invite participants into the same session. - [Overview](https://developer.8x8.com/jaas/docs/iframe-api-overview): Embedding the Jitsi Meet API (Jitsi iFrame API) into your site or app enables you to host and provide secure video meetings with your colleagues, t... - [JaaS Browser Support](https://developer.8x8.com/jaas/docs/jaas-browser-support): | Browser | Support | Versions | Notes | - [Activity](https://developer.8x8.com/jaas/docs/jaas-console-activity): The **Activity** page allows you to see your usage within your subscription plan. - [Analytics (beta)](https://developer.8x8.com/jaas/docs/jaas-console-analytics): The **meetings overview dashboard** is a fairly straightforward presentation of the overall state of your meetings ecosystem. - [API keys](https://developer.8x8.com/jaas/docs/jaas-console-api-keys): The Developer Console **API Keys** page enables you to define and manage the authentication keys for your meeting participants. You add the API key... - [Billing](https://developer.8x8.com/jaas/docs/jaas-console-billing): The **Billing** provides detailed billing information for your JaaS subscription. You can view your current and previous invoices, monthly balance,... - [Branding](https://developer.8x8.com/jaas/docs/jaas-console-branding): The **Branding** page enables you to brand the meetings run on your AppID with your own: - [Contact support](https://developer.8x8.com/jaas/docs/jaas-console-contact-support): You can contact the 8x8 JaaS Support Team either by clicking the **Contact support** link from the left navigation bar or by clicking the envelope ... - [Help & documentation](https://developer.8x8.com/jaas/docs/jaas-console-help-and-docs): **Documentation** button of the JaaS console navigator is a direct link to this documentation. - [My sample app](https://developer.8x8.com/jaas/docs/jaas-console-my-sample-app): The **My sample app** page presents an example of integrating a JaaS meeting into an application. It uses the [**IFrame API**](https://jitsi.github... - [Overview](https://developer.8x8.com/jaas/docs/jaas-console-overview): The Developer Console provides management of your JaaS account. It offers the tools and details that enable you to manage and configure key details... - [My plan + manage subscriptions](https://developer.8x8.com/jaas/docs/jaas-console-plans-and-subscriptions): The **My plan** page provides the details of your 8x8 JaaS subscription. On this page, you can view the MAUs and charges included in your monthly s... - [Start guide](https://developer.8x8.com/jaas/docs/jaas-console-start-guide): The **Start guide** page on the Developer Console provides you access is your go-to reference for quick, accessible information about your 8x8 JaaS... - [Team management](https://developer.8x8.com/jaas/docs/jaas-console-team-management): Access to and use of the Developer Console can be shared across your JaaS team using the **Team management** page. - [Webhooks](https://developer.8x8.com/jaas/docs/jaas-console-webhooks): The Developer Console **Webhooks** page enables you to define **`POST HTTP`** JaaS platform requests. These requests can be triggered by selected a... - [Overview](https://developer.8x8.com/jaas/docs/jaas-onboarding): Jitsi as a Service (JaaS) enables you to develop and integrate Jitsi Meetings functionality into your web applications. The JaaS integration incorp... - [Advanced branding](https://developer.8x8.com/jaas/docs/jaas-prefs-advanced-branding): Advanced branding allows you to configure elements on your meeting's UI per-room. - [Setting up audio/video devices](https://developer.8x8.com/jaas/docs/jaas-prefs-devices): You can set the initial media devices for the call using the following: - [Overview](https://developer.8x8.com/jaas/docs/jaas-prefs-overview): You can find below a few of the JaaS meeting's features. - [Prejoin page](https://developer.8x8.com/jaas/docs/jaas-prefs-prejoin): The prejoin page is displayed before joining a meeting and it allows you to enter a display name and select certain video/audio devices and gives y... - [Recording](https://developer.8x8.com/jaas/docs/jaas-prefs-recording): JaaS allows meeting recording, but it only stores it for 24 hours. In order to preserve the recording, you must listen for ***RECORDING_UPLOADED***... - [Meeting security](https://developer.8x8.com/jaas/docs/jaas-prefs-security): A moderator has the option to secure a meeting either by adding a pincode or by enabling lobby, or both. Any new meeting participant will initially... - [JaaS statistics file](https://developer.8x8.com/jaas/docs/jaas-statistics-file): The JaaS analytics server (rtcstats-server) gathers various WebRTC and Jitsi Meet specific metrics. - [Livestreaming](https://developer.8x8.com/jaas/docs/livestreaming): The livestreaming feature in JaaS allows users to broadcast their video conferences to a larger audience by streaming to platforms like YouTube or ... - [Overview](https://developer.8x8.com/jaas/docs/meet-components-overview): Managing a **self-hosted Jitsi Meet instance** might come with few challenges when it comes to scaling and maintaining your instances. While Jitsi ... - [Telephony access with Debian](https://developer.8x8.com/jaas/docs/meet-components-telephony-access-debian): * Use the stable release [2.0.7830](https://download.jitsi.org/stable/jitsi-meet_2.0.7830-1_all.deb) or newer. - [Telephony access with Docker](https://developer.8x8.com/jaas/docs/meet-components-telephony-access-docker): * Ensure you have a valid certificate for the host domain. - [Telephony access with Manual Installation](https://developer.8x8.com/jaas/docs/meet-components-telephony-access-manual-install): Update the following urls in **config.js**: - [Telephony access overview](https://developer.8x8.com/jaas/docs/meet-components-telephony-access): Quickly connect your self-hosted Jitsi Meet installation to the public telephone network. This service allows you to use 8x8 Jigasi Cloud with your... - [Android SDK](https://developer.8x8.com/jaas/docs/mobile-sdk-android): The Jitsi Meet Android SDK provides the means to embed a JaaS meeting in your Android apps. - [iOS SDK](https://developer.8x8.com/jaas/docs/mobile-sdk-ios): The Jitsi Meet iOS SDK provides the means to embed a JaaS meeting in your iOS apps. - [Overview](https://developer.8x8.com/jaas/docs/mobile-sdk-overview): JaaS features [Mobile SDKs](https://jitsi.github.io/handbook/docs/category/mobile) that enable integration of Jitsi into your mobile app. - [Mobile SDK Releases](https://developer.8x8.com/jaas/docs/mobile-sdk-release-notes): **Highlights** - [PSTN Dial In/Out](https://developer.8x8.com/jaas/docs/pstn-dial-in-and-out): Jaas has capabilities for joining meetings using PSTN/Telephony (Telephone Dialing) audio. - [8 June 2022 Release](https://developer.8x8.com/jaas/docs/release-2995): **UX improvements** - [12 July 2022 Release](https://developer.8x8.com/jaas/docs/release-3118): **UX improvements** - [4 August 2022 Release](https://developer.8x8.com/jaas/docs/release-3192): **UX improvements** - [9 September 2022 Release](https://developer.8x8.com/jaas/docs/release-3315): **UX improvements** - [19 October 2022 Release](https://developer.8x8.com/jaas/docs/release-3527): **UX improvements** - [17 November 2022 Release](https://developer.8x8.com/jaas/docs/release-3636): **UX improvements** - [16 December 2022 Release](https://developer.8x8.com/jaas/docs/release-3704): **UX improvements** - [27 January 2023 Release](https://developer.8x8.com/jaas/docs/release-3792): **Highlights** - [17 March 2023 Release](https://developer.8x8.com/jaas/docs/release-3958): **Highlights** - [3 May 2023 Release](https://developer.8x8.com/jaas/docs/release-4150): **Highlights** - [21 June 2023 Release](https://developer.8x8.com/jaas/docs/release-4245): **Highlights** - [14 August 2023 Release](https://developer.8x8.com/jaas/docs/release-4340): **Highlights** - [5 October 2023 Release](https://developer.8x8.com/jaas/docs/release-4429): **Highlights** - [20 November 2023 Release](https://developer.8x8.com/jaas/docs/release-4546): **UX/UI** - [14 December 2023 Release](https://developer.8x8.com/jaas/docs/release-4620): * Fixes audio output device selection in Firefox for an iFrame client - [6 March 2024 Release](https://developer.8x8.com/jaas/docs/release-4871): **UX/UI** - [2 April 2024 Release](https://developer.8x8.com/jaas/docs/release-4953): **UX/UI** - [30 May 2024 Release](https://developer.8x8.com/jaas/docs/release-5082): **UX/UI** - [4 July 2024 Release](https://developer.8x8.com/jaas/docs/release-5218): **UX/UI** - [17 September 2024 Release](https://developer.8x8.com/jaas/docs/release-5327): * Adds a new "Go Live" feature for Webinars - [21 November 2024 Release](https://developer.8x8.com/jaas/docs/release-5518): **UX/UI** - [23 January 2025 Release](https://developer.8x8.com/jaas/docs/release-5628): **UX/UI** - [24 March 2025 Release](https://developer.8x8.com/jaas/docs/release-5821): **New Features** - [16 June 2025 Release](https://developer.8x8.com/jaas/docs/release-5963): **General** - [15 July 2025 Release](https://developer.8x8.com/jaas/docs/release-6176): * **File Sharing Support**: Users are now able to share files in the chat - [11 November 2025 Release](https://developer.8x8.com/jaas/docs/release-6393): * **Viewer Role Enhancements:** Expanded controls for demoting users to viewers, including new options in moderation menus. - [20 January 2026 Release](https://developer.8x8.com/jaas/docs/release-6524): * Display file uploads as inline chat messages - [19 February 2026 Release](https://developer.8x8.com/jaas/docs/release-6626): * Added tooltip to file upload button for improved user experience - [April 4, 2026 Release](https://developer.8x8.com/jaas/docs/release-6741): * Added separate transcription indicator with contextual notifications for clearer status visibility - [June 12, 2026 Release](https://developer.8x8.com/jaas/docs/release-6869): * Recording and transcription can now be started and stopped independently, with capability-aware buttons, dialogs, and nudges reflecting the avail... - [Release Notes](https://developer.8x8.com/jaas/docs/release-notes): The latest features and improvements for Jitsi as a Service - [Releases](https://developer.8x8.com/jaas/docs/releases): Jitsi as a Service is by default using the latest release. To have full control over which release is being used in your app, you can pin a certain... - [RTC Visualizer](https://developer.8x8.com/jaas/docs/rtc-visualizer): This project contains the server & client used to visualize data from RTC stats server: [https://github.com/jitsi/rtc-visualizer](https://github.co... - [SIP Dial In/Out](https://developer.8x8.com/jaas/docs/sip-dial-in-and-out): JaaS **SIP Dial In/Out** feature allows users to connect with participants on traditional phone networks, extending the flexibility and reach of Ji... - [Meetings domains and IP's](https://developer.8x8.com/jaas/docs/technical-requirements-whitelists): In order to function properly, the 8x8 Meet and Jitsi as a Service clients require access to certain domains and IP addresses. If your users have s... - [Telephony access with Debian](https://developer.8x8.com/jaas/docs/telephony-access-with-debian): * Use the stable release [2.0.7830](https://download.jitsi.org/stable/jitsi-meet_2.0.7830-1_all.deb) or newer. - [Telephony access with Docker](https://developer.8x8.com/jaas/docs/telephony-access-with-docker): * Ensure you have a valid certificate for the host domain. - [Telephony access with Manual Installation](https://developer.8x8.com/jaas/docs/telephony-access-with-manual-installation): Update the following urls in **config.js**: - [Transcription and Translation](https://developer.8x8.com/jaas/docs/transcription-translation): This documentation outlines the transcription and translation capabilities provided by JaaS. These features are designed to enhance the functionali... - [Tutorial: Using Transcription Chunks](https://developer.8x8.com/jaas/docs/tutorial-using-transcription-chunks): When transcription is enabled in a room, JaaS has both **[Iframe event](https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-iframe-events/#tr... - [Overview](https://developer.8x8.com/jaas/docs/web-sdk-overview): JaaS features Web SDKs that enable integration of Jitsi into your web app if it's using: - [React SDK](https://developer.8x8.com/jaas/docs/web-sdk-react): The React SDK allows JaaS users to easily integrate Jitsi into their web apps by using the JaaSMeeting component. More information can be found [he... - [Events](https://developer.8x8.com/jaas/docs/webhooks-events): The following list describes some of the possible webhook **`eventTypes`** (enums): - [JaaS endpoints](https://developer.8x8.com/jaas/docs/webhooks-jaas-endpoints): The following endpoints are exposed by JaaS services for conference management options: - [Overview](https://developer.8x8.com/jaas/docs/webhooks-overview): A webhook enables you to obtain notifications from the Jitsi as a Service (JaaS) platform as changes to your data occur. Information is pushed to a... - [Payload structure](https://developer.8x8.com/jaas/docs/webhooks-payload): The JaaS webhook requests have the following payload structure types: - [Check the webhook signatures](https://developer.8x8.com/jaas/docs/webhooks-signatures): JaaS will sign each of the webhook events it sends to your endpoints by including a signature in each event’s `X-Jaas-Signature` header. This allow... - [Whiteboard](https://developer.8x8.com/jaas/docs/whiteboard): **JaaS (Jitsi as a Service)** has an integrated **whiteboard** feature, providing users with a collaborative, visual workspace. This tool is design... - [8x8 API License Agreement](https://developer.8x8.com/license): :::info Official License Agreement - [8x8 Software Development Kit License Agreement](https://developer.8x8.com/page/sdk-license): :::info Official License Agreement - [Analytics](https://developer.8x8.com/resolve/docs/analytics): ← [Back to Overview](./overview.md) - [Contacts](https://developer.8x8.com/resolve/docs/contacts): ← [Back to Overview](./overview.md) - [Dashboard](https://developer.8x8.com/resolve/docs/dashboard): ← [Back to Overview](./overview.md) - [Incidents](https://developer.8x8.com/resolve/docs/incidents): ← [Back to Overview](./overview.md) - [8x8 Resolve](https://developer.8x8.com/resolve/docs/overview): 8x8 Resolve is a critical communications platform that helps your organisation reach the right people instantly during an incident. Send targeted a... - [Scenarios](https://developer.8x8.com/resolve/docs/scenarios): ← [Back to Overview](./overview.md) - [Settings](https://developer.8x8.com/resolve/docs/settings): ← [Back to Overview](./overview.md) - [Message Templates](https://developer.8x8.com/resolve/docs/templates): ← [Back to Overview](./overview.md) - [`chat-init-v1` Event](https://developer.8x8.com/tech-partner/docs/events/aw-chat-init-v1): The `chat-init-v1` event is triggered when a chat interaction is successfully initialized, providing the initial message history. - [chat-message-received-v1](https://developer.8x8.com/tech-partner/docs/events/aw-chat-message-received-v1): Event to announce when a chat message has been received. - [`chat-message-sent-v1` Event](https://developer.8x8.com/tech-partner/docs/events/aw-chat-message-sent-v1): The `chat-message-sent-v1` event is triggered when the agent sends a chat message during an active chat interaction. - [`close-agent-assist-v1` Event](https://developer.8x8.com/tech-partner/docs/events/aw-close-agent-assist-v1): The `close-agent-assist-v1` event is triggered when the Agent Workspace signals that the agent assist panel should be closed. - [aw-interaction-ended-v1](https://developer.8x8.com/tech-partner/docs/events/aw-interaction-ended-v1): Event to announce when an interaction has ended. - [`interaction-focus-v1` Event](https://developer.8x8.com/tech-partner/docs/events/aw-interaction-focus-v1): > **Deprecated** as of 8 September 2025. Use [`aw-interaction-focus-v2`](./aw-interaction-focus-v2) instead. - [interaction-focus-v2](https://developer.8x8.com/tech-partner/docs/events/aw-interaction-focus-v2): Event used by the Agent Workspace MFE to announce all the integrators about when an interaction is focused. - [interaction-focus-v3](https://developer.8x8.com/tech-partner/docs/events/aw-interaction-focus-v3): Event used by the Agent Workspace MFE to announce all the integrators about when an interaction is focused. - [`hold-v1` Event](https://developer.8x8.com/tech-partner/docs/events/aw-interaction-hold-v1): The `hold-v1` event is triggered when a voice interaction is placed on hold in the Agent Workspace. - [`mute-v1` Event](https://developer.8x8.com/tech-partner/docs/events/aw-interaction-mute-v1): The `mute-v1` event is triggered when a voice interaction is muted in the Agent Workspace. - [`resume-v1` Event](https://developer.8x8.com/tech-partner/docs/events/aw-interaction-resume-v1): The `resume-v1` event is triggered when a voice interaction is resumed from hold in the Agent Workspace. - [aw-interaction-started-v1](https://developer.8x8.com/tech-partner/docs/events/aw-interaction-started-v1): Event to announce when an interaction has started. - [`unmute-v1` Event](https://developer.8x8.com/tech-partner/docs/events/aw-interaction-unmute-v1): The `unmute-v1` event is triggered when a voice interaction is unmuted in the Agent Workspace. - [wrap-up-codes-received-v1](https://developer.8x8.com/tech-partner/docs/events/aw-interaction-wrap-up-codes-received-v1): Event to announce when wrap-up codes have been received for an interaction. - [wrap-up-codes-v1](https://developer.8x8.com/tech-partner/docs/events/aw-interaction-wrap-up-codes-v1): Event to send wrap-up codes from interaction. - [call-manager-call-autoanswer-first-connect-v1](https://developer.8x8.com/tech-partner/docs/events/call-manager-call-autoanswer-first-connect-v1): Event emitted on the first auto-answer call connection - [call-manager-call-caller-number-change-v1](https://developer.8x8.com/tech-partner/docs/events/call-manager-call-caller-number-change-v1): Event emitted when the caller number changes during a call - [call-manager-call-conference-drop-v1](https://developer.8x8.com/tech-partner/docs/events/call-manager-call-conference-drop-v1): Event emitted when a participant is dropped from a conference call - [call-manager-call-conference-start-v1](https://developer.8x8.com/tech-partner/docs/events/call-manager-call-conference-start-v1): Event emitted when a conference call starts - [call-manager-call-connect-v1](https://developer.8x8.com/tech-partner/docs/events/call-manager-call-connect-v1): Event emitted when a call is connected - [call-manager-call-disconnected-v1](https://developer.8x8.com/tech-partner/docs/events/call-manager-call-disconnected-v1): Event emitted when a call is disconnected - [call-manager-call-failed-v1](https://developer.8x8.com/tech-partner/docs/events/call-manager-call-failed-v1): Event emitted when an outbound call fails - [call-manager-call-hold-v1](https://developer.8x8.com/tech-partner/docs/events/call-manager-call-hold-v1): Event emitted when a call is placed on hold - [call-manager-call-inbound-first-connect-v1](https://developer.8x8.com/tech-partner/docs/events/call-manager-call-inbound-first-connect-v1): Event emitted on the first call-connect event for an inbound call - [call-manager-call-incoming-first-v1](https://developer.8x8.com/tech-partner/docs/events/call-manager-call-incoming-first-v1): Event emitted on the first call-incoming event - [call-manager-call-incoming-v1](https://developer.8x8.com/tech-partner/docs/events/call-manager-call-incoming-v1): Event emitted when an call-incoming event is received - [call-manager-call-outbound-first-connect-v1](https://developer.8x8.com/tech-partner/docs/events/call-manager-call-outbound-first-connect-v1): Event emitted on the first call-connect event for an outbound call - [call-manager-call-outgoing-v1](https://developer.8x8.com/tech-partner/docs/events/call-manager-call-outgoing-v1): Event emitted when an outgoing call is initiated - [call-manager-call-record-end-v1](https://developer.8x8.com/tech-partner/docs/events/call-manager-call-record-end-v1): Event emitted when call recording ends - [call-manager-call-record-failed-v1](https://developer.8x8.com/tech-partner/docs/events/call-manager-call-record-failed-v1): Event emitted when call recording fails ( only available when using CTI provider) - [call-manager-call-record-start-v1](https://developer.8x8.com/tech-partner/docs/events/call-manager-call-record-start-v1): Event emitted when call recording starts - [call-manager-call-transfer-blind-success-v1](https://developer.8x8.com/tech-partner/docs/events/call-manager-call-transfer-blind-success-v1): Event emitted when a blind call transfer succeeds - [call-manager-call-transfer-failed-v1](https://developer.8x8.com/tech-partner/docs/events/call-manager-call-transfer-failed-v1): Event emitted when a call transfer fails - [call-manager-call-transfer-success-v1](https://developer.8x8.com/tech-partner/docs/events/call-manager-call-transfer-success-v1): Event emitted when a call transfer succeeds - [call-manager-call-transfer-voicemail-success-v1](https://developer.8x8.com/tech-partner/docs/events/call-manager-call-transfer-voicemail-success-v1): Event emitted when a call transfer to voicemail succeeds - [call-manager-mute-disabled-v1](https://developer.8x8.com/tech-partner/docs/events/call-manager-mute-disabled-v1): Event emitted when the audio input is unmuted at the provider level (applies to all calls). - [call-manager-mute-enabled-v1](https://developer.8x8.com/tech-partner/docs/events/call-manager-mute-enabled-v1): Event emitted when the audio input is muted at the provider level (applies to all calls). - [global-user-details-v1](https://developer.8x8.com/tech-partner/docs/events/global-user-details-v1): Event used by the Shell MFE to announce all the integrators about the global user details data. - [`chat-accepted-cc-v1` Event](https://developer.8x8.com/tech-partner/docs/events/mashell-chat-accepted-cc-event-v1): The `chat-accepted-cc-v1` event is triggered when a web chat is accepted in the 8x8 Contact Center agent panel. - [`chat-completed-cc-v1` Event](https://developer.8x8.com/tech-partner/docs/events/mashell-chat-completed-cc-event-v1): The `chat-completed-cc-v1` event is triggered when a web chat concludes, before the agent finalizes the wrap-up process in the 8x8 Contact Center a... - [`chat-nextgen-accepted-cc-v1` Event](https://developer.8x8.com/tech-partner/docs/events/mashell-chat-nextgen-accepted-cc-event-v1): The `chat-nextgen-accepted-cc-v1` event is triggered when a chat-nextgen (sms or WhatsApp) is accepted in the 8x8 Contact Center agent panel. - [`chat-nextgen-completed-cc-v1` Event](https://developer.8x8.com/tech-partner/docs/events/mashell-chat-nextgen-completed-cc-event-v1): The `chat-nextgen-completed-cc-v1` event is triggered when a chat-nextgen (sms or WhatsApp) concludes, before the agent finalizes the wrap-up proce... - [`chat-nextgen-offered-cc-v1` Event](https://developer.8x8.com/tech-partner/docs/events/mashell-chat-nextgen-offered-cc-event-v1): The `chat-nextgen-offered-cc-v1` event is triggered when a chat-nextgen (sms or WhatsApp) is initiated, before the chat is accepted in the 8x8 Cont... - [`chat-nextgen-terminated-cc-v1` Event](https://developer.8x8.com/tech-partner/docs/events/mashell-chat-nextgen-terminated-cc-event-v1): The `chat-nextgen-terminated-cc-v1` event is triggered when a chat-nextgen (sms or WhatsApp) ends, after the wrap-up process in the 8x8 Contact Cen... - [`chat-offered-cc-v1` Event](https://developer.8x8.com/tech-partner/docs/events/mashell-chat-offered-cc-event-v1): The `chat-offered-cc-v1` event is triggered when a web chat is initiated, before the chat is accepted in the 8x8 Contact Center agent panel. - [`chat-terminated-cc-v1` Event](https://developer.8x8.com/tech-partner/docs/events/mashell-chat-terminated-cc-event-v1): The `chat-terminated-cc-v1` event is triggered when a web chat ends, after the wrap-up process in the 8x8 Contact Center agent panel. - [`email-accepted-cc-v1` Event](https://developer.8x8.com/tech-partner/docs/events/mashell-email-accepted-cc-event-v1): The `email-accepted-cc-v1` event is triggered when an inbound email is accepted in the 8x8 Contact Center agent panel. - [`email-terminated-cc-v1` Event](https://developer.8x8.com/tech-partner/docs/events/mashell-email-terminated-cc-event-v1): The `email-terminated-cc-v1` event is triggered when an email interaction ends in 8x8 Contact Center agent panel. - [`voice-phone-accepted-cc-v1` Event](https://developer.8x8.com/tech-partner/docs/events/mashell-voice-phone-accepted-cc-event-v1): The `voice-phone-accepted-cc-v1` event is triggered when an inbound or outbound voice call is accepted in the 8x8 Contact Center agent panel. - [`voice-phone-accepted-uc-v1` Event](https://developer.8x8.com/tech-partner/docs/events/mashell-voice-phone-accepted-uc-event-v1): The `voice-phone-accepted-uc-v1` event is triggered when an inbound or outbound voice call is accepted in the 8x8 UC agent panel. - [`voice-phone-completed-cc-v1` Event](https://developer.8x8.com/tech-partner/docs/events/mashell-voice-phone-completed-cc-event-v1): The `voice-phone-completed-cc-v1` event is published when a phone interaction is concluded but not yet terminated from the 8x8 Contact Center agent... - [`voice-phone-offered-cc-v1` Event](https://developer.8x8.com/tech-partner/docs/events/mashell-voice-phone-offered-cc-event-v1): The `voice-phone-offered-cc-v1` event is triggered when an inbound or outbound voice call is initiated before the call is accepted in the agent pan... - [`voice-phone-offered-uc-v1` Event](https://developer.8x8.com/tech-partner/docs/events/mashell-voice-phone-offered-uc-event-v1): The `voice-phone-offered-uc-v1` event is triggered when an inbound or outbound voice call is initiated before the call is accepted in the agent pan... - [`voice-phone-terminated-cc-v1` Event](https://developer.8x8.com/tech-partner/docs/events/mashell-voice-phone-terminated-cc-event-v1): The `voice-phone-terminated-cc-v1` event is triggered when an inbound or outbound voice call ends, after the wrap-up process in the 8x8 Contact Cen... - [`voice-phone-terminated-uc-v1` Event](https://developer.8x8.com/tech-partner/docs/events/mashell-voice-phone-terminated-uc-event-v1): The `voice-phone-terminated-uc-v1` event is triggered when an inbound or outbound voice call ends in the 8x8 UC agent panel. - [`voicemail-accepted-cc-v1` Event](https://developer.8x8.com/tech-partner/docs/events/mashell-voicemail-accepted-cc-event-v1): The `voicemail-accepted-cc-v1` event is triggered when a voicemail is accepted (after call interaction on the voicemail number is rejected) in the ... - [`voicemail-completed-cc-v1` Event](https://developer.8x8.com/tech-partner/docs/events/mashell-voicemail-completed-cc-event-v1): The `voicemail-completed-cc-v1` event is triggered when a voicemail interaction concludes, before the agent finalizes the wrap-up process in the 8x... - [`voicemail-offered-cc-v1` Event](https://developer.8x8.com/tech-partner/docs/events/mashell-voicemail-offered-cc-event-v1): The `voicemail-offered-cc-v1` event is triggered when a voicemail interaction is received on the 8x8 Contact Center agent panel - [`voicemail-terminated-cc-v1` Event](https://developer.8x8.com/tech-partner/docs/events/mashell-voicemail-terminated-cc-event-v1): The `voicemail-terminated-cc-v1` event is published after a voicemail interaction is terminated in the 8x8 Contact Center agent panel. - [Overview](https://developer.8x8.com/tech-partner/docs/getting-started-overview): Welcome to the 8x8 Technology Partner documentation. This section covers everything you need to integrate your application with 8x8 products, or em... - [Events](https://developer.8x8.com/tech-partner/docs/partner-sdk-events): 8x8 products provide a comprehensive set of events that partners can receive, enabling enhanced integration capabilities. Partners also have the ab... - [Partner Integration Guide](https://developer.8x8.com/tech-partner/docs/partner-sdk-integration-guide): The **partner integration** allows you to embed your web application as an iframe panel inside an 8x8 application. Your app communicates bidirectio... - [Events](https://developer.8x8.com/tech-partner/docs/partner-sdk-maestro-sdk-events): MaestroSDK provide a comprehensive set of events that partners can receive, enabling enhanced integration capabilities. Partners also have the abil... - [Overview](https://developer.8x8.com/tech-partner/docs/partner-sdk-maestro-sdk-overview): MaestroSDK publishes embeddable events and can be consumed by third-party developers to integrate core 8x8 products into their solutions. - [UI Guidelines](https://developer.8x8.com/tech-partner/docs/ui-guidelines): import PreviewColor from '@site/docusaurus/components/PreviewColor';