| Option | The value
|
|---|
| login | Customer Login.
|
|---|
| psw | Client Password (you can add or change it on this page).
|
|---|
| apikey | A special API key used for simplified authorization instead of the "login+password" pair (you can create it on this page).
|
|---|
| all | 0 (default) - get a list of activated sender names.
1 – get a complete list of sender names.
|
|---|
| sender | The sender name that is being created or deleted.
|
|---|
| mts_step | 1 – register a paid name with the MTS operator.
|
|---|
| sber_step | 1 – register a free name with a Sberbank Mobile operator.
|
|---|
| tele2 | 1 – register a name with the Tele2 operator at the tariff with free names.
|
|---|
| motiv | 1 – register a name with the MOTIF operator according to the tariff with free names.
|
|---|
| mega_step | 1 – register a paid name with the Megafon operator.
|
|---|
| bee_step | 1 – register a paid name with the Beeline operator.
|
|---|
| motiv_step | 1 – register a paid name with the MOTIV operator.
|
|---|
| winmob_step | 1 – register a paid name with the Win-Mobile operator.
|
|---|
| volnamob_step | 1 – register a paid name with the Wave mobile operator.
|
|---|
| tele2_step | 1 – register a paid name with a Tele2 operator.
|
|---|
| ua_reg | 1 – to register a name for Ukraine at a reduced rate of national traffic.
For this tariff, you must additionally pass the following parameters:
fio – Legal name of the organization (LLC/SPD).
inn – EDRPOU/INN.
site – Website address or link to a social network.
email – E-mail for communication.
address – Actual address.
desc – Description of the services provided by the sender.
subj – Subject (purpose of informing).
|
|---|
| ua_int | 1 – register a name for Ukraine at a higher rate for international traffic. To register, you also need to additionally pass the fields described above for the ua_reg parameter.
|
|---|
| by_reg | 1 – register a name for Belarus for a reduced national traffic tariff.
For this tariff, you must additionally pass the following parameters:
by_fio – Company Name.
by_inn – UNP / INN.
by_address – Company address.
by_ocup is the field of activity (options can be specified on this page). Numbering from 1 to 19.
by_type – The type of mailing list (options can be specified on this page). Numbering from 1 to 3.
by_mes – Sample message.
by_site – Site address.
|
|---|
| by_int | 1 – register a name for Belarus at a higher rate for international traffic. To register, you also need to additionally pass the fields described above for the by_reg parameter.
|
|---|
| id | ID of the sender's name, assigned by the Server
automatically when creating a new name.
|
|---|
| cmt | Comment specified when creating the sender name.
|
|---|
| mail | 1 – add the sender's e-mail address.
|
|---|
| name | A comment related to the mail parameter (usually the name of the owner of the e-mail address).
|
|---|
| code | Code for confirming the sender's digital name.
|
|---|
| site | The address of the site from which the codes will be sent to confirm the digital
names of the senders. This parameter must have been previously added and activated as
Sender ID. If omitted, messages will be sent as the sender
by default.
|
|---|
| site_name | The site address specified in the text of the message with the confirmation code.
|
|---|
| user | The user ID of the subclient to which you apply the specified command.
|
|---|
| operators | 1 – add the status code of the sender's name from the operator to the response.
|
|---|
| from_date | Select the names of senders starting from the specified date, for which the name status of any of the operators has been changed.
When this parameter is specified, the names are sorted in descending order of the date when the name statuses were changed. DD.MM.YYYY format.
|
|---|
| prev_id | A unique identifier of the sender's name that is assigned by the Server automatically when the name is created. Used to request a list of names created before the name with the specified ID.
|
|---|
| cnt | The number of sender names returned when requesting a list of names. The maximum value is 15000.
|
|---|
| doc_info | If a document file for operators is passed in the request body when creating or changing the sender's name, then you can specify a description for the passed file in this parameter.
|
|---|
| charset | Encoding of transmitted parameters.
|
|---|
| files | 1 – return in the server response for the get command an array of files containing information about attached document files for operators. This parameter is relevant only for fmt=2 or fmt=3 formats.
The array includes the following fields:
file – File name.
fid – ID of the file in the system.
fstatus – File status (0 - under review, 1 - rejected, 2 - approved).
fcomment – Administrator's comment.
|
|---|
Description of parameters
