Developer Docs
Method for submitting an application for registration of the SMS Sender’s name (Alpha-name) with a mobile operator by a subject individual.
Please note that Sender registration is not available in Demo and Test account modes.
To submit SMS Sender registration by an individual, make a request to this URL:
POST http://one-api.bsg.world/api/senders/requests/natural |
Parameter | Required | Type | Default | Description |
country_code | Yes | string | No | The country where it is necessary to register the Sender name. Must be specified according to the ISO 3166-1 Alpha-2 standard |
type | Yes | string | No | Service for which the Sender is registered. Available values: sms |
sender | Yes | string | No | Sender name. Up to 11 Latin letters or digits, up to 15 – only digits. |
name | Yes | string | No | Last name, first name, and middle name. From 1 to 100 characters. |
code_of_company | Yes | string | No | Company code. Numeric value between 1 and 30 characters. |
description | Yes | string | No | Service description. From 1 to 1 000 characters. |
informing_purpose | Yes | string | No | Purpose of informing. From 1 to 1 000 characters. |
site_url | No | string | No | Website URL. Up to 150 characters. |
comment | No | string | No | Comment. Up to 1 000 characters. |
{
"country_code": "UA",
"type": "sms",
"sender": "sender",
"name": "FullName",
"code_of_company": "string",
"description": "desc",
"informing_purpose": "inf",
"site_url": "https://dev-app.bsg.world/",
"comment": "comm"
}
Parameter | Type | Description |
id | integer | Number of the application for Sender registration |
name | string | Last name, first name, and middle name |
status | string | Status of the application for registration |
type | string | Sender type: sms |
country_code | string | Sender country – country code according to ISO 3166-1 Alpha-2 standard |
sender | string | Sender name |
code_of_company | string | Company code |
site_url | string | Website URL |
informing-purpose | string | Purpose of informing |
comment | string | Comment |
description | string | Service description |
if the request is successful, you will receive a response:
{
"data": {
"id": 3152,
"name": "name",
"status": "new",
"type": "sms",
"created_at": "2021-04-27 19:44:06",
"country_code": "UA",
"sender": "sender",
"code_of_company": "string",
"site_url": "https://dev-app.bsg.world",
"informing_purpose": "informing_purpose",
"comment": "comment",
"description": "description"
}
}