> For the complete documentation index, see [llms.txt](https://bitel.gitbook.io/bitel/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://bitel.gitbook.io/bitel/sms/sms-detail.md).

# 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

<mark style="color:blue;">`GET`</mark> `https://api.bitel.rest/api/v2/sms/status/:requestId`

#### Path Parameters

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

{% tabs %}
{% tab title="200 " %}

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

{% endtab %}

{% tab title="404 " %}

```javascript
{
  "result": null
  "error": "NotFound"

```

{% endtab %}
{% endtabs %}

## 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](/bitel/sms/sms-detail.md#delivery-status-table))                  |
| status      | string        | delivery status of the request in string format(refer to table [DeliveryStatus](/bitel/sms/sms-detail.md#delivery-status-table)) |
| 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                                |