[SMS] Получение статистики по рассылке

Метод: GET

Authorization: Bearer Token (Метод для получения токена по логину и паролю)

URL: https://analyse.twin24.ai/api/v1/search/messaging/messages

Пример запроса

https://analyse.twin24.ai/api/v1/search/messaging/messages?limit=1000&page=0&from=2023-10-31T00%3A00%3A00%2B00%3A00&to=2023-11-01T00%3A00%3A00%2B00%3A00&sort=+createdAt&companyId=1&keyword=74992868344&bulkId=e27ebd69-046f-42fc-98e0-9df074dbd12d&groupId=e9319d2a-866f-41a4-bca6-b170a2e4eeb4&flowId=6e0fef0e-2349-400b-91e5-c636a8925718&status=DELIVERED&channel=SMS

Описание параметров метода:

Параметр	Обязательно	Значение по умолчанию	Описание
limit	Нет	10	Количество элементов в ответе (максимум 1000)
page	Нет	0	Номер "страницы" с элементами (начиная с 0). Например, если в limit указано 1000, а всего элементов 1500, то первая 1000 будет в ответе при page = 0, а остальные 500 при page =1
from	Да	Отсутствует	Дата начала промежутка поиска. Задается в формате: 2023-10-31T00:00:00+00:00 ГГГГ-ММ-ДДTчч:мм:сс+чч:мм Обязательно url-encoded
to	Да	Отсутствует	Дата окончания промежутка поиска. Задается в формате: 2023-10-31T00:00:00+00:00 ГГГГ-ММ-ДДTчч:мм:сс+чч:мм Обязательно url-encoded
sort	Нет	+createdAt	Способ сортировки. Задается в формате: +(по возрастанию)/-(по убыванию)название поля сортировки (см пример в значении по умолчанию) Возможные поля для сортировки: createdAt, sentAt, deliveredAt, sendAt, expiredAt, billedAt
companyId	Нет	Отсутствует	Фильтр по идентификатору компании
keyword	Нет	Отсутствует	Фильтр по значению в любом из полей: message body, messageId, bulkId, groupId, flowId, taskId, templateId, status, statusCode, channel, destination, from, text, network, mccMnc, templateName
bulkId	Нет	Отсутствует	Фильтр по bulkId
groupId	Нет	Отсутствует	Фильтр по groupId
flowId	Нет	Отсутствует	Фильтр по flowId
status	Нет	Отсутствует	Фильтр по статусу сообщения. Возможные статусы: CREATED - Сообщение успешно обработано, но ещё не отправлено. SENT - Сообщение успешно отправлено оператору. PENDING - Сообщение успешно отправлено получателю, но отчёт о доставке ещё не получен. DELAYED - Сообщение успешно обработано, но его отправка отложена. QUEUED - Сообщение успешно обработано и поставлено в очередь (flow) на отправку в качестве резервного варианта. SKIPPED - Сообщение имело статус QUEUED и было отменено из-за успешной доставки предыдущего сообщения очереди (flow). DELIVERED - Сообщение успешно доставлено получателю. UNDELIVERED - Сообщение успешно отправлено, но не было доставлено получателю. CANCELED - Отправка сообщения отменена по запросу клиента. ERROR - При отправке сообщения возникла непредвиденная ошибка. PAUSED - Отправка сообщения приостановлена. READ - Сообщение прочитано. EXPIRED - Сообщение получено и отправлено оператору, но его срок действия истёк.
channel	Нет	Отсутствует	Фильтр по каналу отправки. Для SMS всегда SMS

Ответ в формате JSON

{
    "count": 1,
    "items": [
        {
            "id": "4c627c56-76fd-468b-8f20-4c3803e7888a",
            "bulkId": "b015c5b2-5b70-4181-a257-d5eb98693705",
            "groupId": "00d8cb91-b396-47d6-85f3-f97738d0fb06",
            "flowId": "dc968534-12ab-4092-af19-5c3c5dc00512",
            "taskId": null,
            "status": "DELIVERED",
            "statusRu": "Сообщение успешно доставлено получателю.",
            "statusEn": null,
            "statusCode": 6,
            "companyId": 1,
            "companyName": "Компания",
            "channel": "SMS",
            "destination": "74992868344",
            "from": "TwinService",
            "text": "Привет, Иван! Поздравляю с Днем Рождения! 23 - это крутой возраст!",
            "price": "2.500000",
            "network": null,
            "mccMnc": null,
            "templateId": null,
            "templateName": null,
            "variables": "{\"age\": \"23\", \"name\": \"Иван\"}",
            "partCount": 1,
            "tracks": [],
            "read": null,
            "createdAt": "2023-12-08T04:51:53.899209Z",
            "sentAt": "2023-12-08T04:51:54.498237Z",
            "deliveredAt": "2023-12-08T04:51:58.836160Z",
            "sendAt": "2023-12-06T04:05:00.000000Z",
            "expiredAt": "2023-12-08T02:51:54.498237Z",
            "billedAt": "2023-12-08T04:51:58.891626Z",
            "providerMessageId": null,
            "resellerPrice": "0.000000",
            "resellerCompanyId": null,
            "resellerCompanyName": null
        }
    ]
}

Описание полей ответа:

Поле	Тип	Описание
count	Int	Общее количество найденных элементов
items	Array[Object]	Массив найденных элементов
\| id	String	Идентификатор сообщения
\| bulkId	String	Идентификатор рассылки
\| groupId	String	Внутренний идентификатора
\| flowId	String	Внутренний идентификатора
\| taskId	String	Идентификатор задания на отправку (при отправке из личного кабинета)
\| status	String	Статус сообщения Возможные статусы: CREATED - Сообщение успешно обработано, но ещё не отправлено. SENT - Сообщение успешно отправлено оператору. PENDING - Сообщение успешно отправлено получателю, но отчёт о доставке ещё не получен. DELAYED - Сообщение успешно обработано, но его отправка отложена. QUEUED - Сообщение успешно обработано и поставлено в очередь (flow) на отправку в качестве резервного варианта. SKIPPED - Сообщение имело статус QUEUED и было отменено из-за успешной доставки предыдущего сообщения очереди (flow). DELIVERED - Сообщение успешно доставлено получателю. UNDELIVERED - Сообщение успешно отправлено, но не было доставлено получателю. CANCELED - Отправка сообщения отменена по запросу клиента. ERROR - При отправке сообщения возникла непредвиденная ошибка. PAUSED - Отправка сообщения приостановлена. READ - Сообщение прочитано. EXPIRED - Сообщение получено и отправлено оператору, но его срок действия истёк.
\| statusRu	String	Статус сообщения в человеко читаемом формате на русском языке
\| statusEn	String	Статус сообщения в человеко читаемом формате на английском языке
\| statusCode	Int	Код статуса
\| companyId	Int	Идентификатор компании, отправившей сообщение
\| companyName	String	Имя компании, отправившей сообщение
\| channel	String	Канал отправки сообщения
\| destination	String	Номер телефона клиента, которому было отправлено сообщение
\| from	String	Имя отправителя. Подробнее о регистрации имени отправителя в отдельной статье
\| text	String	Текст сообщения
\| price	String	Цена за сообщение
\| network	String	Не актуально для канала SMS
\| mccMnc	String	Не актуально для канала SMS
\| templateId	String	Идентификатор шаблона для отправки
\| templateName	String	Имя шаблона для отправки
\| variables	String	Список переменных, приложенных к отправке
\| partCount	Int	Количество частей, на которое было разбито сообщение (> 1, если длинна выше разрешенной)
\| tracks	Array	Не актуально для канала SMS
\| read	String	Не актуально для канала SMS
\| createdAt	String	Дата создания сообщения
\| sentAt	String	Дата отправки сообщения
\| deliveredAt	String	Дата доставки сообщения
\| sendAt	String	Дата попадания сообщения в очередь отправки
\| expiredAt	String	Дата истечения срока доставки сообщения
\| billedAt	String	Дата билинга за сообщение
\| providerMessageId	String	Не актуально для канала SMS
\| resellerPrice	String	Стоимость сообщения у ресселлера
\| resellerCompanyId	Int	Идентификатор компании ресселлера
\| resellerCompanyName	String	Имя компании ресселлера

Быстрые ссылки

Дерево страниц