РУ

База знаний

Регистрация

Вход

РУ

База знаний

Контакты

Контакт — сущность, которая связывает пользователя и клиента. Это «карточка контакта», где указан ответственный за клиента менеджер и хранятся контактные данные клиента: номер телефона для связи в WhatsApp, ID в Telegram, юзернейм в Instagram*.

При работе с перечисленными методами используйте в заголовках токен дочернего аккаунта client_access_token, который получили с помощью упрощенной авторизации или OAuth: Authorization: Bearer client_access_token

Перечень методов

GET /v2/contacts — получение списка контактов.
GET /v2/contacts/{contact_id} — получение информации о контакте по ID.
POST /v2/contacts — добавление контактов.
PATCH /v2/contacts — обновление контактов.
DELETE /v2/contacts — удаление контактов.

Модель контакта

Параметры, которые нужны при создании, обновлении контакта, а также приходят в ответах на запросы.

Могут находиться в объекте contacts или data: показали в примерах запросов и ответов к каждому методу, какой объект используется.

Структура

Контакт
│
├── id *
├── responsible_user_id *
├── name *
├── contact_data[] *
│   ├── chat_type *
│   ├── chat_id *
│   ├── username
│   └── phone
└── uri *

Параметр. Обязательные отмечены *	Тип	Описание
`id`*	`string`	ID контакта. Находится в объекте `contacts` или `data` в зависимости от метода
`responsible_user_id`*	`string`	ID ответственного пользователя за контакт. Находится в объекте `contacts` или `data` в зависимости от метода
`name`*	`string`	Имя контакта. Находится в объекте `contacts` или `data` в зависимости от метода
`contact_data`*	`array(object) contact_data`	Данные контакта. Находится в объекте `contacts` или `data` в зависимости от метода
`uri`*	`string`	Ссылка на контакт в CRM

contact_data (объект)

Параметр. Обязательные отмечены *	Тип	Описание
`chat_type`*	`String`	Тип сущности в мессенджере, соцсети. Доступные значения: `whatsapp` — аккаунт в WhatsApp, `whatsgroup` — групповой чат в WhatsApp, `viber` — аккаунт Viber, `instagram` — аккаунт Instagram*, `telegram` — аккаунт в Telegram, `telegroup` — групповой чат в Telegram, `vk` — аккаунт ВКонтакте, `avito` — аккаунт Авито, `max` — аккаунт MAX, `maxgroup` — групповой чат MAX, `cian`— аккаунт Циан.
`chat_id`*	`String`	Идентификатор сущности в мессенджере, соцсети: Для `whatsapp` и `viber` — только цифры, формат 79011112233. Для `instagram` — аккаунт без @ вначале. Для `whatsgroup`, `maxgroup`, `telegram`, `max`, `avito`, `vk`, `cian` приходит в вебхуках входящих сообщений.
`username`	`string`	Только для Telegram. Имя пользователя в Telegram, без @ в начале. Можно использовать при отправке сообщений через Telegram, если неизвестен `chat_id`
`phone`	`string`	Только для Telegram и Max. Телефон контакта в международном формате, без + и иных символов: только цифры с корректным кодом страны. Может использоваться при отправке сообщений через Telegram, если неизвестен `chat_id`

Добавление контактов

Используйте, чтобы передать в Wazzup информацию о новом контакте.

Метод POST /v2/contacts

Параметры запроса
Описаны выше в разделе «Модель контакта». Передавайте параметры в объекте contacts

Пример:

curl -L 'https://tech.wazzup24.com/v2/contacts'
-H 'Authorization: Bearer <client_access_token>'
-H 'Content-Type: application/json'
-d '{
"contacts": [
{
"id": "contacts1",
"responsible_user_id": "1",
"name": "TestContact",
"contact_data": [
{
"chat_type": "whatsapp",
"chat_id": "79999999999"
}
],
"uri": "https://example.com/contact/1"
}]
}'

Пример ответа:

{
"data": {
"processed": 1
},
"meta": {
"timestamp": 1759495852
}
}

Результат: Контакт, список контактов добавлен.

Получение списка контактов

Метод позволяет получить список контактов, которые уже переданы в Wazzup.

Метод GET /v2/contacts

Пример:

curl -L 'https://tech.wazzup24.com/v2/contacts?offset=0&limit=100'
-H 'Authorization: Bearer <client_access_token>'

Пример ответа:

{
"data": [
{
"id": "contacts1",
"name": "TestContact",
"responsible_user_id": "1",
"contact_data": [
{
"chat_type": "whatsapp",
"chat_id": "79999999999",
"username": "",
"phone": ""
}
],
"uri": "/api/v2/contacts/contacts1"
}
],
"meta": {
"timestamp": 1759496601
}
}

Результат: Список всех ранее созданных контактов.

Получение контакта по ID

Метод GET /v2/contacts/{contact_id}

Path-параметры
contact_id — ID контакта в CRM.

Пример:

curl -L 'https://tech.wazzup24.com/v2/contacts/contacts1'
-H 'Authorization: Bearer <client_access_token>'

Пример ответа:

{
"data": [
{
"id": "contacts1",
"name": "TestContact",
"responsible_user_id": "1",
"contact_data": [
{
"chat_type": "whatsapp",
"chat_id": "79999999999",
"username": "",
"phone": ""
}
],
"uri": "/api/v2/contacts/contacts1"
}
],
"meta": {
"timestamp": 1759496601
}
}

Результат: Контакт с id: contacts1, если такой существует.

Обновление контактов

Метод позволяет изменить информацию о ранее переданных контактах в Wazzup. Например, если в CRM обновили имя контакта.

Метод PATCH /v2/contacts

Пример:

curl -L -X PATCH 'https://tech.wazzup24.com/v2/contacts'
-H 'Authorization: Bearer <client_access_token>'
-H 'Content-Type: application/json'
-d '{
"contacts": [
{
"id": "contacts1",
"responsible_user_id": "1",
"name": "NewContactName",
"contact_data": [
{
"chat_type": "whatsapp",
"chat_id": "79999999999"
}
],
"uri": "https://example.com/contact/123"
}
]
}'

Пример ответа:

{
"data": {
"processed": 1
},
"meta": {
"timestamp": 1759495852
}
}

Результат: Если контакт существует, его данные обновлены.

Удаление контактов

Метод DELETE /v2/contacts

Параметры в теле запроса
В запросе передайте массив contact_ids с ID контактов, которые надо удалить.

Пример:

curl -L -X DELETE 'https://tech.wazzup24.com/v2/contacts'
-H 'Authorization: Bearer <client_access_token>'
-H 'Content-Type: application/json'
-d '{
"contact_ids": [
"contacts1"
]
}'

Пример ответа:

{
"data": null,
"meta": {
"timestamp": 1759393502
}
}

Результат: Контакт id: contacts1 удален.

*Запрещены и признаны экстремистскими на территории РФ