Radio API
Play text as audio
This endpoint allows you to play text as audio on the edge device.
Authorizations:
Request Body schema: application/jsonrequired
edgeId required | string Unique identifier for the SYNQ Radio edge device. |
text required | string The text to convert to speech and play as audio. |
actor required | string The name of the actor responsible for this audio. |
process | boolean Default: false Indicated whether to process all voice handlers for this message. |
Responses
Request samples
- Payload
{- "edgeId": "6803a571-8904-441d-b2ec-6886e9307635",
- "text": "The store will be closing in 10 minutes.",
- "actor": "My External Application",
- "process": false
}
Response samples
- 200
- 403
- 404
{- "success": true
}
Play text message from Twilio webhook as audio
This endpoint receives webhook requests from Twilio and plays text messages as audio on the edge device. See Twilio's request to your application for more information.
path Parameters
edgeId required | string Example: 6803a571-8904-441d-b2ec-6886e9307635 Unique identifier for the SYNQ Radio edge device. |
header Parameters
X-Twilio-Signature required | string The signature of the request. The signature uses the HMAC-SHA1 hashing algorithm with your Twilio account's auth token as the secret key. |
Request Body schema: application/x-www-form-urlencodedrequired
AccountSid required | string The 34 character ID of the Twilio account this message is associated with. |
Body required | string The text body of the message. |
From required | string The phone number that sent this message. |
To required | string The phone number of the recipient. |
Responses
Response samples
- 200
- 403
- 404
{- "success": true
}