Отправление HSM

Метод позволяет отправить Клиенту сообщение в соответствии с тем или иным уже созданным HSM-шаблоном (HSM-сообщение).

HTTP-запрос:

POST /cc/md/hsm/send_message

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

№	Параметр	Тип	Обязательный	Описание
1	id	Строка	Да	Уникальный идентификатор вызова, например UUID, используется для логирования и отладки
2	social_user_id	Строка	Да	Номер телефона в WhatsApp
3	channel_id	Целое	Да	Идентификатор канала
4	template_id	Целое	Да	Идентификатор шаблона, используемого при формировании HSM
5	creator_abonent_id	Целое	Да	Идентификатор сотрудника MANGO OFFICE, отправитель сообщения
6	parameters	Объект	Да	Динамические данные HSM
6.1	parameters.bindings	Массив строк	Да	Переменные основного текста шаблона
6.2	parameters.header	Объект	Нет	Данные заголовка
6.2.1	parameters.header.content	Строка	Нет	Ссылка на файл для заголовка
6.2.2	parameters.header.bindings	Массив строк	Нет	Переменные текста заголовка шаблона

Примечание. Согласно модели взаимодействия, в POST-запросах отправляются обязательные поля vpbx_api_key и sign. Подробнее об этих обязательных полях…

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

POST https://app.mango-office.ru/cc/send_hsm

{
    "vpbx_api_key": "qwerty123",
    "sign": "qwerty123",
    "json": {
        "id": "qwerty123",
        "social_user_id": "74955404444",
        "channel_id": 11111,
        "template_id": 22222,
        "creator_abonent_id": 33333,
        "parameters": {
            "bindings": [
                "Иванов Иван"
            ],
            "header": {
                "content": "https://image.png",
                "bindings": [
                    "Иванов Иван"
                ]
            }
        }
    }
}

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

№	Параметр	Тип	Обязательный	Описание
1	name	Строка	Да	Наименование статуса HTTP
2	status	Целое	Да	Статус HTTP
3	code	Целое	Да	Код результата
4	error	Строка	Нет	Текст ошибки, если она произошла
5	message	Объект	Да	Некоторые данные о сообщении на сервере
5.1	message.local_message_id	Строка	Да	Локальный идентификатор отправляемого сообщения
5.2	message.message_id	Строка	Да	Идентификатор сообщения на сервере
5.3	message.time	Целое	Да	Время отправки сообщения в Unix Time в миллисекундах
5.4	message.session_id	Строка	Не указано	Идентификатор сессии

Пример успешного ответа:

{
    "name": "OK",
    "status": 200,
    "code": 1000,
    "message": {
        "local_message_id": "92f7cc123000ecadfe6f0f680972098e",
        "message_id": "449026466343509280",
        "time": 1738009633316,
        "session_id": "mFv5u7SUXl6N+FE/pOsAIMd+"
    }
}

Пример неуспешного ответа:

{
    "result": 3000,
    "error": "error-address-format"
}

Была ли статья полезна?

Общее

Получение списка HSM-шаблонов