Remove a Participant

Removes a rep participant from an active messaging session.

Only use this API if routing is partner-owned (if ConversationChannelDefinition.routingOwner is set to Partner).

When this API is called on an active messaging session, a rep is removed from the messaging session while other participants such as the end user and another rep remain. The messaging session stays open. If After Conversation Work (ACW) is enabled for the service channel or presence configuration, the removed rep goes into ACW.

This API is useful if a rep gets disconnected during an active messaging session with a messaging end user and another rep needs to take over. Calling this API after rerouting the messaging session prevents the disconnected rep from re-joining the session when they reconnect.

This API applies to the following product:

• Bring Your Own Channel for Contact Center as a Service

This API is available in version 65.0 and later.

v1/participant

POST

Format: Bearer <Salesforce Access Token>
String. Standard header. Used to authenticate the user, where <Salesforce Access Token> is the Salesforce access token used as the bearer token to make requests to the Interaction Service APIs. Required.

Format: application/json
String. Standard header. Format of the request payload. Required for any request that includes a body.

Format: <Salesforce Org ID>
String. Custom header. The Salesforce org. <Salesforce Org ID> is the 15-character Org ID of the Salesforce org. Required.

Format: <UUID>
String. Custom header. Universally Unique Identifier (<UUID>) that references and tracks this request. Required.

Format: <AuthorizationContext>
String. Custom header. Additional information for the request authorization used to authenticate and validate requests against the connected app scopes.

• For Bring Your Own Channel for CCaaS, set <AuthorizationContext> to the developer name of the ConversationChannelDefinition record. For example, Partner1_ChannelDefinition1. Required.

1-H $'Authorization: Bearer 00DSG000009SWby!...LN8XxeRIxGe' \
2-H "content-type: application/json" \
3-H "OrgId: 00DSG000009SWby" \
4-H "AuthorizationContext: Partner1_ChannelDefinition1" \
5-H "RequestId: a1b23c45-c06a-4784-c96c-cb95d3321bda" \

Sample Payload

1{
2  "conversationIdentifier": "1234a5bc-52b8-43ed-9608-7997f7b88dc1",
3  "operation": "Remove",
4  "participants": [
5    {
6      "subject": "UserName01"
7      "role": "Agent"
8      "appType": "agent"
9    }
10  ]
11}

Sample Payload

1{
2    “success”:true
3}

• GitHub: Interaction Service APIs