# messageservice.sender.add

URL: https://chugunov.pro/api-bitrix24/messageservice/messageservice-sender-add/
Проверено на Битрикс24 REST API, обновлено 11.09.2026 (ревизия источника fb39d6c).
Источник: официальная документация Битрикс24 (bitrix-tools/b24-rest-docs, лицензия MIT, © Bitrix). Справочник независимый, официальной документацией не является.

Зарегистрировать СМС-провайдер или провайдер сообщений
Scope: `messageservice`
Кто может выполнять метод: администратор

## Описание

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

Метод работает только в контексте [приложения](https://apidocs.bitrix24.ru/settings/app-installation/index.html).

## Параметры

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

## Ответ

HTTP-статус: 200

```json
{
    "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

```json
{
    "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`. Метод вызван вне контекста приложения

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

### cURL (OAuth)

```bash
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
```

### JS (TS)

```ts
// 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)
}
```

### JS (UMD)

```html
<!-- 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>
```

### Python

```python
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}")
```

### PHP

```php
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.js

```js
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());
        }
    }
);
```

### PHP CRest

```php
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>';
```

### Go

```go
// 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)
```

Оригинал в официальной документации: https://apidocs.bitrix24.ru/api-reference/messageservice/messageservice-sender-add.html