Versions Compared

Old Version 4

changes.mady.by.user Former user

Saved on

compared with

New Version 5

changes.mady.by.user Abhinandan Shah (Deactivated)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel7

...

Outbound Make Call API

Use this API to initiate an Outbound Flow request.

Before sending request, make sure to whitelist your IP through which you are sending API request in the whitelist section.

Request Parameters:

Method

Status
colourGreen
titlePOST

Body

JSON

Headers

Content-Type: application/json

Auth

None

...

  1. api-version: Use 1.0 to use the

    Status
    colourBlue
    titleIn production
    or TEST to use the
    Status
    colourYellow
    titleIn Testing
    version of the outbound flow.

  2. security-id: Get the security ID from the ‘Edit Flow’ page of any Outbound Flow

  3. flow-id: Get the 8 character alpha numeric Flow ID from the ‘Edit Flow’ page of any Outbound Flow

  4. calls: Array. Each element in array represents one call. You can have up-to 500 calls in one request.

    1. client-identifier: Callback variable to uniquely represent this request.

    2. start-time: ISO-8601 Timestamp. Date cannot be of past. If time is of past (and date is today) the flow will be initiated immediately.

    3. contact-numbers: Array. Mobile numbers of the customer. You can provide alternate numbers of a customer and calling will be initiated to each number until one is connected in one attempt.

    4. keys: Array of Flow Variables. There’s no limit on how many flow variables can be provided.

      1. "name": "$flow.key.<variable>": Name of flow variable.

      2. "value": "Abhinandan": Value of the above flow variable.

...

Response:

  1. Successful Response:
    Status Code:

    Status
    colourGreen
    title200

    Code Block
    languagejson
    {
  "api-response-code": 200,
  "api-response-message": "Success",
  "request-id": "c46e46f4-dc58-4839-9483-f7dd9aac28a0",
  "call-details": [
    {
      "client-identifier": "2021-04-28T03:48:07.110Z",
      "phonon-uuid": "501c78ee-8d06-498e-8952-fce3495f326b"
    }
  ]
}

...

Status Code

Status Message

Status Name

1

400

Invalid Format

INVALID_FORMAT

2

201

Checksum Repeated

CHECKSUM_REPEATED

3

302

Empty Call List

EMPTY_CALL_LIST

4

500

Failure

FAILURE

5

301

Invalid Flow ID

INVALID_FLOW_ID

6

401

IP Not Whitelisted

IP_NOT_WHITELISTED

7

402

Phone Not Whitelisted

PHONE_NOT_WHITELISTED

8

202

Invalid Security ID

INVALID_SECURITY_ID

9

200

Success

SUCCESS

10

203

API Version not Supported

INVALID_API_VERSION

11

204

Invalid SMS Gateway

INVALID_GATEWAY_ID

12

205

Invalid Contact Number

INVALID_CONTACT_NUMBER

13

206

Failure from Gateway

FAILURE_FROM_GATEWAY

14

207

DID Not Mapped

DID_NOT_MAPPED

15

208

No Mask Available

NO_MASK_AVAILABLE

16

209

Partial Success

PARTIAL_SUCCESS

17

210

Invalid Mandatory Parameters

INVALID_MANDATORY_PARAMETERS

18

303

Max Data List Size Exceeded

MAX_DATA_LIST_SIZE_EXCEEDED

19

211

Validity Expired

VALIDITY_EXPIRED

20

212

Insufficient Balance

INSUFFICIENT_BALANCE

21

304

Invalid Flow Version

INVALID_FLOW_VERSION

22

213

No Data Available

NO_DATA_AVAILABLE

Other Docs:

  1. Todo: https://docs.google.com/document/d/1A5UciLQYB6hS7VwKjazU204IxMwlfD_KwSnexlkaa8Y/edit#

  2. Tech API Docs: /wiki/spaces/CB/pages/201752979

  3. Todo, add Security: /wiki/spaces/CB/pages/209224413