21 Dec Overview fields and options for using the Robocall Campaign API

 

The procedure to create a “robocall” campaign aims to send contacts entered, one or more audio that can be of their interest within a specific campaign.

To create a Robocall Campaign petition should be sent to one of the following URLs:

HTTP (non-SSL)

 

1.1 HTTP Methods

For the Robocall Campaign procedure, the POST HTTP method must be used.

1.2 Authentication Information

All requests require API Key and API Secret authentication credentials. Account Administrators can login to view their account API Key and API Secret in the “My Profile > Settings” section.

To authenticate a request, please use the POST request header.

In the header of the request for “apiKey

Parameter Name

apiKey

Description

The account’s API username (key). Its a 32 character random string.

Example:

 

Variable Type

String

Mandatory?

YES

 

In the header of the request for “Apisecret

Parameter Name

Apisecret

Description

The account’s API password (secret). It’s a numeric random string with a random length between 10 and 15 characters.
Example:

 

Variable Type

String

Mandatory?

YES

 

In the header of the request for “Content-Type

Parameter Name

Content-Type

Description

application/json

Variable Type

String

Mandatory?

YES

 

In the header of the request for “from

Parameter Name

from

Description

The Caller ID (“from”) number from the campaign originates. The Caller ID number can be any number entered by the user consuming the service,will have a max length of 15 numeric characters.
Example:

Variable Type

String

Mandatory?

YES

 

In the header of the request for “toList

Parameter Name

toList

Description

The recipient (“to”) the number of the contact to whom it is addressed the Robocall campaign. The destination number must be in international format and contain only digit values.
Example:

Variable Type

String (1…*)

Mandatory?

YES

 

In the header of the request for “callSteps

Parameter Name

callSteps

Description

Will contain the call for steps (“callSteps”)that make up the Robocall campaign.
The steps may contain will be of type “PLAY“, “SAY“, “DETECT“.

Variable Type

Objects(1…*)

Mandatory?

YES

 

In the header of the request for “PLAY

Parameter Name

PLAY

Description

The type of action (“PLAY“) runs an audio .wav given its location in a url.
parameters to perform their work, will be “sourceType“, “source“.
Example:

“sourceType” only accepts the value of “URL”
“source” be a valid URL of an audio file .wav format

Variable Type

Objects(1…*)

Mandatory?

YES

 

In the header of the request for “SAY

Parameter Name

SAY

Description

The type of action (“SAY“), make an audio (.wav) to be used in the robocall campaign, text sent. Audio will be played with one of the predefined by the platform Telintel voices.
Example:

  • text” only accepts alphanumeric values of a fullest extent of 250 characters.
  • sourceType” only accepts the value “STANDARD”.
  • voice” is the identifier of the voice with which you want to create audio possible values are “CARLOS”, “SOLEDAD” for Spanish and “NITECH” for audios in English.

Variable Type

Objects

Mandatory?

YES

 

In the header of the request for “DETECT

Parameter Name

DETECT

Description

The type of action (“DETECT“) allows execute actions or subsequent steps of the Robocall campaign, depending on the interaction of the subscriber and the numeric keypad (0-9). “DETECT” it is how IVR is implemented in the API Robocall campaign.Example:

  • options” is the array structure containing types “OPTION” which in turn contains “steps”, each step can be a “PLAY” , “SAY” or call redirection “DIAL” or “DETECT“.
  • dtfmCommand” correspond to the value of a numeric key (“0” … “9”) should be pressed by a subscriber.
  • optionId” could be either an alphanumeric value that identifies the “OPTION” should not be in the same “DETECT” two “OPTION” with the same ID.
  • steps” is an array of possible actions to be executed after being pressed a specific numeric key on the “OPTION“, can be a “PLAY“,”SAY” or call redirection or “DETECT“.
  • destination” the value of this attribute allows a redirection the phone number entered.
  • type” to make the call the value of this field will always be “DIAL“.

Variable Type

Objects(1…*)

Mandatory?

YES

The request body will contain a JSON object.
For Example:

Example to create a Robocall campaign with a single audio (url) without IVR.

PHP example

 

Java example (with Apache HTTPClient)

 

6.5 Response Parameters

 

Key

Description

Variable Type

VOICE-SUC-01

The value of this code indicates that the campaign was created successfully. Please reference Response Codes table in Annex A. String

VOICE-ERR-01

The value of this key indicates that the data is not valid for a caller_id. Please reference Response Codes table in Annex A. String

VOICE-ERR-02

The value of this key indicates that a shipment not caller_id. Please reference Response Codes table in Annex A. String

VOICE-ERR-03

The value of this key indicates the list was sent to subscribers empty. Please reference Response Codes table in Annex A. String(…*)

VOICE-ERR-04

The value of this key indicates one or more numbers of the subscriber list is not valid. Please reference Response Codes table in Annex A. String(…*)

Play

Response Parameters for “PLAY

Key

Description

Variable Type

VOICE-ERR-05

The key value “source” of the action “PLAY” must not be empty. Please reference Response Codes table in Annex A. String

VOICE-ERR-06

URL must be specified as the value of “source” of the action “PLAY”. Please reference Response Codes table in Annex A. String

VOICE-ERR-02

The value of this key indicates that a shipment not caller_id. Please reference Response Codes table in Annex A. String

VOICE-ERR-07

Audio (.wav) there must be an url specified as the value of “source” of the action “PLAY”. Please reference Response Codes table in Annex A. String