Clear Routing

Deletes the Pending Service Routing (PSR) record for the specified conversation.

This API doesn’t need to be called for most scenarios; the PSR record is automatically deleted when the call is no longer being routed. However, there are some scenarios, like for missed or abandoned messages when using partner telephony systems (excluding Amazon Connect), where you must explicitly call this API to clear the PSR record.

This API applies to the following product:

  • Bring Your Own Channel for Contact Center as a Service

This API is available in version 62.0 and later.

v1/route

DELETE

Authorization: Bearer <Salesforce access token>
String. Standard header. The authorization token, where \<token\> is the JSON Web Token (JWT). Required.

Content-Type: <Request body format>
String. Standard header. The format of the request body. Valid format is multipart/form-data. Required.

OrgId: <Salesforce Org Id>
String. Standard header. The 15-character Org ID of the Salesforce org. Required.

AuthorizationContext: <ConversationChannel Definition developer name>
String. Standard header. The ConversationChannelDefinition developer name in the format {prefix}_{ConversationChannelDefinitionName}. The prefix must match the developer name prefix of the corresponding connected app. For example, Partner1_ChannelDefinition1. Required.

RequestId: <GUID>
String. Standard header. A globally unique ID (GUID). Required.

For example,

Property NameTypeDescriptionRequired
conversationIdentifierstringThe unique ID for the conversation channel.Yes