InstantCall - Default
Send a call using a previous uploaded Audio File or an IVR on SENDService platform.
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 | 0 or Default | 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 extension of a previous created audio file or IVR on the SENDSerivce platform | integer | 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 Text/json
{
"InstantCalls": [
{
"NumberToCall": "0039.......",
"Extension": ///audio file extension,
"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,
"CallerId": "0039......",
"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 | 0 or Default | 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 |
| Extension | Number of the extension of a previous created audio file or IVR on the SENDSerivce platform | integer | replaced if exist in InstantCall |
| 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": "0039000000000",
"Extension": 1234567,
"CallerId": "0039000000000",
"Type": 0,
"StartDate": "aaaa-MM-ggThh:mm:ss.SSS+01:00",
"EndDate": "aaaa-MM-ggThh:mm:ss.SSS+01:00"
},
{
"NumberToCall": "0039000000000",
"Extension": 1234567,
"CallerId": "0039000000000",
"Type": 0,
"StartDate": "aaaa-MM-ggThh:mm:ss.SSS+01:00",
"EndDate": "aaaa-MM-ggThh:mm:ss.SSS+01:00"
}
],
"User": {
"password": "password",
"username": "username"
}
}
Response
Response are an array with InstantCalls objects which has parameters describe in next table. The other parameter, are defined in the InstantCall request.
| PARAMETERS | DESCRIPTION | TYPE |
|---|---|---|
| ID | The ID generated by the platform | Integer |
| Numbertocall | Number of wich was called | string |
| Extension | the Ex | integer |
| IntervalCall | Time for generate the originate + Phone Ringing | Integer |
| StartDateTimeCall | Date/Time of the call answer | aaaa-MM-ggThh:mm:ss.SSS |
| EndDateTimeCall | Date/Time of the call hangup | aaaa-MM-ggThh:mm:ss.SSS |
| InputDigits | What the reciever digits on his phone during the call | integer |
| Price | The price of the call | decimal |
PricePerMinute | Price for instant calls | decimal |
Retries | Number of retries of the call | integer |
Start Price | Default price for the call | decimal |
| Status of the call | String |
Articoli collegati