Register an SMS Provider or Message Provider messageservice.sender.add
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
messageserviceWho 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 |
Description |
|
CODE* |
Provider code. Allowed characters: |
|
TYPE* |
Provider type. Supported value: |
|
HANDLER* |
Application handler URL that is called when sending a message. The data that comes to the handler is described below |
|
NAME* |
Provider name. Can be a string or an associative array of localized strings like:
|
|
DESCRIPTION |
Provider description. Can be a string or an associative array of localized strings like:
|
What Comes to the Handler
|
Name |
Description |
|
module_id |
Module from which the message was sent. Possible values:
|
|
bindings |
Array of message bindings to CRM entities. Parameter comes if |
|
workflow_id |
Workflow identifier. Parameter comes if |
|
document_id |
Identifier of the workflow document. Parameter comes if |
|
document_type |
Type of the workflow document. Parameter comes if |
|
properties |
Object with message parameters |
|
type |
Provider type. Possible value: |
|
code |
Provider code |
|
message_id |
Unique message identifier. Use it in the messageservice.message.status.update method to update the message status |
|
message_to |
Recipient's message number |
|
message_body |
Message text |
|
ts |
Time of the request in Unix Timestamp format |
|
auth |
Application authorization data |
Properties Object
|
Name |
Description |
|
phone_number |
Recipient's message number |
|
message_text |
Message text |
Code Examples
How to Use Examples in Documentation
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
// 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 error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected 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>';
// client and ctx are already created — see the Go SDK section
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": "Main SMS provider",
})
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("parse response: %w", err)
}
fmt.Println("done:", ok)
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 |
Description |
|
result |
|
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400, 403
{
"error": "ERROR_SENDER_VALIDATION_FAILURE",
"error_description": "Empty sender code!"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
Value |
|
|
|
Empty parameter set |
|
|
|
Required parameter |
|
|
|
|
|
|
|
Required parameter |
|
|
|
Required parameter |
|
|
|
Unsupported |
|
|
|
A provider with this |
|
|
|
Error saving the provider |
|
|
|
Method was invoked by a non-administrator |
|
|
|
Method called outside of application context |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it 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
- Register an SMS Provider or Message Provider messageservice.sender.add
- Update Message Provider messageservice.sender.update
- Get a List of SMS Providers or Message Providers messageservice.sender.list
- Delete SMS Provider or Message Provider messageservice.sender.delete
- Update Message Delivery Status messageservice.message.status.update