Join Engagement

post

{protocol}://{server}{basePath}/accounts/{accountId}/engagements/{engagementId}:join

Allows a customer to join an active dialog associated with the Custom Chat related engagement.

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.

Body Params

request

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.

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.

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