ContactsPOST

Добавить контакт

Добавляет контакт в адресную книгу подключённого аккаунта. Укажите хотя бы одно из полей phone_number или username. whatsapp_options поддерживается только WhatsApp и должно передаваться вложенным объектом. Неподдерживаемые каналы возвращают 501 unsupported_by_provider.

https://api.unifyport.ai/v1/accounts/{account_id}/contacts/add

Заголовки

X-Api-Key

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

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

Content-Type

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

Используйте application/json при отправке JSON-тела запроса.

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

account_id

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

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

Тело запроса

phone_number

string

Номер телефона контакта в международном формате. Укажите хотя бы phone_number или username.

username

string

Имя пользователя контакта у провайдера. Укажите хотя бы username или phone_number.

whatsapp_options

object

Необязательные параметры создания контакта только для WhatsApp; передавайте их вложенными в whatsapp_options.

first_name

string

Необязательное имя контакта WhatsApp.

full_name

string

Необязательное полное имя контакта WhatsApp.

sync_to_device_contacts

boolean

Синхронизировать ли контакт с адресной книгой устройства WhatsApp. По умолчанию false.

Тело ответа

id

string

Идентификатор контакта.

conversation_id

string

Идентификатор беседы для этого контакта; используйте его для отправки сообщений или поиска чата.

display_name

string

Отображаемое имя контакта или пустая строка, если оно отсутствует.

avatar_url

string

URL аватара контакта или пустая строка, если он отсутствует.

provider_user_id

string

Идентификатор пользователя на стороне провайдера для контакта.

is_blocked

boolean

Заблокирован ли контакт подключённым аккаунтом.

extra

object

Дополнительные поля, специфичные для провайдера, например phone.

Ответы

200

200 OK

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

400

Bad Request

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

401

Unauthorized

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

409

Conflict

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

500

Internal Server Error

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

501

Not Implemented

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

502

Bad Gateway

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

Запрос

curl -X POST https://api.unifyport.ai/v1/accounts/{account_id}/contacts/add \
  -H "X-Api-Key: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "phone_number": "8600000000000",
  "username": "alice_user",
  "whatsapp_options": {
    "first_name": "Alice",
    "full_name": "Alice Example",
    "sync_to_device_contacts": false
  }
}'

Ответ

{
  "data": {
    "id": "8600000000000@s.whatsapp.net",
    "conversation_id": "123456789012345@lid",
    "display_name": "Alice Example",
    "avatar_url": "",
    "provider_user_id": "8600000000000@s.whatsapp.net",
    "extra": { "phone": "8600000000000" }
  }
}