OTP Call

Send a numeric OTP to a single phone number

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

Request Body

Name	Type	Description
voiceId	string	Id of the voice that is played before reading the number
phoneNumber	string	target phone number. example: 0912*******
text	string	the number to read, must be only numeric and less than 6 characters. example: 1234
repeatCount	string	how many times the number is played(default = 2)
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

200

{
  "result": {
    "id": "69b9e312e3b64b3880760639f5dfdffa",
    "phoneNumber": "0912*******",
    "status": "WAITING",
    "statusCode": 0,
    "billSec": 0,
    "requestDate": 1564640750,
    "executionDate": 0,
    "price": 0.0
  },
  "error": null
}

Sample Request

{
    "phoneNumber": "0912*******",
    "text": "1234"
}

Sample Response

{
  "result": {
    "id": "69b9e312e3b64b3880760639f5dfdffa",
    "phoneNumber": "0912*******",
    "status": "WAITING",
    "statusCode": 0,
    "billSec": 0,
    "requestDate": 1564640750,
    "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