| 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).
|
|---|
| user | Login subclient.
|
|---|
| pswc | Current password subclient.
|
|---|
| password | The new password of the sub-client. The length must be at least 8 characters, and 3 of the conditions must be met: letters, numbers, different case, symbols.
|
|---|
| sum | The amount transferred to the client from the main account in the currency of the main account.
|
|---|
| balance2 | Flag that sets the possibility of using the electronic balance for deposits, debits, and receiving statistics on messages.
|
|---|
| site_id | The site ID that will own the created subclient.
|
|---|
| new_login | New login subclient when you change.
|
|---|
| type | Account Type.
0 (default) - independent tariff and balance.
1 – main account tariff, independent balance.
2 – tariff and balance of the main account.
3 – main account balance, independent pricing plan.
4 – additional login of the main account.
|
|---|
| email | Primary Email Address.
|
|---|
| fl[9] | A flag that sets the possibility of sending incoming SMS to e-mail.
|
|---|
| email2 | Alternative email address for sending incoming SMS.
|
|---|
| phone | Main phone number.
|
|---|
| fl[8] | A flag that sets the possibility of sending incoming SMS to the phone.
|
|---|
| phone2 | Alternative phone number for sending incoming SMS.
|
|---|
| start | The start date in the period for which statistics are requested. Format: 'dd.mm.yyyy'.
|
|---|
| end | The end date in the period. If omitted, data from the start date is returned. Format: 'dd.mm.yyyy'.
|
|---|
| user_id | The ID of the subclient that is assigned automatically by the server when creating.
|
|---|
| reseller | Types of subclient.
0 or missing – sub-clients using the balance of the main account.
1 – the subclient with independent balance.
|
|---|
| hide_deleted | To hide the statistics on the remote subclient.
0 or missing – output statistics for all sub-clients.
1 – to hide the statistics on the remote subclient.
|
|---|
| mycur | A flag that allows you to display statistics in the currency of the main account.
|
|---|
| fio | Initials (last name, first name, patronymic) or company name.
|
|---|
| props | The "Other details" field of the sub-client.
|
|---|
| cntr | Contract.
|
|---|
| tariff | The current tariff plan. The subclient, you can set data plan is higher tariff plan of the Client. The parameter can take the following values:
0 (default) - 1 tariff (from 1 p.).
1 – 2 tariff (from 1000 to p.).
...
8 – 9 tariff (from 100000 to p.).
|
|---|
| mintrf | The minimum fare. Determines the minimum value of the rate subclient regardless of the amount of the payment.
|
|---|
| curr | The currency of the sub-client's calculations. Used in the add and chg commands. It can take the following basic values:
1 – russian rouble;
2 – uS dollar (USD);
3 – euro;
4 – ukraine hryvnia;
5 – kazakhstan tenge.
|
|---|
| tz | The time zone. The Client's time zone is set by default. Possible values:
0 – GMT-12.
...
12 – GMT+00
...
24 – GMT+12.
|
|---|
| sender | Default Sender name (Sender ID) .
|
|---|
| sender2 | Sender's Backup name.
|
|---|
| fl[29] | A flag that determines whether the Client's list of senders can be used (main Account).
|
|---|
| fl2[9] | A flag that allows the use of more expensive routes for guaranteed message delivery.
|
|---|
| fl2[24] | A flag that allows you to send first via cheap routes, and repeat through expensive ones if not delivered (except for mass messaging).
|
|---|
| fl2[12] | The flag prohibits sending messages with automatic replacement of the sender's name.
|
|---|
| fl2[13] | The flag disables adding the sender's name to the message text without increasing the cost in case of autocorrect.
|
|---|
| nb | Balance for notifications. Upon reaching the specified amount will be sent a notification e-mail subclient.
|
|---|
| ktm | This parameter sets the number of days for storing sent messages, after which SMS messages will be automatically deleted from the history.
|
|---|
| fmts | A list of phone codes that you can send messages to.
|
|---|
| notes | Comments the main account. Not available for the subclient.
|
|---|
| fl2[23] | Prohibition of mass and advertising mailings.
|
|---|
| fl[26] | Permission to use the contact list of the main account.
|
|---|
| fl2[8] | The flag that sets the advanced mode of the personal account.
|
|---|
| fl[16] | Enable answering machine recognition when making calls.
|
|---|
| fl2[31] | Allow the use of master account templates.
|
|---|
| Additional parameters for configuring access to the service
|
|---|
| fl3[20] | Flag that allows you to disable confirmation of access from new IP addresses when logging in.
|
|---|
| ph | A comma-separated list of phone numbers or group numbers for sending SMS messages.
|
|---|
| fl[27] | Prevent changes to the settings of the subclient.
|
|---|
| fl[28] | Prohibit subaccount payments.
|
|---|
| fl[6] | Prohibit mailing lists.
|
|---|
| fl2[1] | To hide messages for subclient.
|
|---|
| fl2[10] | Block a subaccount.
|
|---|
| Additional parameters for limits and restrictions
|
|---|
| dlim | The total SMS limit per day. Defines the maximum number of messages sent per day.
|
|---|
| plim | The limit for one number. Sets the maximum number of messages sent per day to one phone number.
|
|---|
| tlim | The limit on the number and text. Sets the maximum number of messages sent per day with one text per phone number.
|
|---|
| ilim | The limit per IP address. Sets the maximum number of messages sent per day from a single IP address.
|
|---|
| tmlim | The time range in hours h1-h2 in which messages are allowed to be sent. If the current time is less than h1, then an SMS message will be sent to the subscriber when the time h1 arrives, if the current time falls within the range from h1 to h2, then the message will be sent immediately, in another case, the sending will be performed the next day when the time h1 is reached. This function, for example, is useful in order to prevent subscribers from receiving SMS messages at night.
|
|---|
| fl2[15] | Prevent sending at a time other than the one specified in the tmlim parameter, instead of rescheduling to the next day.
|
|---|
| fl2[16] | When using the tmlim parameter, consider the subscribers ' time zone.
|
|---|
| vld | The maximum delivery time of messages to temporarily unavailable subscribers (min.).
|
|---|
| Additional parameters for autoresponders
|
|---|
| answ | Auto-reply to incoming SMS messages.
|
|---|
| answ_call | Auto-reply to incoming calls.
|
|---|
| fl2[4] | Disable call forwarding (by e-mail, phone and handler).
|
|---|
| Additional parameters for API settings
|
|---|
| url | http address (URL) of the script to handle delivery status of SMS messages and (or) incoming SMS messages on the side of the subclient. The specified script will be invoked by the Server after each receiving a delivery status of a previously submitted a subclient SMS messages and (or) of receiving an incoming SMS message from the subscriber.
|
|---|
| fl[10] | Enabling forwarding of message statuses to the http address specified in the url parameter.
|
|---|
| fl[11] | Enabling forwarding of incoming SMS messages to the http address set in the url parameter.
|
|---|
| fl[2] | Enable SMPP access (you must first register an IP address through ONLINE support).
|
|---|
| fl[1] | Transfer incoming SMSes via SMPP connection.
|
|---|
| fl[23] | Track the status of certain SMS parts.
|
|---|
| fl2[27] | Test mode (virtual sending without payment).
|
|---|
| fl[5] | Enable control over the delivery of messages.
|
|---|
| fl[30] | Enabling the API log. Allows you to view the 20 of recent http requests. Stored 10 minutes after the last request.
|
|---|
| Additional parameters for E-mail2sms
|
|---|
| mfl[0] | Flag that allows you to disable the e-mail2sms function.
|
|---|
| mph | Comma-separated list of phone numbers to which messages will be sent.
|
|---|
| mfl[5] | Enables the ability to specify a list of phone numbers in the body of the letter.
|
|---|
| mfl[6] | Enables the ability to specify a list of phone numbers in the email address.
|
|---|
| mfl[1] | Forwarding an email without a subject.
|
|---|
| mfl[2] | Forwarding a message without text.
|
|---|
| mfl[3] | Forwarding a message without a return address (from whom).
|
|---|
| mfl[4] | Translating the text of the letter into transliteration.
|
|---|
| mh1 | The initial value of the time range for sending incoming emails. Together with the mh2 parameter, it defines the range within which incoming messages can be forwarded as SMS messages..
|
|---|
| mh2 | The final value of the time range for sending incoming emails.
|
|---|
| mlen | The maximum message length to which an incoming message is truncated when sent as an SMS message (a number greater than 12 specifies the maximum length of a message,a number less than 12 - the number of SMSes).
|
|---|
List of available operations
