Voice Broadcast API
AdvancedNotifyRequest
This type is used in the NotifyMultiplePhoneAdvanced method.
Type Properties
| Property Name | Description | Data Type | Sample |
|---|---|---|---|
| PhoneNumberToDial | The phone number to call. It can be in any format, as long as there are 10 digits. To dial an extension, add x followed by the extension. | String | 7575559999 |
| TransferNumber | The phone number that the call will be transferred to if the call recipient presses 0. Transfer behavior can be further modified with TextToSay commands. | String | 7575558888 |
| VoiceID | The text-to-speech voice ID. | Integer | 2 |
| CallerIDNumber | The number to display on the receiving party’s Caller ID. | String | 7575550000 |
| CallerIDName | The name to display on the receiving party’s Caller ID. (Most carriers ignore this and use their own directory assistance to display name information.) | String | Esendex Services |
| TextToSay | The text-to-speech text or combination of text-to-speech and script to be read to the receiving party. | String | Hello, this is a sample call from Phone Notify. |
| LicenseKey | Your license key. | String | 00000000-0000-0000-0000-000000000000 |
| TryCount | The number of times to attempt dialing if the initial call is unanswered or busy. The maximum is 3. | Integer | 2 |
| NextTryInSeconds | The number of seconds to wait until the next retry is performed if the original call is unanswered or busy. We recommend waiting at least 60 seconds. | Integer | 180 |
| UTCScheduledDateTime | The date and time at which to send the call, specified as Coordinated Universal Time (UTC). | DateTime | 2020-11-17T08:25:08.336Z |
| TTSrate | The speed that text-to-speech (TTS) will use when speaking the text. The value ranges from 0 to 20 (10 being normal). This can also be controlled within the TextToSay parameter. | Byte | 10 |
| TTSvolume | The volume that text-to-speech (TTS) will use when speaking the text. The value ranges from 0 to 100 (100 being the default). This can also be controlled within the TextToSay parameter. | Byte | 100 |
| MaxCallLength | The maximum time duration of the call, in seconds. We recommend you do not change this unless you absolutely need to. | Integer | 80 |
| StatusChangePostUrl | The URL to post call status changes to. The URL must be in lowercase. The system posts OutgoingPostback data for outgoing calls and IncomingPostback data for incoming calls. | String | https://example.com/callprogress.aspx |
| ReferenceID | An optional ID to help you identify the call. | String | notify1 |
Let’s start sending, together.