Contacts

Получить чёрный список

Возвращает полный список идентификаторов заблокированных контактов. dhash — отпечаток списка: закэшируйте его и сравните при следующем вызове, чтобы заметить изменения без сравнения всего массива.

GEThttps://api.unifyport.ai/v1/accounts/{account_id}/contacts/blocklist

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

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

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

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

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

Заголовки

X-Api-Key

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

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

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

account_id

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

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

Тело запроса

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

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

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

Ответ 200 OK

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "blocklist": [
      "user_example",
      "user_other"
    ],
    "dhash": "2:abcdef123456"
  }
}

Тело ответа

blocklist[]

string[]

Массив идентификаторов заблокированных контактов.

dhash

string

Отпечаток чёрного списка; закэшируйте его и сравните при следующем вызове, чтобы заметить изменения без сравнения всего массива.

Ответы

200

200 OK

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

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 и активность рабочего пространства.