VOICE API

Multi-Level IVR Feature
Overview

Go4clients bases its functionality on campaigns. A campaign is a set of events (Calls, SMS, Landing pages, and many more) with the same characteristics that allows your organization to categorize your customers according to your needs and contact them evenly. Go4Clients allows you to create calls with different levels of interactions. These are the “Multi-Level IVR” calls. To use them, you need to create a campaign via API and then reuse it from the Go4Clients platform. Please refer to Call Steps to see what capabilities this API offers.

1. HTTP Methods

You need to call a POST HTTP for creating a new Multi-Level IVR Campaign. The following URLs are used to publish the IVR voice service:

HTTPS (Recommended):

1
https://go4clients.com/TelintelSms/apimlivr/voice/createcampaign

HTTP (non-SSL):

1
http://go4clients.com:8443/TelintelSms/apimlivr/voice/createcampaign

The following HTTP request will create a Multi-Level IVR campaign to be reused inside Go4Clients.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
POST /TelintelSms/apimlivr/voice/createcampaign HTTP/1.1
Host: go4clients.com:8443
Apikey: a4cb19902d2b4appp62af9ead3416a64e60
Apisecret: 43673211121666
Content-Type: application/json
 
{
  "name": "MLIVR Campaign",
  "description": "Multi-Level IVR campaign",
  "campaignCapacity": 100,
  "callSteps": [
    {
      "type": "SAY",
      "text": "Hello, please press 1 to communicate with sales, 2 to communicate with  technical support, or 3 if you want to repeat this menu",
      "convertVoice": "ALLISON",
      "sourceType": "STANDARD"
    },
    {
      "type": "DETECT",
      "options": [
        {
          "type": "OPTION",
          "dtfmCommand": "1",
          "optionId": "sales",
          "steps": [
            {
              "type": "SAY",
              "text": "Welcome to the  sales area",
              "convertVoice": "SUSAN",
              "sourceType": "STANDARD"
            },
            {
              "destination": "19431843765",
              "type": "DIAL"
            }
          ]
        },
        {
          "type": "OPTION",
          "dtfmCommand": "2",
          "optionId": "technical support",
          "steps": [
            {
              "type": "SAY",
              "text": "Welcome to the  technical support area",
              "convertVoice": "TOM",
              "sourceType": "STANDARD"
            },
            {
              "destination": "19431843765",
              "type": "DIAL"
            }
          ]
        },
        {
          "type": "OPTION",
          "dtfmCommand": "3",
          "optionId": "Repeat the audio above",
          "steps": [
            {
              "type": "REPEAT_AUDIO"
            }
          ]
        }
      ]
    }
  ]
}

2. Authentication

All requests require API Key and API Secret authentication credentials. Your Account Administrator can modify this information under “My Profile > Settings > API” section. The security information goes in the POST Headers:

Parameters
Apikey
String (Required)

The account’s Api key username (key), a 32 character random generated string.

1
"Apikey": "5bf54d157a214f748eede4e4131b874d"
Apisecret
String (Required)

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

Example
1
"Apisecret" : "712968662797"

Please be advised that the header also have to include a parameter “Content-Type” with value “applica-tion/json”.

3. REQUEST PARAMETERS

Request Parameters
name
String

Name you want for the campaign.

description
String

Brief description of the campaign.

campaignCapacity
String

Max. concurrent calls for the campaign.

callSteps
String

List of steps for the campaign. If you want some additional info about steps you can visit Steps types and how to use them.

4. RESPONSE PARAMETERS

Request Parameters
code
String

Code of the result.

success
Boolean

Indicates if the service response is successful or not.

description
String

Brief description of the result.

uniqueCampaignID
String

Unique identificator for the campaign. You must reference it on any operation over the created campaign.

5. Reusing the campaign

After creating the campaign, you can reuse it and launch your own campaigns based on the campaign structure and steps of the Multilevel IVR campaign. You only need to access to the “Create a campaign > Robocall” and select the “Use an existing campaign” option:

Captura-de-pantalla-de

If you select a Multilevel IVR campaign as template for a new campaign, the “Intro message”and “IVR” sections of the Robocall campaign creation will be disabled.