SMS Detail

Get detail of an SMS request

How to get SMS request detail

There are two ways to retrieve the detail of a SMS request:

Single SMS: if the single sms API is used then the response contains a requestId from which the request detail can be retrieved using the Single SMS Request API

Batch SMS: if the batch sms api is used(batch and p2p) then the response contains a batchId from which the request detail can be retrieved using Batch SMS Detail API

Single SMS detail by requestId

GET https://api.bitel.rest/api/v1/sms/detail/single/:requestId

Path Parameters

Name	Type	Description
requestId	string	requestId retrieved from single sms request

200

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

404

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

Batch SMS detail by batchId

GET https://api.bitel.rest/api/v1/sms/detail/batch/:batchId

Path Parameters

Name	Type	Description
batchId	string	batchId retrieved from batch / p2p sms request

200

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

404

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

Detail Description

Key	Type	Description
Id	string	request identifier
text	string	text of message
phoneNumber	string	phone number the message was sent to
requestDate	int64	date the request was created in epoch format
deliveryStatus	string	delivery status of the request(refer to table DeliveryStatus)
deliveryStatusCode	int	same as delivery status, but returns status numeric code instead of string(refer to table DeliveryStatus)
smsCount	int	how many part the message comprise
balanceSubtracted	float(double)	the cost of request in Toman

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
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