GetCount

Метод GetCount

Примените этот метод для получения числа SMS-сообщений по заданным параметрам. Для этого выполните POST-запрос с входными параметрами к точке подключения, указанными ниже.

Точка подключения:

POST: https://api.exolve.ru/messaging/v1/GetCount

Авторизация

Передайте следующие Заголовки HTTP для успешной авторизации.

Имя	Тип	Описание
Authorization	string	API-ключ приложения с `Bearer` перед ним. Пример: `Bearer e*s0`, где `e*s0` замените на API-ключ вашего приложения

Входные параметры

Передайте следующие параметры в теле запроса в JSON-формате. Можно передать пустой запрос — тогда вы получите число всех SMS этого приложения без применения фильтров поиска.

Параметр	Тип	Описание
message_id	string	уникальный идентификатор сообщения (указывается, если нужна информация по одному сообщению)
limit	uint32	лимит выводимых строк
offset	uint64	номер строки, с которой начинать выборку (начинается с 0)
number	string	номер телефона / имя отправителя (альфа-имя)
direction	enum Direction	направление сообщения
delivery_status	enum DeliveryStatus	статус доставки сообщения
billing_status	enum BillingStatus	статус оплаты сообщения
status	enum Status	(объединяет в себе доставку и оплату)
date_gte	string	дата в формате RFC-3339 / ISO-8601, с которой начинать выборку сообщений
date_lte	string	дата в формате RFC-3339 / ISO-8601, до которой продолжать выборку сообщений

Direction

Параметр	Тип	Описание
1	string	входящее сообщение
2	string	исходящее сообщение

DeliveryStatus

Параметр	Тип	Описание
1	string	сообщение поставлено в очередь на отправку
2	string	сообщение доставлено в SMS-центр
3	string	сообщение доставлено получателю
4	string	сообщение не может быть доставлено получателю
5	string	ошибка — закончились попытки переотправки сообщения
6	string	приём и отправка сообщений заблокированы

BillingStatus

Параметр	Тип	Описание
1	string	сообщение поставлено в очередь на обработку и оплату
2	string	сообщение оплачено
4	string	недостаточно средств на балансе для отправки сообщения
6	string	ошибка оплаты сообщения
7	string	плата за сообщение зарезервирована
8	string	ошибка — закончились попытки оплаты сообщения

Status

Параметр	Тип	Описание
1	string	сообщение в очереди на отправку
2	string	сообщение отправлено
3	string	сообщение доставлено
4	string	не удалось отправить сообщение
5	string	недостаточно средств на балансе для отправки сообщения
6	string	прием и отправка сообщений заблокированы

Выходные параметры

Параметр	Тип	Описание
count	int64	количество сообщений

Возможные ошибки

Код	Статус	Пример сообщения	Описание
404	Not Found	page not found	некорректно введен URL-адрес запроса
401	Unauthorized	authorization token is invalid	неправильно указан токен (API-ключ приложения)
400	Bad Request	unknown field	невалидный параметр
400	Bad Request	syntax error	синтаксическая ошибка
400	Bad Request	invalid value	невалидное значение в параметре

Примеры

Входные параметры:

{
    "message_id": "444067567615608452",
    "limit": "10000",
    "offset": "0",
    "number": "79678880033",
    "direction": "2",
    "delivery_status": "3",
    "billing_status": "2",
    "status":"3",
    "date_gte":"2023-01-20T11:30:01.335Z",
    "date_lte":"2023-01-20T11:39:01.335Z"
}

Выходные параметры:

{
    "count": "1"
}