Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Send a call using a previous uploaded Audio File or an IVR on SENDService platform.

...

ParameterDescriptionObject / Right formatRequired

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+UTCYes
EndDate

It represents the last date for your scheduled calls

aaaa-MM-ggThh:mm:ss.SSS+UTCYes

Type

The type of Instant Call0 or DefaultYes

MaxRetries

Number of max retries in case of no answer, busy, etc...integerno

MinutesBetweenRetries

Interval in minutes between 2 retries on the same phone number on the same requestintegerno
ExtensionNumber of the extension of a previous created audio file or IVR on the SENDSerivce platformintegeryes
FirstName
Contact FirstnameString max 128 charactersno
LastNameContact LastnameString max 128 charactersno
IVRRepeats

Repetitions of audio file or introduction audio file on IVR.

integerno
NumberTo CallPhone Number of your contact wich will be calledstring (it must be inserted with the international prefix f.e. 0039)yes
CallerIdCaller 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 GUIDno

...

ParameterDescriptionObject / Right formatRequired
userIt represents required object for the authorization  

"User": {

"username": "your username",
"password": "your password"
}
yes
StartDateIt represents date when you want to schedule your callsaaaa-MM-ggThh:mm:ss.SSSreplaced if exist in InstantCall
EndDateIt represents the last date for your scheduled callsaaaa-MM-ggThh:mm:ss.SSSreplaced if exist in InstantCall
TypeThe type of Instant Call0 or Defaultreplaced if exist in InstantCall
MaxRetriesNumber of max retries in case of no answer, busy, etc...integerreplaced if exist in InstantCall
MinutesBetweenRetriesInterval in minutes between 2 retries on the same phone number on the same requestintegerreplaced if exist in InstantCall
ExtensionNumber of the extension of a previous created audio file or IVR on the SENDSerivce platformintegerreplaced if exist in InstantCall
FirstNameContact FirstnameString max 128 charactersreplaced if exist in InstantCall
LastNameContact LastnameString max 128 charactersreplaced if exist in InstantCall
IVRRepeatsRepetitions of audio file or introduction audio file on IVR.integerreplaced if exist in InstantCall
NumberTo CallPhone Number of your contact wich will be calledstring (it must be inserted with the international prefix f.e. 0039)replaced if exist in InstantCall
CallerIdCaller 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
CodeRequestUnique Identification code for your requestbetter to send a GUIDreplaced if exist in InstantCall
InstantCallsAn array with instant calls which have same parameters of one call

"InstantCalls": [
{
"NumberToCall": "0039...",
"Extension": 0,
"StartDate": "aaaa-MM-ggThh:mm:ss.SSS",
"EndDate": "aaaa-MM-ggThh:mm:ss.SSS",
"Type": 0,
"MaxRetries": 5,
"MinutesBetweenRetries": 60,
"IVRRepeats": 1,
"CallerId": "39"
},

{...}

]

yes

...