SMS Status

Get detail of an SMS request

To get the detail of a SMS request including the price, status and more you need to keep the "id" of the request that is returned in SMS APIs.

SMS Status

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

Path Parameters

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

200

{
  "result": {
    "id": "7123c2cec14c43ac944553f15f3aab18",
    "message": "Hi there",
    "phoneNumber": "0912*******",
    "requestDate": 1542434545,
    "result": "ok",
    "smsCount": 1,
    "balanceSubtracted": 100
  },
  "error": null
}

404

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

Response Description

Key	Type	Description
Id	string	request identifier
message	string	text of message
phoneNumber	string	phone number the message was sent to
requestDate	int64	date the request was created in epoch format
statusCode	int	delivery status of the request(refer to table DeliveryStatus)
status	string	delivery status of the request in string format(refer to table DeliveryStatus)
smsCount	int	how many part the message comprise
price	float(double)	the cost of request in Toman, example -14.0

Delivery Status Table

String Code	Numeric Code	Description
WAITING	0	The message is in process of being sent
DELIVERED	1	The message was successfully delivered
CHECK_OK	2	The message has beed handed to operator
DELIVERY_FAILED	4	The message was sent to operator but the user was probably unreachable
BLACKLIST	5	The message was not sent, because the user has blocked this number
ERROR	9	The message was not sent, due to an error(invalid phone number or connectivity error, etc.)
CHECK_ERROR	10	The message was not sent, because operator denied the access