Spok Go WCTP Protocol Support
Spok Go supports messaging connections from the Spok's consoles and other on-premises systems through WCTP. Spok Go is able to receive up to 50,000 characters in a single WCTP message.
A gateway is required for WCTP integration. See Creating the On-Premises Gateway and Spok Go Integrations for details on creating a gateway in Spok Go.
For more information about the WCTP protocol, see http://www.wctp.org/release/wctp-v1r3_update1.pdf
Standard Message
The following is an example of the data Spok Go supports from the WCTP Protocol for a standard message:
<?xml version="1.0"?>
<!DOCTYPE wctp-Operation SYSTEM "http://dtd.wctp.org/wctp-dtd-v1r3.dtd">
<wctp-Operation wctpVersion="wctp-dtd-v1r3">
<wctp-SubmitRequest>
<wctp-SubmitHeader
submitTimestamp="2019-09-03T11:00:31"
<wctp-Originator
senderID="10.10.87.180:8988/WCTP"
securityCode="xxxxxxxxxxxxx"
/>
<wctp-MessageControl
messageID="8735120"
sendResponsesToID="10.10.87.180:8988/WCTP"
allowResponse="true"
notifyWhenQueued="true"
notifyWhenDelivered="true"
notifyWhenRead="true"
preformatted="true"
allowTruncation="true"
deliveryPriority="NORMAL"
/>
<wctp-Recipient
recipientID="0a79358f-d031-482e-905e-a988cc680f5a"
/>
</wctp-SubmitHeader>
<wctp-Payload>
<wctp-Alphanumeric>Your message text</wctp-AlphaNumeric>
</wctp-Payload>
</wctp-SubmitRequest>
</wctp-Operation>
MCR Message
The following is an example of the data Spok Go supports from the WCTP Protocol for an MCR message:
<?xml version="1.0"?>
<!DOCTYPE wctp-Operation SYSTEM "http://dtd.wctp.org/wctp-dtd-v1r3.dtd">
<wctp-Operation wctpVersion="wctp-dtd-v1r3">
<wctp-SubmitRequest>
<wctp-SubmitHeader
submitTimestamp="2019-09-03T11:00:31"
<wctp-Originator
senderID="10.10.87.180:8988/WCTP"
securityCode="xxxxxxxxxxxxx"
/>
<wctp-MessageControl
messageID="8735120"
sendResponsesToID="10.10.87.180:8988/WCTP"
allowResponse="true"
notifyWhenQueued="true"
notifyWhenDelivered="true"
notifyWhenRead="true"
preformatted="true"
allowTruncation="true"
deliveryPriority="NORMAL"
/>
<wctp-Recipient
recipientID="0a79358f-d031-482e-905e-a988cc680f5a"
/>
</wctp-SubmitHeader>
<wctp-Payload>
<wctp-MCR>
<wctp-MessageText>Your message text</wctp-MessageText>
<wctp-ChoicePair>
<wctp-SendChoice>Yes</wctp-SendChoice>
<wctp-ReplyChoice>y</wctp-ReplyChoice>
</wctp-ChoicePair>
<wctp-ChoicePair>
<wctp-SendChoice>No</wctp-SendChoice>
<wctp-ReplyChoice>n</wctp-ReplyChoice>
</wctp-ChoicePair>
</wctp-MCR>
</wctp-Payload>
</wctp-SubmitRequest>
</wctp-Operation
Alternative wctp-Payload example using <wctp-Choice>
<wctp-Payload>
<wctp-MCR>
<wctp-MessageText>Your message text</wctp-MessageText>
<wctp-Choice>
Yes
</wctp-Choice>
<wctp-Choice>
No
</wctp-Choice>
</wctp-MCR>
</wctp-Payload>
| Field | Description |
| senderID |
Domain of the Spok console server. This field is required. |
| securityCode |
Password of the paging vendor. Matches the security code entered in the Connector. This field is required. |
| messageID | This field is required. |
| sendResponseToID | By default status response messages are sent back to the console server using the location specified in the senderID field. If you include the sendResponsesToID those responses will be sent to this location instead. |
| allowResponse | This is not used. |
| notifyWhenQueued | When set to True, Spok Go will return a QUEUED notification when the message has been accepted by the messaging stack. |
| notifyWhenDelivered | When set to True, Spok Go will returne a DELIVERED notification when the message has been delivered to a user’s device. |
| notifyWhenRead | When set to True, Spok Go will return a READ notification when a user has read the message. |
| preformatted | This is not used. |
| allowTruncation | This is not used. |
| deliveryPriority | Priority of the message being delivered. |
| recipientID |
ID for the recipient in the Spok Go system. This field is required. |