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

Метод: 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=READ&channel=CHAT

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

Параметр	Обязательно	Значение по умолчанию	Описание
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 SKIPPED DELIVERED UNDELIVERED CANCELED ERROR PAUSED READ
channel	Нет	Отсутствует	Фильтр по каналу отправки. Например, CHAT

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

{
    "count": 2,
    "items": [
        {
            "id": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
            "bulkId": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
            "groupId": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
            "flowId": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
            "taskId": null,
            "status": "READ",
            "statusRu": "Сообщение прочитано.",
            "statusEn": null,
            "statusCode": 11,
            "companyId": 1,
            "companyName": "Компания",
            "channel": "CHAT",
            "destination": "74992868344",
            "from": null,
            "text": null,
            "price": "0.000000",
            "network": null,
            "mccMnc": null,
            "templateId": null,
            "templateName": null,
            "variables": "null",
            "partCount": 1,
            "tracks": [],
            "read": null,
            "createdAt": "2023-10-31T04:00:33.135139Z",
            "sentAt": "2023-10-31T04:01:55.587763Z",
            "deliveredAt": "2023-10-31T04:02:02.873465Z",
            "sendAt": "2023-10-31T04:00:33.135139Z",
            "expiredAt": null,
            "billedAt": "2023-10-31T04:02:02.876837Z",
            "providerMessageId": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
            "resellerPrice": "0.000000",
            "resellerCompanyId": 1,
            "resellerCompanyName": "1 | Компания"
        },
        {
            "id": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
            "bulkId": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
            "groupId": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
            "flowId": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
            "taskId": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
            "status": "READ",
            "statusRu": "Сообщение прочитано.",
            "statusEn": null,
            "statusCode": 11,
            "companyId": 1,
            "companyName": "Компания",
            "channel": "CHAT",
            "destination": "74992868344",
            "from": null,
            "text": null,
            "price": "0.000000",
            "network": null,
            "mccMnc": null,
            "templateId": null,
            "templateName": null,
            "variables": "{\"phoneNo\": 74992868344, \"fullName\": \"Иванов Иван Иванович\"}",
            "partCount": 1,
            "tracks": [],
            "read": null,
            "createdAt": "2023-10-31T06:49:45.337901Z",
            "sentAt": "2023-10-31T06:49:49.642247Z",
            "deliveredAt": "2023-10-31T06:49:55.432778Z",
            "sendAt": "2023-10-31T06:49:45.337901Z",
            "expiredAt": null,
            "billedAt": "2023-10-31T06:49:55.439442Z",
            "providerMessageId": "bce7d22e-dde6-4427-b391-ebbdfda44de6",
            "resellerPrice": "0.000000",
            "resellerCompanyId": 1,
            "resellerCompanyName": "1 | Компания"
        }
    ]
}

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

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

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

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