Versions Compared

Key

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

...

  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 Outbound 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 of 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 calling 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.

...

  1. IP Not Whitelisted

    Status
    colourBlue
    title401
    : Please whitelist your IP in the Whitelist section.

  2. Checksum Repeated

    Status
    colourYellow
    title201
    : You can trigger the same API payload more than once. Please change at - least one parameter. (Date-time, client-identifier, etc.)

  3. Invalid Security ID

    Status
    colourYellow
    title202
    : Security ID is invalid. Please check the end point endpoint and security ID.

  4. Invalid Flow ID

    Status
    colourYellow
    title301
    : Flow ID is invalid. Please check the end point endpoint and Flow ID.

  5. Failure

    Status
    colourRed
    title500
    : Any Failure scenario.

...