Wireless Communications Transfer Protocol (WCTP) is the method used to send messages to wireless devices such as pagers and SMS to mobile devices.

The WCTP server allows clients to deliver both one-way and two-way messages to appropriate receiving devices over the internet.

The customer will need a level of familiarity with WCTP functionality, and follows the protocol specification Version 1.3 Update 1.

Accounts Data

TeleMessage will be the Server (Receiver) side and act as carrier gateway, while the client can be an enterprise host, polling enterprise, or transient client (see “Actors and Roles” section in the protocol specification).

Messages should be post to the following address:

https://secure.telemessage.com/servlet/wctp on Port 443

Authentication Details

The sender may choose to use the following methods for authentication:

  • Restriction based on user name of the sender only.
  • Restriction based on user name and IP range of the sender.

In both cases, using a security code is optional (though it is relevant only for part of the operations).

The authentication method will be configured during the customer registration to the system.

Supported Commands

The WCTP protocol defines a number of operations and elements, each represented as a “control block” in an XML form. The operations currently supported are:

Command Functionality Response Element
SubmitClientMessage
Used to initiate a new message from a Transient client to the WCTP Carrier Server.
SubmitClientResponse
SubmitRequest
Used to initiate a new message from an enterprise host, polling enterprise or carrier gateway.
Confirmation
SendMsgMulti
Used to initiate a new multiple-recipient message from a wire line Enterprise Host
SendMsgMultiResponse
Reply – Pull
ClientQuery
A form of a poll operation used by Transient clients to check for status information or responses to a previously submitted message
ClientQueryResponse
PollForMessages
Used by a Polling Enterprise to request and potentially receive messages
PollResponse
MessageReply
Used to report message replies returned on behalf of other messages. (Initiated by the server).  
Reply – Push
StatusInfo
Used to report both message delivery failures as well as notifications returned on behalf of other messages. (Initiated by the server).  
General
VersionQuery
Allows clients to request information about the DTDs that a server application currently supports.
VersionResponse
ReturnToSvc
Used by an enterprise host’s application to inform a carrier’s gateway that the application is alive and waiting for messages to be POSTed to it.
Confirmation
Not Supported
LookupSubscriber
Query the capabilities of a wireless device A set of attributes describing capabilities of the device.
DeviceLocation
If supported, this operation can return either an approximate location determined by the network, or a more precise location which may be determined by the device itself. A set of attributes describing the location of the device.

 

* To use StatusInfo command, please supply the requested return path that will be used. You may check the example section to review the use of this feature.

Backward Compatibility

The use of WCTP version 1.0, 1.1 and 1.2 is allowed to ensure backward compatibility. However, deprecated commands that are not specifically mentioned in the “Supported Commands” (section 2B above) are no longer available.

Element Formats

1) wctpVersion
This attribute specifies the name of the protocol version being used. The format is according to the protocol specification:

WCTP-[SUBTYPE]-V<major release number>R<minor release number>

For example:
<wctp-Operation wctpVersion="wctp-dtd-v1r3">

For backward compatibility, using v1.0 is also allowed:
<wctp-Operation wctpVersion="1.0">

2) wctp-Recipient
This element identifies the recipient of a message. It contains the recipientID, which should be a valid phone number in its international format

For example:
<wctp-Recipient recipientID=”+17816089886”/>

3) wctp-Payload
The payload is the message content sent to or received from a wireless device. The three types of payload include wctp-Alphanumeric, wctp-MCR, wctp-Transparent. Both wctp-Alphanumeric and wctp-MCR are ASCII text payloads, while wctp-Transparent represents binary payload.

The wctp-Alphanumeric is fully supported.

The wctp-MCR (Multi-Choice Response) is only partially supported. While the wctp-MessageText will be used as the content of the message, the other elements of wctp-MCR (wctp-Choice and wctp-ChoicePair) will be ignored.

The wctp-Transparent is not supported as the content is not text.

Example

 

<?xml version="1.0"?>
<!DOCTYPE wctp-Operation SYSTEM "http://www.telemessage.com/dtd/wctp/wctp-dtd-v1r3.dtd">
<wctp-Operation wctpVersion="wctp-dtd-v1r1" wctpToken="11AA">
    <wctp-SubmitRequest>
        <wctp-SubmitHeader submitTimestamp="2013-11-13T08:15:00">
            <wctp-Originator senderID="username" />
            <wctp-MessageControl messageID="1C936BA3"/>
            <wctp-Recipient recipientID="+19131115555"/>
        </wctp-SubmitHeader>
        <wctp-Payload>
            <wctp-Alphanumeric>
                test text WCTP messaging
            </wctp-Alphanumeric>
        </wctp-Payload>
    </wctp-SubmitRequest>
</wctp-Operation>

Note: in order to send an IP Push Notification, you would send the message as if you were sending an SMS. TeleMessage checks if the recipient has the application. If so, the message will then be sent as an IP Push Notification. Please configure whether you want to send IP Push Notifications only, or enable SMS Fallback to ensure that messages will be delivered to the recipient in case the IP Push Notification fails via the TeleMessage web portal

Have a paging tool you’d like to configure? Read more here about setting up popular paging tools with TeleMessage.