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

Выберите инструмент для разработки с AI-агентом:

используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: messageservice

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

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

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

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

Обязательные параметры отмечены *

Название `тип`	Описание
CODE* `string`	Код провайдера. Допустимые символы: `a-z`, `A-Z`, `0-9`, `.`, `-`, `_`
TYPE* `string`	Тип провайдера. Поддерживаемое значение: `SMS`
HANDLER* `string`	URL обработчика приложения, который вызывается при отправке сообщения. Данные, которые приходят в обработчик, описаны ниже
NAME* `string` \| `object`	Название провайдера. Может быть строкой или ассоциативным массивом локализированных строк вида: `'NAME': { 'ru': 'название провайдера', 'en': 'provider name', ... },`
DESCRIPTION `string` \| `object`	Описание провайдера. Может быть строкой или ассоциативным массивом локализированных строк вида: `'DESCRIPTION': { 'ru': 'описание провайдера', 'en': 'provider description', ... },`

Что приходит в обработчик

Название `тип`	Описание
module_id `string`	Модуль, из которого отправлено сообщение. Возможные значения: `crm` — сообщение отправлено из карточки CRM `bizproc` — сообщение отправлено из Бизнес-процессов или робота CRM
bindings `array`	Массив привязок сообщения к объектам CRM. Параметр приходит, если `module_id` равен `crm`
workflow_id `string`	Идентификатор бизнес-процесса. Параметр приходит, если `module_id` равен `bizproc`
document_id `array`	Идентификатор документа бизнес-процесса. Параметр приходит, если `module_id` равен `bizproc`
document_type `array`	Тип документа бизнес-процесса. Параметр приходит, если `module_id` равен `bizproc`
properties `object`	Объект с совместимыми параметрами сообщения
type `string`	Тип провайдера. Возможное значение: `SMS`
code `string`	Код провайдера
message_id `string`	Уникальный идентификатор сообщения. Используйте его в методе messageservice.message.status.update для обновления статуса сообщения
message_to `string`	Номер получателя сообщения
message_body `string`	Текст сообщения
ts `integer`	Время отправки запроса в формате Unix Timestamp
auth `object`	Данные авторизации приложения

Объект properties

Название `тип`	Описание
phone_number `string`	Номер получателя сообщения
message_text `string`	Текст сообщения

Примеры кода

Как использовать примеры в документации

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

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

// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

try {
  const response = await $b24.actions.v2.call.make<boolean>({
    method: 'messageservice.sender.add',
    params: {
      CODE: 'provider1',
      TYPE: 'SMS',
      HANDLER: 'https://provider.example/api/handler',
      NAME: 'Provider 1',
      DESCRIPTION: 'Main SMS provider',
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Sender registered:', result)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}

<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function addSender() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'messageservice.sender.add',
        params: {
          CODE: 'provider1',
          TYPE: 'SMS',
          HANDLER: 'https://provider.example/api/handler',
          NAME: 'Provider 1',
          DESCRIPTION: 'Main SMS provider',
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Sender registered:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', addSender)
</script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.messageservice.sender.add(
        code="provider1",
        type="SMS",
        handler="https://provider.example/api/handler",
        name="Provider 1",
        description="Main SMS provider",
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")

try {
    $response = $b24Service
        ->core
        ->call(
            'messageservice.sender.add',
            [
                'CODE' => 'provider1',
                'TYPE' => 'SMS',
                'HANDLER' => 'https://provider.example/api/handler',
                'NAME' => 'Provider 1',
                'DESCRIPTION' => 'Основной SMS-провайдер',
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    print_r($result);
} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error adding sender: ' . $e->getMessage();
}

BX24.callMethod(
    'messageservice.sender.add',
    {
        CODE: 'provider1',
        TYPE: 'SMS',
        HANDLER: 'https://provider.example/api/handler',
        NAME: 'Provider 1',
        DESCRIPTION: 'Основной SMS-провайдер'
    },
    function(result)
    {
        if (result.error())
        {
            console.error(result.error(), result.error_description());
        }
        else
        {
            console.log(result.data());
        }
    }
);

require_once('crest.php');

$result = CRest::call(
    'messageservice.sender.add',
    [
        'CODE' => 'provider1',
        'TYPE' => 'SMS',
        'HANDLER' => 'https://provider.example/api/handler',
        'NAME' => 'Provider 1',
        'DESCRIPTION' => 'Основной SMS-провайдер',
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "messageservice.sender.add", b24.Params{
	"CODE":        "provider1",
	"TYPE":        "SMS",
	"HANDLER":     "https://provider.example/api/handler",
	"NAME":        "Provider 1",
	"DESCRIPTION": "Основной SMS-провайдер",
})
if err != nil {
	return fmt.Errorf("messageservice.sender.add: %w", err)
}

var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("выполнено:", ok)

Обработка ответа

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, 403

{
    "error": "ERROR_SENDER_VALIDATION_FAILURE",
    "error_description": "Empty sender code!"
}

Название `тип`	Описание
error `string`	Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только `error_description`
error_description `string`	Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

Возможные коды ошибок

Код	Описание	Значение
`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`	Метод вызван вне контекста приложения

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит
`401`	`NO_AUTH_FOUND` Wrong authorization data	В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука
`401`	`INVALID_REQUEST` Https required	Методы вызываются только по протоколу HTTPS
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24
`401`	`ACCESS_DENIED` REST is available only on commercial plans	REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом
`404`	`ERROR_METHOD_NOT_FOUND` Method not found!	Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на `provided by the access token`
`401`	`expired_token` The access token provided has expired	Срок действия access-токена истек
`401`	`user_access_error` The user does not have access to the application	Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям
`403`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

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

Обзор методов

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

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

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

Что приходит в обработчикЧто приходит в обработчик

Объект propertiesОбъект properties

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

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

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

Возможные коды ошибокВозможные коды ошибок

Статусы и коды системных ошибокСтатусы и коды системных ошибок

Продолжите изучениеПродолжите изучение