The method allows sending an SMS to the contacts list from the Contact Book. The campaign can contain personalized data from the contact fields in the text of the message for each contact.
It is possible to specify no more than 10 000 contacts for one campaign.
Limitation:
To send SMS to Contacts list, make a request to this URL::
| POST http://one-api.bsg.world/api/campaigns/sms/send-groups |
| Parameter | Required | Type | Default | Description |
|---|---|---|---|---|
| groups[] | Yes | array <int> | No | An array of lists with contacts from the address book. The ID of the list with the contacts to which the SMS should be sent. |
| sender | Yes | string | No |
SMS Sender name:
|
| text | Yes | string | No |
Message text.
To substitute personalized data of the recipient in the text of the message, you must specify the identifier(s) of the contact field(s) in the form {field_id}. Maximum number of characters for a message text:
|
| validity | No | integer | 72 |
SMS validity period in hours.
Integer from 1 to 72. By default 72 hours. |
| tariff_code | No | integer | 0 | Number of tariff at which the campaign messages will be billed. You can only specify the tariff connected to your account. The parameter format is an integer from 0 to 9. The default is 0. |
| start_at | No | string | now | Date and time of the message sending in ISO 8601 format: yyyy-mm-dd hh:mm:ss. Used only to schedule campaigns for a specific time. Maximum date for scheduling is 30 days. If not specified by the user, the value is set to now (campaign without delay). |
{
"groups": [
1
],
"sender": "string",
"text": "string",
"tariff_code": 0,
"validity": 72,
"start_at": "2025-01-25 09:00:00"
}
| Parameter | Type | Description | |
|---|---|---|---|
| id | integer | Created campaign ID | |
| name | string | Campaign name: auto-generated for the created campaign | |
| sender | string | Sender name | |
| status | string |
Campaign status. Possible values:
| |
| mesage_type | string | Campaign type: sms | |
| start_at | string | Date and time of the campaign start (scheduled). Format ISO 8601: yyyy-mm-dd hh:mm:ss | |
| real_start_at | string | Actual date and time the campaign started. Format ISO 8601: yyyy-mm-dd hh:mm:ss | |
| finished_at | string | Date and time the campaign is completed. Format ISO 8601: yyyy-mm-dd hh:mm:ss | |
| created_at | string | Date and time the campaign is created. Format ISO 8601: yyyy-mm-dd hh:mm:ss | |
| statistics | array | Campaign statistics: | |
| delivered | integer | Total number of messages delivered within the campaign | |
| sent | integer | Total number of messages sent within the campaign |
If the request is successful, you will receive a response:
{
"data": {
"id": 1,
"name": "string",
"sender": "string",
"status": "creation",
"message_type": "sms",
"start_at": "2021-04-27 19:44:06",
"real_start_at": "2021-04-27 19:44:06",
"finished_at": "2021-04-27 19:44:06",
"created_at": "2021-04-27 19:44:06",
"statistics": {
"delivered": 0,
"sent": 0
}
}
}
30% of SMS fail — not because of content, but numbers. Verify before you send.
The start of the school year: when parents trade in their summer margaritas for the
Talking to customers these days is more than just emails or phone calls. Businesses need
