метод REST scope: messageservice

messageservice.sender.update

Обновить провайдер сообщений

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

Описание

Метод messageservice.sender.update обновляет данные зарегистрированного провайдера сообщений.

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

Параметры

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

Код провайдера, который нужно обновить.

Код провайдера можно получить методом messageservice.sender.list

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","HANDLER":"https://provider.example/api/new-handler","NAME":"Provider 1 Updated","DESCRIPTION":"Обновленное описание","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/messageservice.sender.update

Ответ

HTTP-статус: 200

{
    "result": true,
    "time": {
        "start": 1742895600,
        "finish": 1742895600.845505,
        "duration": 0.845505952835083,
        "processing": 0.1402289867401123,
        "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_OTHER_PARAMS_REQUIRED",
    "error_description": "At least one other parameter is required!"
}
Код Описание Значение
ERROR_SENDER_CODE_REQUIRED CODE is required! Не передан обязательный параметр CODE
ERROR_SENDER_OTHER_PARAMS_REQUIRED At least one other parameter is required! Не передан ни один параметр для обновления (HANDLER, NAME, DESCRIPTION)
ERROR_SENDER_NOT_FOUND Sender not found! Провайдер с переданным CODE не найден
ERROR_SENDER_UPDATE_FAILURE Sender update error! Ошибка обновления провайдера
ACCESS_DENIED Application context required Метод вызван вне контекста приложения
ACCESS_DENIED Access denied! Метод запустил не администратор

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

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