метод REST scope: messageservice

messageservice.sender.add

Зарегистрировать СМС-провайдер или провайдер сообщений

Кто может выполнять: администратор

Описание

Метод messageservice.sender.add регистрирует нового провайдера сообщений.

Метод работает только в контексте приложения.

Параметры

CODE string обязательный

Код провайдера.

Допустимые символы: a-z, A-Z, 0-9, ., -, _

TYPE string обязательный

Тип провайдера.

Поддерживаемое значение: SMS

HANDLER string обязательный

URL обработчика приложения, который вызывается при отправке сообщения.

Данные, которые приходят в обработчик, описаны ниже

NAME string обязательный

Название провайдера.

Может быть строкой или ассоциативным массивом локализированных строк вида:

'NAME': {
    'ru': 'название провайдера',
    'en': 'provider name',
    ...
},
DESCRIPTION string необязательный

Описание провайдера.

Может быть строкой или ассоциативным массивом локализированных строк вида:

'DESCRIPTION': {
    'ru': 'описание провайдера',
    'en': 'provider description',
    ...
},

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"CODE":"provider1","TYPE":"SMS","HANDLER":"https://provider.example/api/handler","NAME":"Provider 1","DESCRIPTION":"Основной SMS-провайдер","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/messageservice.sender.add

Ответ

HTTP-статус: 200

{
    "result": true,
    "time": {
        "start": 1742895600,
        "finish": 1742895600.845505,
        "duration": 0.845505952835083,
        "processing": 0,
        "date_start": "2025-03-25T10:00:00+03:00",
        "date_finish": "2025-03-25T10:00:00+03:00",
        "operating_reset_at": 1742896200,
        "operating": 0
    }
}

Возвращаемые данные

result boolean

true, если провайдер успешно зарегистрирован

time time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
    "error": "ERROR_SENDER_VALIDATION_FAILURE",
    "error_description": "Empty sender code!"
}
Код Описание Значение
ERROR_SENDER_VALIDATION_FAILURE Empty data! Пустой набор параметров
ERROR_SENDER_VALIDATION_FAILURE Empty sender code! Не передан обязательный параметр CODE
ERROR_SENDER_VALIDATION_FAILURE Wrong sender code! CODE содержит недопустимые символы
ERROR_SENDER_VALIDATION_FAILURE Empty sender NAME! Не передан обязательный параметр NAME
ERROR_SENDER_VALIDATION_FAILURE Empty sender message TYPE! Не передан обязательный параметр TYPE
ERROR_SENDER_VALIDATION_FAILURE Unknown sender message TYPE! Передан неподдерживаемый TYPE (допустимо только SMS)
ERROR_SENDER_ALREADY_INSTALLED Sender already installed! Провайдер с таким CODE уже зарегистрирован для текущего приложения
ERROR_SENDER_ADD_FAILURE Sender save error! Ошибка сохранения провайдера
ACCESS_DENIED Access denied! Метод запустил не администратор
ACCESS_DENIED Application context required Метод вызван вне контекста приложения

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.