> For the complete documentation index, see [llms.txt](https://api.direct.revicom.ltd/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://api.direct.revicom.ltd/extra/references.md).

# References

## Traffic channels <a href="#channel-types" id="channel-types"></a>

| Channel   |
| --------- |
| SMS       |
| FLASHCALL |
| VIBER     |
| WHATSAPP  |
| VK        |

## Sending methods <a href="#sending-methods" id="sending-methods"></a>

| Sending method | Description                               |
| -------------- | ----------------------------------------- |
| API            | Message was sent via API Direct           |
| UI             | Message was sent via web-interface Direct |

## Message directions <a href="#directions" id="directions"></a>

| Direction | Description      |
| --------- | ---------------- |
| outbound  | Outbound message |
| inbound   | Inbound message  |

## Traffic types <a href="#traffic-types" id="traffic-types"></a>

| Traffic type | Description           |
| ------------ | --------------------- |
| PROMO        | Advertasing traffic   |
| SERVICE      | Service traffic       |
| AUTHORIZE    | Authorization traffic |
| TRANSACT     | Transaction traffic   |

## Main message statuses <a href="#message-states" id="message-states"></a>

| Message status | Description                     |
| -------------- | ------------------------------- |
| delivered      | Delivered (final status)        |
| undelivered    | Undelivered (final status)      |
| unsent         | Unsent (final status)           |
| sent           | Sent; awaiting the final status |
| sending        | Awaiting sending                |

## Read message statuses <a href="#message-read-states" id="message-read-states"></a>

| Message read status | Description                                                                                      |
| ------------------- | ------------------------------------------------------------------------------------------------ |
| read                | Read; available for channels: VIBER, VK, WHATSAPP                                                |
| unread              | Not read during the lifetime of the message (`ttl`); available for channels: VIBER, VK, WHATSAPP |

## Cascading conditions <a href="#cascade-conditions" id="cascade-conditions"></a>

| Condition      | Description                                                                                                          |
| -------------- | -------------------------------------------------------------------------------------------------------------------- |
| not\_delivered | The next cascading message is generated when this message does not receive the delivered status during its lifetime. |
| not\_read      | The next cascaded message is generated when this message has not received the read status during its lifetime.       |

## Callback events <a href="#callback-events" id="callback-events"></a>

| Callback event | Description                                                                                                      |
| -------------- | ---------------------------------------------------------------------------------------------------------------- |
| delivered      | <p>Message received one of the final statuses:</p><ul><li>delivered</li><li>undelivered</li><li>unsent</li></ul> |
| sent           | Message received the status sent                                                                                 |
| read           | <p>Message received one of the statuses:</p><ul><li>read</li><li>unread</li></ul>                                |
| price          | Changing of the message price                                                                                    |
| click          | Click through shortened link                                                                                     |

## FLASHCALL conversion result <a href="#flashcall-result" id="flashcall-result"></a>

| Conversion result | Description            |
| ----------------- | ---------------------- |
| NUMBER\_VERIFIED  | Code verified          |
| WRONG\_CODE       | Wrong code was entered |

## Dispatch statuses <a href="#dispatch-states" id="dispatch-states"></a>

| Status    | Description                                                            |
| --------- | ---------------------------------------------------------------------- |
| initiated | Dispatch is being generated                                            |
| changing  | Transitional status: dispatch is in the process of updating the status |
| scheduled | Dispatch is scheduled: start time has not come yet                     |
| sending   | Dispatch is being sent                                                 |
| awaiting  | All dispatch messages have been sent, awaiting statuses                |
| done      | All dispatch messages have been sent, statuses done *(final status)*   |
| paused    | Dispatch is paused                                                     |
| stopped   | Dispatching is stopped *(final status)*                                |

## Dispatch rate <a href="#dispatch_velocity" id="dispatch_velocity"></a>

| rateTerm value | Description                                                                                                                                 |
| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| d              | the number of messages sent per day, **taking into account the allowed sending hours**, is guaranteed not to exceed the `rate` value :star: |
| h              | the number of messages sent per hour is guaranteed not to exceed the `rate` value                                                           |
| m              | the number of messages sent per minute is guaranteed not to exceed the `rate` value                                                         |

&#x20;:star: For example, when generating a dispatch with the parameters:

```
"rate": 100000,
"rateTerm": "d",
"hours": [10, 11, 12, 13, 14]
```

&#x20;the number of the `rate` messages will be sent within the five allowable sending `hours`. Thus, the maximum allowable dispatch rate will be 20,000 messages per hour.

However, if `hours` are specified: `[10, 11]`, then the maximum allowed dispatch rate will be 50,000 messages per hour.

:warning:The hours value will not be taken into account if `"rateTerm": "h"` or `"rateTerm": "m"` are specified