Справочник API

Contacts

Проверить наличие контакта

Проверяет, есть ли контакт в адресной книге подключённого аккаунта. Для WhatsApp передавайте LID, возвращённый Contact API как conversation_id. is_in_contacts=false — успешный ответ 200, а не ошибка 404. Неподдерживаемые каналы возвращают 501 unsupported_by_provider.

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

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

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

Откуда взять параметры
account_id
Возьмите data.id из создания или запроса аккаунта. Идентификатор относится к рабочему пространству X-Api-Key. Получить аккаунт
contact_id
Контакт для проверки наличия. Для WhatsApp передавайте LID, возвращённый Contact API как conversation_id; URL-кодируйте символ @ в строке запроса.

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

Заголовки

X-Api-Key
stringобязательно

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

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

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

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

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

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

Контакт для проверки наличия. Для WhatsApp передавайте LID, возвращённый Contact API как conversation_id; URL-кодируйте символ @ в строке запроса.

Тело запроса

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

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

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

Ответ 200 OK

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "contact_id": "123456789012345@lid",
    "is_in_contacts": true
  }
}

Тело ответа

contact_id
string

Проверенный идентификатор контакта. Для WhatsApp это LID, переданный в запросе.

is_in_contacts
boolean

Есть ли контакт в адресной книге подключённого аккаунта. false по-прежнему возвращается как успешный ответ 200.

Ответы

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