Getting Started with the HTTP API

<< Click to Display Table of Contents >>

Navigation:   APIs, Plugins & Interfaces > HTTP Interface Overview >

Getting Started with the HTTP API

Previous pageReturn to chapter overviewNext page

 

The following is a quick guide to the simplest form of sending an SMS message with HTTP API Development.

 

 

Prerequisite

You must have requested the HTTP API to be provisioned when filling in the order form.

 

If you wish to receive messages in response to the messages you send through your API, then you need to explicitly request this on your order form.

 

 

 

Step 1: Provision your HTTP API Access

Request HTTP API access to be provisioned for your account.

 

Please specify the 'Username' that will be used for HTTP API access.

 

If you wish to lock your HTTP API access down to originate from a particular host or set of hosts, please provide this information when requesting HTTP API access.

 

 

 

Step 2: Test your Service Provisioning

Once your Service Support Team or Account Executive has confirmed that this has been provisioned for the specified user, you can start using the service.

 

The easiest way to test the service is with your browser.

 

Step 2.a: In your browser's address bar, type/paste the URL.

 

 

 

Where:

 

$mydestination is the mobile number you want to send to in international format i.e. 12912345678

 

$text is the text that you wish to send.

 

 

 

 

Step 2.b: You will be prompted by your browser for your username and password.

 

This should match the username you provided at the time of provisioning.

 

 

 

 

 

Step 2.c: You should receive a confirmation in your browser window that the message was successfully sent, and the message's Client Message ID, which can be used to interrogate the message status.

 

 

Step 3:   Build your HTTP API Application

Various shell script examples include:

 

Perl

wget

PHP

 

 

Code Snippets:

 

VB - Encoding Authentication Strings

 

 

Step 4. Additional Support

Additional support and information exists for API and interface development:

 

Support teams

HTTP & WSDL Interface Specification

Online Help

 

 

Additional Information

HTTP URL depends upon the service that you will utilize.

 

The following is a list of AT&T GSMS HTTP Interface URLs:

 

 

Command

URL

sendmsg

https://na1.smartmessagingsuite.com/cgphttp/servlet/sendmsg

startbatch

https://na1.smartmessagingsuite.com/cgphttp/servlet/startbatch

sendbatch

https://na1.smartmessagingsuite.com/cgphttp/servlet/sendbatch

sendwappush

https://na1.smartmessagingsuite.com/cgphttp/servlet/sendwappush

querymsg

https://na1.smartmessagingsuite.com/cgphttp/servlet/querymsg

cancelmsg

https://na1.smartmessagingsuite.com/cgphttp/servlet/cancelmsg

 

Please note: A license may be required in order to view or use the above features.