Получить диалоги приложения

Этот метод позволяет получать диалоги приложения. Мы используем этот метод на странице "Диалоги".

URL

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

Аргументы

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

Аргумент Описание
auth_token Обязательный. Токен авторизации (нужен scope: conversations-read)
include_not_assigned Укажите true, чтобы к ответу добавились неразобранные диалоги (никому не назначенные диалоги)
closed Укажите true, чтобы получить закрытые диалоги, false - чтобы получить только открытые. Игнорируйте этот аргумент, чтобы получить все
assigned Укажите ID администратора, чтобы получить диалоги, назначенные только ему, либо игнорируйте его, чтобы получить диалоги назначеные на любого администратора. Что бы получить неразобраные диалоги, необходимо отправить в параметре assigned 0 и include_not_assigned отправить true
tags Список тегов (через запятую). Если указан, то будут возвращены диалоги, которым присвоены все эти теги
channel Укажите ID канала, чтобы получить диалоги из определенного канала. Чтобы получить диалоги из всех каналов, игнорируйте этот параметр
after Пагинация. Курсор, с которого нужно начать
count Пагинация. Максимальное количество сообщений, которое нужно вернуть (от 1 до 50). По умолчанию: 20

Подробнее о пагинации.

Ответ

{
  "meta": {
    "status": 200,
    "next_after": 1454408108.30303
  },
  "data": [
    {
      "id": 9334799,
      "created": 1454392168,
      "user": {
        "id": 23939391,
        "user_id": "28231",
        "presence": "idle",
        "props": {
          "$name": "Maks",
          "$email": "maks@my-site.com",
          ...
        }
      },
      "channel": {
        "avatar": "",
        "droppable": true,
        "id": 5,
        "name": "Тестовый канал",
        "not_assigned_count": 0,
        "not_read_count": 0,
        "read_permission": null,
        "type": "manual"
      },
      "read": true,
      "replied": true,
      "clicked": false,
      "unsubscribed": false,
      "closed": false,
      "message": null,
      "type": "popup_chat",
      "reply_type": "text",
      "part_last": {
        "id": 10481096,
        "created": 1454412399,
        "conversation": 9334799,
        "body": "Hello! How are u?",
        "read": true,
        "type": "reply_admin",
        "sent_via": "app_desktop",
        "from": {
          "id": 24463,
          "name": "Dima",
          "avatar": "https://files.carrotquest.io/avatars/1446021235578-be57yp6v.jpg",
          "type": "admin"
        }
      },
      "parts_count": 22,
      "assignee": {
        "id": 24463,
        "name": "Dima",
        "avatar": "https://files.carrotquest.io/avatars/1446021235578-be57yp6v.jpg",
        "type": "admin"
      },
      "unread_parts_count": 0,
      "last_admin": {
        "id": 24463,
        "name": "Dima",
        "avatar": "https://files.carrotquest.io/avatars/1446021235578-be57yp6v.jpg",
        "type": "admin"
      },
      "last_update": 1454412399,
      "tags": []
    },
    ...
  ]
}

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

Примеры

curl -X GET 'https://api.carrotquest.io/v1/apps/$self_app/conversations?auth_token=XXX'