Отправка сообщений по идентификатору шаблона WhatsApp (deprecated)

Обновлено: 23 июля 2026

Для отправки сообщений в канал WhatsApp по идентификатору шаблона templateId используется метод api/v1/out-messages/whatsapp/template.

warning

Метод api/v1/out-messages/whatsapp/template относится к устаревшей версии API.

Для поддержки BSUID рекомендуется использовать новый метод api/v2/out-messages/whatsapp/template.

Отправка сообщений по идентификатору шаблона WhatsApp

Вызов метода

Чтобы отправить сообщение в канал WhatsApp по методу api/v1/out-messages/whatsapp/template, отправьте POST-запрос на URL-адрес https://app.edna.ru/api/v1/out-messages/whatsapp/template.

Формат запроса

{
    "messageId": "string",
    "sender": "string",
    "phone": "string",
    "templateId": number,
    "textVariables": [
        "string",
        "string",
        "string"
    ],
    "buttonVariables": [
        "string",
        "string"
    ],
    "headerVariables": [
        "string"
    ],
    "attachment": {
        "url": "string",
        "name": "string"
    },
    "options": {
        "comment": "string",
        "sendDelay": "string",
        "priority": "string",
        "useMarketingMessagesApi": boolean,
        "messageActivitySharing": boolean
    }
}

Пример запроса

Сообщение с текстом

{
    "sender": "RETAIL_WA",
    "phone": "77771234567",
    "templateId": 81,
    "options": {
        "comment": "2025-08-04T13:00:48.567Z"
    }
}

Сообщение с текстом — доставка через Marketing Messages API с включённой оптимизацией

{
    "sender": "RETAIL_WA",
    "phone": "77771234567",
    "templateId": 81,
    "options": {
        "comment": "2025-08-04T13:00:48.567Z",
        "useMarketingMessagesApi": true,
        "messageActivitySharing": true
    }
} 

Сообщение с документом во вложении

{
    "sender": "RETAIL_WA",
    "phone": "77771234567",
    "templateId": 96,
    "attachment": {
        "url": "https://tourism.gov.in/sites.pdf",
        "name": "example"
    },
    "options": {
        "comment": "promotion"
    }
}

Сообщение с отложенной отправкой, содержащее документ, переменные, текст и динамические кнопки

{
    "messageId": "01987f4a-069e-730e-bf59-cedc1e63349",
    "sender": "RETAIL_WA",
    "phone": "77771234567",
    "templateId": 98,
    "textVariables": [
        "Alex",
        "10.05",
        "Happy Birthday"
    ],
    "buttonVariables": [
        "3FgSD",
        "KNsr6"
    ],
    "headerVariables": [
        "Good Morning"
    ],
    "attachment": {
        "url": "https://tourism.gov.in/sites.pdf",
        "name": "offer"
    },
    "options": {
        "comment": "2025-08-15T12:12:16.984Z",
        "sendDelay": "PT10H15M47S",
        "priority": "NORMAL"
    }
}

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

Параметр	Тип данных	Характер	Описание
messageId	string	Необязательный	Внутренний идентификатор сообщения.
sender	string	Обязательный	Название подписи. Чтобы узнать название подписи, используйте метод API для получения списка каналов — параметр subject. Получение списка каналов
phone	string	Обязательный	Адрес получателя — номер телефона. Чтобы узнать адрес получателя, используйте метод API для запроса данных получателей — параметр addresses.address. Запрос данных получателей
templateId	number	Обязательный	Идентификатор шаблона. Чтобы узнать идентификатор шаблона, используйте метод API для получения списка шаблонов — параметр id. Получение списка шаблонов
textVariables	array of strings	Обязательный, если в шаблоне есть переменные	Значения переменных в сообщении по шаблону.
buttonVariables	array of strings	Обязательный, если в шаблоне есть кнопки с динамическими ссылками	Значения переменных для кнопок с динамическими ссылками в сообщении по шаблону. Шаблон сообщения WhatsApp может содержать до двух кнопок-ссылок.
headerVariables	array of strings	Обязательный, если в заголовке шаблона есть переменная	Значение переменной в заголовке сообщения по шаблону. Заголовок может содержать только одну переменную.
attachment	object	Необязательный	Объект с информацией о вложении.
attachment.url	string	Обязательный, если параметр attachment не пустой	Ссылка на вложение: изображение, файл, видео или аудио.
attachment.name	string	Обязательный, если параметр attachment не пустой	Название изображения, файла, видео или аудио. Максимальная длина — 70 символов.
options	object	Необязательный	Объект с дополнительными настройками отправки сообщения.
options.comment	string	Необязательный	Текстовый комментарий к сообщению. Значение параметра отображается в отчёте по сообщениям.
options.sendDelay	string	Необязательный	Период времени в формате ISO 8601 (например, PT10H15M48S), раньше которого сообщение не будет отправлено. Используется при отложенной отправке.
options.priority	string	Необязательный	Используется для обозначения приоритета сообщений. Возможные значения: - LOW — низкий приоритет; - NORMAL — средний приоритет, значение по умолчанию; - HIGH — высокий приоритет; - REALTIME — доставка в режиме реального времени.
options.useMarketingMessagesApi	boolean	Необязательный	Параметр определяет способ доставки маркетингового сообщения — Marketing Messages API или Cloud API. Возможные значения: - true — через Marketing Messages API; - false — через Cloud API. Включение Marketing Messages API для WhatsApp
options.messageActivitySharing	boolean	Необязательный	Параметр включает оптимизацию доставки маркетингового сообщения через Marketing Messages API и определяет, может ли Meta* анализировать данные сообщения. Возможные значения: - true — оптимизация включена: Meta* может читать сообщение и принимать решение о его доставке получателю. - false — оптимизация отключена: Meta* не имеет доступа к содержанию сообщения и не участвует в принятии решения о доставке. Включение Marketing Messages API для WhatsApp

Формат ответа

{
    "messageId": "string",
    "phone": "string"
}

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

{
    "messageId": "01987f4a-069e-730e-bf59-cedc1e63349",
    "phone": "77771234567"
}

Параметры ответа

Параметр	Тип данных	Описание
messageId	string	Внутренний идентификатор сообщения.
phone	string	Адрес получателя — номер телефона.

Ошибки

Код	Ошибка	Описание	Возможные комментарии
400	mm-api-options-invalid-combination	Несовместимая комбинация настроек при отправке сообщения WhatsApp через Marketing Messages API.	Cannot use messageActivitySharing=true when useMarketingMessagesApi=false — оптимизация доставки сообщения доступна только при отправке сообщения через Marketing Messages API.