EE Messaging Portal powered by Soprano

EEMP HTTP & WSDL Interface Developers Guide
v7.1.0

© 2013 Soprano Design Pty Ltd

Commercial In Confidence

EEMP HTTP & WSDL Interface Developers Guide v7.1.0

© 2013 Soprano Design Pty Ltd AND CONFIDENTIALITY
All rights reserved Soprano Design Pty Ltd. No parts of this work may be reproduced in any form or by any means -
graphic, electronic, or mechanical, including photocopying, recording, taping, or information storage and retrieval
systems - without the written permission of SOPRANO Design Pty Ltd.

Products that are referred to in this document may be either trademarks and/or registered trademarks of the
respective owners.

While every precaution has been taken in the preparation of this document, the publisher and the author assume no
responsibility for errors or omissions, or for damages resulting from the use of information contained in this
document or from the use of programs and source code that may accompany it. In no event shall the publisher and
the author be liable for any loss of profit or any other commercial damage caused or alleged to have been caused
directly or indirectly by this document.

Printed: October 2013 in (wherever you are located)

Commercial In Confidence

Contents

Table of Contents

EEMP HTTP & WSDL Interface Developers Guide 5
API Capability 6
Interface Description 10
Getting Started with the HTTP Interface 12
Sending SMS Messages 14
Request 14
Response 15
Com m ands 15
sendmsg 16
Example: Sending to Single Destination 19
Example: Send a Message to a Single Destination w ith Error 20
Example: Send a Message to Multiple Destinations 20
Example: Send a Message to Multiple Destinations w ith Registered Flag 21
Example: Send a Message to a Single Destination and Request XML Response 21
Example: Send an SMS w ith Registered Delivery - Reply to Email 21
startbatch 22
Example: Initiate a Message Batch 25
Example: Initiate a Message Batch and Request XML Response 25
sendbatch 25
Example: Send Batch Messages 26
Example: Send Batch Messages and Request XML Response (Invalid Content
Value) 27
Example: Send Batch Messages (Error w ith batch_id) 27
Example: Send Batch Messages (Error w ith a Destination) 27
Receiving SMS Messages 29
Preferences 29
Request 30
Response 30
Com m ands 30
Receiving SMS Delivery Reports Messages 33
Delivery Receipt Form at 33
WAP Push 35
Request 35
Response 35
Com m ands 36
sendw appush 36
Example: Send WAP Push message 38
Example: Send WAP Push message to multiple destinations w ith request xml
response 39
Query SMS Messages 40
Request 40
Response 40
Com m ands 41
querymsg 41
Example: Send query message 42
Example: Send query message w ith non-existent/unmatched msg_id 42

© 2013 Soprano Design Pty Ltd
Commercial In Confidence
3

WSDL Definition 66 Appendix H .Text & Data Param eter Restrictions 63 Appendix E .Exam ple Code 64 w get .HTTP API Test Script 65 Encoding Authentication Strings 65 Appendix G .XML response DTD 64 Appendix F .FAQ 69 © 2013 Soprano Design Pty Ltd Commercial In Confidence 4 .DCS Param eter Details 61 Appendix D .0 Example: Send query message w ith multiple msg_Id 42 Cancel SMS Messages 43 Request 43 Response 43 Com m ands 44 cancelmsg 44 Example: Send cancel message 45 Example: Send cancel message w ith w ith non-existent/unmatched msg_id 45 Example: Send cancel message w ith multiple msg_id 45 Web Services – WSDL 47 Request 48 Response 49 Com m ands 49 Request 50 Response 52 Exam ple: Full trace WSDL Interaction 53 Appendices 55 Appendix A .Abbreviations 55 Appendix B .EEMP HTTP & WSDL Interface Developers Guide v7.HTTP API Test Script 65 perl .1.Response Details HTTP 56 Appendix C .

RFC 2617 .html> [7] Freed. D.ietf. et al.Internet Calendaring and Scheduling Core Object Specification (iCalendar). <http://www.ietf.1. mobile messages. This document provides a technical overview of the HTTP and WSDL interfaces for the EE Messaging Portal powered by Soprano platform. F.iCalendar Message-Based Interoperability Protocol (iMIP). RFC 2045 .org/pda/AQuery.faqs. J.Hypertext Transfer Protocol -. et al. To-dos and Journal Entries.org/rfc/ rfc2425. <http://www. <http://www.HTTP Authentication: Basic and Digest Access Authentication.org/rfc/ rfc2426.asp> [9] Howes.txt> [4] Dawson. Premium SMS and WAP Push etc. <http://www.org/rfcs/rfc2617. (1999). (1998). RFC 2616 . R. Issue 1. T. BusyTime.ietf. Digital cellular telecommunications system (Phase 2+). Overview and Document Purpose EE Messaging Portal powered by Soprano is an industry-leading mobile messaging application which facilitates users in the sending and receiving of SMS.org/rfc/rfc2446.org/rfc/rfc2445.org/rfcs/rfc2045. References [1] Soprano Design (2004).faqs. et al.txt> [5] Fielding. (1998). and Borenstein. (1998). F.ietf. SOPRANO Corporate Gateway Platform – System Requirements Specification.ietf.html> [6] Franks.A MIME Content-Type for Directory Information.0 [2] Dawson. T. <http://www.txt> [11] SMPP Developers Forum (1999).4.etsi.38) <http://pda. Alphabets and language-specific information (GSM 03. N. and Howes. RFC 2445 . RFC 2447 . (1999).iCalendar Transport-Independent Interoperability Protocol (iTIP) Scheduling Events.org/rfc/rfc2447. (1998).vCard MIME Directory Profile <http://www. RFC 2426 . (1996).txt> [10] Silverberg. et al. Intended Audience This document is intended for EEMP customers interested in using: EEMP’s HTTP & WSDL interfaces for sending SMS A basic knowledge of the HTTP protocol [5] is required. S.Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies.faqs.0 . <http:// www. N.1. and Stenerson.org/rfcs/ rfc2616.2 Commercial In Confidence 5 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7. version 4. RFC 2446 . (1998).txt> [3] Dawson.HTTP/1. Short Message Peer to Peer Protocol Specification v3. <http:// www.html> [8] ETSI (1996). F. et al. RFC 2425 .

1. Please note that all mobile numbers must be entered in international format when using the APIs & interfaces.0 . Parameters User List Based Authentication Passcode Authentication Source Domain IP Auth.NET (Sim ple) (Standard) Send SMS Receive Inbound SMS Scheduled Delivery Registered Delivery Define Validity Period Reply Control & Management Source Address Control Send to Multiple Recipients Query Message Status Cancel Message Replace Message Limit Content to Single SMS Mobile Barcode Binary Message (Ringtone) vCard / vCalendar Messages WAP Push (SI/SL) Messages One Time Passw ord Secure Connection HTTPS Secure Tunnel (OpenSSL) Username and Passw ord Auth. Commercial In Confidence 6 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7. Basic Username and Passw ord Auth.API Capability The following table describes the API capability available on EE Messaging Portal powered by Soprano. HTTP WSDL SMPP SMTP SMTP OMS Java API .

Long Code (standard international mobile number) or an Alpha Address (up to 11 characters).1. this can be overwritten using the API. or batched. While a default reply path exists within EEMP. Send MMS The protocol/API call provides the ability to send an MMS (Mobile Terminated Multimedia Message) to one or more destinations. email address. Delivery Receipts (or 'Delivery Reports') may not be fully supported across interconnect (such as delivering a message from GSM to CDMA networks or when delivering internationally). If you have multiple short codes you have the ability to nominate which short code to use for each message. Define Validity Period The protocol/API provides the ability to set the length of time the message may reside in the mobile network SMSC without delivery (when a mobile handset is switched off or unavailable). using different time intervals (monthly. or the platform database for reporting purposes only. Messages can be triggered to be sent at a later scheduled time using a relative value from when the request was submitted (e. Delivery receipts are delivered the same way as an Inbound messages. Some countries do not support the sending of messages with alphanumeric Commercial In Confidence 7 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7.0 . 5 minutes). Setting an expiry time for each message (e. 2 hours from now).g. 1 day or 8 hours) enables messages to expire when not delivered within a desired period. Note: The available source addresses may be limited to one or more which have been provisioned for the root customer specifically. This may be defined as a web URL. This may be a Short Code / Vanity Short Code. Scheduled Delivery The protocol/API provides the ability to schedule a Mobile Terminated short message for delivery at a time specified in the future. Reply Control & Management The protocol/API provides the ability to control where replies (Mobile Originated/Delivery Receipts or Reports) are to sent to in our system. prompting the mobile network to return back a delivery receipt once the message is delivered to the device. Receive Inbound SMS The protocol/API provides the ability to receive SMS (Mobile Originated Short Messages) originating from a mobile device and deliver to a customer system in real-time. another mobile. Source Address Control The protocol/API provides the ability to define the 'From' address that will appear on the receiving mobile phone. Registered Delivery The protocol/API provides the ability to request a notification when the network delivers a message to the mobile device. hourly. weekly. API Functions Function Description Send SMS The protocol/API call provides the ability to send an SMS (Mobile Terminated Short Message) to one or more destinations.g. EEMP will automatically allocate a short code to the message if no source address is assigned to the message. daily. This is useful for situations where the message is no longer relevant if not delivered within the defined validity period. A registered flag can be set on a message.

and has not been delivered to a mobile device that is switched off or unavailable. so EEMP can provide the ID in the response received and forwarded to the nominated or default reply address. Commercial In Confidence 8 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7.0 . addresses. which can be used in the transmission of the SMS (one-time password is then stored in a variable for your code to utilise upon challenging). To track responses to internal transactions. Username & Password Auth. Mobile Barcode Not currently supported.Service Loading) over SMS. Binary Message (Ringtone) Not currently supported. Transaction ID The protocol/API provides the ability to automatically manage sessions for customers. utilising HTTPS.1. Secure Tunnel (OpenSSL) The platform provides the ability to utilise Open SSL to set up a 'soft' VPN-type connection. using the message ID that you receive from the platform after sending. to secure communications protocols not already using SSL or equivalent. Query Message Status The protocol/API provides the ability to query the status of a message for final status updates (SMSC response or receipt update). These messages are limited to 140 octets and may not be supported by all networks. WAP Push (Si/SL) Messages The protocol/API provides the ability to send a WAP push (SI . One-Time Password The API (code) provides the ability to call a function that will generate a one- time password. Cancel Message The protocol/API provides the ability to cancel a message that has been scheduled or queued for future delivery. There are also some constraints when setting the source address which will disable automatic reply management in the platform. Secure Connection HTTPS The transport layer of communication with the platform is secured over an SSL socket. Long Concatenated Messages The protocol/API supports long messages (up to 1400 characters). customers can assign an ID to each message sent. Send to Multiple Recipients The protocol/API provides the ability to send to multiple recipients in a single request/API call. Limit Content to Single SMS Protocol/API preferences in the platform allow SMS messages to be truncated to a maximum of 160 characters (1 SMS). The platform supports validation of API access using a username and Basic password encoded with Basic Authentication method and transmitted in the HTTP header. This is applicable to SMTP (Email2SMS API. vCard / vCalendar Messages Not currently supported. where an enterprise mail server may append a footer to the email that is received by the platform). or the current smart phone range. Replace Message The protocol/API provides the ability to override and replace the content of a message that you have previously sent. Note: Not all carriers support this function. which prevents long messages from being generated.Service Indicator or SL .

All supported protocols require configuration by the provisioning team.0 .'. Commercial In Confidence 9 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7. Username & Password Auth. The platform supports validation of API access using username and Parameters password parameters transmitted in the GET / POST parameters. IP address checking can be controlled in the Email API Preferences for SMTP. Secure Domain IP Auth. The platform supports validation of API access by checking a passcode in an email subject line. and is typically used in conjunction with 'User List Based Auth. User List Based Auth. The platform has the ability to lock down API access to a limited set of IP addresses.1. This means that the sender of the message does not have to be a platform user. Passcode Auth. The platform supports validation of API access by looking up a whitelist of allowed senders (the sender does not have to be a platform user).

an SSL secured interface can be used. All 'send' commands require authentication (implemented via HTTP Basic Authentication – refer to 'References [6]') for any requests made. The following is a list of EEMP HTTP Interface URLs: Command URL sendmsg https://t-mmp. A record of all messages sent via the HTTP POST interface is recorded in EE Messaging Portal powered by Soprano and can be accessed via the web or other reporting interfaces.com/cgpwebservices/services/CGPWebSMSInterface Request path: https://t-mmp.1 compliant. what parameters are available.e. Using the WSDL interface. country code followed by the number) without spaces and special characters such as +. This interface can be used in the form of HTTP POST or as URL (HTTP GET).com/cgphttp/servlet/sendmsg startbatch https://t-mmp. username and passwords sent as clear-text over the internet and therefore open to interception by a third party).com/cgpwebservices/services/CGPWebSMSInterface/ sendmsg Commercial In Confidence 10 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7. For example: 447312345678. However.1. EEMP is HTTP version 1. NOTE: The default for all recipient and source numbers is valid international format (i.com/cgphttp/servlet/sendwappush querymsg https://t-mmp.0 . defined customers can see what services are available. The following are the EEMP WSDL interface URLs: Command URL sendmsg (WSDL) https://t-mmp.com/cgphttp/servlet/sendbatch sendwappush https://t-mmp.com/cgphttp/servlet/cancelmsg NOTE: The above URLs will also work with HTTP. It is recommended to use the 'POST' method when sending messages due to the URL length limitations and restriction to the ASCII character-set if 'GET' method.g.com/cgphttp/servlet/querymsg cancelmsg https://t-mmp.com/cgphttp/servlet/startbatch sendbatch https://t-mmp. Since basic authentication is inherently insecure (e. examples throughout this document mainly use the GET method for ease of understanding and demonstration. where to address the Web Services Requests. Only the GET method is used to deliver received messages. Both HTTP and HTTPS are supported.Interface Description Customers can be authorised to send or receive messages using this HTTP interface.

Command URL Commercial In Confidence 11 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7.1.0 .

Prerequisite You must have requested the HTTP API to be provisioned when filling in the order form. please provide this information when requesting HTTP API access. If you wish to lock your HTTP API access down to originate from a particular host or set of hosts.1. 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. 447312345678 $text is the text that you wish to send. then you need to explicitly request this on your order form.c: You should receive a confirmation in your browser window that the message was successfully sent.e. https://t-mmp. Commercial In Confidence 12 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7. If you wish to receive messages in response to the messages you send through your API. which can be used to interrogate the message status.b: You will be prompted by your browser for your username and password. 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.a: In your browser's address bar. Step 2.com/cgphttp/servlet/sendmsg?destination=$mydestination&text=$text Where: $mydestination is the mobile number you want to send to in international format i.Getting Started with the HTTP Interface The following is a quick guide to the simplest form of sending an SMS message with HTTP API Development. The easiest way to test the service is with your browser. you can start using the service. This should match the username you provided at the time of provisioning. and the message's Client Message ID.0 . Step 2. Step 2. type/paste the URL.

1.Encoding Authentication Strings Step 4.NET Various shell script examples include: Perl wget PHP Code Snippets: VB . Step 3: Build your HTTP API Application API code libraries include: Java VB .0 . Commercial In Confidence 13 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7. Additional Support Additional support and information exists for API and interface development: Support teams Online Help Additional Information HTTP URL depends upon the service that you will utilise.

20 Aug 2008 07:14:32 GMT destination=61491000000&text=initial+test+message The above example displays a basic SMS request. followed by a colon (:) and the customer’s password. The example is only valid when there is a pooled SMS source address defined to be used as a source address. if you do not wish to use the basic authentication method for your submission you may use the HTTP Commercial In Confidence 14 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7.charset=utf-8 Content-Length: 30 Date: Wed.0 . and a response is returned from the EEMP to the customer.Sending SMS Messages The HTTP interface may be used to send SMS messages (intended for delivery to one or more destinations). The HTTP interface also supports batch messaging.au:password' where base64_username_and_password is the customer’s username. where the customer’s username and password are provided within the authorization header field. allowing the user to define a template containing elements common to the batch and send only the parameters that change on a message-by-message basis. all encoded as a single string using the base64 encoding scheme (refer to [7]).x 200 OK Content-Type: text/plain.com. Please note that all mobile numbers must be entered in international format when using the APIs & interfaces. The Authorization header line is of the form: Authorization: Basic base64_username_and_password Example: 'YWxpYXNAc29wcmFuby5jb20uYXU6cGFzc3dvcmQ=' equates to: 'alias@soprano.1 Authorization: Basic YWxpYXNAc29wcmFuby5jb20uYXU6cGFzc3dvcmQ= HTTP/1. Alternatively. The first example above includes authorization for a customer whose username is 'Aladdin' and password is 'open sesame'. This requires that the customer’s username and password be included in an authorization line in the HTTP header. Users have the option to use a specific source address from the address list available for the user by adding 'source' parameter to the request.1. The POST and GET requests are to be initiated by the customer. Request Message submission using the POST method conforms to the following structure: Request: POST %HOST_URL%:PORT/cgphttp/servlet/sendmsg HTTP/1. Both POST and GET methods are supported. An example of message submission 'Request' using the GET method may look like: https://HOST_URL:PORT/cgphttp/servlet/sendmsg?destination=61491000000& text=initial+test+message Authentication NOTE: Access to the EEMP host requires authentication (implemented via HTTP Basic Authentication).

13 Aug 2008 03:52:48 GMT Status Line=HTTP/1. and their corresponding parameters.com. due to an unrecognised format. the URL parameters will be ignored and the basic authentication values will be used.3 Date: Mon. a response string (refer to Table 2) and an identifier for the message (which can be used when querying/canceling the message). parameters 'username' and 'password' to authenticate your request.0 .1 200 OK 0 001 OK Message-ID: 7836 The body of all successfully received responses to message submission requests by EEMP will contain a one digit success code (0 = success or 1 = error).command not recognized Note that the response contains text intended for use in automated applications. 21 Jun 2004 09:15:23 GMT Content-Type: text/plain Content-Length: 9 2 001 ERROR .1 Set-Cookie: JSESSIONID=B76916114E6610F0E636EE355FE2B8B7. Section Appendix B: Response Details describes the commands and corresponding responses for the HTTP interface. https://HOST_URL:PORT/cgphttp/servlet/sendmsg?username=demo@soprano. a three digit response code (refer to Table 2). Commands Sending SMS Messages commands include: sendmsg startbatch Commercial In Confidence 15 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7. If the request could not be interpreted by EEMP (e.charset=utf-8 Content-Length: 30 Date: Wed. or missing mandatory parameters). Response The following is an example response for the example POST request above: Server: Apache-Coyote/1.1. For example: Response: HTTP/1. the response will contain a success code of 2 (indicating an error with the command). Path=/cgphttp Content-Type: text/plain. 'sendmsg Commands section' describes the commands that can be used to submit messages to EEMP and corresponding responses for the HTTP interface. and their corresponding parameters.au& password=mypwd01&destination=61491000000&text=initial+test+message If you provide both username and password in the URL parameters AND in your basic authentication. a response code (refer to Table 2) and a response string (refer to Table 2) identifying the error.g.1 200 OK Server: Apache/1.

g. This is a mandatory parameter. some of the message reply features are disabled. destination Destination or recipient number. Note: There is a maximum number of destinations supported in a HTTP sendmsg request of 100 destinations. sendbatch sendmsg The sendmsg command is used to send an SMS message to one or more recipients.447312345679 you will also have to supply the source address. registered Request acknowledgment for message. Note: If programming within the Authorization header field is not possible.0 . Returns 0 Off (default) Commercial In Confidence 16 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7. Note: If you specify multiple destination addresses. format. text Message content. This is a mandatory parameter.1. destination=447312345678. Will only accept text data. including linking Client Message ID of submitted message to the response i. i. Provided in HTTP Authorization field. Typically a valid 1 – 15 digits ISDN number. Note: If programming within the Authorization header field is not possible. you may submit the username & password parameters inside the GET or POST request. you may submit the username & password parameters inside the GET or POST request. but other numbers can be specified along with the use of the destinationTON and destinationNPI parameters. 447312345678 Note: If you define the source address in the request. Parameters Description Restricted Values username Username for the customer. Messages can be sent to multiple recipients by separating the numbers with commas. This is a mandatory parameter.e. If you use the 'source' parameter in the request the replyTo and replyToTON address specified will be ignored. e. Usually the username is the user email address. password Password for this user. Provided in HTTP Username will be in email address Authorization field. Either the text parameter or the data parameter may be used in a single request – not both. source Valid international format number or alphanumeric 1 – 15 digits or 11 character string (corresponding to the sourceTON and alphanumeric string sourceNPI parameters) representing the sender or message source.e.

1. or a valid inbound order ID etc. destinationNPI Numbering Plan Indicator for destination address 0 Unknown (es).0 . 1 (default) If no priority is supplied. replyToTON Type of Number to be used for reply address to 0 INBOX indicate if replyTo field is: INBOX.69) 6 Land Mobile (E. Parameters Description Restricted Values msg_id. EMAIL. delay Delay delivery of SMS to recipient. 1 MOBILE INBOUND. reserved for future. 8 EMAIL 10 URL responseType Specifies the envelope type to be used to send 0 Text/plain (default) HTTP response 1 Text/XML costCentre User cost centre label 100 characters maximum clientMessageId User message reference which will be sent back 100 characters maximum with reply messages Note: if you define the source address in the request. replyTo Specifies the destination the reply goes to. Including linking Client Message ID of submitted message to the response. a default priority of 1 will be used for the message. URL. URL. must be Integer-relative delay (from less than 'valid' value.212) 8 National 9 Private 10 ERMES Commercial In Confidence 17 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7.163/E. If used. Note 2: If you use the 'source' parameter in the request the reply address specified will be ignored. email. can be a valid MSISDN. Note 1: When using replyTo parameter it is mandatory to also use the replyToTON parameter. MOBILE. 1 ISDN (E.121) 4 Telex (F. after which time Relative validity (from message the message will not be sent. This Maximum 250 characters. used for message routing. default = 10080 (7 days)) priority Message priority. some of the message reply features are disabled.164) (default) 3 Data (X. replyToNPI Not used. submission time) in minutes (positive integer greater than 0. message submission time) in minutes (typically greater than 10 for best effect) valid The validity period of the message. user and status to the customer via the 1 On specified channel for acknowledgments.

Either the text parameter or the data parameter may be used in a single request – not both. provided content. 1 International (default) 2 National 3 Network Specific 4 Subscriber Number 5 Alphanumeric 6 Abbreviated sourceNPI Numbering Plan Indicator for the source address.0 .164) (default) 3 Data (X. the only accepted dcs values are: 0. 8. For text. Nokia Group Logos or raw binary data (as indicated by the content_type parameter or the presence of the udh parameter). (160 For data.121) 4 Telex (F. dcs Indicates the Data Coding Scheme for the SMS 0 EEMP will determine the coding scheme based on dcs must be provided if a data value is provided.69) 6 Land Mobile (E. If no special characters (e. The 160 characters or 140 bytes data parameter is used to send Nokia Ringtones. 1 International (default) 2 National 3 Network Specific 4 Subscriber Number 5 Alphanumeric 6 Abbreviated data Message content (hexadecimal encoding).163/E.212) 8 National 9 Private 10 ERMES 14 Internet (IP) 18 WAP Client ID sourceTON Type of Number to be used for the source 0 Unknown address. the only accepted dcs values are: 0. 4. dcs has to be provided and must be set to 2 or 4. If binary data is used. characters per message) 8 Commercial In Confidence 18 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7. maximum Nokia Operator Logos. Nokia Picture Messages.g. 2. Parameters Description Restricted Values 14 Internet (IP) 18 WAP Client ID destinationTON Type of Number to be used for destination address 0 Unknown (es).1. 0 Unknown 1 ISDN (E. 16 UCS2) are found then the value 1 is used.

per message) NOKIA_PICTURE_MESSAGE. Note. 4 binary). Example: Sending to Single Destination Request: http://HOST_URL:PORT/cgphttp/servlet/sendmsg?destination=61403021234&text=initial+ test+message&source=61403020000 For the above example.24 represent flash type (70 characters per messages. 2 Nokia Ringtone This parameter is mainly used to indicate use of 3 Nokia Operator Logo binary messages like logos and ringtones. Note: Optional parameters are shown in italics.0 . (70 characters per message) content_type Specifies the type of content in the text or data 1 Plain text (default) parameter. DCS = 16. Standard GSM 7 bit Alphabet. the text 6 Business Card (vCard) - parameter is assumed to contain plain text (URL Not currently supported encoded).1. UCS2 (ISO/IEC-10646).20. 4 Octet unspecified (8-bit NOKIA_GROUP_LOGO use dcs values: 2. 2. 7 Calendar Event (vCalendar) . (140 characters NOKIA_OPERATOR_LOGO.Not currently supported 8 Raw Binary Data (data includes UDH) udh Contains the UDH (hexadecimal encoding) for the The udh parameter should be less data contained in the data parameter. The purpose is to force messages to be sent from a specific source address rather using a pooled source address. 4 8 UCS2 (ISO/IEC-10646). (140 characters per message) 24 Flash Message. binary). If the content_type parameter is not included when the text parameter is used. (140 characters per message) For RAW_BINARY_DATA use dcs values: 0. message) 16 Flash Message. the mentioned source address has to be a valid address. Commercial In Confidence 19 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7. Octet unspecified (8-bit binary). than 139 bytes if it is to be delivered Either the content_type parameter or udh as a single SMS (refer to Appendix C parameter must be used when the data parameter for more details) is used. Parameters Description Restricted Values 2 Octet unspecified (8-bit For NOKIA_RINGTONE. (160 characters per message) 20 Flash Message. Either the content_type parameter or udh 4 Nokia Picture Message parameter must be used when the data parameter 5 Nokia Group Logo is used.

61432145677. The requirement for 'source address' is to be able to handle and process incoming 'reply' messages on this source address.0 . Response: 0 001 OK Message-ID: 12300012 Example: Send a Message to a Single Destination with Error Request: https://HOST_URL:PORT/cgphttp/servlet/sendmsg?destination=61403021235&text=initial+ test+message&source=61403020000 Response: 1 031 ERROR . 61401425431&text=initial+test+message&source=61403020000 Response: 0 001 OK Message-ID: 12300014 Commercial In Confidence 20 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7. Alternatively. Request ('source' parameter absent): http://HOST_URL:PORT/cgphttp/servlet/sendmsg?destination=61403021234&text=initial+ test+message Using the above example sends the message using one of the pooled source addresses. the system will automatically allocate one from a configurable pool of source addresses. Request: https://HOST_URL:PORT/cgphttp/servlet/sendmsg?destination=61403021235.1.internal CGP failure This error is returned if the service is not activated. if you do not specify a source address. Example: Send a Message to Multiple Destinations When sending a message to multiple addresses a valid 'source address' has to be provided.

in this case an email address (into email client).61432145677& text=initial+test+message&source=61403020000&registered=1 Response: 0 001 OK Message-ID: 1001 Example: Send a Message to a Single Destination and Request XML Response Request: https://HOST_URL:PORT/cgphttp/servlet/sendmsg?destination=61403021234&text=initial+ test+message&source=61403020000&responseType=1 Response: <response> <message> <success_code>0</success_code> <response_code>001</response_code> <response_string>OK</response_string> <message_id>1167</message_id> </message> </response> Example: Send an SMS with Registered Delivery .com.Reply to Email https://HOST_URL:PORT/cgphttp/servlet/sendmsg?destination=61494225344&text=hello13&dcs =8&replyToTON=8&replyTo=peter@soprano. the SMSC platform will forward the delivery receipt to the reply address.Example: Send a Message to Multiple Destinations with Registered Flag Request: https://HOST_URL:PORT/cgphttp/servlet/sendmsg?destination=61403021235. source=61494225344 destination=61407838067 clientMessageId= text=id:4988312 sub:001 dlvrd:001 submit date:1005251604 done date:1005251609 stat:EXPIRED err:000 text:No Text Commercial In Confidence 21 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7.aureplytoton=8&registered=1 Turn handset off. Once the message has expired.1.0 .

‘%’ or ‘&’ that have existing meanings within a URL.e. If you use the 'source' parameter in the request the replyTo and replyToTON address specified will be ignored. user and status to the customer via the specified channel for acknowledgments. Parameters Description Restricted Values username Username for the customer. Provided in HTTP Username will be in email Authorization field. source Valid international format number or alphanumeric 1 – 15 digits or 11 character string (corresponding to the sourceTON and alphanumeric string sourceNPI parameters) representing the sender or message source.’. Note: If you define the source address in the request. registered Request acknowledgment for message.’. including linking Client Message ID of submitted message to the response. It defines the common elements for a batch of messages.) template Message template. a single character such as ‘. .g. Hi ^field2^.’. after which time the Relative validity (from message Commercial In Confidence 22 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7. The ID returned in response to a startbatch request must be used in sendbatch requests to link data with a message template. (Note: If programming within the Authorization header field is not possible. you may submit the username & password parameters inside the GET or POST request.1. ‘. Care should be taken not to use characters such as ‘#’. Note: Field1 is used for the recipient’s mobile phone number and is typically not included in the message template.startbatch The 'startbatch' command is used to initiate batch messaging. Integer-relative delay (from message submission time) in minutes (typically greater than 10 for best effect) valid The validity period of the message. Provided in HTTP Authorization field.) password Password for this user. address format. i. (Note: If programming within the Authorization header field is not possible. 1 On delay Delay delivery of SMS to recipient. your appointment is at ^field3^ tomorrow). delimiter Allows customisation of the delimiter. (default) Typically. you may submit the username & password parameters inside the GET or POST request. ‘|’ or ‘. including optional personalised fields (field2 to fieldN) surrounded by ^ symbols (e. ‘ ’. some of the message reply features are disabled.0 . Hence the first field should be identified with field2. including a message template containing customised fields (customised fields should be referred to within the message template as field1 through to fieldN). Returns 0 Off (default) msgid. with consecutive field numbers incremented by 1 identifying them.

69) 6 Land Mobile (E. 0 Unknown 1 ISDN (E.0 . sourceNPI Numbering Plan Indicator for the source address.212) 8 National 9 Private 10 ERMES 14 Internet (IP) 18 WAP Client ID sourceTON Type of Number to be used for the source address.164) (default) 3 Data (X.212) 8 National 9 Private 10 ERMES 14 Internet (IP) 18 WAP Client ID destinationTON Type of Number to be used for destination address(es) 0 Unknown 1 International (default) 2 National Commercial In Confidence 23 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7. Parameters Description Restricted Values message will not be sent. a default priority of 1 will be used for the message.163/E. default = 10080 (7 days)) priority Message priority. 0 Unknown 1 ISDN (E. submission time) in minutes (positive integer greater than 0.164) (default) 3 Data (X. used for message routing.69) 6 Land Mobile (E.121) 4 Telex (F.121) 4 Telex (F.163/E. 1 (default) If no priority is supplied.1. 0 Unknown 1 International (default) 2 National 3 Network Specific 4 Subscriber Number 5 Alphanumeric 6 Abbreviated destinationNPI Numbering Plan Indicator for destination address(es).

0 EEMP will determine the coding scheme dcs must be provided if a data value is provided. DCS = 16. 16. based on provided content. (140 characters per message) 24 Flash Message. and is not persistent in the unlikely event of EEMP failing (and having to be restarted). Parameters Description Restricted Values 3 Network Specific 4 Subscriber Number 5 Alphanumeric 6 Abbreviated dcs Indicates the Data Coding Scheme for the SMS. 20. If no special For text. If this event does occur. Commercial In Confidence 24 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7.20. (160 Note. (140 characters per message) 4 Octet unspecified (8-bit binary). are found then the value 1 is used. Octet unspecified (8-bit binary). The batch ID is valid for a period of 24 hours after it was generated.1. (140 characters per message) 8 UCS2 (ISO/IEC-10646). (160 characters per message) 20 Flash Message. Standard GSM 7 bit Alphabet. 8.24 represent flash type messages. the only accepted dcs values are: 0. the message template needs to be re- established by re-issuing startbatch and sendbatch commands. (70 characters per message) 16 Flash Message. characters per message) 2 Octet unspecified (8-bit binary).g. (70 characters per message) responseType Specifies the envelope type to be used to send HTTP 0 Text/plain (default) response 1 Text/XML The identifier returned from this command must be used when sending subsequent messages via the sendbatch command. UCS2 (ISO/IEC-10646). UCS2) 24.0 . characters (e.

) password Password for this user. (Note: If programming within the Authorization header field is not possible.1.0 . you may submit the username & password parameters inside the GET or POST request.Example: Initiate a Message Batch Request: https://HOST_URL:PORT/cgphttp/servlet/startbatch?template=Hi+^field2^. Provided in HTTP Username will be in email address Authorization field. Commercial In Confidence 25 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7. +your+balance+is+^field3^ Response: 0 002 OK Batch-ID: 241 Example: Initiate a Message Batch and Request XML Response Request: https://HOST_URL:PORT/cgphttp/servlet/startbatch?template=Hi+^field1^. Provided in HTTP Authorization field.+your+balance+ is+^field2^&responseType=1 Response: <response> <message> <success_code>0</success_code> <response_code>002</response_code> <response_string>OK</response_string> <batch_id>1209139371</batch_id> </message> </response> sendbatch The sendbatch command is used to deliver the content for individual messages for a particular batch. format. Parameters Description Restricted Values username Username for the customer.

120t/XML Note: This command contains no optional parameters. batches started by one customer may only be used by that customer).Mark.Jane.Paul.1.100 Response: 0 001 OK Message-ID: 12300016 61403021234 003 0 001 OK Message-ID: 12300017 61403041744 003 Commercial In Confidence 26 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7. If this event does occur. Batch_ids are only relevant for a period of 24 hours after they were created.) batch_id Batch identifier returned from startbatch command. the message template needs to be re-established by re-issuing startbatch and sendbatch commands.0 .250&content=61403041744. Each content refers to a single message destination address must be the first being generated from a template. where x with each parameter separated by the delimiter denotes a data element. The value. John. Batches may only be used by the user who established them (by virtue of the previous statement.50&content=6140 1425431. defined by data element of the content value and batch_id conform to the format specified by the destinationTON and destinationNPI parameters. Example: Send Batch Messages Request: https://HOST_URL:PORT/cgphttp/servlet/sendbatch?batch_id=241&content=61403021234. and are not persistent in the unlikely event of the EEMP failing (and having to be restarted).100&content=6143214 5677. Joe. content Contains the data to be inserted into the template x delimiterval x delimiterval etc. responseType Specifies the envelope type to be used to send 0 Text/plain (default) HTTP response 1 Text&content=61403021235. Each content parameter represents a single message and a msg_id is returned for each content parameter in the sendbatch command. you may submit the username & password parameters inside the GET or POST request. Parameters Description Restricted Values (Note: If programming within the Authorization header field is not possible.

John 100&content=61432145677.Example: Send Batch Messages and Request XML Response (Invalid Content Value) Request: https://HOST_URL:PORT/cgphttp/sendbatch?batch_id=1209139371&content=61403021234 Joe.Jane&responseType=1 Response: <response> <message> <success_code>1</success_code> <response_code>040</response_code> <response_string>ERROR</response_string> <message_id/> <destination>61403021234</destination> <destination_code>108</destination_code> <destination_description>PARAMS_FOR_TEMPLATE_NOT_MATCHED</destination_description> </message> </response> Care must be taken to ensure that the content values match with the corresponding numbered template fields.250&content=61403041744.50&content=61401425431.Paul.Paul.John.Mark.120 Response: Commercial In Confidence 27 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7.120 Response: 1 002 ERROR – batch_id not found Batch-ID: 24 Example: Send Batch Messages (Error with a Destination) In case of an invalid destination value.1.0 .Mark. Always check the destination value to determine whether there are any failed messages. no messages will be sent.100& content=61432145A677. Example: Send Batch Messages (Error with batch_id) Request: https://HOST_URL:PORT/cgphttp/servlet/sendbatch?batch_id=24&content=61403021235.50&content=61401425431. Request: http://HOST_URL:PORT/cgphttp/sendbatch?batch_id=241&content=61403021235. the entire operation will fail.

1.content Commercial In Confidence 28 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7.0 . 2 017 ERROR .

provided they have configured the their account on EEMP to forward incoming messages to URL. the GET or POST operation is initiated by EEMP. The retry occurs every 20 minutes for 24 hours. there is an option to set the HTTP Method. no retry attempts will be made. log into the EEMP portal as a Customer Administrator and go to the 'Company Setup' Section. Setup > Company Setup > Customer Information > SMS Preference In the MO Delivery settings. Retry on Forward to URL There is a retry schedule for forwarding a Mobile Originated SMS Message to a URL via the API if the targeted web server does not respond. customer(s) will handle the incoming HTTP requests (SMS messages are processed by EEMP and the parameters of this SMS are forwarded to customer's web application) using a web-application running on a web server. Please note that all mobile addresses are forwarded in international format.Receiving SMS Messages SMS messages originating from a mobile device can be delivered to a customer via EEMP using the HTTP GET or POST interface.0 . and the response should be returned by the customer. Note: If you are using an Inbound Campaign to forward messages to a URL. Preferences To set the interface as either HTTP POST or GET. Commercial In Confidence 29 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7. In this instance. Typically. MO Delivery Settings Options for HTTP Method: POST GET Note the option in this section 'Use Plain Text Email' refers to 'Forward to Email' and is unrelated to the HTTP/WSDL interface.1.

This is the mobile number the message was sent from. rather than raising an exception if an unsupported field is received.3 Content-Type: text/plain The response should be as minimal as possible and not contain any body.New fields may be added. Parameters Description Restricted Values source Valid international format number representing 1 – 15 digits the sender address. destination Valid international format number representing 1 – 15 digits the recipient address. to the request parameters.1 200 OK Server: Apache/1. Response EEMP expects the customer’s server to reply with a HTTP status code of 200 (OK) if the SMS message was successfully received. Commercial In Confidence 30 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7.Request Example 1 (HTTP GET): When receiving a mobile-originated message. Any other status value will result in failure to deliver the message and the delivery of the message to the nominated URL will not be re-attempted. http://CUSTOMER_HOST_URL:PORT): https://CUSTOMER_HOST_URL:PORT/yourapplication?destination=61433000203& text=Hello World&source=213123&networkSubmitTime=2011-11-16+10%3A26%3A 13&clientSubmitTime=2011-11-16+10%3A26%3A13 Example 2 (HTTP GET): including legacy fields. https://CUSTOMER_HOST_URL:PORT/yourapplication?destination=61429925830& clientMessageId=10332&source=61494225344&text=KEYWORD+SUBKEYWORD+VALUE& from=61494225344&to=61429925830 &networkSubmitTime=2011-11-16+10%3A26%3A13&clientSubmitTime=2011-11-16+10%3A26%3A13 Note . A sample successful response from the customer would be: HTTP/1. without notice. Your interface should be developed by extracting only the required fields. EEMP will submit a HTTP GET Request to the customer's nominated URL (e.0 .g. from and to which should no longer be used by the application as from equals source and to equals destination.1. Commands The following is a list of all parameters that will be included in the HTTP GET Request to the customer's nominated URL.

Parameters Description Restricted Values This is the number the sender sent the message to. 100 characters maximum This parameter will be set if the incoming message was a reply to an outgoing message tagged with a clientMessageId value.0 . Example: Encoded 2011-11-16 +10%3A26%3A13 is equivalent to the decoded string 2011-11-16 10:26:13 costCentre User cost centre label. using the HTTP API does not use this parameter for long messages. Will only accept text data. To send binary. clientSubmitTime The time that the Inbound application handed Format: YYYY-MM-DD+HH:MM:SS the message and forwarded it on to the provisioned URL. Note: When using the Inbound application. Example: Encoded 2011-11-16 +10%3A26%3A13 is equivalent to the decoded string 2011-11-16 10:26:13 segmentCount The total number of concatenated messages 1 – 2 digits (Part x of y) that make up 1 long SMS message. Commercial In Confidence 31 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7. clientMessageId User message reference. networkSubmitTime The time when the EEMP Platform received the Format: YYYY-MM-DD+HH:MM:SS message from the network element (typically the SMSC). segmentNumber The segment number of this concatenated 1 – 2 digits message in a list of messages (Part x of y) that make up 1 long SMS message. messageId The MO (Mobile Originated) message ID. use the data parameter instead. forwarding to the URL have the same reference number. forwarding to the URL using the HTTP API does not use this parameter for long messages. to Same as 'destination' field. referenceNumber A common identified for the multiple segmented 1 – 3 digits messages of a long SMS message.1. text Message content. Note: When using the Inbound application. Note: When using the Inbound Each segment of a long SMS message will all application. forwarding to the URL using the HTTP API does not use this parameter for long messages. Either the text parameter or the data parameter may be used in a single request – not both. 100 characters maximum Only set if the user is allocated a cost centre label.

The use of this parameter will be phased out in future versions of this interface.0 . DO NOT USE this parameter. from Same as 'source' field. Commercial In Confidence 32 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7. This is provided for backward compatibility to an older version of this interface. The use of this parameter will be phased out in future versions of this interface. Parameters Description Restricted Values DO NOT USE this parameter.1. This is provided for backward compatibility to an older version of this interface.

Figure: Flow from the platform delivering a m essage to w hen a delivery receipt is provided back to the platform The format of the text that you will receive in the Delivery Report / Receipt message follows that defined in the open SMPP Specification version 3. This is String only relevant when the original message was submitted to Commercial In Confidence 33 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7.Receiving SMS Delivery Reports Messages When sending an SMS message to a mobile you can request acknowledgment of when the handset received the message (DELIVERED) or when it has expired from the network without being sent (EXPIRED). (Decimal) sub 3 C-Octet Number of short messages originally submitted. Available for download from: http://sopranodesign. This is known as a Delivery Report / Delivery Receipt.1. The fields of the above delivery receipt example are explained in the following table: Field Size Type Type Description (Octets) id 10 C-Octet The message ID allocated to the message by the SMSC String when originally submitted.4.0 .pdf Delivery Receipt Format The format of the delivery receipt that you will receive can be seen in the following example: Normal Delivery Receipt Message Text: id:10127438101647284 sub:001 dlvrd:001 submit date:1005260205 done date:1005260206 stat:DELIVRD err:000 text:ext:JZ TEST REGISTER The following is extracted directly from the SMPP specification to assist you with the interpretation of the fields provided.com/downloads/ SMPP_v3_4_Issue1_2.

ACCEPTED ACCEPTD Message is in accepted state (i. The following table describes the states that may be received from the network upon delivering a message.e. The value is padded with leading zeros if necessary. These errors are Network or SMSC specific text 20 Octet String The first 20 characters of the short message. REJECTED REJECTD Message is in a rejected state. has been manually read on behalf of the subscriber by customer service). stat 7 C-Octet Fixed The final status of the message. UNDELIVERABLE UNDELIV Message is undeliverable. The format is the same used for the submit date. DELETED DELETED Message has been deleted. submit date 10 C-Octet Fixed The time and date at which the short message was Length String submitted.0 . dlvrd 3 C-Octet Fixed Number of short messages delivered. Message State Final Message Description State DELIVERED DELIVRD Message is delivered to destination. Length String For settings for this field see the table below. In the case of a message which has been replaced. This is only relevant Length String where the original message was submitted to a (Decimal) distribution list. The value is padded with leading zeros if necessary. this may hold a network-specific error Length String code or an SMSC error code for the attempted delivery of the message. UNKNOWN UNKNOWN Message is in invalid state. The format is as follows: YYMMDDhhmm where: YY = last two digits of the year (00-99) MM = month (01-12) DD = day (01-31) hh = hour (00-23) mm = minute (00-59 done date 10 C-Octet Fixed The time and date at which the short message reached its Length String final state. Commercial In Confidence 34 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7. EXPIRED EXPIRED Message validity period has expired.1. this is the date that the original message was replaced. (Decimal) a distribution list. err 3 C-Octet Fixed Where appropriate.

If the request could not be interpreted (due to for example an unrecognised format.0 . a response string (refer to Table 2) and an identifier for the message. a response code (refer to Table 2) and a response string (refer to Table 2) identifying the error. 05 Sep 2008 04:42:31 GMT Content-Type: text/plain Content-Length: 30 0 001 OK Message-ID: 12300050 The body of all responses to WAP Push requests will contain a one digit success code (0 = success or 1 = error). Request Response Commands Request A valid submission of a WAP Push request may look like: POST /sendwappush HTTP 1.1 200 OK Server: Apache/1. Alternatively.3 Date: Mon. Response The following response is an example response to the request above: HTTP/1.blah.WAP Push The HTTP POST interface can be used to send WAP Push messages to a recipient’s handset.com/wap&https=true Where the customer’s username and password are provided within the Authorization header field. if you do not wish to use the Basic Authentication method for your submission you may use the HTTP parameters 'username' and 'password' to authenticate your request. The following is an Commercial In Confidence 35 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7. the response will contain a success code of 2 (indicating an error with the command). Refer to Section 2.1 Host: xxx.1.61496230051&priority=1&message=Please+click+ on+the+link+to+authorise+your+transaction&url=wap.1.au& password=mypwd01&destination=61491000000&text=initial+test+message If you provide both username and password in parameters AND in your Basic Authentication.1 for more details on the Authorization field. charset=utf-8 Content-length: 166 http://HOST_URL:PORT/cgphttp/servlet/sendwappush?source=61491261028& destination=61494022810. a three digit response code (refer to Table 2).com. the parameters will be ignored and the Basic Authentication values will be used.xxxx Authorization: Basic YWxpYXNAc29wcmFuby5jb20uYXU6cGFzc3dvcmQ= Content-type: application/x-www-form-urlencoded.xxxx. https://HOST_URL:PORT/cgphttp/servlet/sendmsg?username=demo@soprano. or the request lacking mandatory parameters).

password Password for this user. some of the message reply features are disabled.1 200 OK Server: Apache/1. Note: If programming within the Authorization header field is not possible. Provided in HTTP Authorization field.e. Commercial In Confidence 36 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7. 21 Jun 2008 09:15:23 GMT Content-Type: text/plain Content-Length: 9 2 001 ERROR .command not recognised Commands Commands for WAP Push include: sendwappush sendwappush The WAP Push framework allows information to be transmitted to a device without a user request. Provided in Username will be in email address format.1.3 Date: Mon. HTTP Authorization field. Only the service indication method can be used with this command. Service loading cannot be used. you may submit the username & password parameters inside the POST request.0 . you may submit the username & password parameters inside the POST request. Including linking Client Message ID of submitted message to the response. source Valid international format number or 1 – 15 digits or 11 character alphanumeric alphanumeric string (corresponding to the string sourceTON and sourceNPI parameters) representing the sender or message source. If you use the 'source' parameter in the request the replyTo and replyToTON address specified will be ignored. i. Parameters Description Restricted Values username Username for the customer. example: HTTP/1. Note: If programming within the Authorization header field is not possible. Note 1: If you define the source address in the request.

priority Message priority.0 .1.164) (default) 3 Data (X.69) 6 Land Mobile (E.163/E. url The URL address where the mobile device is to connect to when receiving this message.4473123456 79 you will also have to supply the source address. Note: If you specify multiple destination addresses. 1 ISDN (E.e. sourceNPI Numbering Plan Indicator for the source 0 Unknown address. destination=447312345678. a default priority of 1 will be used for the message. Parameters Description Restricted Values destination Destination or recipient number. i.212) 8 National 9 Private 10 ERMES 14 Internet (IP) 18 WAP Client ID destinationNPI Numbering Plan Indicator for the 0 Unknown destination address(es). https The flag indicating whether or not the URL True (default) if secure connection is used. message The alert message to display to the recipient. Typically a valid ISDN number.121) 4 Telex (F.69) 6 Land Mobile (E.121) 4 Telex (F. 1 ISDN (E.212) 8 National 9 Private Commercial In Confidence 37 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7. but other numbers can be specified along with the use of the destinationTON and destinationNPI parameters. Messages can be sent to multiple recipients by separating the numbers with commas. If no priority is supplied. used for message 1 (default) to 9 routing.164) (default) 3 Data (X.163/E. uses secure connection False if secure connection is not used.

Example: Send WAP Push message Request: https://HOST_URL:PORT/sendwappush?source=61421261028&destination=61414022810. 1 International (default) 2 National 3 Network Specific 4 Subscriber Number 5 Alphanumeric 6 Abbreviated sourceTON Type of Number to be used for the source 0 Unknown address. 1 International (default) 2 National 3 Network Specific 4 Subscriber Number 5 Alphanumeric 6 Abbreviated responseType Specifies the envelope type to be used to 0 Text/plain (default) send HTTP response. 1 Text/XML Note: Optional parameters are shown in italics.com/wap&message=Try%20this%20new%20stuff Response: 0 005 OK Message-ID: 12300053 Commercial In Confidence 38 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7.1.0 . 61416230051&priority=1&url=wap. Parameters Description Restricted Values 10 ERMES 14 Internet (IP) 18 WAP Client ID destinationTON Type of Number to be used for destination 0 Unknown address(es).blah.

Example: Send WAP Push message to multiple destinations with request xml response Request: https://HOST_URL:PORT/sendwappush?source=61421261028&destination=61414022810& priority=1&url=wap.1.blah.0 .com/wap&message=Try%20this%20new%20stuff& responseType=1 Response: <response> <message> <success_code>0</success_code> <response_code>001</response_code> <response_string>OK</response_string> <message_id>1167</message_id> </message> </response> Commercial In Confidence 39 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7.

a response string (refer to Table 2) and an identifier for the message which contains the message's ID and the message's status.1 Host: api.au Content-type: application/x-www-form-urlencoded Content-length:50 msg_id=12179 username=demo@soprano.3 Date: Mon. if you do not wish to use the Basic Authentication method for your submission you may use the HTTP parameters 'username' and 'password' to authenticator your request.au Content-type: application/x-www-form-urlencoded Content-length:50 Authorization: Basic YWxpYXNAc29wcmFuby5jb20uYXU6cGFzc3dvcmQ= msg_id=12179 Where the customer’s username and password are provided within the Authorization header field. The POST operation is initiated by the Customer.com. 05 Sep 2008 05:42:31 GMT Content-Type: text/plain.0 . the URL parameters will be ignored and the Basic Authentication values will be used.soprano. Response The following response is valid for the request above: HTTP/1.com.1 Host: api.1. Refer to Commercial In Confidence 40 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7. POST /cgphttp/servlet/querymsg HTTP 1. Request A valid submission of a query request may look like: POST /cgphttp/servlet/querymsg HTTP 1.charset=utf-8 Content-Length: 43 0 003 OK 12179 ACCEPTED_BY_NETWORK_ELEMENT The body of all responses to query requests that were received successfully by EEMP will contain a one digit success code (0 = success or 1 = error). Alternatively.au password=mypwd01 If you provide both username and password in the URL parameters AND in Basic Authentication.soprano. and the response returned by EEMP.1 200 OK Server: Apache/1.com. a three digit response code (refer to Table 2).Query SMS Messages The HTTP POST interface can be used to query a message sent to EEMP before.

Parameters Description Restricted Values msg_id The Message-IDs returned in previous response to submit of WAP Push requests. Note: If programming within the Authorization header field is not possible. you may submit the username & password parameters inside the POST request. Note: If programming within the Authorization header field is not possible. password Password for this user.0 .. username Username for the customer. Provided in HTTP Authorization field. Username will be in email address format. a sample response may look like: HTTP/1. Commercial In Confidence 41 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7.. you may submit the username & password parameters inside the POST request.charset=utf-8 Content-Length: 35 1 050 ERROR 45051 MSG_ID_NOT_FOUND Commands Commands include: querymsg querymsg The querymsg command is used to query the status of SMSs sent to EEMP before. 21 Jun 2004 09:12:23 GMT Content-Type: text/plain.1. Provided in HTTP Authorization field. If the msg_id specified is not found for the Customer in EEMP.3 Date: Mon. Table 3 for a list of possible message status.1 200 OK Server: Apache/1.

12679.Example: Send query message Request: https://HOST_URL:PORT/cgphttp/servlet/querymsg?msg_id=12678 Response: 0 003 OK 12678 ACCEPTED_BY_NETWORK_ELEMENT Example: Send query message with non-existent/unmatched msg_id Request: https://HOST_URL:PORT/cgphttp/servlet/querymsg?msg_id=12610 Response: 1 050 ERROR 12610 MSG_ID_NOT_FOUND Example: Send query message with multiple msg_Id Request: https://HOST_URL:PORT/cgphttp/servlet/querymsg?msg_id=12678.12680 Response: 0 003 OK 12678 ACCEPTED_BY_NETWORK_ELEMENT 12679 ACCEPTED_BY_NETWORK_ELEMENT 12680 ENROUTE_IN_CIQ Commercial In Confidence 42 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7.0 .1.

au password=mypwd01 If you provide both username and password in the URL parameters AND in Basic Authentication.0 .com. Request A valid submission of a 'cancel' request may look like: POST /cancelmsg HTTP 1.com. 05 Sep 2008 05:42:31 GMT Content-Type: text/plain. Response The following response is valid for the request above: HTTP/1. the URL parameters will be ignored and the Basic Authentication values will be used.1 Host: api. The message status will be changed to 'DELETED' after a successful 'cancel' request.com.1 200 OK Server: Apache/1.3 Date: Mon. The POST operation is initiated by the customer. and the response returned by EEMP.1 for more details on the Authorization field.1. Refer to Section 2.1 Host: api.au Content-type: application/x-www-form-urlencoded Content-length:50 msg_id=12179 username=demo@soprano.soprano.charset=utf-8 Content-Length: 43 0 004 OK The body of all responses to cancel requests that were received successfully by the EEMP will contain a one digit Commercial In Confidence 43 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7. if you do not wish to use the Basic Authentication method for your submission you may use the HTTP parameters 'username' and 'password' to authenticate your request.au Content-type: application/x-www-form-urlencoded Content-length:50 Authorization: Basic YWxpYXNAc29wcmFuby5jb20uYXU6cGFzc3dvcmQ= msg_id=12179 Where the customer’s username and password are provided within the Authorization header field. Alternatively. POST /cancelmsg HTTP 1. The interface doesn't cancel messages that have been sent to the network through EEMP.1.soprano.Cancel SMS Messages The HTTP POST interface can be used to cancel messages sent to EEMP and still queuing or scheduling inside EEMP.

21 Jun 2004 09:12:23 GMT Content-Type: text/plain. a response string (refer to Table 2).3 Date: Mon. (Note: If programming within the Authorization header field is not possible. an extra line of the response will contain the message id and the message's current status. success code (0 = success or 1 = error).0 .) Commercial In Confidence 44 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7. Parameters Description Restricted Values msg_id The Message-IDs returned in previous response to submit of WAP Push requests. username Username for the customer.charset=utf-8 Content-Length: 43 1 050 ERROR 12179 ACCEPTED_BY_NETWORK_ELEMENT If the msg_id specified is not found for the customer in EEMP. a sample response may look like: HTTP/1. If EEMP cannot cancel the message(s) for some reason.3 Date: Mon. 05 Sep 2008 05:42:31 GMT Content-Type: text/plain.1 200 OK Server: Apache/1. you may submit the username & password parameters inside the POST request. Refer to Table 3 for a list of possible message statuses and the statuses that can be canceled.1 200 OK Server: Apache/1.1.charset=utf-8 Content-Length: 35 1 050 ERROR 45051 MSG_ID_NOT_FOUND Commands Commands include: cancelmsg cancelmsg The 'cancelmsg' command is used to cancel sending out an SMS through EEMP. Provided in HTTP Authorization field. a three digit response code (refer to Table 2). HTTP/1. Username will be in email address format.

(Note: If programming within the Authorization header field is not possible. you may submit the username & password parameters inside the POST request. Parameters Description Restricted Values password Password for this user.0 .776576 Response: Commercial In Confidence 45 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7.4565.4567.) Example: Send cancel message Request: https://HOST_URL:PORT/cgphttp/servlet/cancelmsg?msg_id=12678 Response: 0 003 OK 12678 ACCEPTED_BY_NETWORK_ELEMENT Example: Send cancel message with with non-existent/unmatched msg_id Request: https://HOST_URL:PORT/cgphttp/servlet/querymsg?msg_id=12610 Response: 1 050 ERROR 12610 MSG_ID_NOT_FOUND Example: Send cancel message with multiple msg_id Request: https://HOST_URL:PORT/cgphttp/servlet/cancelmsg?msg_id=4566.1. Provided in HTTP Authorization field.

1.0 . 1 050 ERROR 4566 4567 4565 ACCEPTED_BY_CLIENT 776576 MSG_ID_NOT_FOUND Commercial In Confidence 46 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7.

effectively.0 . HTTP Request (POST) XML SOAP Envelope SOAP Body HTTP Response (POST) XML SOAP Envelope SOAP Body Commercial In Confidence 47 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7.Web Services – WSDL The WSDL defines the relevant information to the SOPRANO WSDL API such as: Interface information Data types Binding information Address information WSDL is. a different type of HTTP-based interface which uses a Request/Response interaction with an XML payload over HTTP.1.

which has in turn changed the Content-length parameter.com.soprano.localhost.cgp.com.au </ns1:username> </ns2:request> </ns2:sendmsg> </soapenv:Body> </soapenv:Envelope> Note: the example above has been edited to alter the username and login credentials.au/xsd"> 61425318543 </ns1:destinations> <ns1:message xmlns:ns1="http://cgpwebservices.web.com.w3.0' encoding='UTF-8'?> <soapenv:Envelope xmlns:soapenv="http://www.web.Request A valid submission of a WSDL sendmsg request may look like: POST /cgpwebservices/services/CGPWebSMSInterface HTTP/1.com.au/xsd"> test4.com.web.com.cgp. charset=UTF-8.web.0 .au/xsd"> </ns1:replyTo> <ns1:source xmlns:ns1="http://cgpwebservices.web.soprano.cgp.com.cgp.org/2003/05/soap-envelope"> <soapenv:Body> <ns2:sendmsg xmlns:ns2="http://cgpwebservices.cgp.cgp.web.au/xsd"> </ns1:source> <ns1:username xmlns:ns1="http://cgpwebservices. Commercial In Confidence 48 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7.web.soprano.com.soprano. your account balance is $505.com Content-Length: 990 <?xml version='1.soprano.au/xsd"> mytestacc@soprano.soprano. action="urn:sendmsg" User-Agent: SopranoTestAgent Host: my.1.cgp.web.au"> <ns2:request> <ns1:clientMessageId xmlns:ns1="http://cgpwebservices.soprano.au/xsd"> </ns1:clientMessageId> <ns1:destinations xmlns:ns1="http://cgpwebservices.cgp.soprano. </ns1:message> <ns1:password xmlns:ns1="http://cgpwebservices.com.au/xsd"> mypassword </ns1:password> <ns1:replyTo xmlns:ns1="http://cgpwebservices.1 Content-Type: application/soap+xml.

web.Response The following response is an example response to the request above: HTTP/1.soprano.localhost.org/2003/05/soap-envelope"> <soapenv:Body> <ns:sendmsgResponse xmlns:ns="http://cgpwebservices.web. Server: Sun-ONE-Web-Server/6.com Cache-Control: private.soprano.Set-cookie: ESS-WebApp-8083=52f71a2852f71b0aa52dbac4. action="urn:sendmsgResponse".charset=UTF-8 Set-Cookie : SMSESSION=DeVtGsphMisaXLgeSnwfY5wMb6Mk9AnzPZwrkfPncvnu3cwAlLzQmkt hyNB+K0kAfomkkNvFzS1hMxOeO8rxP9R/591HKeNHyuaHXCEUbBiqmqe8gLEzlrz6asOsM5IG9sSi 4lP9OJnw96q+Mo6rbMJSAWelPYyxB6Xmi2ubLcLCjDnNnUy856VxGv+e+dLEQ5OSCgiywrBS/v8cw /5+YcU4EJbltp6Mn6ttmsvSXUmBn+8d+TxkDvsk7rFMrlb61+ASManjZlyOt2/yxb/l7SuzwZoN5N uCsIJU3H/VVQ8=.web. domain=.0 .com.au/xsd" type="au..com. path=/.Response"> <ax21:messageId> 97172314 </ax21:messageId> <ax21:responseCode> 001 </ax21:responseCode> <ax21:responseString> OK </ax21:responseString> <ax21:successCode> 0 </ax21:successCode> </ns:return> </ns:sendmsgResponse> </soapenv:Body> </soapenv:Envelope> Commands Commands include: WSDL Send Message Request WSDL Send Message Response Commercial In Confidence 49 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7. path=/ Transfer-encoding: chunked <?xml version='1.1 200 OK.1. max-age=60 Cache-control: private X-powered-by: Servlet/2.soprano.w3.cgp.4.com.0' encoding='UTF-8'?> <soapenv:Envelope xmlns:soapenv="http://www.1 Date: Fri.cgp. 20 Feb 2009 01:47:49 GMT Content-type: application/soap+xml.au"> <ns:return xmlns:ax21="http://cgpwebservices.cgpwebservices.cgp.

based on provided content. String. Commercial In Confidence 50 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7.0 . contentType This field is currently ignored. delay Delay field is used for the Time unit is minutes. a default priority of 1 will be used for the message. This field is currently ignored dcs dcs value in the request is SOPRANO CGP will determine the coding scheme ignored. If no special characters (e. ClientMessageId User message reference 100 characters maximum (*) which will be sent back with reply messages.g. If no priority is supplied. password (*) Password for this user. Username will be in email address format. This field is currently ignored costCentre User cost centre label. message The alert message to display to the recipient. Scheduled time = Current Time + Number of minutes delay. UCS2) are found then the value 1 is used. Parameters Description Restricted Values username (*) Username for the customer. Provided in the Authorization field. If used the combined time must be less that set in the 'ValidityPeriod' field. destinationTON Type of Number to be used for 0 Unknown destination address(es). Typically a valid MISDN number. destinationNPI parameters. but other Destinations are between 8-15 digits depending. used for 1 (default) to 9 message routing. 100 characters maximum data This field is currently ignored.Request The WSDL framework allows information to be transmitted to a device without a User request. Provided in the Authorization field. 1 International (default) 2 National 3 Network Specific 4 Subscriber Number 5 Alphanumeric 6 Abbreviated destinations (*) Destinations or recipient String numbers. scheduling the time to for the message to be sent. priority Message priority.1. numbers can be specified along with the use of the Note: If you want to send to multiple destinations then destinationTON and you need to supply multiple "destinations" elements.

Parameters Description Restricted Values registered Request acknowledgment for 0 Off (default) message. including linking Client Message ID of submitted message to the response. 10 URL source Valid international format 1 – 15 digits or 11 character alphanumeric string number or alphanumeric string (corresponding to the sourceTON and sourceNPI parameters) representing the sender or message source.0 .1. i. replyToNPI Not used. or a valid inbound order ID etc. URL. Note 1: When sending a message to multiple addresses a valid 'source address' must be provided.164) (default) 3 Data (X. sourceNPI Numbering Plan Indicator for 0 Unknown the source address. 8 EMAIL URL. email.e.69) Commercial In Confidence 51 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7. reserved for future. MOBILE. Note 2: If you use the 'Source' parameter in the request the reply address specified will be ignored. replyTo (*) Specifies the destination the Maximum 250 characters. reply goes to. EMAIL. 1 ISDN (E. Note 1: When using replyTo parameter it is mandatory to also use the replyToTON parameter.163/E. This can be a valid MSISDN. INBOUND. user and status to the customer via the specified channel for 1 On acknowledgments. some of the message reply features are disabled. If you use the 'source' parameter in the request the replyTo and replyToTON address specified will be ignored. replyToTON (*) Type of Number to be used for 0 INBOX reply address to indicate if 1 MOBILE replyTo field is: INBOX.121) 4 Telex (F. Note 2: If you define the source address in the request. Returns msg_id.

0 . unit in minutes added into the current time to make a future time for the validity of the message. URL. responseCode A three digit response code. HTTPS & responseType are not supported in WSDL currently. Note: (*) denotes mandatory field. (refer to Table 2 ) responseString Textual response string. 1 Error Commercial In Confidence 52 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7. Note: WSDL is a subset of HTTP Parameters.212) 8 National 9 Private 10 ERMES 14 Internet (IP) 18 WAP Client ID sourceTON Type of Number to be used for 0 Unknown the source address. 1 International (default) 2 National 3 Network Specific 4 Subscriber Number 5 Alphanumeric 6 Abbreviated udh This field is currently ignored This field is currently ignored validityPeriod Unit (in minutes) that will be Long. Response Parameters Description Restricted Values messageId Message reference which will be sent back with submission response. (refer to Table 2) successCode One Digit Code summarising the 0 Success result. Parameters Description Restricted Values 6 Land Mobile (E.1.

0 .soprano.web.web.com.cgp.cgp.cgp.au/xsd"> 61494225344</ns1:destinations> <ns1:message xmlns:ns1="http://cgpwebservices.web.w3.au/xsd"> Password</ns1:password> <ns1:replyTo xmlns:ns1="http://cgpwebservices.soprano.web.domain</ns1:username> </ns2:request> </ns2:sendmsg> </soapenv:Body> </soapenv:Envelope> Commercial In Confidence 53 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7.org/2001/XMLSchema-instance" xsi:nil="1" /> <ns1:costCentre xmlns:ns1="http://cgpwebservices.Example: Full trace WSDL Interaction POST /cgpwebservices/services/CGPWebSMSInterface HTTP/1.1 Content-Type: application/soap+xml.soprano.cgp.w3.cgp.soprano.au/xsd"> Hello World</ns1:message> <ns1:password xmlns:ns1="http://cgpwebservices.cgp.111.au/xsd"> 111111</ns1:source> <ns1:username xmlns:ns1="http://cgpwebservices.com.au/xsd" xmlns:xsi="http://www.cgp. charset=UTF-8.120:9081 Transfer-Encoding: chunked <?xml version='1.com.w3.cgp.soprano. action="urn:sendmsg" User-Agent: Axis2 Host: 192.soprano.au"> <ns2:request> <ns1:clientMessageId xmlns:ns1="http://cgpwebservices.com.168.au/xsd" xmlns:xsi="http://www.soprano.w3.org/2001/XMLSchema-instance" xsi:nil="1" /> <ns1:source xmlns:ns1="http://cgpwebservices.au/xsd"> username@email.com.org/2001/XMLSchema-instance" xsi:nil="1" /> <ns1:destinations xmlns:ns1="http://cgpwebservices.com.web.web.soprano.web.cgp.com.1.com.web.org/2003/05/soap-envelope"> <soapenv:Body> <ns2:sendmsg xmlns:ns2="http://cgpwebservices.0' encoding='UTF-8'?> <soapenv:Envelope xmlns:soapenv="http://www.soprano.au/xsd" xmlns:xsi="http://www.com.web.

org/2003/05/soap-envelope"> <soapenv:Body> <ns:sendmsgResponse xmlns:ns="http://cgpwebservices.web.com.com.w3.cgpwebservices.au"> <ns:return xmlns:ax21="http://cgpwebservices.0' encoding='UTF-8'?> <soapenv:Envelope xmlns:soapenv="http://www.com.soprano.soprano. charset=UTF-8.au/xsd" type="au.soprano.1 200 OK Content-Type: application/soap+xml. HTTP/1.cgp.cgp. action="urn:sendmsgResponse" Content-Language: en-US Transfer-Encoding: chunked Date: Wed.0 .web.0 <?xml version='1.web. 15 Dec 2010 03:58:25 GMT Server: WebSphere Application Server/7.cgp.Response"> <ax21:messageId>211879</ax21:messageId> <ax21:responseCode>001</ax21:responseCode> <ax21:responseString>OK</ax21:responseString> <ax21:successCode>0</ax21:successCode> </ns:return> </ns:sendmsgResponse> </soapenv:Body> </soapenv:Envelope> Commercial In Confidence 54 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7.1.

WSDL Definition Appendix H . concatenation and more.Abbreviations Appendix B . The UDH contains information on the message type.underlying technology of the EEMP – mobile messaging infrastructure which enables the sending and receipt of mobile messages. SMTP Simple mail transfer protocol – a standard API used for email. Commercial In Confidence 55 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7.Abbreviations API Application Programming Interface – a programmatic interface which enables an application to use the facilities of EEMP. MO Mobile Originating – messages sent inbound from a handset – to be routed to a EEMP customer by EEMP.messages sent by the EEMP (on instruction from a customer) out through the telecommunications network to mobile handsets. XML Extensible Markup Language – a flexible standard for formatting information exchanged between applications.Appendices Appendix A .XML response DTD Appendix F . SMS Short Message service – a mobile messaging service enabling the sending of short text and data messages. HTTP Hypertext Transfer Protocol – an internet standard for transporting information to/from a WEB server. 'MO' messages) arriving at the EEMP from the telecommunications network. MT Mobile Terminated – outbound messages sent by an application through the EEMP to reach a particular handset. to be forwarded to a EEMP customer. CGP SOPRANO Corporate Gateway Platform .0 . the length of a message.DCS Parameter Details Appendix D .messages sent from a handset (i.FAQ Appendix A .User Data Header .1. The UDH is specific to each manufacturer. UDH UDH .Example Code Appendix G .Response Details HTTP Appendix C . Inbound Inbound messages .e.Text & Data Parameter Restrictions Appendix E .specialised information that is normally posted with 8-bit messages. Outbound Outbound messages .

1 002 ERROR – Could not find message template batch_id not with the specified batch_id found 1 050 ERROR – Could not find message id with the msg_id not specified msg_id found 2 005 ERROR – Invalid parameter value .dcs value 2 009 ERROR – Invalid parameter value – content_type content_type Commercial In Confidence 56 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7. command not command contains unknown or recognised missing mandatory parameter(s).sourceNPI sourceNPI value 2 021 ERROR – Invalid parameter value - destinationNP destinationNPI I value 2 006 ERROR – Invalid parameter value – onNet onNet value 2 007 ERROR – ack Invalid parameter value .ack value 2 008 ERROR – dcs Invalid parameter value . Note that not all responses are relevant for each of the HTTP POST commands.Response Details HTTP Table 2 shows the responses that could be returned from EEMP as part of the response to an HTTP request. 0 002 OK startbatch command completed successfully 0 003 OK querymsg command completed successfully 0 004 OK cancelmsg command completed successfully 005 OK WAPPush command completed 0 successfully 2 001 ERROR – command not recognised. contains repeated parameters or XML parsing error. Note that no identifier will be returned if this error occurs. or sendbatch command completed successfully.1.0 . Table 2 Response details Success Code Respo Response Explanation s st s q c W s W nse String e ar e u a A e S Code n tb n e n P n D d at d ry cl P d L m c b m m u b s h at s s s ar g c g g h c h o d e 0 001 OK sendmsg.Appendix B . etc.

valid valid value 2 017 ERROR . dcs value does not match bit binary dcs content_type value. Refer to Table 1.source source value 2 015 ERROR – Invalid parameter value .content content 2 018 ERROR . The response should be extended to include the status of each destination 2 013 ERROR – Invalid parameter value . Invalid parameter value . Invalid parameter value . value expected 2 023 ERROR – 8. Success Code Respo Response Explanation s st s q c W s W nse String e ar e u a A e S Code n tb n e n P n D d at d ry cl P d L m c b m m u b s h at s s s ar g c g g h c h o d e value 2 022 ERROR – 8.1.priority priority 2 019 ERROR – Invalid parameter value - sourceTON sourceTON Commercial In Confidence 57 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7.0 . dcs value does not match bit binary dcs content_type value.destination destination value 2 014 ERROR – Invalid parameter value .delay delay value 2 016 ERROR – Invalid parameter value . Refer to Table 1 value not expected 2 028 ERROR – dcs dcs value is not supported value (not supported) 2 029 ERROR – udh Combination of separate and parameter not integrated udh not supported in the expected EEMP 2 030 ERROR – text dcs value does not match with text parameter not parameter (data parameter expected expected) 1 031 ERROR – Internal system error Internal System error 1 032 ERROR – User is not authorised to send this Request is not request authorised 1 040 ERROR The error response code when an error occurs with a destination.

Success Code Respo Response Explanation s st s q c W s W
nse String e ar e u a A e S
Code n tb n e n P n D
d at d ry cl P d L
m c b m m u b
s h at s s s ar
g c g g h c
h o
d
e

value
2 020 ERROR – Invalid parameter value -
destinationTO destinationTON
N value
2 025 ERROR – udh Invalid parameter value – udh
value (invalid invalid hexadecimal format.
hexadecimal
string)
2 027 ERROR – Invalid parameter value – data
data value invalid hexadecimal format.
(invalid
hexadecimal
string)
2 041 ERROR - Invalid reply to TON
replyToTON
value
2 042 ERROR – Invalid reply to NPI
replyToNPI
value
2 045 ERROR - Invalid response type
invalid
response type
2 046 ERROR – Validity period value must be greater
valid must be than delay value
greater than
delay
2 050 ERROR – Invalid https value
https value
2 070 ERROR - Invalid textToEncode value
textToEncode
value
2 071 ERROR - Invalid symbology value
symbology
value
2 072 ERROR - Invalid scaling value
scaling value
2 073 ERROR - Invalid whiteSpace value
whiteSpace
value
2 074 ERROR - Invalid messageType value
messageType
value
2 075 ERROR - Invalid barcode width value
barcode width

Commercial In Confidence
58
© 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7.1.0

Success Code Respo Response Explanation s st s q c W s W
nse String e ar e u a A e S
Code n tb n e n P n D
d at d ry cl P d L
m c b m m u b
s h at s s s ar
g c g g h c
h o
d
e

value
2 076 ERROR - Invalid barcode height value
barcode
height value
077 ERROR - Invalid barcode dimensions value
2 barcode
dimensions
value
078 ERROR - Barcode width and height are too
2 barcode big for a barcode symbology or
dimensions messageType
value
exceeded
079 ERROR - Barcode width and height are too
2 barcode big for a Nokia Picture Message
picture size barcode
exceeded
value
2 080 ERROR - Ean8Barcode type/data is invalid or
Ean8Barcode not numeric
type/data is
invalid or not
numeric
2 081 ERROR – Format of the textFile is invalid or not
invalid textFile supported
format
2 082 ERROR – Format of the audioFile is invalid or
invalid not supported
audioFile
format
2 083 ERROR – Format of the imageFile is invalid or
invalid not supported
imageFile
format
2 084 ERROR – Format of the videoFile is invalid or
invalid not supported
videoFile
format
2 085 ERROR – An attachment is missing. The
attachment message will be sent without the
missing attachment
2 086 ERROR – The length of costCentre exceeds
invalid the max length(100)
costCentre
2 087 ERROR – The length of clientMessageId

Commercial In Confidence
59
© 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7.1.0

Success Code Respo Response Explanation s st s q c W s W
nse String e ar e u a A e S
Code n tb n e n P n D
d at d ry cl P d L
m c b m m u b
s h at s s s ar
g c g g h c
h o
d
e

invalid exceeds the max length(100)
clientMessage
Id
2 088 ERROR – The content_type is invalid
invalid
content_type
2 089 ERROR – The default handset profile for the
missing customer is not defined in
default database.
handset
profile
2 090 ERROR – The length of subject exceeds the
subject too max length
long

† Some messages could have been successfully sent before EEMP went offline or encountered an error. Therefore
it is recommended to query the identifier to determine which (if any) messages were received. The command
parameters can then be adjusted accordingly before resubmitting the command.

Table 3 shows all the possible states for an outbound message returned when the user query a message status
using the querymsg or when the user attempts to cancel a message.

Table 3 Outbound Message Statuses

Status Description
ACCEPTED_BY_NETWORK_ELEMENT* Message has been sent to the network through EEMP
DELIVERED* Message has been delivered and a deliver receipt has been
received from the network
ENROUTE_IN_CIQ Message is queuing in EEMP
ENROUTE_IN_NOQ Message is queuing in EEMP
SCHEDULED_IN_CIQ Message is scheduled to be sent in EEMP
SCHEDULED_IN_NOQ Message is scheduled to be sent in EEMP
UNDELIVERABLE* Cannot send this message
EXPIRED* Message has been expired and will not be sent
DELETED Message has been canceled
REJECTED* Message has been rejected by the network
CONCATENATE_SPLIT* Message has been split into few child messages to send to
the network
SUBMIT_MULTI_SPLIT* Message has been split into few child messages to send to
the network
Error Code = <xxx>* Message failed to be sent as network rejected it with the error

Commercial In Confidence
60
© 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7.1.0

Therefore.0 . 5 or 8. 4. contentType 1 2 3 4 5 6 7 8 udh udh udh udh udh udh udh udh udh udh udh udh udh udh udh udh abs pres abs pres abs pres abs pres abs pres abs pres abs pres abs presen ent ent ent ent ent ent ent ent ent ent ent ent ent ent ent t 0 B C B C B C B C C C E F 1 I I I I I I I I I I I I I I I I 2 H H H H H H H H H H H H H H H H 3 I I I I I I I I I I I I I I I I dcs 4 A A B C B C B C B C D C D C E F 5 I I I I I I I I I I I I I I I I 6 I I I I I I I I I I I I I I I I 7 I I I I I I I I I I I I I I I I 8 B C B C B C B C C C E F Commercial In Confidence 61 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7. Table C. an error will be returned. * Messages with this message state cannot be canceled.1. an error will be returned. Table C.2 below explicitly define the behaviour of EEMP when both the 'dcs' and 'contentType' parameters are included in a message for both the 'text' and 'data' parameters respectively.DCS Parameter Details The 'dcs' parameter is an optional parameter within the interface however it is required when sending a message to an SMSC.1 EE Messaging Portal powered by Soprano Behaviour when 'dcs'. 'contentType' and 'text' parameters are included in an EMAIL message. 3. If the 'dcs' parameter is not included AND the 'contentType' parameter is set to 1. The 'dcs' value is dependent on the value of the contentType parameter. Status Description code. Appendix C . 6 or 7.1 and Table C. 3. If the 'dcs' parameter is included but is not set to 8-bit binary AND the 'contentType' parameter is set to 2. If the 'dcs' parameter is not included AND the 'contentType' parameter is set to 2. 4. it is the EEMP responsibility to determine a value for the 'dcs' parameter when it has not been included in a request. the EEMP will set the 'dcs' value to 8-bit binary when submitting the message to the SMSC. 5 or 8. the EEMP should set the 'dcs' value to SMSC default alphabet when submitting the message to the SMSC. and this is used (as described below) to set an appropriate value for the 'dcs' parameter (rather than applying a default value for all messages). If the 'dcs' parameter is included and set to 8-bit binary AND the 'contentType' parameter is set to 6 or 7.

Legend: message accepted A Invalid: 8-bit data is not text (reject message and return error 2 030) B Invalid: pictures and tones are not text (reject message and return error 2 030) C Combination of user-supplied and EEMP-generated udh not supported in EEMP 4.2 EEMP Behaviour when 'dcs'.0 (reject message and return error 2 029) H Set dcs value to 4 (refer to the behaviour for 4) I dcs value not supported by EEMP 4.0 (reject message and return error 2 029) D Invalid: vCards/ vCalendars are text (reject message and return error 2 023) E Invalid: data including udh is not text (reject message and return error 2 030) F Combination of separate and integrated udh not supported in EEMP 4.0 (reject message and return error 2 028) Table C.1. 'contentType' and 'data' parameters are included in an EMAIL message contentType 1 2 3 4 5 6 7 8 udh udh udh udh udh udh udh udh udh udh udh udh udh udh udh udh abs pres abs pres abs pres abs pres abs pres abs pres abs pres abs presen ent ent ent ent ent ent ent ent ent ent ent ent ent ent ent t 0 G C G C G C G C C C F 1 I I I I I I I I I I I I I I I I 2 H H H H H H H H H H H H H H H H 3 I I I I I I I I I I I I I I I I dcs 4 C C C C D C D C F 5 I I I I I I I I I I I I I I I I 6 I I I I I I I I I I I I I I I I 7 I I I I I I I I I I I I I I I I 8 G C G C G C G C C C F Legend: message accepted Commercial In Confidence 62 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7.0 .

8 data length <= 140 bytes present data length + udh length <= 139 bytes 2-5 text any Invalid: pictures & tones are not text data absent 4 (default) data length <= 133 bytes any any other than 2.0 (reject message and return error 2 029) G Invalid: pictures & tones are 8-bit data (reject message and return error 2 022) H Set dcs value to 4 (refer to the behaviour for 4) I dcs value not supported by the EEMP 4. 4. 4 Invalid: pictures & tones are 8-bit data 6-7 text absent 0 (default) text length <= 152 characters data 8 text length <= 66 characters any 0 (default). Please note that the restrictions identified below apply to messages that will not require concatenation.0 Commercial In Confidence 63 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7. content_type content field udh field dcs Restrictions 1 text absent 0 (default) text length <= 160 characters 8 text length <= 70 characters present 0 (default) text length <= 160 .0 (reject message and return error 2 029) D Invalid: vCards/ vCalendars are text (reject message and return error 2 023) F Combination of separate and integrated udh not supported in EEMP 4.(1 + udh length in bytes) / 2 characters any 4 Invalid: 8-bit data is not text data absent 0.Text & Data Parameter Restrictions Restrictions on the length of the text and data parameters are shown in the table below.(1 + udh length in bytes) * 8 / 7 characters 8 text length <= 70 . 8 data length <= 133 bytes 4 2-7 any present any Combination of user-supplied and EEMP-generated UDH not supported in EEMP 4. The EEMP can guarantee the delivery of any message within these limits as a single SMS message. C Combination of user-supplied and EEMP-generated udh not supported in EEMP 4.0 (reject message and return error 2 028) Appendix D .0 .1.

Example Code Code libraries Java VB . For example. See case for 4. 8 data length <= 140 bytes any present any Combination of separate and integrated UDH not supported in EEMP 4.1.destination_description?)> <!ELEMENT success_code (#PCDATA)> <!ELEMENT response_code (#PCDATA)> <!ELEMENT response_string (#PCDATA)> <!ELEMENT message_id ANY> <!ELEMENT batch_id (#PCDATA)> <!ELEMENT destination (#PCDATA)> <!ELEMENT destination_code (#PCDATA)> <!ELEMENT destination_description (#PCDATA)> ]> Appendix F . 2. any other than 0. Not supported by GSM or EEMP 8 4. Appendix E . content_type content field udh field dcs Restrictions 8 text any Invalid: data including UDH is not text data absent 0.0 Note: "data length" and "udh length" mean the length of the raw data represented by the supplied hexadecimal.0 .destination_code?.XML response DTD Document Type Definition (DTD) for XML response: <!DOCTYPE response [ <!ELEMENT response (message+)> <!ELEMENT message (success_code.NET Various Shell Script examples include: Perl wget Code Snippets: Encoding Authentication Strings Commercial In Confidence 64 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7.(message_id|batch_id). destination?. "0a2b3c" has a length of 3 bytes.response_string.response_code. 4. 4.0 any 2 Not supported by GSM: Mapped to 4 by EEMP for GSM networks.

"text/plain.GetBytes("somebody@somewebsite.ASCIIEncoding. Commercial In Confidence 65 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7.com.NET Dim oWeb As New System.Headers.com/cgphttp/servlet/sendmsg'.ToBase64String(bytHeaders)) oWeb.WebClient Dim bytHeaders As Byte() 'code the username and password into basic authorization bytHeaders = System. Encoding Authentication Strings Setting the encoding string. $destination='61494225344'. $req = HTTP::Request->new(GET => "$url?destination=$destination&text=$text"). $username='<<username>>'.com/cgphttp/servlet/sendmsg?destination=61494225344&text=hello+world" wget -O.-v --http-user=$username --http-password=$password --no-check-certificate $url Options in the wget that are not mandatory depending on the deployment: -v: Verbose --no-check-certificate: to prevent validation of server certificates perl .wget . $url='http://t-mmp. Fill in the relevant username and password for the script.pl #!/usr/bin/perl use LWP::UserAgent.Net.au" + ":" + "thepassword") oWeb. $password='<<password>>'.0 .Add("Content-Type". print $ua->request($req)->as_string.1. #!/bin/bash username="" password="" url="http://t-mmp.HTTP API Test Script Save the following file as: testHTTP.charset=utf-8") Perl: use MIME::Base64.UTF8. "Basic " + Convert. $text='Test the HTTP Interface'. . $req->authorization_basic("$username".HTTP API Test Script The following Shell script requires 'wget' to be installed on the server.Text. $ua = LWP::UserAgent->new. "$password").Add("Authorization".Headers.

org/wsdl/http/" xmlns:ns1="http://cgpwebservices.xmlsoap.com. "\n".web.encode("base64") print "QWxhZGRpbjpvcGVuIHNlc2FtZQ==". PHP: echo base64_encode("Aladdin:open sesame").cgp. 27 Nov 2004 10:19:07 GMT Content-Type: text/html Content-Length: 10476 Appendix G .web. "\n".WSDL Definition WSDL for Request and Response for EEMP <?xml version="1.0 ."\n".au" xmlns:soap12="http:// schemas.org/wsdl/mime/" xmlns:ns0="http://cgpwebservices.org/wsdl/" xmlns:axis2="urn:sopranoonline" xmlns:mime="http://schemas.0 200 OK Server: HTTPd/1.soprano.soprano.0" encoding="UTF-8"?> <wsdl:definitions xmlns:wsdl="http://schemas.1.xmlsoap.decode("base64") Ruby: require 'base64' puts Base64::encode64("Aladdin:open sesame") puts Base64::decode64("QWxhZGRpbjpvcGVuIHNlc2FtZQ==") XQuery (eXist-db): let $encode := util:base64-encode('Aladdin:open sesame') let $decode := util:base64-decode('QWxhZGRpbjpvcGVuIHNlc2FtZQ==') OpenSSL: $ printf "Aladdin:open sesame" | openssl enc -base64 QWxhZGRpbjpvcGVuIHNlc2FtZQ== $ echo "QWxhZGRpbjpvcGVuIHNlc2FtZQ==" | openssl enc -base64 -d Aladdin:open sesame Server response: HTTP/1.xmlsoap."\n".au/xsd" xmlns:wsaw="http:// Commercial In Confidence 66 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7.0 Date: Sat.cgp. Python: print "Aladdin:open sesame".xmlsoap. print decode_base64("QWxhZGRpbjpvcGVuIHNlc2FtZQ==").com. print encode_base64("Aladdin:open sesame").org/wsdl/soap12/" xmlns:http="http://schemas. echo base64_decode("QWxhZGRpbjpvcGVuIHNlc2FtZQ==").

soprano.soprano.web.cgp.web.1.w3.xmlsoap.com.au/xsd" attributeFormDefault="unqualified" elementFormDefault="qualified" targetNamespace="http://cgpwebservices. www.w3.com.org/wsdl/soap/" targetNamespace="urn:sopranoonline"> <wsdl:types> <xs:schema xmlns:ns="http://cgpwebservices.au"> <xs:element name="sendmsg"> <xs:complexType> <xs:sequence> <xs:element minOccurs="0" name="request" nillable="true" type="ns1:Request"/> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="sendmsgResponse"> <xs:complexType> <xs:sequence> <xs:element minOccurs="0" name="return" nillable="true" type="ns1:Response"/> </xs:sequence> </xs:complexType> </xs:element> </xs:schema> <xs:schema xmlns:ax21="http://cgpwebservices.web.org/2006/05/addressing/wsdl" xmlns:xs="http://www.soprano.com.cgp.com.au" attributeFormDefault="unqualified" elementFormDefault="qualified" targetNamespace="http://cgpwebservices.0 .web.soprano.au/xsd"> <xs:complexType name="Request"> <xs:sequence> <xs:element minOccurs="0" name="clientMessageId" nillable="true" type="xs:string"/> <xs:element minOccurs="0" name="contentType" type="xs:int"/> <xs:element minOccurs="0" name="costCentre" nillable="true" type="xs:string"/> <xs:element minOccurs="0" name="data" nillable="true" type="xs:string"/> <xs:element minOccurs="0" name="dcs" type="xs:int"/> <xs:element minOccurs="0" name="delay" type="xs:int"/> <xs:element minOccurs="0" name="destinationNPI" type="xs:byte"/> <xs:element minOccurs="0" name="destinationTON" type="xs:byte"/> <xs:element maxOccurs="unbounded" minOccurs="0" name="destinations" nillable="true" type="xs:string"/> <xs:element minOccurs="0" name="message" nillable="true" type="xs:string"/> <xs:element minOccurs="0" name="password" nillable="true" type="xs:string"/> <xs:element minOccurs="0" name="priority" type="xs:byte"/> <xs:element minOccurs="0" name="registered" type="xs:byte"/> <xs:element minOccurs="0" name="replyTo" nillable="true" type="xs:string"/> <xs:element minOccurs="0" name="replyToNPI" type="xs:byte"/> <xs:element minOccurs="0" name="replyToTON" type="xs:byte"/> <xs:element minOccurs="0" name="source" nillable="true" type="xs:string"/> <xs:element minOccurs="0" name="sourceNPI" type="xs:byte"/> <xs:element minOccurs="0" name="sourceTON" type="xs:byte"/> <xs:element minOccurs="0" name="udh" nillable="true" type="xs:string"/> <xs:element minOccurs="0" name="username" nillable="true" type="xs:string"/> <xs:element minOccurs="0" name="validityPeriod" type="xs:long"/> </xs:sequence> </xs:complexType> <xs:complexType name="Response"> <xs:sequence> <xs:element minOccurs="0" name="messageId" nillable="true" type="xs:string"/> Commercial In Confidence 67 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7.org/2001/XMLSchema" xmlns:soap="http://schemas.cgp.cgp.

<xs:element minOccurs="0" name="responseCode" nillable="true" type="xs:string"/> <xs:element minOccurs="0" name="responseString" nillable="true" type="xs:string"/> <xs:element minOccurs="0" name="successCode" nillable="true" type="xs:string"/> </xs:sequence> <xs:attribute name="type" type="xs:string"/> </xs:complexType> </xs:schema> </wsdl:types> <wsdl:message name="sendmsgRequest"> <wsdl:part name="parameters" element="ns0:sendmsg"/> </wsdl:message> <wsdl:message name="sendmsgResponse"> <wsdl:part name="parameters" element="ns0:sendmsgResponse"/> </wsdl:message> <wsdl:portType name="CGPWebSMSInterfacePortType"> <wsdl:operation name="sendmsg"> <wsdl:input message="axis2:sendmsgRequest" wsaw:Action="urn:sendmsg"/> <wsdl:output message="axis2:sendmsgResponse" wsaw:Action="urn:sendmsgResponse"/> </wsdl:operation> </wsdl:portType> <wsdl:binding name="CGPWebSMSInterfaceSOAP11Binding" type="axis2:CGPWebSMSInterfacePortType"> <soap:binding transport="http://schemas.xmlsoap.org/soap/http" style="document"/> <wsdl:operation name="sendmsg"> <soap12:operation soapAction="urn:sendmsg" style="document"/> <wsdl:input> <soap12:body use="literal"/> </wsdl:input> <wsdl:output> <soap12:body use="literal"/> </wsdl:output> </wsdl:operation> </wsdl:binding> <wsdl:binding name="CGPWebSMSInterfaceHttpBinding" type="axis2:CGPWebSMSInterfacePortType"> <http:binding verb="POST"/> <wsdl:operation name="sendmsg"> <http:operation location="CGPWebSMSInterface/sendmsg"/> <wsdl:input> <mime:content type="text/xml" part="parameters"/> </wsdl:input> <wsdl:output> <mime:content type="text/xml" part="parameters"/> </wsdl:output> </wsdl:operation> </wsdl:binding> <wsdl:service name="CGPWebSMSInterface"> Commercial In Confidence 68 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7.xmlsoap.1.org/soap/http" style="document"/ > <wsdl:operation name="sendmsg"> <soap:operation soapAction="urn:sendmsg" style="document"/> <wsdl:input> <soap:body use="literal"/> </wsdl:input> <wsdl:output> <soap:body use="literal"/> </wsdl:output> </wsdl:operation> </wsdl:binding> <wsdl:binding name="CGPWebSMSInterfaceSOAP12Binding" type="axis2:CGPWebSMSInterfacePortType"> <soap12:binding transport="http://schemas.0 .

com/wsdl/t-mmp. Or use the link: http://t-mmp.com.g.com/cgpwebservices/services/ CGPWebSMSInterface"/> </wsdl:port> <wsdl:port name="CGPWebSMSInterfaceHttpport" binding="axis2:CGPWebSMSInterfaceHttpBinding"> <http:address location="http://t-mmp.com/cgpwebservices/services/ CGPWebSMSInterface"/> </wsdl:port> </wsdl:service> </wsdl:definitions> Note: For accuracy. USER DETAILS: Username: demo@soprano.com/cgpwebservices/services/ CGPWebSMSInterface"/> </wsdl:port> <wsdl:port name="CGPWebSMSInterfaceSOAP12port_http" binding="axis2:CGPWebSMSInterfaceSOAP12Binding"> <soap12:address location="http://t-mmp.wsdl Appendix H . <wsdl:port name="CGPWebSMSInterfaceSOAP11port_http" binding="axis2:CGPWebSMSInterfaceSOAP11Binding"> <soap:address location="http://t-mmp.1.au Password: XXXXXXXX REQUEST URL: https://[DOMAIN]/cgphttp/servlet/sendmsg?destination=61494225344&text=Test+Message%0D% 0ANew+Line RESPONSE: 0 001 OK Message-ID: 87121508 Commercial In Confidence 69 © 2013 Soprano Design Pty Ltd EEMP HTTP & WSDL Interface Developers Guide v7.FAQ Q: How do I insert a new line in the message text using the HTTP API (HTTP GET request)? A: URL encode the carriage return '%0D%0A' Example: text=Test+Message%0D%0ANew+Line. e. please obtain the latest WSDL file directly from your Account Executive.com.0 .