Call Status

Retrieve detail of single or batch call

To get the status of a call including the execution date, status, price and more, you need to store the "id" of the request that is returned in the response of call APIs.

Call Status

GET https://api.bitel.rest/api/v2/voice/status/:requestId

Path Parameters

Name	Type	Description
requestId	string	id returned in the response of call APIs

200

{
    "id": "755021ff3bfd4669af3145b285297756",
    "phoneNumber": "0912*******",
    "status": "NORMAL",
    "statusCode": 1,
    "billSec": 12,
    "requestDate": 1564643999,
    "executionDate": 1564645842,
    "price": -34.2
}

404

{
  "result": null
  "error": "NotFound"
}

{
    "id": "755021ff3bfd4669af3145b285297756",
    "phoneNumber": "0912*******",
    "status": "NORMAL",
    "statusCode": 1,
    "billSec": 12,
    "requestDate": 1564643999,
    "executionDate": 1564645842,
    "price": -34.2
}

Detail Description

Key	Type	Description
id	string	request identifier
phoneNumber	string	phone number that was called
status	string	call status (see Call Status table)
statusCode	int	integer representation of status(see Call Status table)
requestDate	int64	date the request was created in epoch format
executionDate	int64	date the request was executed in epoch format
billSec	string	duration of the call in seconds
price	float(double)	the cost of request in Toman

Call Status

Status	Status Code	Description
WAITING	0	the call request has been queued
NORMAL	1	the call has finished normally
NO_ANSWER	2	the user didn't pick up the phone
USER_BUSY	3	the phone number was busy
EXPIRED	10	the request has expired, most likely due to high server loads
ERROR	11	an error has occurred while making the call
UNKNOWN	20	oops, something went wrong