Information on SMS interface (As at March 31 th 2009) Delivery is possible to both mobile subscribers worldwide and the German fixed network



Similar documents
Technical documentation

Spryng Making Business Mobile Mobile Terminated Premium SMS Gateway. Contents:

Spryng Making Business Mobile (0) Spryng Headquarters: Herengracht BW Amsterdam - The Netherlands

Technical Specification Premium SMS gateway

MXSAVE XMLRPC Web Service Guide. Last Revision: 6/14/2012

HTTP/SOAP Application Program Interface (API) Version 1.0

SaaS Encryption Enablement for Customers, Domains and Users Quick Start Guide

Technical Specification Normal SMS gateway

Note: With v3.2, the DocuSign Fetch application was renamed DocuSign Retrieve.

State of Michigan Data Exchange Gateway. Web-Interface Users Guide

DocuSign Connect for Salesforce Guide

AMD Telecom SMS GATEWAY HTTP API INTERFACE. Technical Specifications

Clickatell Communicator2 Help Gui

IP Phone Service Administration and Subscription

Table of Contents. Introduction How to access the Safari Backoffice How Safari corporate accounts are structured...

Remote Viewer Recording Backup

Advanced HTTP API Documentation

Quick Start Guide. Contents. Quick Start Guide Version 1.0 webcrm November 09

Spambrella SaaS Encryption Enablement for Customers, Domains and Users Quick Start Guide

1. Change Log Introduction Flow summary Flow Overview Premium SMS flow Pin Flow Redirect Flow...

THE CHALLENGE OF ADMINISTERING WEBSITES OR APPLICATIONS THAT REQUIRE 24/7 ACCESSIBILITY

Denbigh Administration

Diafaan SMS Server 3.0 Manual Diafaan communication software

account multiple solutions

Legal and Copyright Notice

Messaging API. API Specification Document Messaging API. Functionality: Send SMS Messages.

Messaging Dashboard Quick Reference Guide

USING MYWEBSQL FIGURE 1: FIRST AUTHENTICATION LAYER (ENTER YOUR REGULAR SIMMONS USERNAME AND PASSWORD)

Avaya one-x Mobile User Guide for iphone

Easy Manage Helpdesk Guide version 5.4

Flowlink Pro Server Software Installation Guide

GRS Advantage Website User Reference Guide

Creating an Campaign

Data Mailbox. support.ewon.biz. Reference Guide

CoventryOne Agent Portal User Guide

AT&T Business Messaging Account Management

Tips & Tricks. Guide to Accessing and Navigating Around the ABB Customer Portal and Downloading LinkOne Software

PaymentNet Federal Card Solutions Cardholder FAQs

Using WhatCounts Publicaster Edition To Send Transactional s

Vodafone Bulk Text. User Guide. Copyright Notice. Copyright Phonovation Ltd

Customer Portal User Manual Scott Logic Limited. All rights reserve Scott Logic Limited. All rights reserved

MBLOX RESELLER GUIDE. User guide

KPN SMS mail. Send SMS as fast as !

Parallels Plesk Panel

DALHOUSIE NOTES ON PAYROLL EXPENSE DETAIL IN FINANCE SELF SERVICE. QUICK REFERENCE As of September 1, 2015

MEETINGONE ONLINE ACCOUNT MANAGEMENT PORTAL ACCOUNT ADMIN USER GUIDE

How to Schedule Report Execution and Mailing

SMS for REST Professional

Personal Portfolios on Blackboard

Helix Practice Manager

FACULTY & STAFF RESOURCES

Fairsail REST API: Guide for Developers

Gravity Forms: Creating a Form

USING THE STUDENT RECORD SYSTEM A GUIDE FOR PERSONAL TUTORS

CABI Training Materials. CAB Direct MyCABDirect, Alerts and RSS Feeds KNOWLEDGE FOR LIFE.

Contents. 1 VPN Remote Access Service

Domains Help Documentation This document was auto-created from web content and is subject to change at any time. Copyright (c) 2016 SmarterTools Inc.

Now SMS/MMS Android Modem Quick Start Guide

Sprint Worldwide Services Guide

Avaya one-x Mobile User Guide for iphone

1: 2: : 3.1: 3.2: 4: 5: & CAPTCHA

PHP Tutorial From beginner to master

Personal Communication Manager Quick Reference Guide.

Contact Center Anywhere: Supervision Manager (SM) Overview

SMS Inbound Germany, Austria & Switzerland Specification of Services

Embedded Document Accounting Solution (edas) for Cost Recovery. Administrator's Guide

FTP API Specification V2.6

Grant Management System Training Guide Module 9 Notification Center Home Dashboard Ver 6.1 Updated:

Registration for My Profile & Administration

API. Application Programmers Interface document. For more information, please contact: Version 2.01 Aug 2015

Vodafone multitxt Outlook Mobile Services (OMS)

MyMobileAPI. mymobileapi.com

Normandale Community College Student Employment Website Employer User Guide Updated December 15, 2010

BreezingForms Guide. 18 Forms: BreezingForms

WildFire Cloud File Analysis

Secure File Exchange

Creating a Content Group and assigning the Encrypt action to the Group.

Zipit Chat. Functional Specification / User Manual

TriCore Secure Web Gateway User Guide 1

Plesk for Windows Copyright Notice

How to create an template

SRFax Fax API Web Services Documentation

HTTP Reverse Proxy Scenarios

2) Log in using the Address and Password provided in your confirmation

Parallels Plesk Control Panel

Spambrella SaaS Encryption Enablement for Customers, Domains and Users Quick Start Guide

emobile Bulk Text User Guide Copyright Notice Copyright Phonovation Ltd

Fax User Guide 07/31/2014 USER GUIDE

Configuration Guide Copyright 2013 HiPay wallet All Rights Reserved Last updated in July 2013

Bitrix Site Manager 4.0. Quick Start Guide to Newsletters and Subscriptions

Version 2.1.x. Barracuda Message Archiver. Outlook Add-In User's Guide

Load Balancing Microsoft AD FS. Deployment Guide

MasterCard Smartdata.gen2 (Smartdata)

Online shopping store

AdHoc Translation Management System (TMS) Guide Contents

PaperCut Payment Gateway Module - RBS WorldPay Quick Start Guide

Transcription:

Information on SMS interface (As at March 31 th 2009) Delivery is possible to both mobile subscribers worldwide and the German fixed network URL: http://gateway.any-sms.biz/send_sms.php https: https://www.any-sms.biz/gateway/send_sms.php passing variables: variable format comment/description id numeric (integer) Your customer id (user id) pass alphanumeric string chosen password gateway numeric (integer) SMS-gateway text alphanumeric string (maximum is 160 characters if 'long' variable is not set) the message itself nummer 00491795687454 recipient's number (MSISDN) in international format absender max. 16 digits or 11 characters chosen originator identifier notify notify=1 requests a delivery report (only gateway 20) long long=1 concatenated SMS with more than 160 characters (only gateway 10 and 20) wap_url wap_url=http://www.test.com/pic.gif download URL for wap-push SMS wap_text wap_text=download_picture download identifier of sent wap-push SMS wap wap=1 Send as a WAP push flash flash=1 sends a flash SMS, i.e. message text is displayed upon reception note: recipients mobile must support this feature! time YYYYMMDDHHII variable for delayed delivery. Format is explained below: Y = year 4 digit length, M = month 2 digit length, D = day 2 digit length, H = hour 2 digit length, I = minute 2 digit length xml xml=1 returns a xml structure test test=1 call the interface for testing purpose output of error variable $err: value Description 0 SMS has been accepted -1 invalid user id and/or password -2 Invalid IP address -3 no sufficient credit available for sub-account -4 no sufficient credit available for main-account -5 SMS has been rejected/couldn't be delivered mes.mo GmbH. Stuttgarter Str. 4. 73262 Reichenbach. Phone: +49-7153 558835. Fax: +49-7153 619426 Page 1 of 8

-6 gateway isn't available for this network -9 SMS with identical message text has been sent too often within the last 180 seconds -18 SMS is lacking indication of price (premium number ads) Information on SMS gateways 10 11 SMS worldwide with a fixed originator identifier. Bulk mailings are possible furthermore replies can be received aswell. SMS worldwide with a fixed originator identifier only 'Person to Person' mailings are allowed (no identical SMS message text may be sent to the same recipient's number) optional possibility to receive a reply. 15 SMS worldwide with a fixed originator sent. Bulk mailings are possible replies can not be received. 16 20 SMS worldwide with a fixed originator identifier only 'Person to Person' mailings are allowed (no identical SMS message text may be sent to the same recipient's number) no possibility to receive reply. SMS may be sent worldwide via high-quality routes with a variable originator identifier and an optional delivery report. There is a 99,9% guarantee that SMS will be delivered within 20 seconds. 30 SMS worlwide with a variable originator identifier are handled by international roaming routes. 31 Delivery of individual SMS 'Person to Person' via international roaming routes. NB Upon request we can offer further gateways, which might meet your personal needs better than the ones listed above. Don't hesitate to ask our support team at office@mesmo.de. Return values (with variable xml=1 set) <error></error> <nummer></nummer> <msgid></msgid> <preis></preis> <guthaben></guthaben> <limit></limit> error-code recipient's number (MSISDN) message ID (if set) cost for this SMS delivery remaining credit credit limit Normal return values (without the `xml` variable) line 1: error-code line 2: recipient's number (MSISDN) line 3: message ID (if set) line 4: cost for this SMS delivery line 5: remaining credit line 6: credit limit Information on MMS interface (only available for German mobile networks) mes.mo GmbH. Stuttgarter Str. 4. 73262 Reichenbach. Phone: +49-7153 558835. Fax: +49-7153 619426 Page 2 of 8

URL: http://gateway.any-sms.biz/send_mms.php https: https://www.any-sms.biz/gateway/send_mms.php passing variables: variable format comment/description id numeric (integer) your customer id (user id) pass alphanumeric string chosen password nummer 00491795687454 recipient's number (MSISDN) in international format betreff string (ISO-8859-1 & urlencoded) subject maximum 36 characters used[x] 1 used[x]=1, if bildli[1] has been passed bildli[x] URL image x (0 to 5) in.jpg or.gif format textli[x] string (urlencoded) text x for image x tonli[x] URL sound x for image x (amr format) duration[x] value ranging from 0 to 20 display duration (0 = proceed manually) xml xml=1 returns a xml structure NB Please replace the wildcard character [x] with a numeric value ranging from 0 to 5. Up to 6 multimedia attachments simultaneously per SMS (x=0,1,2,3,4,5) are allowed. output of error variable $err: value description 0 MMS has been accepted -1 invalid user id and/or password -2 Invalid IP address -3 no sufficient credit available for sub-account -4 no sufficient credit available for main-account -5 MMS has been rejected/couldn't be delivered -6 MMS gateway isn't available for this network -7 recipient's number is either too short or too long -8 missing needed variables Return values (with variable xml=1 set) <error></error> error-code <nummer></nummer> recipient's number (MSISDN) <kb></kb> size of MMS (in kilobyte) <preis></preis> cost for this MMS delivery <guthaben></guthaben> remaining credit <limit></limit> credit limit Normal return values (without the `xml` variable) mes.mo GmbH. Stuttgarter Str. 4. 73262 Reichenbach. Phone: +49-7153 558835. Fax: +49-7153 619426 Page 3 of 8

line 1: error-code line 2: recipient's number (MSISDN) line 3: size of MMS (in kilobyte) line 4: cost for this SMS delivery line 5: remaining credit line 6: credit limit mes.mo GmbH. Stuttgarter Str. 4. 73262 Reichenbach. Phone: +49-7153 558835. Fax: +49-7153 619426 Page 4 of 8

Information on sending SMS to an existing group of recpients URL: http://gateway.any-sms.biz/send_group.php https: https://www.any-sms.biz/gateway/send_group.php passing variables: variable format comment/description userid numeric (integer) your customer id (user id) passwd alphanumeric string chosen password accid numeric (integer) 'SMS-Gateway vom Handy' - account id accpasswd alphanumeric string 'SMS-Gateway vom Handy' password (see above) msg alphanumeric string (ISO-8859-1 & urlencoded) Prerequisites for using this interface alphanumeric string maximum is 160 characters First of all you have to create a group of recipients (compare menu item `Empfängergruppen` after succesful login on http://www.any-sms.de/) click on the `Empfängergruppe hinzufügen` link. Then enter a name for the group and press the `speichern` button which will finally save the newly added group. Of course you will have to add recipients to the group which can be done via the add ` ` icon. After having created the group you have to set up a new account which can be done via the menu item `SMS-Gateway`. In order to actually create a new account click on the `Neuen Account anlegen?` link. Now choose a suitable gateway in the `Gateway:` drop-down field then enter an originator identifier (15 digits or 11 characters length) in the input field labeled `Absenderkennung` after that select a recipient group in the `Empfängerliste` drop-down field and finally enter a password for this account. After having created this account click on the `SMS-Gateway` link again. You should then see the newly added account. Now write down the `ID` (compare variable `accid` under passing variables table above) and the password - `Passwort` - (compare `accpasswd`) as both are needed for calling the interface. Example URL for a GET Request (* replace with your values) http://gateway.any-sms.biz/send_group.php?userid=***&passwd=***&accid=***&accpasswd=***&msg=hello+world It is also possible to call the interface with the http POST method. To do this name the form s input fields corresponding to the variables listed in the `passing variables` table above. The shown GET call should return `GET Anfrage akzeptiert!` this indicates that no error occured. A succesful POST call should return `POST Anfrage akzeptiert!`. mes.mo GmbH. Stuttgarter Str. 4. 73262 Reichenbach. Phone: +49-7153 558835. Fax: +49-7153 619426 Page 5 of 8

Information on HLR interface (retrieves information on a MSISDN) URL: http://gateway.any-sms.biz/send_hlr.php https: https://www.any-sms.biz/gateway/send_hlr.php passing variables: variable format comment/description id numeric (integer) your customer id (user id) passwd alphanumeric string chosen password nummer 00491795687454 recipient's number (MSISDN) in international format plus plus=1 execute a `HLR-Plus` query xml xml=1 returns a xml structure Without the `plus` variable you will execute a `HLR-Basic` query which can only retrieve information on German MSISDNs (that means this will work for German mobile networks only). If you want to gather information on a non-german MSISDN you will have to set `plus=1`. This will return both the MNC (mobile network code) and the MCC (mobile country code) furthermore a numeric code (compare `<code>` xml tag or `status code` or $code) on the success of the query itself. The `HLR-Plus` query can be performed succesfully for most international mobile network operators however there are some countries/operators that are known to deliver wrong or undependable results. Affected operators are: - SFR (France) Affected countries are: - USA output of error variable $err: value description 0 query has been performed succesfully -1 invalid user id and/or password -2 Invalid IP address -3 no sufficient credit available for sub-account -4 no sufficient credit available for main-account -5 MSISDN couldn t be checked -6 gateway isn't available for this network -7 recipient's number is either too short or too long mes.mo GmbH. Stuttgarter Str. 4. 73262 Reichenbach. Phone: +49-7153 558835. Fax: +49-7153 619426 Page 6 of 8

output of error variable $code: value description 200 query has been performed succesfully 811 unknown MSISDN 812 MSISDN hasn t registered with HLR for a long period of time 813 carrier denied query 814 queried MSISDN is invalid 815 query couldn t be handled by system 816 query blocked 817 query refused 818 query not supported 819 system failure Return values (with variable xml=1 set) <error></error> <nummer></nummer> <preis></preis> <code></code> <mcc></mcc> <mnc></mnc> <guthaben></guthaben> <limit></limit> error-code recipient's number (MSISDN) cost for this MMS delivery query status code mobile country code mobile network code remaining credit credit limit Normal return values (without the `xml` variable) line 1: error-code line 2: recipient's number (MSISDN) line 3: cost for this SMS delivery line 4: query status code line 5: MCC mobile country code line 6: MNC mobile network code line 7: remaining credit line 8: credit limit mes.mo GmbH. Stuttgarter Str. 4. 73262 Reichenbach. Phone: +49-7153 558835. Fax: +49-7153 619426 Page 7 of 8

Exemplary PHP script for calling the http-interface `send_sms.php` (GET method) $text = Hello World ; $text = urlencode($text); $msisdn = "00491774700456"; $gw = 20; $p = mypassword ; $originator = INFO ; // the MSISDN $url = "http://gateway.any-sms.biz/ send_sms.php?id=100&pass=$p&text=$text&nummer=$msisdn&gateway=$gw&absender=$originator"; $fp = fsockopen ("gateway.any-sms.biz",80,$errno,$errstr,5); if (!$fp) { $back[0] = "connection failed!"; echo $back[0]; } else { $fp = @fopen($url,"r"); while (!feof($fp)) { $back[] = fgets($fp,100); } fclose($fp); NB Don t insert a break row into the URL as this will cause an error. } echo $back[0] // = error code echo $back[1] // = recipient's number echo $back[2] // = price for this SMS echo $back[3] // = remaining credit echo $back[4] // = message ID echo $back[5] // = credit limit mes.mo GmbH. Stuttgarter Str. 4. 73262 Reichenbach. Phone: +49-7153 558835. Fax: +49-7153 619426 Page 8 of 8