SMSGateway

<back to all web services

SendSmsRequest

The following routes are available for this service:
POST/sendsms
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class SendSmsRequest
    {
        public SecurityRequestDto security = null;
        public SmsBodyDto notify = null;
        
        public SecurityRequestDto getSecurity() { return security; }
        public SendSmsRequest setSecurity(SecurityRequestDto value) { this.security = value; return this; }
        public SmsBodyDto getNotify() { return notify; }
        public SendSmsRequest setNotify(SmsBodyDto value) { this.notify = value; return this; }
    }

    public static class SecurityRequestDto
    {
        public String partner_id = null;
        public String time = null;
        public String hash = null;
        
        public String getPartnerId() { return partner_id; }
        public SecurityRequestDto setPartnerId(String value) { this.partner_id = value; return this; }
        public String getTime() { return time; }
        public SecurityRequestDto setTime(String value) { this.time = value; return this; }
        public String getHash() { return hash; }
        public SecurityRequestDto setHash(String value) { this.hash = value; return this; }
    }

    public static class SmsBodyDto
    {
        public String service_id = null;
        public String number = null;
        public String carrier = null;
        public String message = null;
        public Integer encode = null;
        public String url = null;
        public Integer test = null;
        public String mask = null;
        public HashMap<String,String> xtraparams = null;
        
        public String getServiceId() { return service_id; }
        public SmsBodyDto setServiceId(String value) { this.service_id = value; return this; }
        public String getNumber() { return number; }
        public SmsBodyDto setNumber(String value) { this.number = value; return this; }
        public String getCarrier() { return carrier; }
        public SmsBodyDto setCarrier(String value) { this.carrier = value; return this; }
        public String getMessage() { return message; }
        public SmsBodyDto setMessage(String value) { this.message = value; return this; }
        public Integer getEncode() { return encode; }
        public SmsBodyDto setEncode(Integer value) { this.encode = value; return this; }
        public String getUrl() { return url; }
        public SmsBodyDto setUrl(String value) { this.url = value; return this; }
        public Integer getTest() { return test; }
        public SmsBodyDto setTest(Integer value) { this.test = value; return this; }
        public String getMask() { return mask; }
        public SmsBodyDto setMask(String value) { this.mask = value; return this; }
        public HashMap<String,String> getXtraparams() { return xtraparams; }
        public SmsBodyDto setXtraparams(HashMap<String,String> value) { this.xtraparams = value; return this; }
    }

    public static class ResponseSmsDto
    {
        public ResultResponseDto result = null;
        
        public ResultResponseDto getResult() { return result; }
        public ResponseSmsDto setResult(ResultResponseDto value) { this.result = value; return this; }
    }

    public static class ResultResponseDto
    {
        public String code = null;
        public String message = null;
        public String id = null;
        
        public String getCode() { return code; }
        public ResultResponseDto setCode(String value) { this.code = value; return this; }
        public String getMessage() { return message; }
        public ResultResponseDto setMessage(String value) { this.message = value; return this; }
        public String getId() { return id; }
        public ResultResponseDto setId(String value) { this.id = value; return this; }
    }

}

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