22 Dec Create a Robocall Campaign With IVR, using an action “SAY” “DETECT” and “PLAY”.

 

The objective is to create a campaign robocall successfully running the IVR process,for this purpose, it used a “SAY” with text indicating the subscriber, who must press numerical key.This response will be processed by DETECT with a “OPTION”. The OPTION will have a “step” which will be an action “PLAY” ending the campaign.

To send a message the request must be submitted one of the following URLs:

 

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 one of the following options:

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

Object

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

 

2.3 Request 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

 

Say

Response Parameters for “SAY

Key

Description

Variable Type

VOICE-ERR-08

A value for the “sourceType” key action “SAY” must exist. for now the only accepted value is “STANDARD”. Please reference Response Codes table in Annex A. String

VOICE-ERR-09

The audio for the action “SAY” may not be empty or be null. Please reference Response Codes table in Annex A. String

VOICE-ERR-10

The value for the key “text” of an action “SAY” must not be empty.Please reference Response Codes table in Annex A. String

VOICE-ERR-11

The value for the key “voice” of an action “SAY” must not be empty possible values are “CARLOS”, “Solitude” for Spanish language and “Nitech” for English language. Please reference Response Codes table in Annex A. String

 

 

Dial

Response Parameters for “DIAL

Key

Description

Variable Type

VOICE-ERR-12

The value for the key “destination” of the action “DIAL” must not be empty, must correspond to a valid telephone number with the international nomenclature (ex: “573128406895” for a mobile phone in Colombia). Please reference Response Codes table in Annex A. String

VOICE-ERR-13

The value for the key “destination” of the action “DIAL” must be numeric characters. Please reference Response Codes table in Annex A. String

 

 

Detect

Response Parameters for “DETECT

Key

Description

Variable Type

VOICE-ERR-14

DETECT should have at least one “OPTION” must not be empty. Please reference Response Codes table in Annex A. String

VOICE-ERR-15

The value for “dtfmCommand” key “OPTION” not be empty. Please reference Response Codes table in Annex A. String

VOICE-ERR-16

The value for “dtfmCommand” in “OPTION” key must be a string of numeric characters. Please reference Response Codes table in Annex A. String

VOICE-ERR-17

The value for “optionId” key to “OPTION” not be empty. Please reference Response Codes table in Annex A. String

VOICE-ERR-18

The list of “steps” of a “OPTION” must have at least one step. Please reference Response Codes table in Annex A. String

VOICE-ERR-19

“Unknown Error”. Please reference Response Codes table in Annex A. String

 

The request body will contain a JSON object as following:

PHP example

 

Java example (with Apache HTTPClient)