Метод: GET

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

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

https://twin24.ai/analyse/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=%2274992868344%22&bulkId=bce7d22e-dde6-4427-b391-ebbdfda44de6&groupId=bce7d22e-dde6-4427-b391-ebbdfda44de6&flowId=bce7d22e-dde6-4427-b391-ebbdfda44de6&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

Для точного поиска нужно указывать в кавычках

Обязательно url-encoded

bulkId

НетОтсутствуетФильтр по bulkId

groupId

НетОтсутствуетФильтр по groupId

flowId

НетОтсутствуетФильтр по flowId

status

НетОтсутствует

Фильтр по статусу сообщения. 

Возможные статусы:

  • CREATED - Сообщение успешно обработано, но ещё не отправлено.
  • SENT - Сообщение успешно отправлено оператору.
  • PENDING - Сообщение успешно отправлено получателю, но отчёт о доставке ещё не получен.
  • DELAYED - Сообщение успешно обработано, но его отправка отложена.
  • QUEUED - Сообщение успешно обработано и поставлено в очередь (flow) на отправку в качестве резервного варианта.
  • SKIPPED - Сообщение имело статус QUEUED и было отменено из-за успешной доставки предыдущего сообщения очереди (flow).
  • DELIVERED - Сообщение успешно доставлено получателю.
  • UNDELIVERED - Сообщение успешно отправлено, но не было доставлено получателю.
  • CANCELED - Отправка сообщения отменена по запросу клиента.
  • ERROR - При отправке сообщения возникла непредвиденная ошибка.
  • PAUSED - Отправка сообщения приостановлена.
  • READ - Сообщение прочитано.

channel

НетОтсутствует

Фильтр по каналу отправки. 

Например, CHAT

output

НетОтсутствует

Используется для получения данных в виде файла, а не в JSON теле ответа. 

Возможные значения:

  • CSV
  • EXCEL

filename

НетОтсутствует

Имя файла без расширения.

Актуально только при использовании output

archive

НетОтсутствует

Возвращать ли файл в архиве. 

true/false

Актуально только при использовании output


{
    "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 - Сообщение успешно обработано и поставлено в очередь (flow) на отправку в качестве резервного варианта.
  • SKIPPED - Сообщение имело статус QUEUED и было отменено из-за успешной доставки предыдущего сообщения очереди (flow).
  • DELIVERED - Сообщение успешно доставлено получателю.
  • UNDELIVERED - Сообщение успешно отправлено, но не было доставлено получателю.
  • CANCELED - Отправка сообщения отменена по запросу клиента.
  • ERROR - При отправке сообщения возникла непредвиденная ошибка.
  • PAUSED - Отправка сообщения приостановлена.
  • READ - Сообщение прочитано.

|    statusRu

StringСтатус сообщения в человеко читаемом формате на русском языке

|    statusEn

StringСтатус сообщения в человеко читаемом формате на английском языке

|    statusCode

IntКод статуса

|    companyId

IntИдентификатор компании, отправившей сообщение

|    companyName

StringИмя компании, отправившей сообщение

|    channel

StringКанал отправки сообщения

|    destination

String

Идентификатор клиента в мессенджере

|    from

String

Отправитель сообщения

|    text

StringТекст сообщения

|    price

StringЦена за сообщение

|    network

StringЗначение network

|    mccMnc

StringЗначение mccMnc

|    templateId

StringИдентификатор шаблона для отправки

|    templateName

StringИмя шаблона для отправки

|    variables

StringСписок переменных, приложенных к отправке

|    partCount

IntКоличество частей сообщения

|    tracks

ArrayЧасти сообщения

|    read

StringПрочитано ли сообщение

|    createdAt

StringДата создания сообщения

|    sentAt

StringДата отправки сообщения

|    deliveredAt

StringДата доставки сообщения

|    sendAt

StringДата попадания сообщения в очередь отправки

|    expiredAt

StringДата истечения срока доставки сообщения

|    billedAt

StringДата билинга за сообщение

|    providerMessageId

StringИдентификатор сообщения у провайдера (для CHAT – идентификатор сессии в twin)

|    resellerPrice

StringСтоимость сообщения у ресселлера 

|    resellerCompanyId

IntИдентификатор компании ресселлера

|    resellerCompanyName

StringИмя компании ресселлера