Add Participant

post

{protocol}://{server}{basePath}/accounts/{accountId}/engagements/{engagementId}/participants/{participantId}:add

Adds a new Participant to an Engagement or CJ's touchpoint.

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.

engagementId

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 internal id that represents the engagement.

participantId

string

required

length between 1 and 36

The unique id that represents the participant.

Body Params

Participant details

Any External, Agent or Treatment participant

type

string

enum

required

The type of Participant, for example EXTERNAL, AGENT or TREATMENT.

Allowed:

string

required

length ≤ 36

The unique 36 character internal id that represents the Participant.

dialogId

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 internal id that represents the Dialog.

timestamp

date-time

required

The datetime of when the Participant was added to the Engagement in ISO 8601 format, for example 2018-11-13T20:27:12+00:00

channelId

string

required

length between 3 and 50

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

channelType

string

required

length between 3 and 50

The Contact Center Channel Type. Only valid Contact Center Channel Types are accepted. See Contact Center Channel list in Developers guide for further details.

callingNumber

string

required

length between 3 and 256

The calling number of the Participant.

dialledNumber

string

required

length between 3 and 256

The original dialled number for the Engagement.

Responses

202

Accepted

Language

Credentials

URL

Loading…

Response

Choose an example:

application/problem+json

400Bad Request. accountId must be exactly 6 characters engagementId must be a 36 character UUID participantId must be a 36 character UUID

401Unauthorized

403Forbidden

404Not Found

500Internal Server Error