SMSGateway

<back to all web services

SendSmsRequest

The following routes are available for this service:
POST/sendsms
import 'package:servicestack/servicestack.dart';

class ResultResponseDto implements IConvertible
{
    String? code;
    String? message;
    String? id;

    ResultResponseDto({this.code,this.message,this.id});
    ResultResponseDto.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        code = json['code'];
        message = json['message'];
        id = json['id'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'code': code,
        'message': message,
        'id': id
    };

    getTypeName() => "ResultResponseDto";
    TypeContext? context = _ctx;
}

class ResponseSmsDto implements IConvertible
{
    ResultResponseDto? result;

    ResponseSmsDto({this.result});
    ResponseSmsDto.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        result = JsonConverters.fromJson(json['result'],'ResultResponseDto',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'result': JsonConverters.toJson(result,'ResultResponseDto',context!)
    };

    getTypeName() => "ResponseSmsDto";
    TypeContext? context = _ctx;
}

class SecurityRequestDto implements IConvertible
{
    String? partner_id;
    String? time;
    String? hash;

    SecurityRequestDto({this.partner_id,this.time,this.hash});
    SecurityRequestDto.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        partner_id = json['partner_id'];
        time = json['time'];
        hash = json['hash'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'partner_id': partner_id,
        'time': time,
        'hash': hash
    };

    getTypeName() => "SecurityRequestDto";
    TypeContext? context = _ctx;
}

class SmsBodyDto implements IConvertible
{
    String? service_id;
    String? number;
    String? carrier;
    String? message;
    int? encode;
    String? url;
    int? test;
    String? mask;
    Map<String,String?>? xtraparams;

    SmsBodyDto({this.service_id,this.number,this.carrier,this.message,this.encode,this.url,this.test,this.mask,this.xtraparams});
    SmsBodyDto.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        service_id = json['service_id'];
        number = json['number'];
        carrier = json['carrier'];
        message = json['message'];
        encode = json['encode'];
        url = json['url'];
        test = json['test'];
        mask = json['mask'];
        xtraparams = JsonConverters.toStringMap(json['xtraparams']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'service_id': service_id,
        'number': number,
        'carrier': carrier,
        'message': message,
        'encode': encode,
        'url': url,
        'test': test,
        'mask': mask,
        'xtraparams': xtraparams
    };

    getTypeName() => "SmsBodyDto";
    TypeContext? context = _ctx;
}

class SendSmsRequest implements IConvertible
{
    SecurityRequestDto? security;
    SmsBodyDto? notify;

    SendSmsRequest({this.security,this.notify});
    SendSmsRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        security = JsonConverters.fromJson(json['security'],'SecurityRequestDto',context!);
        notify = JsonConverters.fromJson(json['notify'],'SmsBodyDto',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'security': JsonConverters.toJson(security,'SecurityRequestDto',context!),
        'notify': JsonConverters.toJson(notify,'SmsBodyDto',context!)
    };

    getTypeName() => "SendSmsRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: '67.208.218.153', types: <String, TypeInfo> {
    'ResultResponseDto': TypeInfo(TypeOf.Class, create:() => ResultResponseDto()),
    'ResponseSmsDto': TypeInfo(TypeOf.Class, create:() => ResponseSmsDto()),
    'SecurityRequestDto': TypeInfo(TypeOf.Class, create:() => SecurityRequestDto()),
    'SmsBodyDto': TypeInfo(TypeOf.Class, create:() => SmsBodyDto()),
    'SendSmsRequest': TypeInfo(TypeOf.Class, create:() => SendSmsRequest()),
});

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