SMSGateway

<back to all web services

SendSmsRequest

The following routes are available for this service:
POST/sendsms
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ResultResponseDto:
    code: Optional[str] = None
    message: Optional[str] = None
    id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ResponseSmsDto:
    result: Optional[ResultResponseDto] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SecurityRequestDto:
    partner_id: Optional[str] = None
    time: Optional[str] = None
    hash: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SmsBodyDto:
    service_id: Optional[str] = None
    number: Optional[str] = None
    carrier: Optional[str] = None
    message: Optional[str] = None
    encode: int = 0
    url: Optional[str] = None
    test: int = 0
    mask: Optional[str] = None
    xtraparams: Optional[Dict[str, str]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SendSmsRequest:
    security: Optional[SecurityRequestDto] = None
    notify: Optional[SmsBodyDto] = None

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