Send an SMS

The SMS Gateway account you are sending the message through.

Required: yes

The password for the account.

Required: yes

The mobile number of the message recipient in international format — for example, 447700900750. No leading "+" is required.

Required: yes

Your sender details; also referred to as your message originator. This can be either a phone number (up to 16 digits) or an alphanumeric string encoded in the Modified Latin-9 character set (up to 11 characters).

Required: for bulk services outside the US.

This value is ignored for premium rate services (your short code is used instead) and any US messaging. In these scenarios, the originator is set for each account and cannot be changed.

Whether you want a delivery report returned for the message. We recommend setting report to 7, so that you receive all possible reports.

• 0 - no delivery reports are sent
• 1 - Enables BUFFERED (intermediate) reports.
• 2 - Enables DELIVERED (successful) reports.
• 3 - Enables BUFFERED and DELIVERED reports.
• 4 - Enables FAILED (failure) and REJECTED reports.
• 5 - Enables BUFFERED, FAILED and REJECTED delivery reports.
• 6 - Enables DELIVERED, FAILED and REJECTED delivery reports.
• 7 - Enables BUFFERED, DELIVERED, FAILED and REJECTED delivery reports.

Required: no

Default: 0

Note that will be stored in the transaction log and passed back with delivery reports. This can be up to 160 characters in length.

This field is not passed to the mobile operator, and has no effect on the delivery of the message.

Required: no

Default: no default

Sub-account to be stored in the transaction log. This can be up to 30 characters in length. OpenMarket's Partner Centre can provide reporting based on this field. Sub-accounts do not need to be preconfigured.

This field is not passed to the mobile operator, and has no effect on the delivery of the message.

Required: no

Default: no default

Length of time, in seconds, that the mobile operator will attempt to send the SMS to the end user. If the operator cannot initially reach the end user, then the standard retry strategy for the operator is used until this validity period is reached. You can specify any positive number; however, OpenMaket may need to adjust the value as some operators have minimum validity periods, or only allow specific values (such as in 30 second increments).

See Overview for more information about validity periods.

Required: no

Default: There is no validity period set. OpenMarket and the mobile operator will use their standard retry strategies.

Enable single-shot billing for the message. Any non-empty value will enable single-shot billing. This parameter is only valid when sending a premium rate message in the UK, Ireland, or Australia.

You can enter any value for this parameter to enable it. For example:

billingsingleshot=anything

See Overview for more information about single-shot billing.

Required: no

Default: messages are submitted as normal

The response body contains a submit status code and a text description of the problem. For example:

submitstatus: 10700

detail: Bad username/password

The message text, encoded in the Modified Latin-9 character set.

Required: yes

The bits parameter is used to identify the type of data you are sending in the message body of the request. You only need to specify this parameter when you are sending User Data Header (UDH) information in the SMS message (with the smsudh parameter). For this type of request, bits must equal 7.

Required: no

Default: message does not include UDH

Determines whether the message is sent as a flash message. Flash messages are shown immediately on an end user's mobile phone without the user taking any action, and are often not saved to the phone. It is not recommended to send an SMS that is both multipart and flash.

• 0 - Message is not sent as a flash message.
• 1 - Message sent as a flash message.

Required: no

Default: 0

Enables you to add User Data Header (UDH) information. The format of UDH information is octet pairs in decimal notation — for example, 06050430393039.

For this specific message request, you must also specify bits=7 if you are including UDH information in the message.

If you specify the smsudh parameter, then OpenMarket will ignore the split parameter, if specified. To send a multipart message, you will need to manually split the message into separate requests and use the UDH information to concatenate the message.

Required: no

Default: no default

The message text, encoded in the GSM 03.38 character set.

Required: yes

Determines whether the message is sent as a flash message. Flash messages are shown immediately on an end user's mobile phone without the user taking any action, and are often not saved to the phone. It is not recommended to send an SMS that is both multipart and flash.

• 0 - Message is not sent as a flash message.
• 1 - Message sent as a flash message.

Required: no

Default: 0

Enables you to add User Data Header (UDH) information. The format of UDH information is octet pairs in decimal notation— for example, 06050430393039.

If you specify the smsudh parameter, then OpenMarket will ignore the split parameter, if specified. To send a multipart message, you will need to manually split the message into separate requests and use the UDH information to concatenate the message.

Required: no

Default: no default

The message text as hexadecimal encoded UCS-2.

Required: yes

Enables you to add User Data Header (UDH) information. The format of UDH information is octet pairs in decimal notation— for example, 06050430393039.

If you specify the smsudh parameter, then OpenMarket will ignore the split parameter, if specified. To send a multipart message, you will need to manually split the message into separate requests and use the UDH information to concatenate the message.

Required: no

Default: no default

The 8-bit binary content you are sending. You must hexadecimal encode the data.

Required: yes

This identifies to OpenMarket that you are sending a WAP Push. You must set this to the number 0.

Required: yes

This tells the mobile 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 mobile phones may behave differently from described.

• 0 - The WAP Push is delivered without the mobile 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 mobile phone displays the WAP Push as a message as soon as possible without interrupting any task the end user is performing on the mobile phone. For example, if the end user is on a call or using a phone application, the mobile phone will not display the message until the end user has finished with the call or application.
• 3 - The mobile 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 mobile 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.

Required: yes

The location (URI) of the WAP Push content. This must begin with either http:// or https://.

Required: yes

Name of the Service Indication. This is delivered to the end user's mobile phone, and may be used by the mobile phone to identify the WAP Push to the end user.

Required: yes

A text string used to identify each WAP Push in a mobile 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 or 123@siid.example.org).

Required: no

Default: the URI specified by the push_href parameter

This sets an expiry date and time for the WAP Push. When it reaches this date, the mobile phone should either delete the WAP Push SI or mark it as expired. If this 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 — for example: push_siexpires=2011-02-27T14:00:00

Required: no

Default: no expiry date is set

The length of time, in minutes, that the message will be available. Setting an expiry time ensures that you do not need to host content indefinitely. However, individual mobile phones may ignore this value and may use another expiry value. There is no defined maximum value for this parameter. The minimum value is 1 (one minute).

Required: yes

The "message class", as per the MMS specification. This enables some mobile phones to filter messages based on their class (for example, to ignore any MMS notification where class=81). There is currently no specific regulatory requirements for setting the MMS message type.

• 80 - Personal
• 81 - Advertisement
• 82 - Informational
• 83 - Auto

Required: yes

The URI of the location hosting the MMS content. This must start with HTTP://. For maximum compatibility with different mobile phones, do not use HTTPS.

Required: yes

The full size of message in bytes. This is passed to the mobile phone so that it can display the file size to the end user before they download the file. The mobile phone should not reject the message if this size is not exactly the same as the file itself.

Required: yes

This identifies to OpenMarket that the request is for an MMS Notification. You must set this to 1.

Required: yes

A unique ID generated by your platform to identify the notification request when the mobile phone retrieves the MMS content. This ensures that the platform can deliver dynamic content for each MMS notification sent. This can be an alphanumeric string.

Required: yes

Specifies the MMS specification version number. Currently there is only one version supported, version 1.0. You must set this parameter to 1.0.

Required: yes

Sets an originator for the MMS notification that is displayed to the end user before the MMS message is downloaded. You can set this to any value; however, long values may be clipped by the mobile phone. Some mobile phones may not show this value at all.

The value can be a number or email address, in one of these formats:

+447700900999/TYPE=PLMN

58870/TYPE=PLMN

yourbusiness@example.com

Some mobile phones may overwrite this with the value of the smsfrom field delivered with the MMS content.

Required: no

Your account cannot send a message to the number as it is registered in a country you cannot send messages to. Talk to your OpenMarket account manager about sending messages to this region.

Broadcast requests: this code is returned for individual mobile numbers in your 200 response, rather than in a 400-499 response.

The mobile number appears to be an incorrect length or includes non-numerical characters.

Broadcast requests: this code is returned for individual mobile numbers in your 200 response, rather than in a 400-499 response.

The end user is with a mobile operator that does not support WAP Pushes. You will need to send the URL to the end user as a plain-text SMS with the URL included.

Broadcast requests: this code is returned for individual mobile numbers in your 200 response, rather than in a 400-499 response.

The value of the push_siexpires parameter must be a date 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

This status occurs only for broadcast requests.

Requests to the broadcast endpoints must be sent via HTTP POST.

This status occurs only for broadcast request.

This endpoint cannot accept the broadcast request, as it is currently processing the maximum number of broadcast SMS requests it will accept at the same time. Wait one minute then resubmit the rejected request.

This status occurs only for broadcast requests.

The request has the same submitid of a request you have very recently sent (within the last minute). After OpenMarket has finished processing the original request, we will return an HTTP 200 response. If you are attempting to send a different request, then change the value of the submitid parameter before resubmitting the request.

The mobile number is currently in the number blacklist. Contact your OpenMarket account manager for more information.

Broadcast requests: this code is returned for individual mobile numbers in your 200 response, rather than in a 400-499 response.

The mobile number cannot receive the type of SMS message you are sending, or the number is outside the range of mobile operators that we can send that type of message to.

Broadcast requests: this code is returned for individual mobile numbers in your 200 response, rather than in a 400-499 response.

The request was rejected as sending the SMS messages would exceed your monthly per-account credit limit.

Broadcast requests: this code is returned for individual mobile numbers in your 200 response, rather than in a 400-499 response.

You have reached the maximum number of messages you can send to this mobile number in a day.

Broadcast requests: this code is returned for individual mobile numbers in your 200 response, rather than in a 400-499 response.