Контакт — сущность, которая связывает пользователя и клиента. Это «карточка контакта», где указан ответственный за клиента менеджер и хранятся контактные данные клиента: номер телефона для связи в 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* |
string |
ID контакта. Находится в объекте contacts или data в зависимости от метода |
responsible_user_id* |
string |
ID ответственного пользователя за контакт. Находится в объекте contacts или data в зависимости от метода |
name* |
string |
Имя контакта. Находится в объекте contacts или data в зависимости от метода |
contact_data* |
array |
Данные контакта. Находится в объекте contacts или data в зависимости от метода |
contact_data.chat_type* |
String |
Тип чата. Доступные значения:
|
contact_data.chat_id* |
String |
Вариант идентификации для всех типов чата — ID чата, то есть аккаунт контакта в мессенджере.
|
contact_data.username |
string |
Только для Telegram. Имя пользователя в Telegram, без @ в начале. Можно использовать при отправке сообщений через Telegram, если неизвестен chatId |
contact_data.phone |
string |
Только для Telegram и Max. Телефон контакта в международном формате, без + и иных символов: только цифры с корректным кодом страны. Может использоваться при отправке сообщений через Telegram, если неизвестен chatId |
uri |
string |
Ссылка на контакт в CRM |
Используйте, чтобы передать в 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
}
}
Результат: Список всех ранее созданных контактов.
Метод 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 удален.
*Запрещены и признаны экстремистскими на территории РФ