Set up ZyDesk Send Message feature for text messages (SMS)

1. In the Administration Portal menu, select INSTALL > Portal Configuration

2. Select Messaging, and click Save

3. In the Administration Portal menu, select NETWORK > Messaging Gateway

4. In Gateway URL, enter an URL similar to http://<winappserver>:35028/MessagingPortal

1. In Gateway Service, select CP SMS
2. In Account name and Password, enter your CP SMS account credentials
3. In Senders name, enter the name that you want to appear as sender
4. Select Log in StatDB

1. In Gateway Service, select Click-a-tell
2. In Account name and Password and API ID, enter your CP SMS account credentials and API ID
3. In Senders name, enter the name that you want to appear as sender
4. Select Log in StatDB

1. In the Deployment Manager menu, select Deployment > Tomcat Services

2. In Instance, select the instance on port 8080 that already hosts Authentication, Client Manager, and ZyCore ID

3. In Available Tomcat applications, select Messaging Portal, and click Deploy Services

1. In a web browser, open an URL similar to http://<winappserver>:8080/MessagingPortal, and log in as admin with the password for Tomcat instance ZyTomcat1-8080-8443 user admin
2. In the Messaging Portal menu, select TEST SMS
3. In Send to, enter the mobile number that you want to send a test message to, for example your own number in E.164 format, such as +4512345678
4. In From (optional), enter the sender, for example Zylinc test
5. In Message, enter Test SMS Message

Depending on the provider, you should see a status message similar to one of the following:

Test Result CP SMS
Gateway URL: http://www.cpsms.dk/sms/
Response Source: Remote GatewayResponse Http Status Code: 200
Gateway Response Result: SMS succesfully sent to 1 recipient(s)
Error Message: No error message

Test Result Click-a-tell
Gateway URL: http://api.clickatell.com/http/sendmsg
Response Source: Remote Gateway
Response Http Status Code: 200
Gateway Response Result: ID: 58a51cdde7342bf955738fd4cb705f94
Error Message: No error message

If you see an error, you can view information about the error directly on the screen, or you can open the log file for the Tomcat service Messaging Portal and inspect the bottom of the log file for information about the error. To locate the log file, see Open latest log file from specific Zylinc module

Typical errors are caused by wrong user name, or password, or a firewall rule that blocks outgoing connections to the specified server.

Solve any errors and make sure that the Messaging Portal can send text messages (SMS) before you continue to the next step.

1. Log in to ZyDesk

2. Click Send Message (in the top-right corner)

3. Select SMS

4. In To, enter the mobile number that you want to send a test message to

   Use E.164 format, for example +4512345678

5. In Message, enter the message text to send

6. Click Send

Ask the receiver to verify that the text message (SMS) has arrived.

In addition to the providers described in the previous, you can get a software developer, who has knowledge about web services and how to send text messages, to implement a custom web service to send text messages (SMS).

You can give the developer the following information about the protocol to use:

HTTP Request

To send an SMS message, perform a HTTP POST with these parameters in its body:

Parameter name	Data type	Info	Always provided
recipients	string	Recipient(s) of the message. Value may contain multiple recipients delimited by a , (that's a comma)	Yes
from	string	Sender of the message	Yes
message	string	The message itself	Yes
timestamp	string	Timestamp of when client sent message	Yes

HTTP Response

The HTTP response is a combination of the status code and, potentially also, a body

HTTP Response Structure:

Status code	When	Body
200 OK	Message was sent successfully	Body may contain additional information, which will be logged by the Messaging portal
Other status codes	An error occurred	Body may contain an error, which will be logged by the Messaging portal

Response examples

Successful send message request:

POST /sms HTTP/1.1
Host: localhost:49020
Content-Type: application/x-www-form-urlencoded; charset=utf-8

recipients=%2B4512345678%2C%2B4587654321&from=Test+Person&message=Hey!+How+are+you+doing%3F&timestamp=1482247954016

Successful send message response:

HTTP/1.1 200 OK

Unsuccessful send message request response:

HTTP/1.1 500 Internal Server Error
Content-Length: 29
SMS Gateway down at this time

Syntax

Send SMS:

http:\\[serverip]:[port]/MessagingPortal/sms?from=[smssender]&message=[sms body]&recipients=[sms receivers]&timestamp=[timestamp]

from=[smssender]& is optional

Example: http:\\10.10.10.51:8080/MessagingPortal/sms?from=Zylinc Test&message=Test SMS Message&recipients=+4531120406&timestamp=1411977021082&user=Test

By default, the agent's name will be added to the message as a signature. Alternatively, you can use a custom text as a signature:

1. In the Administration Portal menu, select CLIENTS > General Settings
2. In the Agent Default Settings section, under Sms signature, select Use Custom, and specify your Custom Text
3. Click Save

It's your provider that determines which text length and character sets you can use for your SMS text messages. Ask your provider if in doubt.