Получить диалоги с пользователем

Этот метод позволяет получить диалоги с пользователем.

URL

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

В качестве {id} можно использовать:

  • ID из нашей системы
  • Ваш User ID (укажите параметр by_user_id=true). Если пользователя с таким идентификатором не существует, будет возвращена ошибка 400 LookupError.

Параметры

Параметры аутентификации.
Параметры пагинации. Пагинация по времени последнего обновления (поле last_update) объекта Conversation.
Параметр id_as_string. Параметры, включающие опциональные поля объекта Conversation.
Опциональные поля user, important_part_last, reply_last, part_last включены по умолчанию.

Параметр Тип Описание
by_user_id Optional[boolean] Если вы делаете выборку не по ID из Carrot quest, а по своему User ID, этот параметр должен иметь значение true. По умолчанию: false
with_user_replies_only Optional[boolean] Если флаг указан (true), то возвращает только диалоги, в которых были реплики пользователя чата (тип reply_user). По умолчанию: false
recipient_type Optional[строка] Тип получателя ручного или автосообщения, начавшего диалог. Допустимы значения web (по умолчанию) или sdk
app Optional[ID] ID приложения, делающего запрос. По умолчанию определяется на основе токена доступа.

Ответ

Поле data ответа будет содержать объекты Conversation.
Поле meta будет содержать новые параметры пагинации. 

{
  "data": [
    {
      "id": 7100586,
      "created": 1450342055,
      "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-je57yp6v.jpg",
        "type": "admin"
      },
      "last_update": 1450345019,
      "tags": []
    },
    ...
  ],
  "meta": {
    "next_after": 1447339319.900966,
    "status": 200
  }
}

Ошибки

Стандартные ошибки Web API.

Примеры

curl -X GET -H "Authorization: Token XXX" "https://api.carrotquest.io/users/8173131/conversations"