Says
Say records are generated when you are using the <Say> verb. Those records are hosted with CPaaS and are available for you to retrieve. The Say records list resource represents a set of an Account’s Say records.
Resource Properties
Property | Description |
---|---|
sid |
A string that uniquely identifies this record. |
date_created |
The date this record was created. |
account_sid |
The unique id of the Account that created this record. |
org_sid |
The unique id of the Organization to which the Account belongs to. |
call_sid |
The unique id of the call during which Say (Text-to-Speech) was executed. |
api_version |
The API version in use during the recording. |
status |
The status of the Text-to-Speech. Possible values are: |
reason |
The error code and text returned by CPaaS in case of an error. This information is provided when the status is |
duration |
The duration in seconds of the just-completed Say verb. |
character_count |
The number of characters used in the Say text. |
provider |
The Text-to-Speech provider used in the Say verb. |
language |
The language used in the Say verb. |
voice |
The voice used in the Say verb. |
loop |
The number of repetitions set in the Say verb. |
uri |
The URI of the Say record, relative to |
Supported Operations
HTTP GET. Returns the representation of a Say resource, including the properties above.
Example Request
curl -X GET https://mycompany.restcomm.com/restcomm/2012-04-24/Accounts/ACea59167c974743ecb8dbe4cc8bb85712/Says/RFc377eb0e657e415383de087ab38797db \
-u 'YourAccountSid:YourAuthToken'
Example Response
{
"sid":"SA2c0bd8c5536447eab7227b5e0adca447",
"call_sid":"ID339a19657f0540559df11bbebdf132ab-CA25758b7f10b54c6cb23efa25917d24c3",
"date_created":"Wed, 23 Jun 2021 01:18:18 +0000",
"account_sid":"ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"org_sid":"OR87a155237d5241b6bbe11b05fe6f9836",
"api_version":"2012-04-24","status":"completed",
"reason":"",
"duration":2,
"character_count":25,
"provider":
"voicerss",
"language":"en-us",
"voice":"man",
"loop":1,
"uri":"2012-04-24/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Says/SA2c0bd8c5536447eab7227b5e0adca447"
}
Getting a List of Say Records
Here is how you can list your Say records:
curl -X GET https://mycompany.restcomm.com/restcomm/2012-04-24/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Says \
-u 'YourAccountSid:YourAuthToken'
The response will be similar to the one below.
Example Response
{"page":0,"num_pages":0,"page_size":50,"total":34,"start":"0","end":"34","uri":"/api/2012-04-24/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Says","first_page_uri":"/api/2012-04-24/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Says?Page=0&PageSize=50","previous_page_uri":"null","next_page_uri":"null","last_page_uri":"/api/2012-04-24/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Says?Page=0&PageSize=50","says":
[
{
"sid":"SA2c0bd8c5536447eab7227b5e0adca447",
"call_sid":"ID339a19657f0540559df11bbebdf132ab-CA25758b7f10b54c6cb23efa25917d24c3",
"date_created":"Wed, 23 Jun 2021 01:18:18 +0000",
"account_sid":"ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"org_sid":"OR87a155237d5241b6bbe11b05fe6f9836",
"api_version":"2012-04-24","status":"completed",
"reason":"",
"duration":2,
"character_count":25,
"provider":
"voicerss",
"language":"en-us",
"voice":"man",
"loop":1,
"uri":"2012-04-24/Accounts/ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Says/SA2c0bd8c5536447eab7227b5e0adca447"
},
...
]
}
Request Parameters
Parameter | Description |
---|---|
DateCreated |
Only show say records that started on this date/time or later, given as an ISO-8601 date/time string, like YYYY-MM-DDTHH:MM:SS (for example 2018-10-05T22:45:32). If you want to omit the time, YYYY-MM-DD (for example 2018-10-05). If only a date is provided the time is assumed to be at midnight of the given date. Note that the given date/time is inclusive and is assumed to be in the UTC timezone. A 400 response will be returned if the syntax is invalid. |
Paging Information
The request supports standard paging information. For more details, please visit the Paging Information documentation.