Versions Compared

Key

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

Dialer Make Call API

Use this API to initiate a Dialer Flow request.

...

API URL: https://central.phonon.in/kairos-apis/outbounddialer/create

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 characters alphanumeric Flow ID from the ‘Edit Flow’ page of any Dialer Flow

  4. calls: Array. Each element in the 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. The date cannot be of past. If time is past (and the 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 calls 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": "Ankit": 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"
        }
      ]
    }

...