Получить диалог

Этот метод позволяет получить данные о конкретном диалоге.

URL

GET https://api.carrotquest.io/v1/conversations/{id}

В качестве {id} нужно использовать ID диалога.

Аргументы

Этот метод следует общим правилам. Аргументы передаются как GET или POST параметры.

Аргумент Описание
auth_token Обязательный. Токен авторизации (нужен scope: conversations-read)

Ответ

{
  "data": {
    "id": 7100586,
    "created": 1450342055,
    "user": {
      "id": 7722092,
      "app": 3,
      "user_id": "27384",
      "presence": "idle",
      "props": {
        "$last_seen": "2015-12-17T13:01:32",
        "$name": "Alex",
        "$email": "alex@example.com",
        ...
      }
    },
    "read": true,
    "replied": true,
    "clicked": false,
    "unsubscribed": false,
    "closed": false,
    "message": null,
    "type": "popup_chat",
    "reply_type": "text",
    "part_last": {
      "id": 7855356,
      "created": 1450345019,
      "conversation": 7100586,
      "body": "...",
      "type": "reply_user",
      "sent_via": "web_user",
      "from": 16588048
    },
    "parts_count": 13,
    "assignee": null,
    "unread_parts_count": 2,
    "last_admin": {
      "id": 24601,
      "name": "Maks",
      "avatar": "https://files.carrotquest.io/avatars/1446021235578-n653y667.jpg",
      "type": "admin"
    },
    "last_update": 1450345019,
    "tags": []
  }
  "meta": {
    "status": 200
  }
}

Ответ будет содержать объект Conversation.

Ошибки

Эта таблица содержит ошибки, которые могут быть возвращены. Однако, в случае непредвиденных ситуаций ввиду неработоспособности сервиса могут возникнуть другие ошибки. Всегда следует проверять параметр meta.status.

Ошибка Описание
MethodNotAllowed Неверный HTTP-метод
AuthenticationFailed Токен авторизации неверен (или отсутствует)
PermissionDenied Нет доступа к этому диалогу (скорее всего, диалог принадлежит другому приложению)

Примеры

curl -X GET https://api.carrotquest.io/v1/conversations/313341?auth_token=XXX