Sending a WAP Push using HTTP
There are two WAP Push SMS message types:
- Service Indication
A Service Indication provides a URL to the end user that they must click to access the content.
- Service Loader (not supported)
A Service Loader is designed to push the user to a given URL automatically. This type of WAP Push is quite outmoded, and not supported by modern cell phones.
How a WAP Push is displayed to an end user is dependent on the cell phone. For example, some cell phones may show a WAP Push immediately with no regard for the value set for the push_action parameter.
In the US, you must have a binary-enabled Short Code to use WAP Pushes. Please contact your MX Telecom business development manager for more information.
Sending a WAP Push Service Indication (SI)
You can use this request to send, replace, or delete a WAP Push SI.
Single-recipient end points:
Broadcast end points: (HTTP POST only)
Example single-recipient request:http://sms.openmarket.com/sms/v1/send?
This sends a WAP Push SI message for the address http://www.example.com/. The parameter push_action requests that the WAP Push is displayed to the end user as soon as the cell phone is free to do so. The WAP Push is uniquely identified in the cell phone with siid=example.com-siid123. The push_siname is a description for the WAP Push which the cell phone may display to the end user.
|user||The SMS Gateway account you are sending the message through.|
|pass||The password for the SMS Gateway account.|
|smsto||The MSISDN of the message recipient in international format (e.g. 12515550100). No leading "+" is required.
If you are sending a broadcast SMS request, separate each MSISDN with a line break (e.g. smsto=12515550100%0A12515550123%0A12515550145).
|pushtype||This identifies to the SMS Gateway that you are sending a WAP Push. You must set this to the number 0.|
|push_action||This tells the cell phone what action to take when the WAP Push arrives. We recommend setting this to 2 for WAP Push messages to URIs that you wish the end user to visit immediately. Some cell phones may behave differently from described.|
|0||The WAP Push is delivered without the cell phone notifying the end user. This is useful for sending a series of website bookmarks as a background task, rather than interrupting the end user as each URL is sent.|
|1||The WAP Push is delivered with minimal notification to the end user. Using this option is not recommended.|
|2||The cell phone displays the WAP Push as a message as soon as possible without interrupting any task the end user is performing on the cell phone. For example, if the end user is on a call or using a phone application, the cell phone will not display the message until the end user has finished with the call or application.|
|3||The cell phone displays the WAP Push as soon as possible, and may interrupt a running application or display the message onscreen while the end user is on a call.|
|4||This action is used to delete a previously sent WAP Push. The cell phone deletes from its mailbox any previous WAP Push entry that has the same SI ID as this WAP Push. To delete a WAP Push entry, you must also send the push_siid parameter.|
|push_href||The location (URI) of the WAP Push content. This must begin with either http:// or https://.|
|push_siname||Name of the Service Indication. This is delivered to the end user's cell phone, and may be used by the cell phone to identify the WAP Push to the end user.|
Optional parameters specific to this request type:
|push_siid||A text string used to identify each WAP Push in a cell phone. This parameter is required if
you are deleting a WAP Push (using push_action=4).
To avoid conflicts between messages from your services and other
services, it is highly recommended that you create an SI ID that includes a URI you
control and a unique identifier from your system (for example: www.example.org/siid/123
Default: the URI specified by the push_href parameter
|push_siexpires||This attribute sets an expiry date and time for the WAP Push. When it reaches this
date, the cell phone should either delete the WAP Push SI or mark it as expired. If this
attribute is not specified, the SI never expires and should not be automatically deleted.
The date must be in the format yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss, where 'T' is literally the character T. For example: push_siexpires=2011-02-27T14:00:00
Default: no expiry date is set
|push_initiator||The brand name or number you want associated with the WAP Push. This will replace the originator on
some cell phones.
We recommend setting this parameter for all WAP Push messages.
Default: no default
Carrier-specific parameters and requirements:
Where possible, OpenMarket removes the complexity of sending messages to multiple carriers. However, there are several carriers where you services may need to provide additional parameters or use a different messaging workflow. For information on these, please see US Carrier-Specific Requirements. The specific parameters are:
- purpose: adds message purpose details required by Verizon for Premium Rate services
- managed_consent_type, initial_optin_keyword: adds opt-in details required by Verizon for Premium Rate services
- managed_consent_type, pin: adds opt-in details required by AT&T US for Premium Rate services
- optin1, optin1ts, optin2, optin2ts: adds opt-in details required by T-Mobile US for Premium Rate services
Optional parameters you can use for any request type:
- smsfrom: sets the originator for the message—this parameter is mandatory for standard rate messages in all regions bar the US
- submitid: used to send broadcast SMS messages
- report: sets the delivery reports you want for the message
- response: (for single-recipient requests only) changes the format of the HTTP response from the SMS Gateway
- note, subaccount: optional reporting notes that you can add to the request
- vp, billingsingleshot: alters the validity period and billing for the SMS message
This request deletes a WAP Push SI message on an end user's cell phone:http://sms.openmarket.com/sms/v1/send?
The parameter push_action identifies that the request is to delete rather than add a WAP Push on the cell phone. The parameter push_siid identifies the WAP Push to delete.
For full details on the WAP 1.2 Push Service Indication see WAP Service Indication Specification.