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 Array Direction направление сообщения
billing_status Array BillingStatus статус оплаты сообщения
delivery_status Array DeliveryStatus статус доставки сообщения
status Array Status статус сообщения (объединяет в себе доставку и оплату)
date_gte string дата последнего изменения статуса сообщения в формате RFC-3339 / ISO-8601, с которой начинать выборку сообщений
date_lte string дата последнего изменения статуса сообщения в формате RFC-3339 / ISO-8601, до которой продолжать выборку сообщений
date_sent_received_gte string дата отправки исходящего/получения входящего сообщения в формате RFC-3339 / ISO-8601, с которой начинать выборку сообщений
date_sent_received_lte string дата отправки исходящего/получения входящего сообщения в формате RFC-3339 / ISO-8601, до которой продолжать выборку сообщений
receiver string номер получателя
sender string номер отправителя / имя отправителя
receiver_mcc string MCC-код оператора получателя, формат: 250
receiver_mnc string MNC-код оператора получателя, формат: 42
receiver_mobile_operator string оператор получателя, формат: MTT
category Array CategoryType категория сообщения, подробнее

Direction

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

BillingStatus

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

DeliveryStatus

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

Status

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

CategoryType

Параметр Тип Описание
0 enum категория не указана
1 enum сообщение с мобильного номера
2 enum рекламное сообщение от имени отправителя
3 enum авторизационное сообщение от имени отправителя
4 enum сервисное сообщение от имени отправителя
5 enum транзакционное сообщение от имени отправителя

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

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

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

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

Примеры

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

{
    "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",
    "date_sent_received_gte":"2023-01-20T11:30:01.335Z",
    "date_sent_received_lte":"2023-01-20T11:39:01.335Z"
}

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

{
    "count": "1"
}

Содержание статьи