Scroll To Top

Configure CySMS

SMS Server

SMS.png

The configurations in this tab are only available if the system is licensed for SMS Server.

 Add – Adds a new SMS Profile using the SMS Profile Editor. Following are three examples showing the SMS Profiles for SMSGlobal, Clickatell and Red Oxygen.

 

Note:

Click here to sign up for a free trial today and your first 100 messages are on SMSGlobal

http://hs.smsglobal.com/partnerregistration/cytrack

2.jpg

3.jpg

4.jpg

Each SMS service provider has their own format for the command which needs to be sent to them to send an SMS

For example it might be http://SMSSERVICE.COM?COMMAND=SEND&NUMBER=12345&MESSAGE=HELLO
which would send the message ‘HELLO’ to number ‘12345’

Or it might be
http://ANOTHERSMSSERVICE.COM?ACTION=SEND&DEST=12345&TEXT=HELLO

To be able to work with these different providers, we allow the name of the various parameters to be configurable, plus in some cases the value sent after the = is also set specifically. Please see the examples for a better understanding

Parameters

Name – Profile Name

SMS Profile Type – Currently the only type supported is HTTP with Callback

Sending SMS

  • Server URL – The web address (URL) provided by the SMS provider
  • Data Fields
    • Field Name – Name of the field
    • Field Value – Value of the field
  • User Name – Username. You must provide the name of the username field and also the username value. Please see examples for more information.
  • Password – Password
  • Additional ID – In some configurations, there is an additional ID which must be provided – please see examples for more information
  • Destination Number – The name of the ‘number’ field required by the SMS provider
  • Message Text – The name of the field which contains the actual message to be sent
  • Extra Field 1 – In most cases the SMS provider requires a ‘command’ type field – this allows you to specify the name and value of the command field
  • Extra Field 2 – In some cases the SMS provider requires another additional field to be set – this allows you to specify the name and value of that field
  • Internal Message ID – This is where we pass in the numeric ID of the message, as stored in the internal database, for linking with replies
  • Success Response – When the send command is issued, there is a response. This value is what response is expeceted if the send request is succcessful
  • Returned Message ID – The name of the field that the message ID is returned in, if any
  • Poll Time(seconds) – The amount of time in seconds that the system should wait between

Receiving SMS and Notifications

  • Incloming TCP Port – TCP Port for incoming sms and notifications
  • Receipt Suffix – If your server is http://mydomain.com and you have specified port 12345 above, you can se the Receipt Suffix to ‘Receipts’ and then receipts would be sent to http://mydomain.com:12345/Receipts
  • Incoming Suffix – Similar the Receipt Suffix, this is what is added to the base URL of the server for Incoming messages

 Deliver Receipts

  • Message ID – The name of the field that indicates the ID of the message that the delivery receipt applies to
  • Status Field – The name of the field which indicates whether the delivery was successful
  • Success Value – The value passed in the Status field to indicate that the delivery was successful
  • Charge Field – Some SMS providers report back the charge that was applied to the SMS – this is only stored in our internal database as a ‘string’ value
  • Related Sent ID – The name of the field which indicates an additional ID field if necessary
  • Status Code Field – The name fo the field which indicates the status, if necessary
  • Status Date Field – The name of the field which the SMS provider reports the status date in. Because this can be any format, this is stored in the internal database as just a ‘string’ value

Incoming Messages

  • From Field – The name of the field indicating the senders number
  • To Field – The name of the field indicating the number that the incoming call was addressed to
  • Message Text Field – The name of the field containing the text of the incoming message
  • Related Sent ID Field – If appropriate, the ID of the message that this message is a reply to
  • Retrieve Date Field – The name of the field which the SMS provider reports the message date and time in. Because this can be any format, this is stored in the internal database as just a ‘string’ value
  • Original ID Field – This field indicates the additional ID of the original outgoing message that this incoming reply relates to
  • Charset Field – This field is for information purposes only

 

Once the Profile is configured, add the profile to the CySMS Server service by right-clicking on the profile column in the service configuration, and set the service to automatic and start it.

 

 

Have more questions? Submit a request

Comments