SMS Gateway API

<back to all web services

SMSSend

Saves the specified SMS and sends it for background processing

Requires Authentication
The following routes are available for this service:
POST/api/sendmessage
POST/api/sendmessage/immediate
POST/api/send
POST/api/sms/send
POST/api/send/immediate
POST/api/sms/send/immediate
SMSSend Parameters:
NameParameterData TypeRequiredDescription
SMSModelbodySMSModelNo
CreateCommunicationReferencesImmediatelybodyboolNo
SMSModel Parameters:
NameParameterData TypeRequiredDescription
FromformSMSContactNo
ToformList<SMSContact>No
MessageBodyformstringNo
ReplyIsAllowedformboolNo
ReplyIsRequiredformboolNo
NotesformstringNo
LinkedObjectIdformGuidNo
SuiteIdformGuidNo
BaseLicenseeEnforcedServiceModel Parameters:
NameParameterData TypeRequiredDescription
LicenseeIdformGuidNo
SMSContact Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
PhoneNumberformstringNo
ContactIdformGuidNo
CommResponse Parameters:
NameParameterData TypeRequiredDescription
CommIdformGuidNo
ReferenceformstringNo
StatusformboolNo
MessageformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/sendmessage HTTP/1.1 
Host: production-eros-gateway-api-sms-wa.azurewebsites.net 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"SMSModel":{"From":{"Name":"String","PhoneNumber":"String","ContactId":"00000000000000000000000000000000"},"To":[{"Name":"String","PhoneNumber":"String","ContactId":"00000000000000000000000000000000"}],"MessageBody":"String","ReplyIsAllowed":false,"ReplyIsRequired":false,"Notes":"String","LinkedObjectId":"00000000000000000000000000000000","SuiteId":"00000000000000000000000000000000","LicenseeId":"00000000000000000000000000000000"},"CreateCommunicationReferencesImmediately":false}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"CommId":"00000000000000000000000000000000","Reference":"String","Status":false,"Message":"String"}