Developer Docs

Table of contents

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.

To submit SMS Sender registration by an individual, make a request to this URL:

POST  http://one-api.bsg.world/api/senders/requests/natural

Request parameters:

ParameterRequiredTypeDefaultDescription
country_codeYesstringNoThe country where it is necessary to register the Sender name. 
Must be specified according to the ISO 3166-1 Alpha-2 standard
typeYesstringNoService for which the Sender is registered.
Available values: sms
senderYesstringNoSender name. 
Up to 11 Latin letters or digits, up to 15 – only digits.
nameYesstringNoLast name, first name, and middle name. From 1 to 100 characters.
code_of_companyYesstringNoCompany code. Numeric value between 1 and 30 characters.
descriptionYesstringNoService description.
From 1 to 1 000 characters. 
informing_purposeYesstringNoPurpose of informing.
From 1 to 1 000 characters.
site_urlNostringNoWebsite URL. 
Up to 150 characters.
commentNostringNoComment.
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:

ParameterTypeDescription
idintegerNumber of the application for Sender registration
namestringLast name, first name, and middle name
statusstringStatus of the application for registration
typestringSender type: sms
country_codestringSender country – country code according to ISO 3166-1 Alpha-2 standard
senderstringSender name
code_of_companystringCompany code
site_urlstringWebsite URL
informing-purposestringPurpose of informing
commentstringComment
descriptionstringService 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"
  }
}