1MSG
ReferenceInbox API

List conversations

GET
/api/v1/inbox/conversations

Newest lastMessageAt first. Pass pagination.nextCursor as cursor for the next page.

Authorization

bearer
headerAuthorizationBearer <token>

Key issued in Settings → Developer → API key. Inbox methods need the Inbox scope. Campaigns methods need the Campaigns scope.

Query Parameters

limit?number

Page size. Default 50.

cursor?string

pagination.nextCursor from the previous page (ISO lastMessageAt).

channelId?string

Limit to one channel.

status?string

Conversation status.

Value in"OPEN""CLOSED"
unread?boolean

true keeps only conversations with unread messages.

tab?string

mine_open: open and assigned to this key. unassigned: open and nobody assigned. all: no extra tab filter.

Value in"mine_open""unassigned""all"
assigneeId?string

Only conversations assigned to this user id.

Response Body

application/json
  1. response
data*array<>
pagination*
curl -X GET 'https://api.1msg.io/api/v1/inbox/conversations'
{  "data": [    {      "id": "string",      "channelId": "string",      "contactId": "string",      "status": "OPEN",      "assignedTo": "string",      "assignedUser": {        "id": "b2bb82f0-2253-4e05-b955-a21f3d699caa",        "name": "QA Stage",        "avatar": null      },      "lastMessageAt": "2019-08-24T14:15:22Z",      "isUnread": true,      "tags": [        "string"      ],      "lastMessagePreview": "string",      "lastMessageType": "string",      "lastMessageDirection": "INBOUND",      "lastMessageStatus": "string",      "unreadCount": 0,      "isBlocked": true,      "title": "string",      "lastCustomerMessageAt": "2019-08-24T14:15:22Z",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "contact": {        "id": "string",        "phoneNumber": "79001234567",        "name": "string",        "avatar": "string"      },      "channelType": "WABA",      "customerPhone": "string"    }  ],  "pagination": {    "hasMore": true,    "nextCursor": "2019-08-24T14:15:22Z",    "limit": 50  }}