post
/api/v1/{subAccountId}/calls
- This endpoint is used to send Voice Messages individually (1 request per Voice Message).
- It is ideal to send single personalised messages for use-cases like notifications or alerting for example.
URL
The Wavecell subaccountid to use is defined in the URL where you send your POST request as shown below:
https://voice.wavecell.com/api/v1/{subAccountId}/calls
You must replace {subAccountId}
in the URL above with the subaccountid that you want to use.
Authorization
apiKey - Authorization
Request Parameters
1 Path Parameter
Request Body
- To send a single Voice Message using the Wavecell Voice Message API you need to POST a JSON object to the url defined above.
- Additionally it is required to set either a language code or a voice profile in the request, to guarantee the correct pronunciation of the voice message.
- The JSON object takes the following properties:
2 Examples
Schema
clientRequestId
string
Optional client side id to represent request.
callflow
array[object]
Action or set of actions which are performed during the call.
Responses
Should the request authenticate successfully and pass all validation, the response will contain an updated Voice Message Object. The following is an example response:
1 Example
Schema
uid
string
Unique message ID automatically generated by Wavecell
status
object
destination
string
Destination phone number to which the Voice Message was sent to.
clientRequestId
string
Optional client side id to represent request.
Send a Test Request
POST
Send requests directly from the browser (CORS must be enabled)
Path Params
subAccountId
$$.env
Authorization
subAccountId