Description
You can now secure pause (and resume) a conversation without having to being a participant in the conversation. A new set of endpoints in the Conversation API has been created for this:
- PUT /api/v2/conversations/calls/{conversationId}/recordingstate
- PUT /api/v2/conversations/callbacks/{conversationId}/recordingstate
- PUT /api/v2/conversations/chats/{conversationId}/recordingstate
- PUT /api/v2/conversations/cobrowsesessions/{conversationId}/recordingstate
- PUT /api/v2/conversations/emails/{conversationId}/recordingstate
- PUT /api/v2/conversations/messages/{conversationId}/recordingstate
- PUT /api/v2/conversations/screenshares/{conversationId}/recordingstate
- PUT /api/v2/conversations/socials/{conversationId}/recordingstate
- PUT /api/v2/conversations/videos/{conversationId}/recordingstate
Also, a new permission is now available: - Conversation > Recording > PauseOthers
To use these endpoints, simply be authenticated as an API user with this new permission. This enables you to programmatically secure pause and resume calls (or other kinds of conversations) based on certain external events, such as an agent accessing a certain 3rd-party CRM or billing screen where customer sensitive or payment information would be discussed.
Change Category
Informational, API
Change context
This is for upcoming GA release of WEM-449: Ability to Secure Pause Recording of Other User's Conversations.
Change impact
The existing endpoints to toggle Secure Pause for the respective channels, such as PATCH /api/v2/conversations/calls/{conversationId} with recordingState as a parameter, will continue to work as-is. That is, you can use these existing endpoints to secure pause conversations, as long as the authenticated user has the existing permission Conversation > Recording > Pause and is one of the participants of the conversation.
Date of Change
18/May/22
Impacted APIs
- PUT /api/v2/conversations/calls/{conversationId}/recordingstate
- PUT /api/v2/conversations/callbacks/{conversationId}/recordingstate
- PUT /api/v2/conversations/chats/{conversationId}/recordingstate
- PUT /api/v2/conversations/cobrowsesessions/{conversationId}/recordingstate
- PUT /api/v2/conversations/emails/{conversationId}/recordingstate
- PUT /api/v2/conversations/messages/{conversationId}/recordingstate
- PUT /api/v2/conversations/screenshares/{conversationId}/recordingstate
- PUT /api/v2/conversations/socials/{conversationId}/recordingstate
- PUT /api/v2/conversations/videos/{conversationId}/recordingstate
References
WEM-449