post https://api.talkdeskapp.com/interactions//announcement
Play an announcement in an interaction. Example: play a beep to announce that the call is being recorded.
Scope
interactions-announcement:write
Request Body (required)
{
"mp3_file_url": "https://www.examplesound.com/examples/mp3/example.mp3"
}
Body Response - Schema
400 (the request parameters are invalid), 401 (account not authorized), 403 (forbidden access: can't find the required scope in the JWT), 404 (interaction not found), 406 (provider unsupported action)
| Parameter | Type | Description | Required |
|---|---|---|---|
| code | string | n/a | yes |
| message | string | n/a | yes |
| description | string | n/a | yes |
| fields | array[object] | "fields" subdivides into: "name" (string) "description" (string) | yes (name and description) |
API Availability
The Interaction Announcement API has been in Early Access (EA) since August 2020.
To enter the EA program, contact a Customer Success Manager.
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.