InstantCall - IVR with TTS
Send a call using a previous created IVR on SENDService platform with a custom introduction TextToSpeech.
1 Call - 1 Request
Parameters
| Parameter | Description | Object / Right format | Required |
|---|---|---|---|
user | It represents required object for the authorization | "User": { "username": "your username","password": "your password" } | Yes |
| StartDate | It represents date when you want to schedule your calls | aaaa-MM-ggThh:mm:ss.SSS+UTC | Yes |
| EndDate | It represents the last date for your scheduled calls | aaaa-MM-ggThh:mm:ss.SSS+UTC | Yes |
Type | The type of Instant Call | 4 or IVRwithTTS | Yes |
MaxRetries | Number of max retries in case of no answer, busy, etc... | integer | no |
MinutesBetweenRetries | Interval in minutes between 2 retries on the same phone number on the same request | integer | no |
| Extension | Number of the previous created IVR on the SENDSerivce platform. NB: IVR MUST BE USED IN 1 CAMPAIGN | integer | yes |
| TextToSpeech | Introduction text of the call which will be converted in audio file | String | no |
| LanguageCode | Language for the conversion of the introduction TextToSpeech | Check our available language codes | yes |
FirstName | Contact Firstname | String max 128 characters | no |
| LastName | Contact Lastname | String max 128 characters | no |
IVRRepeats | Repetitions of audio file or introduction audio file on IVR. | integer | no |
| NumberTo Call | Phone Number of your contact wich will be called | string (it must be inserted with the international prefix f.e. 0039) | yes |
| CallerId | Caller phone number, please communicate it to your reseller. | string - fixed number inserted with the international prefix without 00 (f.e. 39....) | yes |
| CodeRequest | Unique Identification code for your request | better to send a GUID | no |
Example Application/json or Text/json
Example Application/json or Text/json
{
"InstantCalls": [
{
"NumberToCall": "0039......",
"Extension": 200980,
"StartDate": "aaaa-MM-ggThh:mm:ss.SSS+01:00",
"EndDate": "aaaa-MM-ggThh:mm:ss.SSS+01:00",
"Type": 4,
"MaxRetries": 5,
"MinutesBetweenRetries": 60,
"IVRRepeats": 1,
"TextToSpeech": "Welcome to ASP.NET Web API! Modify the code in this template to jump-start your ASP.NET Web API development.",
"CallerId": "39.......",
"LanguageCode": "it-IT-F1"
}
],
"User": {
"password": "your password",
"username": "your username"
}
}
More Calls - 1 Request
Parameters
| Parameter | Description | Object / Right format | Required |
|---|---|---|---|
| user | It represents required object for the authorization | "User": { "username": "your username","password": "your password" } | yes |
| StartDate | It represents date when you want to schedule your calls | aaaa-MM-ggThh:mm:ss.SSS | replaced if exist in InstantCall |
| EndDate | It represents the last date for your scheduled calls | aaaa-MM-ggThh:mm:ss.SSS | replaced if exist in InstantCall |
| Type | The type of Instant Call | 4 or IVRWithTTS | replaced if exist in InstantCall |
| MaxRetries | Number of max retries in case of no answer, busy, etc... | integer | replaced if exist in InstantCall |
| MinutesBetweenRetries | Interval in minutes between 2 retries on the same phone number on the same request | integer | replaced if exist in InstantCall |
| TextToSpeech | Text of the introduction TTS of the call which will be converted in audio file | String | Yes |
| LanguageCode | Language for the conversion of the TextToSpeech | Check our available language codes | Yes |
| Extension | Number/Extension of the previous created IVR on the SENDSerivce platform | String | Yes |
| FirstName | Contact Firstname | String max 128 characters | replaced if exist in InstantCall |
| LastName | Contact Lastname | String max 128 characters | replaced if exist in InstantCall |
| IVRRepeats | Repetitions of audio file or introduction audio file on IVR. | integer | replaced if exist in InstantCall |
| NumberTo Call | Phone Number of your contact wich will be called | string (it must be inserted with the international prefix f.e. 0039) | replaced if exist in InstantCall |
| CallerId | Caller phone number, please communicate it to your reseller. | string - fixed number inserted with the international prefix without 00 (f.e. 39....) | replaced if exist in InstantCall |
| CodeRequest | Unique Identification code for your request | better to send a GUID | replaced if exist in InstantCall |
| InstantCalls | An array with instant calls which have same parameters of one call | "InstantCalls": [ {...} ] | yes |
Example Application/json or Text/json
Example Application/json Text/json
{
"InstantCalls": [
{
"NumberToCall": "0039......",
"Extension": 200980,
"StartDate": "aaaa-MM-ggThh:mm:ss.SSS+01:00",
"EndDate": "aaaa-MM-ggThh:mm:ss.SSS+01:00",
"Type": 4,
"MaxRetries": 5,
"MinutesBetweenRetries": 60,
"IVRRepeats": 1,
"TextToSpeech": "Welcome to ASP.NET Web API! Modify the code in this template to jump-start your ASP.NET Web API development.",
"CallerId": "39.......",
"LanguageCode": "it-IT-F1"
},
{
"NumberToCall": "0039......",
"Extension": 200980,
"StartDate": "aaaa-MM-ggThh:mm:ss.SSS+01:00",
"EndDate": "aaaa-MM-ggThh:mm:ss.SSS+01:00",
"Type": 4,
"MaxRetries": 5,
"MinutesBetweenRetries": 60,
"IVRRepeats": 1,
"TextToSpeech": "Welcome to ASP.NET Web API! Modify the code in this template to jump-start your ASP.NET Web API development.",
"CallerId": "39.......",
"LanguageCode": "it-IT-F1"
}
],
"User": {
"password": "your password",
"username": "your username"
}
}