/api/v1/sendBulkSms
Send message(s) to multiple lists, as well as personal messages in batch mode
Request URL
POST https://app.sms.by/api/v1/sendBulkSms
If you need to send 1 message to a list of numbers, then use the parameter 'message_type': 'bulk', as in the example below, passing an array of numbers:
If you need to send each message to a separate phone number, then use 'message_type': 'personal', transmitting each time the text of the message and the phone number:
To schedule a mailing, you can specify the mailing time via the parameter schedule_time, in format YYYY-MM-DDTHH:mm:ss
Sample api request
'delivery_list': [ '375297777777', '375295555555', ]
If you need to send each message to a separate phone number, then use 'message_type': 'personal', transmitting each time the text of the message and the phone number:
'delivery_list': [
{
'phone': '375299999999',
'text': 'personal message 1'
},To schedule a mailing, you can specify the mailing time via the parameter schedule_time, in format YYYY-MM-DDTHH:mm:ss
Sample api request
{
'token': 'eyJpdiI6IjJzOFlFcXBmOUZEcGJlYzlzeFJValE9PSIsInZhbHV...',
'callback_url': '',
'messages': [
{
'alphaname_id': '123',
'name': 'mailing list 1',
'message_type': 'personal',
'schedule_time': '2024-12-31T23:59:59',
'delivery_list': [
{
'phone': '375299999999',
'text': 'personal message 1'
},
{
'phone': '375298888888',
'text': 'personal message 2'
}
]
},
{
'alphaname_id': '234',
'name': 'mailing list 2',
'message_type': 'bulk',
'text': 'message text 2',
'schedule_time': '2024-12-31T23:59:59',
'delivery_list': [
'375297777777',
'375295555555',
]
}
]
}Parameters
| Parameter | Location | Type | Required | Description |
|---|---|---|---|---|
| token | query | string | Yes | Your API key |
| callback_url | query | string | Yes | URL to which the response will be sent when the method is running in asynchronous mode |
| messages | query | array | Yes | Message Array (Sample Request Description) |
Responses
200 — Completed successfully
{
"uuid": "cc9c8043-8caf-11ef-b035-9e8f47954dec",
"success": "OK"
}