All requests must be authenticated using the login and password you use to access your account.

Similar documents
Quriiri HTTP MT API. Quriiri HTTP MT API v , doc version This document describes the Quriiri HTTP MT API version 1 (v1).

HTTP API. Table of Contents

Wired 2 Wireless Technology Solutions API Help Document Copyright Introduction. 2. Parameter list

SMS Outbound. HTTP interface - v1.1

SOAP API. The correct URL has been hidden. Please contact your account manager for the full URL information.

Gatesms.eu Mobile Solutions for Business

Forthnet Mobile Platform - groupsms http interface v1.0 1 / 9

API Documentation. Release Version 1 Beta

LINK Mobility SMS REST API MT and Delivery Reports Version 1.3; Last updated September 21, 2017

REST SERVICE. Web Services API Version 1.5

HappyFox API Technical Reference

Technical Guide. REST API for Mobile Outbound SMS

HTTP Authentication API

SMS HTTP API DOCUMENTATION December 2012

Integrating with Cellsynt's SMS gateway via HTTP interface (technical documentation)

HTTP API-HELP DOCUMENT

Way2mint SMS Mobile Terminate (MT) API Guide for HTTP HTTPS

SMS4BD Gateway Integration

WE POWER YOUR MOBILE WORLD FTP INTEGRATION MANUAL

SMS Outbound. SMTP interface - v1.1

Dynmark Messaging Platform XML HTTP Interface Quick Start Guide. Draft Revision September

version 2.0 HTTPS SMSAPI Specification Version 1.0 It also contains Sample Codes for -.Net - PHP - Java

Bulk HTTP API Specification

Composer Help. Web Request Common Block

Response: Note: Please define Dynamic Value in ##Field## The following are the parameters used: For Unicode Message:

Fax Broadcast Web Services

Cloud SMS API Guide. Version 5.1

ezeesms URL API Documentation

ERMES. Technical Specification for ex MPAY services integration. version /10/2018

SONERA OPERATOR SERVICE PLATFORM OPAALI PORTAL SMS. FREQUENTLY ASKED QUESTIONS, version 2.0

Please note: This is a working document and is subject to change. Please check back periodically to ensure you have the latest version of this spec.

EBULKSMS

MultiTexter.com Smart Messaging System. HTTP Application Programming Interface

Requirement Document v1.2 WELCOME TO CANLOG.IN. API-Key Help Document. Version SMS Integration Document

XML API SMS GATEWAY. Issue 2.0 Dec XML API

HTTP Specification Version 1.83

Bulk SMS API Integration Document Version 1.8

API Spec Sheet For Version 2.5

SMS-Bulk Gateway HTTP interface

VISA QIWI WALLET PULL PAYMENTS API ver. 2.1

HTTP Based Unified API

Message parameter details

Transactional- Interface Specification

Overview Introduction Messaging Error Codes Message parameter details Contact Details... 7

SMS Submit Interface description HTTP Version 1.5

SMS API TECHNICAL SPECIFICATION

text2reach2 SMS API Sep 5, 2013 v1.1 This document describes application interface (API) between SMS service provider (SP) and SMS gateway (SMSGW).

Quick Answers. You may create any Sender ID for the transactional route, provided the Sender ID should be of 6 alpha characters only.

Issue No. Date Description of Changes Initial issue Added basic authentication

Requirement Document v1.1 WELCOME TO CANLOG.IN. API Help Document. Version SMS Integration Document

Quenbec inc # henri bourassa H3L-3N3 Montreal, QC,Canada Toll free: Mobile

Reseller Web Site Instructions Manual

REST Web Services Objektumorientált szoftvertervezés Object-oriented software design

The HTTP protocol. Fulvio Corno, Dario Bonino. 08/10/09 http 1

Opaali Portal Quick guide

API Specification Doc

Web Services User Guide

Business On Line File Gateway Guide

Requirement Document v1.1 WELCOME TO CANLOG.IN. API Help Document. Version SMS Integration Document

cellip CELLIPS SMS INTERFACE DESCRIPTION HTTP GET INNEHÅLLSFÖRTECKNING

Before you start! : 1. It is important to know some things code, before starting the deal with this file.

FaxCore API Reference A web based API for sending, receiving and managing faxes through the FaxCore network.

E POSTBUSINESS API Login-API Reference. Version 1.1

SMS API User Guide. Document Reference: October Version: 6

WAM!NET Submission Icons. Help Guide. March 2015

User Guide for Payroll Service (APS+)

HTTP Interface API. for SMS Services. Version 2. Claude ICT Poland Sp. z o. o.

1. Overview Account Configuration Details... 3

Magento Survey Extension User Guide

RouteMobile Mobile Client Manual for Android Version: 2.0

Integration Guide Xura Messaging HTTP-Interface

HLR Lookup Service (Release 1.1.0)

Integration Guide Xura Messaging SMTP- Interface

User Manual. MDWorkflow. Web Application from Midrange Dynamics

Administration Guide

API Integration Guide

Network Policy Controller UAM/RADIUS Guide

redcoal InteraktSMS Technical Guide

HTTP API - HELP DOCUMENT

Integrating with ClearPass HTTP APIs

Messaging Service REST API Specification V2.3.2 Last Modified: 07.October, 2016

Postman User Guide. Document Reference: July Version: 2

SMS Relay. API Documentation SPLIO - SPRING Contact and Campaign SMS Relay API - EN v1.2.docx

HTTP API Specification V2.7

API-SMS HTTP/GET Interface Ref Push SMS, Balance, ACKs. April 18, 2017 v1.12

Introduction. Copyright 2018, Itesco AB.

Requirement Document v1.2 WELCOME TO CANLOG.IN. API-Key Help Document. Version SMS Integration Document

Assure Self-Service Portal

External HTTPS Trigger AXIS Camera Station 5.06 and above

Essential Import Service

Error Handling Strategy. DCC Guidance Document

Product Guide SMS PLUS + Copyrights RouteSms Solutions Limited Page 1

API Spec Sheet For HLR v1.4

5/10/2009. Introduction. The light-saber is a Jedi s weapon not as clumsy or random as a blaster.

User Guide for Outward Interbank GIRO (OBG) For Direct Debit (Collections)

Table of Contents 1 AQL SMS Gateway How to Guide...1

PCCW mobile SMS Web Access 2.0 User Guide

API HTTP TECHNICAL DOCUMENTATION WEB-BASED SMS SENDING PLATFORM. Version Update: July 12th Mobile Marketing and Messaging Solutions

NIC SMS SERVICE INTEGRATION

SMS+ Client User Manual

Transcription:

The REST API expects all text to be encoded as UTF-8, it is best to test by sending a message with a pound sign ( ) to confirm it is working as expected. If you are having issues sending as plain text, you can hex encode the message in Latin1 or GSM, and use the hex variable to flag that the message is already encoded. All requests must be authenticated using the login and password you use to access your account. We currently support POST requests in the following formats, specify the format in the Content Type header field: Content Type application/xml application/json application/x-www-form-urlencoded And will respond with the following, set the Accept header field to the desired option: Accept text/xml text/json text/html (html table) text/csv The system does not check if you have sufficient balance to send messages, but you can either poll the message status to confirm it has been sent and/or setup a delivery handler to receive notification of the delivery status. Common error codes: 0 / 00 Sent 99 Blacklisted we have been asked to bar messages to this number 100 Insufficient credits to send message 202 Message rejected by handset 204 / 208 Buffered, could be temporary delay 216 Rejected by SMSC

To submit messages send POST Request to: https://secure.divatelecom.co.uk/api/index.php/v1/message The variables supported are: mobile message subject param1 param2 handler hex encoding* Comma delimited list of mobiles, 077XX or 4477xx format The message to send, this can be up to 608 characters in length if you want to send a long message, or 160 characters if you just want to send a basic single SMS. For long messages you will be charged based on the number of 152 character chunks required to send the full message. The recipients phone will re-assemble the chunks into a single large message. The sender, up to 11 alphanumeric characters, if not specified will send as SMS Customer field, returned in message status response, and also in delivery handler if used. So you can include your own reference to track the messages. 2nd field as above This is the URL of a webpage you have setup to receive a delivery or status report for this message. It must specify protocol. We currently only support HTTP post e.g. handler=http://www.mysite.com/deliveryhandler.php 1 = Message already encoded as hex If your message is encoded in anything other than UTF-8 you must specify the encoding used, otherwise character such as will not be properly detected, and your message may not arrive as intended. The following common character sets enable you to send the full GSM character set : iso-8859-15, utf-8, gsm0338. Please note that iso-8859-1 (latin 1) can be used, but doesn t support characters such as the euro symbol. Message submission request Send a single message to two mobiles: <message>hello World</message> <mobile>0777576xxxx, 0786655XXXX</mobile> Message submission response For a successful submission the response is a unique batch number that can be used with the message status request to track delivery. The status code will be 200 <batch>77081</batch>

For unsuccessful submission the return code will be as follows: 401 Invalid login credentials 403 No message variable set 403 No mobile variable set 500 Server error raise a support ticket Message status request Submit a GET Request to https://secure.divatelecom.co.uk/api/index.php/v1/message Include the batch, and optionally a mobile parameter to get a specific entry. Message status response <batch>77081</batch> <param1/> <param2/> <reports> <report> <mobile>0777576xxxx</mobile> <code>00</code> <time>2011-02-27 09:08:13</time> <credits>1</credits> <status>success</status> </report> <report> <mobile>0786655xxxx</mobile> <code>00</code> <time>2011-02-27 09:08:16</time> <credits>1</credits> <status>success</status> </report> </reports> For unsuccessful requests the return code will be as follows: 400 Batch variable not set 401 Invalid login credentials 403 You are not authorised to query this batch this batch number was not created using your account. 500 Server error raise a support ticket

Delivery and status report messages are sent using a HTTP Post request to a URL specified in your submission. Delivery reports contain the following fields: batch_id mobile report code param1 param2 This is the Batch ID returned when you submitted the messages The mobile number of the recipient. Please note this may have been reformatted to international format. This will either be success, pending or fail. A numeric delivery code for more detailed investigation of delivery problems Your reference, as set when submitting the message. Your second reference field. If your delivery handling page is down, or unresponsive, we will re-try sending the delivery notification several times before giving up. Submit a GET Request to: https://secure.divatelecom.co.uk/api/index.php/v1/account There are no parameters for this request, it will simply return the number of credits you have remaining e.g. XML: <credits>763</credits> From the main menu, select Reports then Traffic Report, choose the time period you are interested in, and change the message direction to Out.

We support the full 03.38 7 bit GSM alphabet as below: