Contact Center Chat Gateway

WebHooks
JwkKeys
- Returns the public JWK.get
Channels
Conversations
Participants
- Retrieve the conversation participants.get
- User leaves conversation.patch
Messages
Attachments

Chapi - Chat API

chat
- Send a message to a public chat room.post
- Fetches messages for a room. Defaults to `CHAPI sandbox` room.get

8x8 Contact Center Dynamic Campaigns

Campaign Control
- The change status for an existing campaign.patch
Record Management
- Add a new customer to an existing campaignpost
- This method deletes customers from an existing campaign.delete

Contact Center Agent Status API

Agent status

Contact Center Agent Status API

Agent status

8x8 Contact Center Chat API V2

Authentication
- Creates a new access token that can be used for API access.post
WebHooks
JwkKeys
- Returns the public JWK.get
Channels
Conversations

Contact Center Chat Gateway

WebHooks
JwkKeys
- Returns the public JWK.get
Channels
Conversations
Participants
- Retrieve the conversation participants.get
- User leaves conversation.patch
Messages
Attachments

Chapi - Chat API

chat
- Send a message to a public chat room.post
- Fetches messages for a room. Defaults to `CHAPI sandbox` room.get

8x8 Contact Center Dynamic Campaigns

Campaign Control
- The change status for an existing campaign.patch
Record Management
- Add a new customer to an existing campaignpost
- This method deletes customers from an existing campaign.delete

Contact Center Agent Status API

Agent status

Contact Center Agent Status API

Agent status

8x8 Contact Center Chat API V2

Authentication
- Creates a new access token that can be used for API access.post
WebHooks
JwkKeys
- Returns the public JWK.get
Channels
Conversations

Retrieves conversation details.

get https://api.8x8.com/chat-gateway/v1/conversations/{conversationId}

Path Params

conversationId

string

required

Conversation identifier.

Headers

X-8x8-Tenant

string

Tenant ID, it is going to be mandatory if customer has more than one CC tenant in his organisation.

Responses

Response body

object

channelId

string

Channel ID for which the transaction will be created.

assignment

object

type

string

Defaults to queue

string

Queue or Script identifier, depending of which type is being used.

user

object

The attached data which contains user details. The data fields include name, userId, customerId, email, phone, company, caseId, language, ipaddress and timezoneOffset are predefined; however, you can also add any metadata. Any information about the user can be attached to a Chat API conversation, and it will be shown to Contact Center agent as part of transaction details in the chat panel.
For example: { name: John Doe, email: john.doe@email.com, language: en, additionalProperties: [ { key: myCustomProperty, value: customValue }, { key: anyKey, value: anyValue } ] }

name

string

Sets the Contact Center user’s name. The Contact Center agent views this name in the chat conversation. For example: John Doe

userId

string

When using 8x8's native CRM, the userId could match a customerId in 8x8's CRM and that will trigger a screen pop for agent.

string

phone

string

company

string

caseId

string

language

string

Defaults to en

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 language can be one of the following:

en => English
ru => Русский
de => Deutsch
ja => 日本語
es => Español
fr => Français
pt => Português
it => Italiano
pl => Polski
hr => Hrvatski
nl => Dutch
ar => العرية
da => Dansk
ko => 한국
no => Norsk
sv => Svenska
vi => Tiếng Việt
cy => Cymraeg
th => ไทย
zh-CN => 简体中文
zh-TW => 中國傳統

additionalProperties

array of objects

additionalProperties

object

key

string

value

string

Conversation / Transaction identifier.

state

string

Conversation state.

created active idle

Response body

object

message

string

code

string

Response body

object

message

string

Error message.

errors

array of objects

errors

object

message

string

code

string

referenceId

string

Response body

object

message

string

Error message.

errors

array of strings

errors

Response body

object

message

string

Error message.

errors

array of objects

errors

object

code

string

Unique error code.

message

string

Free text error description.

Response body

object

message

string

Error message.

errors

array of objects

errors

object

code

string

Unique error code.

message

string

Free text error description.

Updated over 1 year ago

Patch a conversation details.

Returns all conversations belonging to the customer.

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.8x8.com/chat-gateway/v1/conversations/conversationId \
3
     --header 'accept: application/hal+json'

Click Try It! to start a request and see the response here! Or choose an example:

application/hal+json

application/problem+json

Updated over 1 year ago

Patch a conversation details.

Returns all conversations belonging to the customer.

Contact Center Chat Gateway
WebHooks
The endpoint used to validate that the webhook is working and reachable.post
Deletes the webhook by Id.delete
Updates the full webhook resource by Id.put
Get webhook by Id.get
Creates a new customer webhook.post
Retrieves all customer webhooks based on the associated token information.get
JwkKeys
Returns the public JWK.get
Channels
Delete ChatAPI channel by Id.delete
Update ChatAPI channel by Id.put
Get ChatAPI channel by Id.get
Creates a channel.post
Retrieves all customer Chat API channels.get
Conversations
Returns all conversations belonging to the customer.get
Retrieves conversation details.get
Patch a conversation details.patch
Update a conversation details.put
Creates a new conversation.post
Returns all conversations belonging to the customer.get
Participants
User leaves conversation.patch
Retrieve the conversation participants.get
Messages
Retrieves the conversation messages.get
Send a message.post
Retrieves the conversation messages.get
Attachments
Download attachment.get
Get an attachment from Conversation.get
Add an attachment.post
Get attachments in Conversation.get

Chapi - Chat API
chat
Fetches messages for a room. Defaults to `CHAPI sandbox` room.get
Send a message to a public chat room.post

8x8 Contact Center Dynamic Campaigns
Campaign Control
The change status for an existing campaign.patch
Record Management
This method deletes customers from an existing campaign.delete
Add a new customer to an existing campaignpost

Contact Center Agent Status API
Agent status
Sets the agent status for a specific agent.put
Obtains the status for a specific agent.get
The bulk operation for setting the status for multiple agents.post
Obtain the status for tenant agents. Agents can be filtered by group. Pagination is currently not available.get

Contact Center Agent Status API
Agent status
Sets the agent status for a specific agent.put
Obtains the status for a specific agent.get
The bulk operation for setting the status for multiple agents.post
Obtain the status for tenant agents. Agents can be filtered by group. Pagination is currently not available.get

8x8 Contact Center Chat API V2
Authentication
Creates a new access token that can be used for API access.post
WebHooks
The endpoint used to validate that the webhook is working and reachable.post
Deletes the webhook by Id.delete
Updates the full webhook resource by Id.put
Get webhook by Id.get
Creates a new customer webhook.post
Retrieves all customer webhooks based on the associated token information.get
JwkKeys
Returns the public JWK.get
Channels
Delete ChatAPI channel by Id.delete
Update ChatAPI channel by Id.put
Get ChatAPI channel by Id.get
Creates a channel.post
Retrieves all customer Chat API channels.get
Conversations
Send a message.post
Retrieves the conversation messages.get
Customers leaves conversation.delete
Retrieve the conversation participants.get
Retrieves conversation details.get
Creates a new conversation.post
Returns all conversations belonging to the customer.get

Contact Center Chat Gateway
WebHooks
The endpoint used to validate that the webhook is working and reachable.post
Deletes the webhook by Id.delete
Updates the full webhook resource by Id.put
Get webhook by Id.get
Creates a new customer webhook.post
Retrieves all customer webhooks based on the associated token information.get
JwkKeys
Returns the public JWK.get
Channels
Delete ChatAPI channel by Id.delete
Update ChatAPI channel by Id.put
Get ChatAPI channel by Id.get
Creates a channel.post
Retrieves all customer Chat API channels.get
Conversations
Returns all conversations belonging to the customer.get
Retrieves conversation details.get
Patch a conversation details.patch
Update a conversation details.put
Creates a new conversation.post
Returns all conversations belonging to the customer.get
Participants
User leaves conversation.patch
Retrieve the conversation participants.get
Messages
Retrieves the conversation messages.get
Send a message.post
Retrieves the conversation messages.get
Attachments
Download attachment.get
Get an attachment from Conversation.get
Add an attachment.post
Get attachments in Conversation.get

Chapi - Chat API
chat
Fetches messages for a room. Defaults to `CHAPI sandbox` room.get
Send a message to a public chat room.post

8x8 Contact Center Dynamic Campaigns
Campaign Control
The change status for an existing campaign.patch
Record Management
This method deletes customers from an existing campaign.delete
Add a new customer to an existing campaignpost

Contact Center Agent Status API
Agent status
Sets the agent status for a specific agent.put
Obtains the status for a specific agent.get
The bulk operation for setting the status for multiple agents.post
Obtain the status for tenant agents. Agents can be filtered by group. Pagination is currently not available.get

Contact Center Agent Status API
Agent status
Sets the agent status for a specific agent.put
Obtains the status for a specific agent.get
The bulk operation for setting the status for multiple agents.post
Obtain the status for tenant agents. Agents can be filtered by group. Pagination is currently not available.get

8x8 Contact Center Chat API V2
Authentication
Creates a new access token that can be used for API access.post
WebHooks
The endpoint used to validate that the webhook is working and reachable.post
Deletes the webhook by Id.delete
Updates the full webhook resource by Id.put
Get webhook by Id.get
Creates a new customer webhook.post
Retrieves all customer webhooks based on the associated token information.get
JwkKeys
Returns the public JWK.get
Channels
Delete ChatAPI channel by Id.delete
Update ChatAPI channel by Id.put
Get ChatAPI channel by Id.get
Creates a channel.post
Retrieves all customer Chat API channels.get
Conversations
Send a message.post
Retrieves the conversation messages.get
Customers leaves conversation.delete
Retrieve the conversation participants.get
Retrieves conversation details.get
Creates a new conversation.post
Returns all conversations belonging to the customer.get

200Returns the conversation details.

401Contains a description of the error.

403Contains a descriptive response.

404Contains a descriptive information.

500Contains a description of the error.

defaultContains a description of the error.