Robo call API

openapi: 3.0.2

version: 1.0.0

https://{baseOpenAPI}}/v1

Queue up calls request

• HTTP method: POST
• URL: /call
• Content type: application/json
• operationId: queueUpCall
• header: x-credential-api-key

This API will trigger a call with a configured call flow (including Play message, Gather input from user, or Transfer call) to a bulk of [E.164] phone number destinations.

• Click here to know E.164 format: https://en.wikipedia.org/wiki/E.164

All the calls will be queued sequentially. The number of calls triggered at a point of time equals to the number of free concurrent calls your organization at that moment.

• Your organization has 6 concurrent calls, and 100 calls are queued with request id _call_request_1
• At moment t1, your organization has 2 ongoing calls from BizPhone app then 4 queued calls will be triggered.
• At moment t2, your organization has 5 ongoing calls from BizPhone app then 1 queued call will be triggered.
• The process continue until all queued calls are triggered

Robo: Check status of an submitted call request

• HTTP method: GET
• URL: /status/{requestId}
• Content type: application/json
• Description: The API provides the status of a specific request and also status of all its calls
• operationId: checkCallStatus

Parameters

Example value

{
  "requestId": "request_10",
  "destinations": [
    {
      "phone": "+84917660247",
      "caller": "+6582674904",
      "properties": {
        "name": "Alex",
        "dueDate": "August 20th, 2020",
        "amount": "200,000$"
      }
    },
    {
      "phone": "+84912860330",
      "caller": "+6582674904",
      "properties": {
        "name": "Alex",
        "dueDate": "August 20th, 2020",
        "amount": "200,000$"
      }
    }
  ],
  "enableCallRecording": true,
  "callFlow": {
    "steps": [
      {
        "name": "play",
        "message": {
          "msg": "thanks {{name}}",
          "lang": "en",
          "gender": "male"
        }
      },
      {
        "name": "gather",
        "message": {
          "msg": "Dear Mr {{name}}, the amount of {{amount}} will be due on {{dueDate}}"
        },
        "branches": [
          {
            "digit": "1",
            "default": "false",
            "callFlow": {
              "steps": [
                {
                  "name": "gather",
                  "message": {
                    "msg": "message need to play",
                    "lang": "en",
                    "gender": "female"
                  },
                  "branches": [
                    {
                      "default": "true",
                      "callFlow": {
                        "steps": [
                          {
                            "name": "play",
                            "message": {
                              "msg": "msg need to play"
                            }
                          }
                        ]
                      }
                    }
                  ]
                }
              ]
            }
          },
          {
            "digit": "0",
            "default": "true",
            "callFlow": {
              "steps": [
                {
                  "name": "transfer",
                  "destination": "Ext:1000"
                }
              ]
            }
          }
        ]
      }
    ]
  }}

Response result

Example of successful result

{
  "requestId": "string",
  "status": "submitted",
  "details": [
    {
      "requestId": "string",
      "caller": "string",
      "destination": "string",
      "status": "onProgress",
      "callFlowSteps": [
        {
          "stepName": "string",
          "info": {
            "call_state": "ongoing",
            "call_status": "answered",
            "status": "sucess_ok error_concurrent_call_limit_reache",
            "userPressedDigits": "string",
            "transfer_status": "answered"
          }
        }
      ],
      "monitorData": [
        {
          "uuid": "string",
          "type": "string",
          "dest": "+6591991191 1000"
        }
      ]
    }
  ]}

Example of bad result

{
  "status": "string",
  "message": "string"}

Call detail parameters