Register an SMS Provider or Message Provider messageservice.sender.add

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Scope: messageservice

Who can execute the method: administrator

The method messageservice.sender.add registers a new message provider.

This method works only in the context of an application.

Method Parameters

Required parameters are marked with *

Name `type`	Description
CODE* `string`	Provider code. Allowed characters: `a-z`, `A-Z`, `0-9`, `.`, `-`, `_`
TYPE* `string`	Provider type. Supported value: `SMS`
HANDLER* `string`	Application handler URL that is called when sending a message. The data that comes to the handler is described below
NAME* `string` \| `object`	Provider name. Can be a string or an associative array of localized strings like: `'NAME': { 'de': 'Anbietername', 'en': 'provider name', ... },`
DESCRIPTION `string` \| `object`	Provider description. Can be a string or an associative array of localized strings like: `'DESCRIPTION': { 'de': 'Anbieterbeschreibung', 'en': 'provider description', ... },`

What Comes to the Handler

Name `type`	Description
module_id `string`	Module from which the message was sent. Possible values: `crm` — message sent from the CRM card `bizproc` — message sent from Workflows or a CRM automation rule
bindings `array`	Array of message bindings to CRM entities. Parameter comes if `module_id` equals `crm`
workflow_id `string`	Workflow identifier. Parameter comes if `module_id` equals `bizproc`
document_id `array`	Identifier of the workflow document. Parameter comes if `module_id` equals `bizproc`
document_type `array`	Type of the workflow document. Parameter comes if `module_id` equals `bizproc`
properties `object`	Object with message parameters
type `string`	Provider type. Possible value: `SMS`
code `string`	Provider code
message_id `string`	Unique message identifier. Use it in the messageservice.message.status.update method to update the message status
message_to `string`	Recipient's message number
message_body `string`	Message text
ts `integer`	Time of the request in Unix Timestamp format
auth `object`	Application authorization data

Properties Object

Name `type`	Description
phone_number `string`	Recipient's message number
message_text `string`	Message text

Code Examples

How to Use Examples in Documentation

cURL (OAuth)

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":"Main SMS provider","auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/messageservice.sender.add

try
        {
            const response = await $b24.callMethod(
                'messageservice.sender.add',
                {
                    CODE: 'provider1',
                    TYPE: 'SMS',
                    HANDLER: 'https://provider.example/api/handler',
                    NAME: 'Provider 1',
                    DESCRIPTION: 'Main SMS provider'
                }
            );
        
            const result = response.getData().result;
            console.log(result);
        }
        catch (error)
        {
            console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'messageservice.sender.add',
                    [
                        'CODE' => 'provider1',
                        'TYPE' => 'SMS',
                        'HANDLER' => 'https://provider.example/api/handler',
                        'NAME' => 'Provider 1',
                        'DESCRIPTION' => 'Main SMS provider',
                    ]
                );
        
            $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: 'Main SMS provider'
            },
            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' => 'Main SMS provider',
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

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

Returned Data

Name `type`	Description
result `boolean`	`true` if the provider was successfully registered
time `time`	Information about the request execution time

Error Handling

HTTP status: 400, 403

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

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code	Description	Value
`ERROR_SENDER_VALIDATION_FAILURE`	`Empty data!`	Empty parameter set
`ERROR_SENDER_VALIDATION_FAILURE`	`Empty sender code!`	Required parameter `CODE` not provided
`ERROR_SENDER_VALIDATION_FAILURE`	`Wrong sender code!`	`CODE` contains invalid characters
`ERROR_SENDER_VALIDATION_FAILURE`	`Empty sender NAME!`	Required parameter `NAME` not provided
`ERROR_SENDER_VALIDATION_FAILURE`	`Empty sender message TYPE!`	Required parameter `TYPE` not provided
`ERROR_SENDER_VALIDATION_FAILURE`	`Unknown sender message TYPE!`	Unsupported `TYPE` provided (only `SMS` is allowed)
`ERROR_SENDER_ALREADY_INSTALLED`	`Sender already installed!`	A provider with this `CODE` is already registered for the current application
`ERROR_SENDER_ADD_FAILURE`	`Sender save error!`	Error saving the provider
`ACCESS_DENIED`	`Access denied!`	Method was invoked by a non-administrator
`ACCESS_DENIED`	`Application context required`	Method called outside of application context

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not permitted for calls using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The HTTPS protocol is required for method calls
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is only available on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user associated with the access token or webhook used to call the method lacks the necessary permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Overview of Methods

Update Provider

Register an SMS Provider or Message Provider messageservice.sender.add

Method ParametersMethod Parameters

What Comes to the HandlerWhat Comes to the Handler

Properties ObjectProperties Object

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning