# Получение рассылок
## Получение рассылок
`GET` `https://direct.i-dgtl.ru/api/v1/dispatch`
Метод позволяет получить массив рассылок, подходящих под условия параметров.
#### Query Parameters
| Name | Type | Description |
| ------------------- | ------- | ---------------------------------------------------------------------------------------- |
| created\_from | string | Минимальная дата создания рассылки в формате
yyyy-mm-ddThh:MM:ssZ
|
| created\_to | string | Максимальная дата создания рассылки |
| status | string | Статус рассылки |
| dispatch\_id | integer | Идентификатор рассылки |
| dispatch\_name | string | Название рассылки |
| traffic\_center\_id | integer | Идентификатор ЦРТ |
#### Headers
| Name | Type | Description |
| ----------------------------------------------- | ------ | ----------------- |
| Authorization\* | string | `Basic {TOKEN_1}` |
::::::{tab-set}
:::::{tab-item} 200
```
{
"total": 1,
"items": [
{
"dispatchId": 1234,
"dispatchName": "имя рассылки",
"created": "2020-07-07T20:00:00Z",
"localSendTime": "2020-07-08 10:00:00",
"localCompletionTime": "2020-07-08 20:00:00",
"useLocalTime": true,
"status": "sending",
"source": "sendername",
"message": "текст сообщения",
"trafficCenterId": 12,
"trafficCenterName": "ЦРТ для рассылок",
"base": {
"included": {
"type": "FILE",
"name": "имя_файла.xlsx"
},
"excluded": {
"type": "FILE",
"name": "исключаемые_абоненты.xlsx"
}
},
"parts": {
"total": 1235,
"delivered": 1000,
"undelivered": 100,
"unsent": 30,
"sent": 45,
"sending": 60
},
"messages": {
"total": 1235,
"delivered": 1000,
"undelivered": 100,
"unsent": 30,
"sent": 45,
"sending": 60
}
}
]
}
```
:::::
:::::{tab-item} 401
Использование невалидного токена.
::::{tab-set}
:::{tab-item} 4012
```
{
"error": {
"code": 4012,
"msg": "Bad credentials"
}
}
```
:::
:::{tab-item} 4010
```
{
"error": {
"code": 4010,
"msg": "Not Authenticated"
}
}
```
:::
::::
:::::
:::::{tab-item} 403
Использование неподходящего токена.
```
{
"error": {
"code": 4030,
"msg": "Access Denied"
}
}
```
:::::
::::::
Возможные варианты перечислений:
| Параметр | Варианты |
| -------- | -------------------------------------------------------- |
| status | [Статусы рассылок](../extra/references/#dispatch-states) |
## Параметры объекта ответа
| Параметр | Тип | Описание |
| -------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| total | integer | Количество найденных рассылок |
| items | array | Массив найденных рассылок |
| items.dispatchId | integer | Идентификатор рассылки |
| items.dispatchName | string | Название рассылки |
| items.created | string | Дата создания рассылки |
| items.localSendTime | string | Дата начала рассылки |
| items.localCompletionTime | string | Дата завершения рассылки |
| items.useLocalTime | boolean | Учитывается ли местное время получателей |
| items.status | string | [Статус рассылки](../extra/references/#dispatch-states) |
| items.source | string | Имя отправителя |
| items.message | string | Текст сообщения |
| items.trafficCenterId | integer | Идентификатор ЦРТ |
| items.trafficCenterName | string | Название ЦРТ |
| items.base | object | Информация об источнике получателей |
| items.base.included | object | Включенные получатели |
| items.base.included.type | string | Тип источника получателей
MANUAL – ввод вручную
FILE –импорт из файла
API- создание через API
|
| items.base.included.name | string | Имя файла |
| items.base.excluded | object | Исключенные получатели |
| items.base.excluded.type | string | Тип источника исключаемых получателей
MANUAL – ввод вручную
FILE –импорт из файла
|
| items.base.excluded.name | string | Имя файла |
| items.parts | object | Статистика по частям сообщений рассылки |
| items.parts.total | integer | Общее количество частей |
| items.parts.delivered | integer | Доставлено частей |
| items.parts.undelivered | integer | Не доставлено частей |
| items.parts.unsent | integer | Не отправлено частей |
| items.parts.sent | integer | Отправлено частей; в ожидании статуса |
| items.parts.sending | integer | Частей в ожидании отправки |
| items.messages | object | Статистика по сообщениям рассылки |
| items.messages.total | integer | Общее количество сообщений |
| items.messages.delivered | integer | Доставлено сообщений |
| items.messages.undelivered | integer | Не доставлено сообщений |
| items.messages.unsent | integer | Не отправлено сообщений |
| items.messages.sent | integer | Отправлено сообщений; в ожидании статуса |
| items.messages.sending | integer | Сообщений в ожидании отправки |