Отправка сообщений с контактными данными через WhatsApp
Обновлено: 12 марта 2026
Для отправки контактных данных в канал WhatsApp используется метод api/v1/out-messages/whatsapp.
подсказка
Метод api/v1/out-messages/whatsapp относится к новой версии API.
Вызов метода
Чтобы отправить сообщение с контактными данными в канал WhatsApp, отправьте POST-запрос на URL-адрес https://app.edna.ru/api/v1/out-messages/whatsapp.
Формат запроса
{
"sender": "string",
"phone": "string",
"content": {
"type": "string",
"name": {
"name": "string",
"firstName": "string",
"lastName": "string"
},
"phones": [
{
"phone": "string",
"type": "string",
"userId": "string"
},
{
"phone": "string",
"type": "string",
},
{
"phone": "string",
"type": "string",
},
],
"addresses": [
{
"city": "string",
"country": "string",
"street": "string",
"type": "string"
},
{
"city": "string",
"country": "string",
"street": "string",
"type": "string"
}
],
"emails": [
{
"email": "string",
"type": "string"
},
{
"email": "string",
"type": "string"
}
],
"urls": [
{
"url": "string",
"type": "string"
},
{
"url": "string",
"type": "string"
}
],
"org": {
"company": "string",
"department": "string",
"title": "string"
}
}
}
Пример запроса
{
"sender": "wa_subject_1",
"phone": "+79991234567",
"content": {
"type": "CONTACT",
"name": {
"name": "Мстислав директор",
"firstName": "Мстислав",
"lastName": "Грибоедов"
},
"phones": [
{
"phone": "+79123456789",
"type": "CELL",
"userId": "79123456789"
},
{
"phone": "+79459998765",
"type": "WORK",
},
{
"phone": "+79456789012",
"type": "HOME",
},
],
"addresses": [
{
"city": "Москва",
"country": "RUSSIA",
"street": "Малый Харитоньевский переулок, 8",
"type": "HOME"
},
{
"city": "Москва",
"country": "RUSSIA",
"street": "ул. Тверская-Ямская, 2",
"type": "WORK"
}
],
"emails": [
{
"email": "sweethome@gmail.com",
"type": "HOME"
},
{
"email": "m.griboedov@lovelywork.com",
"type": "WORK"
}
],
"urls": [
{
"url": "nicesite.ru",
"type": "HOME"
},
{
"url": "lovelywork.com",
"type": "WORK"
}
],
"org": {
"company": "Издательство KnightHood",
"department": "Юридический департамент",
"title": "Директор юридического департамента"
}
}
}
Параметры запроса
| Параметр | Тип данных | Характер | Описание |
|---|---|---|---|
sender | string | Обязательный | Название подписи. Чтобы узнать название подписи, используйте метод API для получения списка каналов — параметр subject.
Получение списка каналов |
phone | string | Обязательный | Адрес получателя — номер телефона в соответствии с форматом стандарта E.164.
Паттерн стандарта: ^+[1-9]\d{1,14}$.
Чтобы узнать адрес получателя, используйте метод API для запроса данных получателей — параметр addresses.address.
Запрос данных получателей |
content | object | Обязательный | Объект с информацией о содержимом сообщения.
Обязательно должны быть указаны: - параметр content.name;
- один из параметров — content.phones, content.addresses, content.emails, content.urls или content.org. |
content.type | string | Обязательный | Тип содержимого сообщения.
Возможные значения: - TEXT — текстовое сообщение;
- IMAGE — изображение;
- DOCUMENT — документ, вложенный в сообщение;
- VIDEO — сообщение, содержащее видео;
- AUDIO — сообщение, содержащее звук;
- LOCATION — сообщение с координатами, адресом и описанием места. Координаты преобразуются в снимок Google maps;
- LIST_PICKER — кнопки интерактивного меню WhatsApp;
- FLOW — сообщение, содержащее WhatsApp Flows.
- CONTACT — сообщение, содержащее данные контакта. |
content.name | object | Обязательный | Объект с информацией об именах контакта.
Обязательно должны быть указаны: - параметр content.name.name;
- один из параметров — content.name.firstName или content.name.lastName. |
content.name.name | string | Обязательный | Название контакта. Максимальная длина — 1024 символа. |
content.name.firstName | string | Необязательный | Имя контакта. Максимальная длина — 1024 символа. |
content.name.lastName | string | Необязательный | Фамилия контакта. Максимальная длина — 1024 символа. |
content.phones | array of objects | Необязательный | Массив телефонных номеров. |
content.phones.phone | string | Необязательный | Номер телефона. Максимальная длина — 1024 символа. |
content.phones.type | string | Необязательный | Признак телефонного номера.
Возможные значения: - HOME – домашний;
- WORK – рабочий;
- IPHONE – iPhone;
- MAIN – основной;
- CELL – мобильный. |
content.phones.userId | string | Необязательный | Если значение указано, то в приложение WhatsApp будет передан WhatsApp ID – телефонный номер, к которому привязан аккаунт. В этом случае контакт отобразится с кнопками «Написать» и «Сохранить». Если значение не указано, контакт отобразится с кнопкой «Добавить». Максимальная длина — 1024 символа. |
content.addresses | array of objects | Необязательный | Массив адресов проживания и нахождения.
Значения параметра content.addresses отображаются только в web-версии WhatsApp. |
content.addresses.city | string | Необязательный | Город контакта. Максимальная длина — 1024 символа. |
content.addresses.country | string | Необязательный | Страна контакта. Максимальная длина — 1024 символа. |
content.addresses.street | string | Необязательный | Улица контакта. Максимальная длина — 1024 символа. |
content.addresses.type | string | Необязательный | Тип адреса контакта.
Возможные значения: - HOME – домашний;
- WORK – рабочий. |
content.emails | array of objects | Необязательный | Массив email-адресов.
Значения параметра content.emails отображаются только в web-версии WhatsApp. |
content.emails.email | string | Необязат ельный | Email-адрес контакта. Максимальная длина — 1024 символа. |
content.emails.type | string | Необязательный | Тип email-адреса контакта.
Возможные значения: - HOME – домашний;
- WORK – рабочий. |
content.urls | array of objects | Необязательный | Массив адресов веб-страниц.
Значения параметра content.urls отображаются только в web-версии WhatsApp. |
content.urls.url | string | Необязательный | Адрес веб-страницы. Максимальная длина — 1024 символа. |
content.urls.type | string | Необязательный | Тип адреса веб-страницы.
Возможные значения: - HOME – домашний;
- WORK – рабочий. |
content.org | object | Необязательный | Объект с информация об организации. |
content.org.company | string | Необязательный | Название организации. Максимальная длина — 1024 символа. |
content.org.department | string | Необязательный | Подразделение организации. Максимальная длина — 1024 символа. |
content.org.title | string | Необязательный | Должность контакта. Максимальная длина — 1024 символа. |
Формат ответа
{
"outMessageId": "string",
"phone": "string"
}
Пример ответа
{
"outMessageId": "020be4b9-bb7d-781d-8517-913fa44e80e6",
"phone": "+79991234567"
}