Беседы

Список меток бесед

Возвращает метки бесед на стороне аккаунта, с пагинацией через limit / cursor. Каждая метка возвращает id и name. Пока только WhatsApp — остальные провайдеры возвращают 501 unsupported_by_provider.

GEThttps://api.unifyport.ai/v1/accounts/{account_id}/conversations/labels

Перед вызовом

Используйте X-Api-Key нужного рабочего пространства на сервере. Перед запуском замените все заполнители.

Откуда взять параметры

account_id: Возьмите data.id из создания или запроса аккаунта. Идентификатор относится к рабочему пространству X-Api-Key. Получить аккаунт

Параметры запроса

Заголовки

X-Api-Key

stringобязательно

API-ключ рабочей области. Рабочая область определяется по этому заголовку.

Параметры пути

account_id

stringобязательно

Идентификатор для маршрута раздела conversations.

Параметры запроса

cursor

string

Непрозрачный next_cursor. Пропустите для первой страницы; невалидные или устаревшие курсоры обрабатываются провайдерами по-разному.

limit

integer

Размер страницы от 1 до 100; значение по умолчанию указано на странице эндпоинта.

minimum: 1 · maximum: 100

Тело запроса

Этот эндпоинт не требует JSON-тела запроса.

Как понять результат

Следуйте описанию полей и HTTP-статуса. Успешный 204 не содержит тела; для диагностики используйте X-Request-Id. Следующий шаг указан в связанных операциях.

Ответ 200 OK

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "items": [
      {
        "id": "label_example",
        "name": "VIP"
      }
    ],
    "next_cursor": "",
    "has_more": false
  }
}

Тело ответа

id

string

Идентификатор метки беседы.

name

string

Отображаемое имя метки беседы.

next_cursor

string

Непрозрачный курсор для следующей страницы. Передайте его обратно как cursor; пустая строка означает, что больше страниц нет.

has_more

boolean

true, когда за пределами этой страницы доступно больше результатов.

Ответы

200

200 OK

Запрос выполнен. См. пример тела ответа.

400

Bad Request

Тело запроса, путь или параметры некорректны.

401

Unauthorized

Заголовок X-Api-Key отсутствует или недействителен.

409

Conflict

Запрошенная операция конфликтует с существующим аккаунтом провайдера или ресурсом.

500

Internal Server Error

Сервис столкнулся с неожиданной ошибкой.

501

Not Implemented

Выбранный провайдер не реализует эту операцию.

502

Bad Gateway

Адаптер или вышестоящий провайдер не смог завершить операцию.

При ошибке запроса

Проверьте HTTP и error.code/numeric_code, сохраните request_id. Исправьте параметры, завершите авторизацию или проверьте runtime. До повторной отправки или записи выясните результат предыдущей попытки. Справочник ошибок

invalid_request · 10000 · 400: Проверьте обязательные поля, форматы и условия канала, затем исправьте запрос.
invalid_api_key · 11001 · 401: Проверьте X-Api-Key и активность рабочего пространства.