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
"use strict";
export class CommResponse {
    /** @param {{CommId?:string,Reference?:string,Status?:boolean,Message?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    CommId;
    /** @type {string} */
    Reference;
    /** @type {boolean} */
    Status;
    /** @type {string} */
    Message;
}
export class BaseLicenseeEnforcedServiceModel {
    /** @param {{LicenseeId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    LicenseeId;
}
export class SMSContact {
    /** @param {{Name?:string,PhoneNumber?:string,ContactId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Name;
    /** @type {string} */
    PhoneNumber;
    /** @type {string} */
    ContactId;
}
export class SMSModel extends BaseLicenseeEnforcedServiceModel {
    /** @param {{From?:SMSContact,To?:SMSContact[],MessageBody?:string,ReplyIsAllowed?:boolean,ReplyIsRequired?:boolean,Notes?:string,LinkedObjectId?:string,SuiteId?:string,LicenseeId?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {SMSContact} */
    From;
    /** @type {SMSContact[]} */
    To;
    /** @type {string} */
    MessageBody;
    /** @type {boolean} */
    ReplyIsAllowed;
    /** @type {boolean} */
    ReplyIsRequired;
    /** @type {string} */
    Notes;
    /** @type {string} */
    LinkedObjectId;
    /** @type {string} */
    SuiteId;
}
export class SMSSend {
    /** @param {{SMSModel?:SMSModel,CreateCommunicationReferencesImmediately?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {SMSModel} */
    SMSModel;
    /** @type {boolean} */
    CreateCommunicationReferencesImmediately;
}

JavaScript SMSSend DTOs

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

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<SMSSend xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Dvaravartman.Common.Model.ServiceModel">
  <CreateCommunicationReferencesImmediately>false</CreateCommunicationReferencesImmediately>
  <SMSModel xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Subtle.Dvaravartman.Common.Model">
    <LicenseeId xmlns="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.Library.ServiceModels">00000000-0000-0000-0000-000000000000</LicenseeId>
    <d2p1:From>
      <d2p1:ContactId>00000000-0000-0000-0000-000000000000</d2p1:ContactId>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:PhoneNumber>String</d2p1:PhoneNumber>
    </d2p1:From>
    <d2p1:LinkedObjectId>00000000-0000-0000-0000-000000000000</d2p1:LinkedObjectId>
    <d2p1:MessageBody>String</d2p1:MessageBody>
    <d2p1:Notes>String</d2p1:Notes>
    <d2p1:ReplyIsAllowed>false</d2p1:ReplyIsAllowed>
    <d2p1:ReplyIsRequired>false</d2p1:ReplyIsRequired>
    <d2p1:SuiteId>00000000-0000-0000-0000-000000000000</d2p1:SuiteId>
    <d2p1:To>
      <d2p1:SMSContact>
        <d2p1:ContactId>00000000-0000-0000-0000-000000000000</d2p1:ContactId>
        <d2p1:Name>String</d2p1:Name>
        <d2p1:PhoneNumber>String</d2p1:PhoneNumber>
      </d2p1:SMSContact>
    </d2p1:To>
  </SMSModel>
</SMSSend>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CommResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Dvaravartman.Common.Model">
  <CommId>00000000-0000-0000-0000-000000000000</CommId>
  <Message>String</Message>
  <Reference>String</Reference>
  <Status>false</Status>
</CommResponse>