Disconnect Dialog

post

{protocol}://{server}{basePath}/accounts/{accountId}/provider-dialogs/{providerDialogId}:disconnect

Disconnects the customer from the live dialog within AXP associated with the conversation. This eventually terminates the dialog. For asynchronous messaging, calling this API will not be required under usual circumstances. However in scenarios where provider wants to terminate a conversation, disconnect AXP from participating in the conversation, clean up an inactive conversation or handle any erroneous situation, call this API to terminate the live dialog within AXP.

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.

providerDialogId

string

required

length between 3 and 256

The provider side identifier for a Contact Center dialog. Messages with same 'providerDialogId' value are considered part of same conversation. If no or blank value is passed while sending a message, a new individual dialog will be created. For integrating third party providers, provide the identifier that represents an individual conversation in the third party provider.

Body Params

request

channelProviderId

string

required

length between 3 and 256

The unique id that represents the channel provider

businessAccountName

string

required

length between 3 and 256

The name of the business account configured on the channel provider. For custom messaging integration, provide the unique id of the integration (integrationId) here.

reason

string

enum

Reason for termination of client session of a customer

Allowed:

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