Batch Call

Play one voice for multiple(up to 100) phone numbers

POST https://api.bitel.rest/api/v2/voice/batch

Request Body

Name
Type
Description

phoneNumbers

string

target phone number. example: 0912*******

voiceId

string

the identifier of the voice(refer to Upload File Page)

retryCount

number

how many times the call is retried if the number if either busy or doesn't answer(default = 1)

serverId

string

Identifier of dialer from which the voice will be originated

{
  "result": [
    {
      "id": "755021ff3bfd4669af3145b285297756",
      "phoneNumber": "0912*******",
      "status": "WAITING",
      "statusCode": 0,
      "billSec": 0,
      "requestDate": 1564643999,
      "executionDate": 0,
      "price": 0.0
    },
    {
      "id": "b694d5431c654c4082aa4a2de82ee5f2",
      "phoneNumber": "0912*******",
      "status": "WAITING",
      "statusCode": 0,
      "billSec": 0,
      "requestDate": 1564643999,
      "executionDate": 0,
      "price": 0.0
    }
  ],
  "error": null
}

Sample Request

{
  "phoneNumbers": [
    "0912*******"
  ],
  "voiceId": "08e815cbcd724386805103ac0d45e4c2",
  "retryCount": 3
}

Sample Response

{
  "result": [
    {
      "id": "755021ff3bfd4669af3145b285297756",
      "phoneNumber": "0912*******",
      "status": "WAITING",
      "statusCode": 0,
      "billSec": 0,
      "requestDate": 1564643999,
      "executionDate": 0,
      "price": 0.0
    },
    {
      "id": "b694d5431c654c4082aa4a2de82ee5f2",
      "phoneNumber": "0912*******",
      "status": "WAITING",
      "statusCode": 0,
      "billSec": 0,
      "requestDate": 1564643999,
      "executionDate": 0,
      "price": 0.0
    }
  ],
  "error": null
}

To understand the definition of the response, refer to Call Status

Make sure to store the "id" of the response in order to get the call status

Error Codes

Code

Description

InvalidRequest

Indicates that the submitted request is invalid

InvalidServer

Indicates that the selected server id is invalid

Make sure to store the campaignId returned from the response

Last updated