1. SMS Sender registration by an individual
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.
Request URL
|
POST http://one-api.bsg.world/api/senders/requests/natural |
Request parameters
|
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. |
Request sample
|
{ "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" } |
Response parameters
|
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 |
Response sample
Response to successful request:
|
{ "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" } } |
2. SMS Sender registration by a legal entity
Method for submitting an application for registration of the SMS Sender's name (Alpha-name) with a mobile operator by a subject legal entity.
Please note that Sender registration is not available in Demo and Test account modes.
Request URL
|
POST http://one-api.bsg.world/api/senders/requests/legal |
Request parameters
|
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. |
|
sender |
Yes |
string |
No |
Sender name. Up to 11 Latin letters or digits, up to 15 - only digits. |
|
type |
Yes |
string |
No |
Service for which the Sender is registered. Available values: sms |
|
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. |
|
legal_name |
Yes |
string |
No |
Legal name. From 3 to 100 characters. |
|
address |
Yes |
string |
No |
Legal address. From 3 to 200 characters. |
|
tax_number |
Yes |
string |
No |
Taxpayer number. From 1 to 20 characters. |
Request sample
|
{ "country_code": "UA", "type": "sms", "sender": "sender", "code_of_company": "string", "tax_number": "string", "description": "desc", "informing_purpose": "inf", "site_url": "https://dev-app.bsg.world/", "comment": "comm", "legal_name": "juridical_name", "address": "juridical_address" } |
Response parameters
|
Parameter |
Type |
Description |
|
id |
integer |
Number of the application for Sender registration |
|
sender |
string |
Sender name |
|
name |
string |
Last name, first name, and middle name |
|
address |
string |
Legal address |
|
status |
string |
Status of the application for Sender registration. Possible values:
|
|
type |
string |
Sender type: sms |
|
created_at |
string |
Date of creating the application for Sender registration. Format: yyyy-mm-dd hh:mm:ss |
|
country_code |
string |
Sender country - country code according to ISO 3166-1 Alpha-2 standard |
|
code_of_company |
string |
Company code |
|
tax_number |
string |
Taxpayer number |
|
site_url |
string |
Website URL |
|
informing_purpose |
string |
Purpose of informing |
|
comment |
string |
Comment |
|
description |
string |
Service description |
Response sample
Response to successful request:
|
{ "data": { "id": 3152, "sender": "sender", "legal_name": "juridical_name", "address": "juridical_address", "status": "new", "type": "sms", "created_at": "2021-04-27 19:44:06", "country_code": "UA", "code_of_company": "string", "tax_number": "string", "site_url": "https://dev-app.bsg.world", "informing_purpose": "informing_purpose", "comment": "comment", "description": "description" } } |
3. Get applications for SMS Senders registration
Method allows:
- getting a list of all created applications for Sender registration for the SMS service
- getting applications for SMS Sender registration satisfying the given input parameters.
Request URL
|
GET http://one-api.bsg.world/api/senders/requests/sms |
Request parameters
|
Parameter |
Required |
Type |
Default |
Description |
|
page[offset] |
No |
integer |
0 |
Get the Sender registration applications starting from offset |
|
page[limit] |
No |
integer |
50 |
Number of applications in the response |
|
sort |
No |
string |
id |
Sort by conditions: id, sender, status, country_code, created at |
|
way |
No |
string |
asc |
Sorting options: asc, desc |
|
filter[status] |
No |
string |
no |
Filter for receiving applications in the selected status:
|
|
filter[id] |
No |
integer |
no |
Filter for getting an application by its identifier |
|
filter[country_code] |
No |
string |
no |
Filter for getting applications by their Sender registration country. Format according to ISO 3166-1 standard. |
|
filter[sender] |
No |
string |
no |
Filter for getting applications by their Sender SMS Sender name. Up to 15 characters. |
|
filter[created_at] |
No |
string |
null |
Filter to receive applications for the specified date of the application for registration, yyyy-mm-dd |
Response parameters
|
Parameter |
Type |
Description |
|
|
id |
integer |
Application for Seder registration ID |
|
|
sender |
string |
SMS Sender name |
|
|
status |
string |
Application status |
|
|
created_at |
string |
Date and time of creating the application for Sender registration. Format ISO 8601: yyyy-mm-dd hh:mm:ss |
|
|
registered_at |
string|null |
Sender registration date |
|
|
status_changed_at |
string|null |
Date and time when the status of the application for Sender registration changed. Format ISO 8601: yyyy-mm-dd hh:mm:ss |
|
|
country_code |
string |
Sender country, according to ISO 3166-1 Alpha-2 standard |
|
|
code_of_company |
string |
Company code |
|
|
tax_number |
string |
Legal entity ID |
|
|
type |
string |
Sender type: sms |
|
|
site_url |
string|null |
Company URL |
|
|
name |
string|null |
Last name, first name, and middle name |
|
|
legal_name |
string|null |
Legal entity name |
|
|
address |
string|null |
Legal entity address |
|
|
informing_purpose |
string|null |
Purpose of informing |
|
|
comment |
string|null |
Comment |
|
|
rejection_reason |
string|null |
Reason for rejecting the application for Sender registration. Displayed only for the “rejected” application status. |
|
|
description |
string|null |
Service description |
|
Response sample
If the request is successful, you will receive a response:
|
{ "data": [ { "id": 3152, "sender": "sender", "status": "new", "created_at": "2021-04-27 19:44:06", "registered_at": "2021-04-27 19:44:06", "status_changed_at": "2021-04-27 19:44:06", "country_code": "UA", "code_of_company": "123123123", "tax_number": "123123123", "type": "sms", "site_url": "https://dev-app.bsg.world", "name": "name", "legal_name": "juridical_name", "address": "juridical_address", "informing_purpose": "informing_purpose", "comment": "comment", "rejection_reason": "rejection_reason", "description": "description" } ], "meta": { "page": { "total": 1, "offset": 20, "limit": 40 } } } |
Comments
0 comments
Article is closed for comments.