get https://api.talkdeskapp.com/users//call-streaming-settings
Retrieves the call streaming settings for a user
Scope
call-streaming-settings:read
Body Response - Schema
200 (an object describing the current call streaming settings for the user)
| Parameter | Type | Description | Required |
|---|---|---|---|
| agent_stream_enabled | boolean | enables or disables the stream of the agent's calls for the given user | yes |
| agent_stream_url | string | The URL to where Twilio will stream the audio from the agent's call. Match pattern: ^wss://.*$ | yes |
| agent_stream_track | string | The audio track from the agent's call that should be streamed by Twilio. Allowed values: inbound_track , outbound_track, both_tracks | yes |
| _links | object | Subdivides into "self": "href" (string) Default: http://api-docs.talkdesk.org/users/{user_id}/call-streaming-settings | no |
401 (unauthorized), 403 (forbidden), 404 (not found), 500 (internal server error)
| Parameter | Type | Description | Required |
|---|---|---|---|
| code | string | n/a | yes |
| message | string | n/a | yes |
| description | string | n/a | no |
| fields | array[object] | "fields" subdivides into: "name" (string) "description" (string) | yes (name and description) |
API Availability
The Conversation Streams API is only available for customers enrolled in Talkdesk's Early Access (EA) program. To enter the EA program, contact a Customer Success Manager.
The Conversation Streams has been in EA since January 2022.
Troubleshooting
If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.