API - information

Wstecz

 

Definitions

In order to facilitate communication we have adopted certain definitions; you can find them below.

 

Information message

It is information with the same content sent to one or many recipients.

 

Message

This is the content of the information which gets to one or many recipients. A message can consist of one or more text messages.

 

Text message/SMS

It is a part of a message. A message can consist of one or more SMSs; the number of text messages depends on the length of the message. There is a table further on specifying the number of SMSs a message can contain. This depends not only on the length of the message, but also on the type of the characters used.

 

Standard characters

A set of standard symbols whose application in the messages is treated like entering a single character. These are as follows:

@ £ $ ¥ è é ù ì ò Ç Ø ø Å å Δ _ Φ Γ Λ Ω Π Ψ Σ Θ Ξ Æ æ ß É ! " # ¤ % & ' ( ) * + , - . / 0 1 2 3 4 5 6 7 8 9 : ; < = > ? ¡ A B C D E F G H I J K L M N O P Q R S T U V W X Y Z Ä Ö Ñ Ü § ¿ a b c d e f g h i j k l m n o p q r s t u v w x y z ä ö ñ ü à

Standard characters are as well:

^ { } [ ] ~ \ | € and ,but these are treated in the messages as double characters. Special characters are not included in the standard characters set. Using even one special character in a message means that each character, including standard characters, is treated as double characters; this makes the message shorter.

 

Special characters

wAll the characters not included in the standard characters set. Using even one special character in a message means that each character, including standard characters, is treated as double characters; this makes the message shorter.

 

Coding

All the information messages in the system are coded with the UTF-8 coding. Such coding is also required for API triggers in order to correctly support the signs out of the standard ASCII range.

 

Message length

Depending on the number of the used characters, as well as the type of characters in the messages (standard/non-standard characters), a message can contain more than one SMS. It is important to remember that using even one non-standard character in the message causes the length of the message to shrink.

 

The length of the message (not including special characters) vs. the number of SMSs included.

 

Massage lengthNumber of SMSs included
from 1 to 160 1
from 161 to 306 2
from 307 to 459 3
from 460 to 612 4

 

The table below shows the number of SMSs included if there is even one special character in the message .

 

The length of the message (including special characters) vs. the number of SMSs included.

 

Message lengthNumber of SMSs included
from 1 to 70 1
from 71 to 134 2
from 135 to 201 3
from 202 to 268 4

 

Final statuses of the operation

Delivery status is returned every time after sending a message through HTTP/SOAP SSL API. This is a confirmation whether the message was sent correctly. A list of possible returned statuses along with descriptions below:


Statuses returned when texting

 

StatusStatus description
001 Sent correctly
002 Message correctly forwarded to sending, but due to technical reasons will be sent at a later time (concerns FasterSMS)
011 Necessary parameters have not been given, no GET/POST data.
021 Wrong log-in or password
022 Insufficient fund in the account to complete sending.
023 Problem sending message, contact Customer Service.
031 Sender field too long (maximum 16 characters for numerical sender and 11 characters for alphanumerical sender).
032 You haven’t given the recipient of the message or the recipient given is incorrect (incorrect/nonexistent mobile number/landline number).
033 You haven’t given the message content.
034 Past time is given a preferred sending time.
035 The number of own IDs is bigger than the number of the recipients of the sent message.
036 MaxSMS type is selected, but the sender is not specified (maximum 11 alphanumeric characters).
037 You only allow one-SMS-messages and this message is longer.
038 The content of the message exceed the technically allowed length (more than 4 SMSs in one message).
039 You have selected FasterSMS and at the same trying to send a message to more than one recipient which is not allowed (FasterSMS is used to send single text messages, for example with one-time password).
040 Sender name is not registered, contact the Customer Service.
080 IP address which triggered API is not on the list of authorized address allowed to use the API. Log in to the SMS Panel configure the API settings.
041 The message contains characters out of the allowed UTF-8 characters range.
091 Error connecting to base. Contact the PromoSMS company.
092 Error sending messages. Contact the PromoSMS company.

 

Message delivery Reports


Each message can have one kind of statues dedicated. Their full description is included in the table below.

 

Kinds of statuses

 

StatusStatus description
0 The message has not been forwarded to sending yet. This status is possible immediately after ordering sending (messages are forwarded to the service provider on average every 15 seconds) or in case of messages which are scheduled to be sent in the future (time parameter while sending).
4 lub 8 The message has been forwarded to the service provider. At this moment the PromoSMS platform is waiting for completing the order. Status number 8 can be compared to sending a text message from a phone when the phone has already sent the message, but it is not confirming the sending/failure to send from the service provider. Moreover, if the recipient’s phone is off, and the provider tried to deliver the message correctly, this kind of status is to be expected as well.
1 This status means that the message has been delivered to the recipient’s mobile.
2 lub 16 The message has not been delivered. There might be a few reasons. The most likely are: the recipient’s number is incorrect, the recipient’s phone has been off for a long time and the message expired.

 

Types of mobile numbers


There is a list of the types of mobile numbers recognized by the system in the table below.

 

Mobile numbers type description

 

Number typeType description
1 Landline number
2 Mobile number
3 It is possible in some countries that the number is a landline and a mobile at the same time.
4 Toll-free number
5 Higher toll number.
6 The cost of connection is shared between the caller and the recipient (for example the 801 type of number).
7 VoIP number
8 Personal number, it can be a mobile or a landline at the same time (see here: http://en.wikipedia.org/wiki/Personal_Numbers )
9 Pager
10 Universal Access Numbers or Company Numbers (one company number but the call may be transferred)
10 or -1 Incorrect or other number, unidentified type of number.