Parameters required for US networks
Overview
This page describes the parameters required when sending an SMS message to specific US networks:
For information about integrating with the SMS Gateway, see either Sending a Single SMS or Broadcasting an SMS.
Verizon purpose codes
Verizon requires you to identify the purpose of some standard rate messages sent as part of a premium rate campaign.
| Parameter | Description | |
| purpose | Identifies the specific purpose of the message.
Default: No default | |
| opt_in_premium | Use for standard rate messages sent during the opt-in process. | |
| premium_content | Use when delivering purchased premium content in a standard rate message. | |
T-Mobile opt in details
These parameters are required by T-Mobile in the United States only.
T-Mobile US requires you to send opt-in tracking data for certain transactions. The transaction types that require this data are:
| Service type | MT message that requires opt-in details |
| One time Premium Rate | The Premium Rate SMS message used to bill the end user. |
| Premium Rate subscriptions | The monthly Premium Rate SMS message used to renew the subscription. |
Transactions which do not include this data may fail, and T-Mobile may remove the associated services from their network.
To supply the required opt-in information when you send an SMS message, there are four parameters you may need to include. The parameters optin1 and optin2 are always mandatory. These specify the method used by the end user to opt in to your service. The parameters optints1 and optints2 specify the time these opt-ins occurred. If opt-in was carried out via SMS, you do not need to specify the time, as the SMS Gateway already has this information.
For example, the following request specifies that the first opt-in was web-based and occurred on the 5th of January 2010, and the second opt-in was via SMS:
http://sms.openmarket.com/sms/v1/send?| Parameter | Description | |
| optin1 | Describes how the first opt-in occurred. It takes the format source:sourceid, where both source and sourceid are mandatory. | |
| sms:smsid | The SMS ID returned by the SMS Gateway that corresponds to the first Mobile Originated (MO) SMS opt-in message. Example: optin1=sms:123455678 | |
| url:website | The URL where a web opt-in occurred. Example: optin1=url:http://example.com | |
| other:text | Description of any other opt-in scenario. Example: optin1=other:at+point+of+sale | |
| optin1ts | The time that the first opt-in occurred. This timestamp is in seconds since 01/01/1970 (also known as a Unix timestamp). This parameter is optional if the end user's first opt in was through an SMS message, i.e., where the value of optin1 is sms:smsid. Example (5th September 2010 @ 07:30:00): optin1ts=1283689800 | |
| optin2 | Describes how the second opt-in occurred. | |
| pin:pin | PIN used for PIN opt-in services. Example: optin2=pin:1337 | |
| sms:smsid | The SMS ID returned by the SMS Gateway that corresponds to the second Mobile Originated (MO) SMS opt-in message.
Example: optin2=sms:123455678 | |
| url:website | The URL where a web opt-in occurred. Example: optin2=url:http://example.com | |
| other:text | Description of any other opt-in scenario. Example: optin2=other:at+point+of+sale | |
| optin2ts | The time that the second opt-in occurred. This timestamp is in seconds since 01/01/1970 (also known as a Unix timestamp). This parameter is optional if the end user's second opt in was through an SMS message, i.e., where the value of optin2 is sms:smsid. Example (5th September 2010 @ 07:30:00): optin1ts=1283689800 | |
