Messaging |
The Infosystem has a module for sending SMS message using UMS as a provider. The following describes the use of this integration via the web service API.
To send a message to a customer you basically need to know two things.
The telephone number to send a message to
The UMS configuration code
The telephone number is rather obvious, the UMS configuration code however is basically a pointer to the integration details for UMS. This is needed because there can be multiple UMS configurations, and each configuration determines the sender of the message and various other details. If you are a third party integrating with the system contact your customer about the possibly values of this code, if you are the customer someone in your organization have set this up and should be able to give you the values.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://tech.infosoft.no/schemas/2011/10"> <soapenv:Header/> <soapenv:Body> <ns:SendSMSRequest> <ns:MobilePhoneNumber>1122334455</ns:MobilePhoneNumber> <ns:Message>This is an awesome test message</ns:Message> <ns:ConfigurationCode>SMS1</ns:ConfigurationCode> </ns:SendSMSRequest> </soapenv:Body> </soapenv:Envelope>
Having a look at SendSMSRequest you will notice that there is a property CustomerNumber. Using this property is optional, but IF you provide it, a communication entry will be logged on the customer containing the message that is being sent. This entry is available in the client so the customer services can see what has been sent.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://tech.infosoft.no/schemas/2011/10"> <soapenv:Header/> <soapenv:Body> <ns:SendSMSRequest> <ns:CustomerNumber>123321</ns:CustomerNumber> <ns:MobilePhoneNumber>1122334455</ns:MobilePhoneNumber> <ns:Message>This is an awesome test message</ns:Message> <ns:ConfigurationCode>SMS1</ns:ConfigurationCode> </ns:SendSMSRequest> </soapenv:Body> </soapenv:Envelope>
Note that no matter which customernumber is specified, the telephone number that is send in will be used.
If for some reason you have the customer number, but you don't have the telephonenumber, and you still want to send a message to said customer. This can be achieved by specifying the CustomerNumber and hoping that the customer has a configured telephone number. If he/she has a message will be sent, AND logged.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://tech.infosoft.no/schemas/2011/10"> <soapenv:Header/> <soapenv:Body> <ns:SendSMSRequest> <ns:CustomerNumber>123321</ns:CustomerNumber> <ns:Message>This is an awesome test message</ns:Message> <ns:ConfigurationCode>SMS1</ns:ConfigurationCode> </ns:SendSMSRequest> </soapenv:Body> </soapenv:Envelope>
For now there is no option of sending message in bulk. For reasonable amounts of messages this can be achieved by just issuing multiple requests, however if you need it for large bulks, let us know and we can expose the functionality in the API.