Create Engagement

post

{protocol}://{server}/api/digital/channel/v1beta/accounts/{accountId}/engagements

Creates a Digital engagement in the Contact Center. If an engagement already exists for the customer then a new dialog will be created for the existing engagement, otherwise a new engagement and dialog will be created.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

accountId

string

required

length between 6 and 6

^[a-zA-Z]{6}$

The unique 6 character internal id that represents the customer account.

Body Params

request

Request payload to create an engagement

sessionId

string

required

length between 36 and 36

^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

The unique 36 character id (uuid) that represents the users session.

channelId

string

required

length between 3 and 50

The unique id representing the Contact Center Channel. Only valid Contact Center Channel Id's are accepted. See Contact Center Channel list in Developers guide for further details.

conversation

string

length ≤ 256

The conversation (or intent) of the Engagement

providerDialogId

string

length ≤ 256

The provider side identifier for a Contact Center dialog.

engagementParameters

object

Optional key/value context information on the engagement. This information might be used to make business decisions on how the engagement is treated. For example, the client application might want to send hints about customer's interest based on the customer's searches or FAQ browsing. Key is limited to 64 characters

correlationId

string

length ≤ 256

The correlation id is used to uniquely identify the client request. This is an optional field but when specified can be used to correlate the callback event with the original API request. If the client does not pass any value for the correlation id in the request, a unique value will be generated automatically and sent back in the response.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Choose an example:

application/json

application/problem+json

201A new engagement or a dialog created

400Bad Request

401Unauthorized.

403Forbidden.

404Not Found.

408Request Timeout

500Internal Server Error