Registration

Miscellaneous

API response codes

List of possible SMS message statuses

URL-encoded string

API response codes

CodeTypeDescription
0integerThe operation completed successfully.
1integerTransmitted data validation error while creating or updating of any entity. The data field provides information on the fields incorrectly filled. Please correct mistakes and repeat the request with a new data.
2integerRequested entry was not found. It is likely to be deleted, the entry ID is incorrect or the user trying to access the entry does not have the appropriate access rights to it.
3integerUnidentified application error occurred. Please contact the support team and let us know the details of the request for which it was received.
4integerParameter "module" is incorrect. Please check the spelling accuracy in the API documentation.
5integerParameter "method" is incorrect. Please check the spelling accuracy in the API documentation.
6integerParameter "format" is incorrect. Please check the spelling accuracy in the API documentation.
8integerLogin failed. Error occurs if: 1. Login details are incorrect. 2. When a user session has expired during the system operation or was forcibly closed by the server. For the detailed information see "message" field.
9integerRequired method access error.
10integerServer saving data error directly during this operation. Usually this error is related to simultaneous data access from several clients or changes in the conditions for data saving in the process of saving.
11integerSome of the required parameters are missing in the request. Please check the spelling accuracy in the API documentation and add the required parameters to your request.
12integerThe input parameter of the request does not comply with the specified conditions or restrictions. This error code occurs when a parameter violates restrictions when executing a request with parameters. It looks like an attribute validation error but can be received in requests not aimed at creation or modification of data.
13integerAn attempt to request the API-server that does not serve this user. Should you receive this code, look for the correct domain in the "data" field.
14integerThis error occurs if the user account was blocked or removed.
15integerError occurred while performing of any operation not related to updating of data. Details of this error are listed in the "message" field of the API response.
30integerExcess of permissible operations limit error within a specific time interval. This error occurs due to excessively frequent requests to the same API method. In case it occurs, reduce the frequency of requests.
98integerThe operation was not performed in full, but with part of the data. Usually, you get this code for any bulk operations, during the execution of which some elements were not processed due to errors or restrictions, but others were processed. Upon receipt of this code, you can check the information on processed and non-processed elements and look for the errors in the contents of the "data" field.
99integerNone of the bulk operation elements was not processed. For the detailed information on errors in each specific element check the "data" field, for the general description of the error - the "message" field.
100integerThis code is not an error and means that the operation is executed as a background process. In this case "data" field contains the background process ID, the state of which can be checked using method Taskqueue::GetStatus.
999integerGeneral error. For details check the "message" field.

List of possible SMS message statuses

StatusFinalDescription
NEWnoNew message, not yet sent
ENQUEUDnoPassed the moderation and queued for sending
ACCEPTDnoSent from the system and accepted by the operator for further sending to the recipient
UNDELIVyesNot delivered to the recipient
REJECTDyesDeclined by the operator on one of a variety of reasons - the wrong recipient's number, forbidden text, etc.
PDLIVRDnoNot all message segments were delivered to the recipient (this status applies to messages only, but not to segments). Some operators return a delivery report only for the first segment of long message, that's why status of such messages will be changed to DELIVRD after the expiration period
DELIVRDyesDelivered to the recipient in full
EXPIREDyesDelivery failed because the message has expired (3 days by default)
DELETEDyesDeleted due to restrictions and not delivered to the recipient

URL-encoded string

Every server language has some kind of function, returning the string, in which all non-alphanumeric characters except -_. have been replaced with a percent (%) sign followed by two hex digits and spaces encoded as plus (+) signs. It is encoded the same way that the posted data from a web-form, that is the same way as in application/x-www-form-urlencoded media type. This differs from the RFC 3986 encoding that for historical reasons, spaces are encoded as a plus (+) sign.

PHP

In PHP it is represented by urlencode function.

Miscellaneous