Say enables you to send a voice message (text-to-speech) to an end/ user.
The requests for all actions are the same as v1.1 except the removal of clientRequestId
Sample of a sayrequest
sayrequest
{
"callflow": [
{
"action": "say",
"params": {
"source": "+6568332000",
"destination": "+6591234567",
"text": "Hello this is a test from 8 by 8. 1 2 3 4 5 6",
"repetition": 1,
"voiceProfile": "en-US-ZiraRUS",
"speed": 1
}
}
]
}
Response
Success
{
"sessionId": "d9874358-89ac-4c50-bbab-1eb634482a94",
"sessionStatus": "CREATED",
"callFlowRequestId": "89b545a5-0676-11ee-8100-d500c0d203fc",
"statusCode": 1,
"statusMessage": "Created"
}
Failure
{
"sessionStatus": "NOT_CREATED",
"callFlowRequestId": "0564e804-0a7e-11ee-9c83-6df9c048a122",
"statusCode": -1002,
"statusMessage": "Speech profile or language parameter invalid"
}
Explaining Session Status
Session status indicates if a call is successfully accepted & created or not created on the 8x8 platform. 8x8 returns two status:
CREATED- call is successfully created on the platform.NOT CREATED- call is not successfully created on the platform and 8x8 returnsstatusCodeandstatusMessageto understand why the call was not accepted on the platform
Status Code and Status Message
| Status Code | Message |
|---|---|
| 1 | Created |
| -1001 | Invalid JSON request body |
| -1002 | Speech profile or language parameter invalid |
| -1003 | Valid maxDigits required when minDigits provided |
| -1005 | Valid overallTimeout is required when digitTimeout provided |
| -1007 | $.callflow[0].action should be one of: [Call action names] Eg: $.callflow[0].action should be one of: say,playFile,sayAndCapture |
| -1008 | Valid maxDigits is required when completeOnHash is false |
| -1009 | Invalid call flow entry provided. [Additional error details here]. Eg: Invalid call flow entry provided. $.callflow[0].params.text: is missing but it is required |
| -9999 | An unknown error has occurred. |