SMS Gateway API

SMSSend

Saves the specified SMS and sends it for background processing

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


export class CommResponse
{
    public CommId: string;
    public Reference: string;
    public Status: boolean;
    public Message: string;

    public constructor(init?: Partial<CommResponse>) { (Object as any).assign(this, init); }
}

export class BaseLicenseeEnforcedServiceModel
{
    public LicenseeId: string;

    public constructor(init?: Partial<BaseLicenseeEnforcedServiceModel>) { (Object as any).assign(this, init); }
}

export class SMSContact
{
    public Name: string;
    public PhoneNumber: string;
    public ContactId: string;

    public constructor(init?: Partial<SMSContact>) { (Object as any).assign(this, init); }
}

export class SMSModel extends BaseLicenseeEnforcedServiceModel
{
    public From: SMSContact;
    public To: SMSContact[];
    public MessageBody: string;
    public ReplyIsAllowed: boolean;
    public ReplyIsRequired: boolean;
    public Notes: string;
    public LinkedObjectId: string;
    public SuiteId: string;

    public constructor(init?: Partial<SMSModel>) { super(init); (Object as any).assign(this, init); }
}

/** @description Saves the specified SMS and sends it for background processing */
// @Api(Description="Saves the specified SMS and sends it for background processing")
export class SMSSend
{
    public SMSModel: SMSModel;
    public CreateCommunicationReferencesImmediately: boolean;

    public constructor(init?: Partial<SMSSend>) { (Object as any).assign(this, init); }
}

TypeScript 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>