Http Sms Api - Sms Gateway - Email Sms, Web Sms _ Smsglobal 1o2g6e

4/18/2017

HTTP SMS API ­ SMS Gateway ­ Email SMS, Web SMS | SMSGlobal GET STARTED



HTTP API Our documentation, simply, easy. Our SMS Tech

API Documentation

REST API

SMPP API

HTTP API

SOAP API

MMS API

Services

This document provides a reference for all features available to you via the HTTP interface for sending SMS. The HTTP-API allows you to integrate your Application (Client) to SMSGlobal (Vendor) using the HTTP protocol to send SMS. HTTPS is also ed for secure transactions using SSL encryption. The Client issues either a HTTP GET or POST request to the SMSGlobal HTTP interface supplying a list of required parameters. SMSGlobal issues back a HTTP Response which indicates the validity of the transaction. The HTTP-API is used for 1 way messaging only. Therefore you need to provide a valid MSISDN as the Sender ID of the message to allow the recipient the ability to respond.  

Features Custom Sender ID Dedicated Virtual Numbers Delivery Receipt Noti�cations via Email/SMS Recipient OPT Out Option 24/7 via our system  

Sending an SMS URL: https://www.smsglobal.com/http‐api.php

 

HTTP Parameters Find below a list of parameters when issuing a HTTP Request. Parameter

Description

Presence

action

Action to be taken. [Default: sendsms]

Mandatory



Your SMSGlobal name

Mandatory



Your SMSGlobal

Mandatory

from

MSIDSN or Sender ID that the message will appear from. Eg: 61409317436  (Do not use +before the country code)

Mandatory

to

MSIDSN of the recipient that the message will be sent to. Eg: 61409317436 (Do not use + before the country code)

Mandatory

text

Message to be sent. Must be URL encoded.

Mandatory

maxsplit

Enables splitting of message if text exceeds 160 characters. Speci�es number of times allowed to split.

Optional

scheduledatetime

To schedule the message to be sent sometime/date in the future. Time/Date format is: “yyyy-mm-dd hh:mm:ss” which is URL encoded.

Optional

http://smsglobal.com/http­api/

1/4

4/18/2017

HTTP SMS API ­ SMS Gateway ­ Email SMS, Web SMS | SMSGlobal

 

HTTP Response The HTTP Response from SMSGlobal contains the following:  Status Code  Sent Queued Message ID (Internal use only)  SMSGlobalMsgId  Error message (if present)  

Status Codes If the message has been sent successfully the status code will return OK: 0  

Example: OK: 0; Sent queued message ID: 941596d028699601 SMSGlobalMsgID:6764842339385521

If the message was unable to be delivered it will return ERROR: {Status code} {Error Msg}  

Example: ERROR: Missing parameter: from

 

Examples Below are example requests when using the HTTP interface.  

Example Request name: test : secret From: Test To: 61447100250 Message: Hello World  

Request: https://www.smsglobal.com/http‐api.php?action=sendsms&=test&=secret&&from=Test&to=61447100250&text=Hello%20world

Output: OK: 0; Sent queued message ID: 941596d028699601 SMSGlobalMsgID:6764842339385521

 

Scheduling an SMS It is possible to schedule delivery of a message to be sent at a speci�ed date and time in the future. This is done by using the scheduledatetime parameter in your request. Time/Date format is: “yyyy-mm-dd hh:mm:ss” Note: Date/time must be URL Encoded.   name: test : secret

http://smsglobal.com/http­api/

2/4

4/18/2017

HTTP SMS API ­ SMS Gateway ­ Email SMS, Web SMS | SMSGlobal

From: Test To: 61447100250 Message: Hello World Schedule Date: 10th Jan, 2010 at 3pm

Request: https://www.smsglobal.com/http‐api.php?action=sendsms&=test&=secret&from=Test&to=61447100250&  text=Hello%20world&scheduledatetime=2010‐01‐10%2015%3A00%3A00

Output: SMSGLOBAL DELAY MSGID:19736759

  Note: A SMSGlobal Delay MSG ID is not the same as a SMSGlobal Message ID.  

Status Codes   Parameter

Description

delivrd

The message has been received by the handset.

expired

The carrier has timed out.

undeliv

The messages failed to reach the handset.

  Information on Unicode   Is your message splitting into multiple parts without MAXSPLIT?   Multi-Part Message Knowledgebase Article  

Incoming SMS Please �nd below a list of available parameters. Parameter

Description

Limitation

action

Action to be taken. [Default: sendsms]

Mandatory



Your SMSGlobal name

Mandatory



Your SMSGlobal

Mandatory

to

MSIDSN of Recipient that the message will be going to.Eg: 61409317436  (Do not use + before the country code)

Mandatory

text

Message to be sent.

Mandatory

api

Enables 2-way messaging. [Default: 1]1 = enabled0 = disabled

Mandatory

maxsplit

Enables splitting of message if text exceeds 160 characters. Speci�es number of times allowed to split. [Default: 1]

Optional

�eld

Custom Field within which you can store internal ID or other information that you want returned to you with any reply to your outgoing SMS.

Max 255 Characters

Mandatory

Optional

 

Incoming SMS HTTP Post Back

http://smsglobal.com/http­api/

3/4

4/18/2017

HTTP SMS API ­ SMS Gateway ­ Email SMS, Web SMS | SMSGlobal

Incoming SMS HTTP Post Back If you would like noti�cation of your Incoming SMS to be pushed to your server, please ensure you specify a URL in your settings. In order for our system to know that your URL has received the delivery notice, at the end of your script you must echo out “OK”. The post back response time is restricted to �ve seconds. If the speci�ed URL does not return ‘OK’ within �ve seconds of being sent, the request will be marked as incomplete and the process will be repeated.

Please �nd below the list of parameters that are sent.   Parameter

Description

to

Mobile Terminated Number, where the message was sent to

from

Mobile Originated Number, where the message was sent from

msg

Contents of the message

�eld

Unique �eld ed in the original request

date

Date the message was received by SMSGlobal.

  Important Information If You Have Dedicated Numbers Often it is practical to have all SMS trac sent from the same number each time. This makes it easier for recipients to reply to your message or when sending our message campaigns. A dedicated number works like a normal mobile number. Once you have purchased one you will be able to receive text messages to it as you would a regular mobile number. Friends, customers or anybody with a mobile will be able to send SMS text messages to you. Note: When you start using 2 way SMS and dedicated numbers, the �eld no longer works and is ignored on the API.  

Start integrating with an SMPP API into your business today!

Get Started

Company The Hub Careers We want to hear from you!



LinkedIn TwitterFacebook Solutions

SMS Messaging Bulk SMS Messaging MMS Messaging & WAP Dedicated Numbers Bespoke SMS Solutions Our Platforms Web SMS Platform Help Ask a Question Global Coverage API Documentation Legal Docs & Conditions Anti Spam Policy

http://smsglobal.com/http­api/

4/4