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 Contact Center Chat API V2

8x8 Contact Center Chat API v2 for creating and driving chat conversations, messages and participants inside the contact center.

8x8 Contact Center Chat API V2 is one of 36 APIs that 8x8 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 20 operations across 12 paths, organized into 5 resource areas, and defines 39 schemas. It is described by OpenAPI 3.0.0, at version 2.0.

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

20 operations 12 paths 39 schemas 3 DELETE9 GET6 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0
Base URL
https://api.8x8.com
Authentication
HTTP Bearer, HTTP Basic
Resource Areas
5

Authentication & Security 2

8x8 Contact Center Chat API V2 declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (8x8APIBearerToken). It accepts HTTP basic authentication (8x8APIBasic).

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

Paths & Operations 20

Across 12 paths, the API surfaces 20 operations — 3 DELETE, 9 GET, 6 POST, 2 PUT. They span 5 resource areas: Authentication, WebHooks, JwkKeys, Channels, Conversations. Each is listed below with its method, path, parameters, and response codes.

Authentication 1

Creates access tokens for endpoint access.

POST
/oauth/v2/token
Creates a new access token that can be used for API access.
createaccesstoken body → 200400401500default
WebHooks 6

Enables webhook definitions that can be associated to channels.

GET
/vcc/{region}/chat/v2/tenant/{tenant-id}/web-hooks
Retrieves all customer webhooks based on the associated token information.
getwebhooks 4 params → 200401403500default
POST
/vcc/{region}/chat/v2/tenant/{tenant-id}/web-hooks
Creates a new customer webhook.
createwebhook 2 params body → 200400401403500default
GET
/vcc/{region}/chat/v2/tenant/{tenant-id}/web-hooks/{web-hook-id}
Get webhook by Id.
getwebhookbyid 3 params → 200401403404500default
PUT
/vcc/{region}/chat/v2/tenant/{tenant-id}/web-hooks/{web-hook-id}
Updates the full webhook resource by Id.
updatewebhook 4 params body → 200400401403404500default
DELETE
/vcc/{region}/chat/v2/tenant/{tenant-id}/web-hooks/{web-hook-id}
Deletes the webhook by Id.
deletewebhookbyid 3 params → 204401403404500default
POST
/vcc/{region}/chat/v2/tenant/{tenant-id}/web-hooks/verify
The endpoint used to validate that the webhook is working and reachable.
verifywebhook 2 params body → 204400401403500default
JwkKeys 1

An API that offers JWK public key access to customers.

GET
/vcc/{region}/chat/v2/jwk/{jwk-id}/public
Returns the public JWK.
getjwkpublickey 2 params → 200401403404500default
Channels 5

Enables ChatAPI channel registration and association with a webhook containing channel.

GET
/vcc/{region}/chat/v2/tenant/{tenant-id}/channels
Retrieves all customer Chat API channels.
getchatapichannels 6 params → 200401403404500default
POST
/vcc/{region}/chat/v2/tenant/{tenant-id}/channels
Creates a channel.
createchatapichannel 2 params body → 200400401403500default
GET
/vcc/{region}/chat/v2/tenant/{tenant-id}/channels/{channel-id}
Get ChatAPI channel by Id.
getchatapichannel 3 params → 200401403404500default
PUT
/vcc/{region}/chat/v2/tenant/{tenant-id}/channels/{channel-id}
Update ChatAPI channel by Id.
updatechatapichannel 4 params body → 200400401403500default
DELETE
/vcc/{region}/chat/v2/tenant/{tenant-id}/channels/{channel-id}
Delete ChatAPI channel by Id.
deletechatapichannelbyid 3 params → 204401403404500default
Conversations 7

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

Schemas 39

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

PageResult
object
1 property
AuthResponse
object
12 properties
ChannelIdentifierField
object
1 property
WebHookIdentifierField
object
1 property
ConversationIdentifierField
object
2 properties
ConversationCustomerData
object
1 property
MessageListResult
ConversationParticipants
object
3 properties
MessageResult
object
5 properties 4 required
WebHooksV2ListResult
EventVersion
string
Event API version.
WebHookV2CreateRequest
WebHookV2PutRequest
WebHookV2VerifyRequest
WebHookV2Result
ChannelsV2ListResult
ChannelV2Result
ChannelV2CreateRequest
ChannelV2PutRequest
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…
ExternalAuthorType
string
AuthorType
HistoryMessageV2
object
2 properties 1 required
CreateTransactionRequest
TransactionStatus
string
Transaction status.
ConversationListResult
ConversationResult
ChannelRoutingOptions
object
1 property 1 required
InteractionInfo
object
3 properties
SendConversationMessagePayload
object
2 properties 1 required
GenericExceptionPayload
object
2 properties
ValidationExceptionPayload
ConstraintViolationProblem
object
2 properties
OAuthConstraintViolationProblem
object
2 properties
ForbiddenViolationProblem
object
2 properties
UnauthorizedProblem
object
1 property
ResourceNotFoundProblem
object
2 properties
InternalServerProblem
object
3 properties
EventVersionIdentifierField
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

8x8-actions-events-8x8-contact-center-chat-api-v2.json Raw ↑

Other APIs 8x8 publishes across the network.

8x8 Contact Center Dynamic Campaigns
Contact Center Campaigns API
Chapi - Chat API
Contact Center Agent Status API
8x8 Contact Center Call API Reference
Contact Center Chat Gateway
8x8 Administration - Address Management API
8x8 Administration - Operations API
8x8 Administration - Phone Number Management API
8x8 Administration - Ring Group Management API
8x8 Administration - Site Management API
8x8 Administration - User Management API
Where this information came from

This is an independent, third-party profile of 8x8 Contact Center Chat API V2, 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.