SMSGateway

<back to all web services

SendSmsRequest

The following routes are available for this service:
POST/sendsms

export class ResultResponseDto
{
    public code: string;
    public message: string;
    public id: string;

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

export class ResponseSmsDto
{
    public result: ResultResponseDto;

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

export class SecurityRequestDto
{
    public partner_id: string;
    public time: string;
    public hash: string;

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

export class SmsBodyDto
{
    public service_id: string;
    public number: string;
    public carrier: string;
    public message: string;
    public encode: number;
    public url: string;
    public test: number;
    public mask: string;
    public xtraparams: { [index: string]: string; };

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

export class SendSmsRequest
{
    public security: SecurityRequestDto;
    public notify: SmsBodyDto;

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

TypeScript SendSmsRequest 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 /sendsms HTTP/1.1 
Host: 67.208.218.153 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SendSmsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SMSGateway.ServiceModel.Types">
  <notify xmlns:d2p1="http://schemas.datacontract.org/2004/07/SMSGateway.ServiceModel.Requests">
    <d2p1:carrier>String</d2p1:carrier>
    <d2p1:encode>0</d2p1:encode>
    <d2p1:mask>String</d2p1:mask>
    <d2p1:message>String</d2p1:message>
    <d2p1:number>String</d2p1:number>
    <d2p1:service_id>String</d2p1:service_id>
    <d2p1:test>0</d2p1:test>
    <d2p1:url>String</d2p1:url>
    <d2p1:xtraparams xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:xtraparams>
  </notify>
  <security xmlns:d2p1="http://schemas.datacontract.org/2004/07/SMSGateway.ServiceModel.Requests">
    <d2p1:hash>String</d2p1:hash>
    <d2p1:partner_id>String</d2p1:partner_id>
    <d2p1:time>String</d2p1:time>
  </security>
</SendSmsRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ResponseSmsDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SMSGateway.ServiceModel.Responses">
  <result>
    <code>String</code>
    <id>String</id>
    <message>String</message>
  </result>
</ResponseSmsDto>