How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

8x8 Conversations API

Provides Contact Center interaction capabilities.

8x8 Conversations API is one of 71 APIs that 8x8 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Conversations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 17 operations across 12 paths, and defines 43 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://api.8x8.com.

17 operations 12 paths 43 schemas 1 DELETE7 GET1 PATCH7 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.8x8.com
Authentication
HTTP Bearer, HTTP Basic, API Key
Resource Areas
1

Authentication & Security 3

8x8 Conversations API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (8x8APIBearerToken). It accepts HTTP basic authentication (8x8APIBasic). An API key is passed in the header as x-api-key (8x8ApiKey).

  • 8x8APIBearerToken — Bearer Token obtained from https://api.8x8.com
  • 8x8APIBasic — Bearer Token obtained from https://api.8x8.com

Paths & Operations 17

Across 12 paths, the API surfaces 17 operations — 1 DELETE, 7 GET, 1 PATCH, 7 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Conversations 17

Provides Contact Center interaction capabilities.

GET
/vcc/{region}/chat/v2/tenant/{tenant-id}/conversations
Returns all conversations belonging to the customer.
getcctransactions 10 params → 200401403404500default
POST
/vcc/{region}/chat/v2/tenant/{tenant-id}/conversations
Creates a new conversation.
createcctransaction 2 params body → 202400401403500default
GET
/vcc/{region}/chat/v2/tenant/{tenant-id}/conversations/{conversation-id}
Retrieves conversation details.
getcctransaction 3 params → 200401403404500default
GET
/vcc/{region}/chat/v2/tenant/{tenant-id}/conversations/{conversation-id}/participants
Retrieve the conversation participants.
getparticipantsforcctransaction 3 params → 200401403404500default
DELETE
/vcc/{region}/chat/v2/tenant/{tenant-id}/conversations/{conversation-id}/participants/customer
Customers leaves conversation.
customerparticipantleavecctransaction 3 params → 204401403404500default
GET
/vcc/{region}/chat/v2/tenant/{tenant-id}/conversations/{conversation-id}/messages
Retrieves the conversation messages.
getmessagesforcctransaction 4 params → 200401403404500default
POST
/vcc/{region}/chat/v2/tenant/{tenant-id}/conversations/{conversation-id}/messages
Send a message.
sendmessagetocctransaction 3 params body → 202401403404500default
GET
/chat-gateway/v1/conversations
Returns all conversations belonging to the customer.
getcctransactions-1 5 params → 200400401403500default
POST
/chat-gateway/v1/conversations
Creates a new conversation.
createcctransaction-1 1 param body → 202401403400500default
PUT
/chat-gateway/v1/conversations/{conversationId}
Update a conversation details.
putcctransaction 2 params body → 202401403404500default
PATCH
/chat-gateway/v1/conversations/{conversationId}
Patch a conversation details.
patchcctransaction 2 params body → 202401403404500default
GET
/chat-gateway/v1/conversations/{conversationId}
Retrieves conversation details.
getcctransaction-1 2 params → 200401403404500default
GET
/chat-gateway/v1/conversations/{conversationId}/interactions
Returns all conversations belonging to the customer.
getccinteractions 2 params → 200400401403404500default
POST
/chat-gateway/v1/conversations/{conversationId}/post-agent-assignment
Creates a post agent assignment for a conversation.
createpostagentassignment 1 param body → 201400401403404500default
POST
/chat-gateway/v1/conversations/{conversationId}/typing
Creates a typing indicator for a conversation.
sendtypingindicator 1 param body → 204400401403404500default
POST
/chat-gateway/v1/conversations/{conversationId}/thinking
Sends a thinking indicator for a conversation.
sendthinkingindicator 1 param body → 204400401403404500default
POST
/chat-gateway/v1/conversations/{conversationId}/read-receipt
Sends a read receipt for a conversation.
sendreadreceipt 1 param body → 204400401403404500default

Schemas 43

The contract defines 43 schemas that model the data the API accepts and returns. The most detailed are MessageResult (5 properties), InteractionInfo (3 properties), InternalServerProblem (3 properties), ConversationParticipants (3 properties). Each schema is shown below with its type and property counts.

AdditionalPropertiesPayload
ConversationResult_2
ConversationListResult
ConversationParticipants
object
3 properties
ConversationIdentifierField
object
2 properties
CreateTransactionRequest
ChannelIdentifierField
object
1 property
PageResult
object
1 property
PostAgentAssignmentConfigurationRequest
object
1 property
ConversationListResult_2
ConversationResult
ResourceNotFoundExceptionPayload
object
2 properties
SendConversationMessagePayload
object
2 properties 1 required
InteractionsListResult
MessageResult
object
5 properties 4 required
ConversationIdentifierField_2
object
2 properties
AssignmentField
object
1 property
GenericExceptionPayload
object
2 properties
PatchTransactionRequest
ForbiddenViolationProblem
object
2 properties
InternalServerProblem
object
3 properties
MessageListResult
PageResult_2
object
1 property
InteractionInfo
object
3 properties
ReadReceiptRequest
object
2 properties 2 required
ConstraintViolationProblem
object
2 properties
AuthorType
ResourceNotFoundProblem
object
2 properties
ConversationUserData
object
1 property
UnauthorizedProblem
object
1 property
Language_2
string
The language of the user. Based on this property the user is assigned to an agent who speaks their language. The default value is English (en). The sender lang…
UpdateTransactionRequest
ExternalAuthorType
string
InvalidParameterExceptionPayload
object
3 properties
TransactionStatus
string
Transaction status.
HistoryMessageV2
object
2 properties 1 required
ThinkingIndicatorRequest
object
Request body for the thinking indicator. All fields are optional with defaults.
2 properties
Links
object
1 property
ConversationCustomerData
object
1 property
Language
string
The language of the customer. Based on this property the customer is assigned to an agent who speaks their language. The default value is English (en). The sen…
TypingRequest
PostAgentAssignmentRequest
PostAgentAssignmentType
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

8x8-conversations-api-openapi.yml Raw ↑

Other APIs 8x8 publishes across the network.

8x8 Event Streaming API
Jitsi as a Service (JaaS)
8x8 CPaaS Voice Webhooks
8x8 Addresses API
8x8 Agent Activity API
8x8 Agent status API
8x8 Agents API
8x8 Analytics API
8x8 Attachments API
8x8 Audit API
8x8 Authentication API
8x8 Batch API
Where this information came from

This is an independent, third-party profile of 8x8 Conversations API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.