1MSG
ReferenceInbox API

Сообщения диалога

GET
/api/v1/inbox/conversations/{conversationId}/messages

Сначала самые новые. Если не передавать kind или передать kind=all, вместе с сообщениями придут события SYSTEM (статус, ответственный, блокировка, название). kind=messages скрывает события SYSTEM. kind=system возвращает только их. Заметки идут вместе с сообщениями. Чтобы загрузить более старые записи того же kind, передайте nextCursor в cursor.

Authorization

bearer
headerAuthorizationBearer <token>

Ключ выдаётся в Settings → Developer → API key. Методам Inbox нужен доступ Inbox, методам Campaigns — доступ Campaigns.

Path Parameters

conversationId*string

id диалога

Query Parameters

limit?number

Размер страницы. По умолчанию 50.

cursor?string

nextCursor из предыдущей страницы (createdAt в ISO). Возвращает записи старше этого момента, с тем же фильтром kind.

kind?string

all (по умолчанию, если не передан): все записи. messages: всё, кроме SYSTEM. system: только SYSTEM.

Value in"all""messages""system"

Response Body

application/json
  1. response
messages*array<>

Сначала самые новые. Включая события SYSTEM.

nextCursor?|

Передайте обратно в cursor, чтобы загрузить более старые сообщения. null на последней странице.

Formatdate-time
hasMore*boolean
curl -X GET 'https://api.1msg.io/api/v1/inbox/conversations/string/messages'
{  "messages": [    {      "id": "string",      "conversationId": "string",      "channelId": "string",      "direction": "INBOUND",      "type": "TEXT",      "content": "string",      "mediaUrl": "string",      "mediaType": "string",      "fileName": "string",      "fileSize": 0,      "mediaDuration": 0,      "thumbnailUrl": "string",      "templateName": "string",      "templateLanguage": "string",      "status": "PENDING",      "externalId": "string",      "sentAt": "2019-08-24T14:15:22Z",      "deliveredAt": "2019-08-24T14:15:22Z",      "readAt": "2019-08-24T14:15:22Z",      "createdAt": "2019-08-24T14:15:22Z",      "systemEventSource": "string",      "systemEventOperatorName": "string",      "systemEventOperatorEmail": "string",      "assignmentEvent": {        "kind": "assign",        "actor": {          "id": "b2bb82f0-2253-4e05-b955-a21f3d699caa",          "name": "QA Stage",          "avatar": null        },        "target": {          "id": "b2bb82f0-2253-4e05-b955-a21f3d699caa",          "name": "QA Stage",          "avatar": null        }      },      "author": {        "id": "b2bb82f0-2253-4e05-b955-a21f3d699caa",        "name": "QA Stage",        "avatar": null      },      "quotedMessage": {        "id": "string",        "content": "string",        "type": "string",        "direction": "INBOUND",        "contactName": "string",        "contactPhone": "string",        "mediaUrl": "string",        "fileName": "string"      },      "latitude": 0,      "longitude": 0    }  ],  "nextCursor": "2019-08-24T14:15:22Z",  "hasMore": true}