Sending vCard messages using HTTP


OpenMarket now offers a RESTful and feature-rich Global SMS API. Compared to the existing MX Telecom APIs, the Global SMS API provides:

  • Automated originator selection, which selects the correct short code or VMN for any country or territory
  • Our highest level SLA and increased messaging capacity
  • Better security through Basic authentication
  • A test environment for new and migrating customers

as well as a host of other benefits. While we will continue to support our existing SMS APIs, we believe that our Global SMS API offers some exciting features and benefits that you'll want to take advantage of, and future feature development will be focused on the Global SMS API. For more information, see the Release Note on our Docs and Resources website.

Note that currently the Global SMS API does not support Premium Rate messaging. Existing Premium Rate customers should continue to use the MX Telecom APIs.

This page describes how to send a vCard message through the SMS Gateway. For information about integrating with the SMS Gateway, see either Sending a Single SMS or Broadcasting an SMS.

Sending a vCard

Single-recipient end points:

Broadcast end points: (HTTP POST only)

Example single-recipient request:

This send a vCard for John Smith to the number 12515550100. Each line in the vCard must have a carriage return and line feed character (different cell phones require either one of these characters). The URL encoding for these is %0D%0A.

The example vCard, before being URL encoded, has the following format and content:

FN:John Smith

Mandatory parameters:

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).
vcard_dataThe vCard you are sending.

Optional parameters specific to this request type:

There are no optional parameters specific to sending a vCard message request.

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:

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