Differences

This shows you the differences between two versions of the page.

Link to this comparison view

ravenweb_api_en [2012/02/14 16:40] (current)
Line 1: Line 1:
 +{{:logo_trasp.png|}}
  
 +
 +
 +==== Language ====
 +
 +
 +
 +[[ravenweb api|{{italy.png|Italiano}}]] [[ravenweb api en|{{united_kingdom_great_britain_.png|English}}]] [[ravenweb api fr|{{france.png|Français}}]]
 +
 +
 +
 +====== RavenWeb API ======
 +
 +
 +
 +===== Sending of a Single SMS =====
 +
 +
 +
 +
 +
 +<note important>This type of sending makes it possible to send a single message to a mobile telephone number.</note>
 +
 +
 +
 +
 +
 +Reference URL: http://gateway.airtelco.com/raven/sms/send
 +
 +
 +
 +<note> Example:
 +
 +                 http://gateway.airtelco.com/raven/sms/send?login=LOGIN&password=PASSWORD
 +
 +                               &phone=%2b393330000000&from=Mittente&body=Testo
 +
 +</note>
 +
 +
 +
 +
 +
 +==== Parameters ====
 +
 +
 +
 +
 +
 +  * __login__
 +
 +
 +
 +//ID of the account, provided when activating the service.//
 +
 +
 +
 +
 +
 +  * __password__
 +
 +
 +
 +//Password of the account, provided when activating the service.//
 +
 +
 +
 +  * __from__
 +
 +
 +
 +//Optional parameter. The value of this parameter will be displayed as the sender of the message.//
 +
 +
 +
 +  * __body__
 +
 +
 +
 +//The value of this parameter will be used as the body of the message.//
 +
 +
 +
 +  * __phone__
 +
 +
 +
 +//Mandatory parameter. Indicates the recipient of the message.// 
 +
 +
 +
 +<note important>The telephone number must be in international format: +[international prefix][operator prefix][telephone number] 
 +
 +Example: +393330000000</note>
 +
 +
 +
 +  * __quality__
 +
 +
 +
 +//Optional parameter. Indicates the quality of the message. If the quality parameter is not given a Premium quality value will be used.
 +
 +//
 +
 +
 +
 +**Possible values: p (Premium Quality), s (Standard Quality)**
 +
 +
 +
 +  * __action__
 +
 +
 +
 +//Optional parameter for sending a single message. If it is not given a value then the default sms action
 +
 +will be used.//
 +
 +
 +
 +  * __type__
 +
 +
 +
 +//Optional parameter. Indicates the type of message which is being sent.//
 +
 +
 +
 +**Possible values: text, ucs, long, lucs, binary, wappush**
 +
 +
 +
 +//The default value is **text**.//
 +
 +
 +
 +  * __encoding__
 +
 +
 +
 +//Optional parameter. It is possible to specify the encoding used by the client.//
 +
 +
 +
 +**Possible values: latin-1, utf8.**
 +
 +
 +
 +If it is not given a value then the default encoding will be used: **latin-1**.
 +
 +
 +
 +  * __url__
 +
 +
 +
 +__Mandatory parameter for wappush-type sms messages__. Please indicate the URL which will be used for the creation of the WAP PUSH message.
 +
 +
 +
 +  * __udh__
 +
 +
 +
 +__Mandatory parameter for binary-type sms messages.__ Please indicate the value of the User Data Header field for the 8bit message which will be forwarded to the mobile phone.
 +
 +
 +
 +
 +
 +=== Description of possible values of parameter type ===
 +
 +
 +
 +  * text
 +
 +
 +
 +//Text message (7bit) of 160 characters//
 +
 +
 +
 +  * ucs
 +
 +
 +
 +//Unicode message of 70 characters.// To send Unicode-type messages, it is necessary to convert each text character of the message with the equivalent unicode hexadecimal value. (Using this method will make it possible to send texts which contain characters not supported by the GSM alphabet, such as Japanese symbols for example.)
 +
 +
 +
 +<note>Example: for the text “AABB” the value of the body field must be “41414242”</note>
 +
 +
 +
 +  * long
 +
 +
 +
 +//Messaggio long.// Allows for the sending of text messages with more than 160 characters in a single request. Each single part of a long text message is made up of 152 characters. For example a message of 320 characters will be counted as 3 messages, the first and the second
 +
 +part having 152 characters and the third part having 16 characters.
 +
 +
 +
 +  * lucs
 +
 +
 +
 +//Messaggio long unicode.// Allows for the sending of Unicode messages with more than 70 characters in a single request. Each single part of a long unicode message is made up of 62 characters. For example a message of 140 characters will be counted as 3 messages, the first and the
 +
 +second having 62 characters and the third part having 16 characters.
 +
 +
 +
 +  * binary
 +
 +
 +
 +//Messaggio binario (8bit).// Allows for the sending of binary messages such as for example logos, ringtones, picture messages and EMS. When using this type of message, it will also be necessary to give a value to the udh parameter. To send binary-type messages it is necessary to convert every byte of the message body into its corresponding hexadecimal value. 
 +
 +
 +
 +  * wappush
 +
 +
 +
 +Messaggio WAP PUSH. Allows for the sending of wap push messages (messages which consist of a text section and a URL) . Using this type of message, it will also be necessary to give a value to the url parameter.
 +
 +
 +
 +
 +
 +
 +
 +==== Responses from the SMS gateway ====
 +
 +
 +
 +
 +
 +  * **Success**
 +
 +  
 +
 +The gateway will return a string formatted as follows: **SENT [Message ID]**
 +
 +
 +
 +<note tip>Example: SENT 1344</note>
 +
 +
 +
 +  * **Error**
 +
 +
 +
 +The gateway will return a string formatted as follows: **ERR [Error Code] [Message]**
 +
 +
 +
 +
 +
 +===== Sending of Multiple SMS Messages =====
 +
 +
 +
 +<note important>Through this type of sending it will be possible to send the same message to a list of comma-separated numbers. It will be possible to add a maximum of 500 numbers within the list.</note>
 +
 +
 +
 +Reference URL: http://gateway.airtelco.com/raven/sms/send
 +
 +
 +
 +<note>Example: 
 +
 +<code>http://gateway.airtelco.com/raven/sms/send?login=LOGIN&password=PASSWORD&phone=%2b393330000000,%2b393112222222&
 +
 +from=Mittente&body=Testo&action=batch</code></note>
 +
 +
 +
 +
 +
 +==== Parameters ====
 +
 +
 +
 +<note>The description of the parameters stays the same as for the sending of a single SMS message</note>
 +
 +
 +
 +  * __action__
 +
 +
 +
 +//Mandatory parameter.// To enable this sending method the action parameter must contain the **batch** value.
 +
 +
 +
 +  * __phone__
 +
 +
 +
 +//Mandatory parameter.// The phone parameter can for example contain one or more comma-separated telephone numbers.
 +
 +
 +
 +
 +
 +==== Response from the SMS gateway ====
 +
 +
 +
 +  * **Success**
 +
 +
 +
 +The gateway will return a string formatted as follows: **SENT [Sending ID] – [Successfully sent] – [Not sent]**
 +
 +
 +
 +<note tip>Example: SENT 100 – 500 – 0</note>
 +
 +
 +
 +
 +
 +  * **Error**
 +
 +
 +
 +The gateway will return a string formatted as follows: **ERR [Error Code] [Message]**
 +
 +
 +
 +===== SMS control and remaining credits =====
 +
 +
 +
 +<note important>This function allows you to check the remaining credit or the number of SMS messages still available.</note>
 +
 +
 +
 +Reference URL: http://gateway.airtelco.com/raven/sms/send
 +
 +
 +
 +==== Remaining credit ====
 +
 +
 +
 +http://gateway.airtelco.com/raven/sms/send?login=LOGIN&password=PASSWORD&action=credit
 +
 +
 +
 +==== Number of SMS messages available ====
 +
 +
 +
 +http://gateway.airtelco.com/raven/sms/send?login=LOGIN&password=PASSWORD&action=sms
 +
 +
 +
 +==== SMS messages available by quality ====
 +
 +
 +
 +http://gateway.airtelco.com/raven/sms/send?login=LOGIN&password=PASSWORD&action=smsdetails
 +
 +
 +
 +
 +
 +==== Response from the SMS gateway ====
 +
 +
 +
 +  * **credit**
 +
 +
 +
 +Abstract: **[Currency] [Remaining Credit]**
 +
 +
 +
 +<note tip>Example: EUR 45.10</note>
 +
 +
 +
 +  * **sms**
 +
 +
 +
 +Abstract: **[SMS Number]**
 +
 +
 +
 +<note tip>Example: 1100</note>
 +
 +
 +
 +  * **smsdetails**
 +
 +
 +
 +<code><?xml version="1.0" encoding="iso-8859-1"?><xml><premium>80</premium><standard>100</standard></xml></code>
 +
 +
 +
 +===== SMS notifications =====
 +
 +
 +
 +<note important>Sending premium quality messages will enable you to receive a confirmed delivery notification for the message.
 +
 +The confirmed delivery notification is a message sent by the recipient's mobile phone to the service centre of the operator which
 +
 +forwarded the SMS. The gateway will in turn forward the notification received from the operator to the customer, through an HTTP POST 
 +
 +to a URL previously set up by the customer within the private area.</note>
 +
 +
 +
 +Example: http://sitoclient/script?obj_id=1344&send_id=340&status=Delivered&timestamp=2008-11-07%2015:10:00&phone=%2b393112222222
 +
 +
 +
 +
 +
 +==== Client-side parameters ====
 +
 +
 +
 +  * obj_id
 +
 +
 +
 +//Unique ID for the message sent.// This parameter will be given the value of the ID previously returned by the gateway in response to a single sending.
 +
 +
 +
 +  * send_id
 +
 +
 +
 +//Unique ID for a sending.// This parameter will be given the value of the ID previously returned by the gateway in response to a multiple sending.
 +
 +
 +
 +  * status
 +
 +
 +
 +//Status of the message.// Possible values are “Delivered” “Undelivered”, which will indicate whether message delivery occurred or failed respectively.
 +
 +
 +
 +  * timestamp
 +
 +
 +
 +//Date and time of message receipt.// If the message status is “Delivered” the timestamp will show the date and time of message delivery. If this is not the case it will show the date and time of receipt of the notification.
 +
 +
 +
 +  * phone
 +
 +
 +
 +__Telephone number of message recipient.__
 +
 +
 +
 +
 +
 +<note>In the event that the customer's URL cannot be reached, the system will attempt an incremental retry for 10 minutes. In the event of continued failure, the data associated with the notification will be saved within the customer's own repository to allow the customer (by contacting support) to request a report of notifications received within a specific time period. The details of notifications will be maintained within the repository for 30 days. The gateway will consider the URL to be unreachable even when timeout occurs, with a maximum waiting time of 5 seconds.</note>
 +
 +===== List of Errors =====
 +
 +
 +
 +**ERR 10** Authentication error\\
 +
 +**ERR 11** No user or password\\
 +
 +**ERR 12** IP Address not allowed\\
 +
 +**ERR 20** Wrong action value\\
 +
 +**ERR 23** Wrong deferred date or time\\
 +
 +**ERR 64** Sender content not allowed\\
 +
 +**ERR 65** Message content not allowed\\
 +
 +**ERR 66** Deferred mode blocked\\
 +
 +**ERR 67** Quality Blocked\\
 +
 +**ERR 68** Account Blocked\\
 +
 +**ERR 299** Wrong message type\\
 +
 +**ERR 301** Wrong Wap Push URL\\
 +
 +**ERR 302** Wrong unicode or binary encoding\\
 +
 +**ERR 303** Wrong user data header\\
 +
 +**ERR 304** 
 +
 +  * Binary message too long
 +
 +  * Unicode message too long (Max 140 byte)
 +
 +  * Long Unicode message too long (Max 496 byte - 4 parts)
 +
 +**ERR 305** Wrong Sender\\
 +
 +**ERR 306** Message too long (Max 760 characters)\\
 +
 +**ERR 307** Message type not available in standard quality\\
 +
 +**ERR 308** Not enough credit\\
 +
 +**ERR 309** Phone number out of coverage list\\
 +
 +**ERR 400** System error\\
 +
 +**ERR 401** Unable to enqueue message\\
 +
 +===== Useful Links =====
 +
 +
 +
 +__Binary Message__ : 
 +
 +
 +
 +  - http://en.wikipedia.org/wiki/Smart_Messaging (introduction)\\
 +
 +  - http://www.forum.nokia.com/main/html_readers/smart_messaging_faq.html (detailed)
 +
 +
 +
 +__GSM Alphabet__ :
 +
 +
 +
 +  - http://www.airtelco.com/docs/gsm_default_alphabet.html
ravenweb_api_en.txt · Last modified: 2012/02/14 16:40 (external edit)
 
Recent changes RSS feed Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki