SMSGateway

<back to all web services

SendSmsRequest

The following routes are available for this service:
POST/sendsms
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports SMSGateway.ServiceModel.Types
Imports SMSGateway.ServiceModel.Requests
Imports SMSGateway.ServiceModel.Responses

Namespace Global

    Namespace SMSGateway.ServiceModel.Requests

        Public Partial Class SecurityRequestDto
            Public Overridable Property partner_id As String
            Public Overridable Property time As String
            Public Overridable Property hash As String
        End Class

        Public Partial Class SmsBodyDto
            Public Sub New()
                xtraparams = New Dictionary(Of String, String)
            End Sub

            Public Overridable Property service_id As String
            Public Overridable Property number As String
            Public Overridable Property carrier As String
            Public Overridable Property message As String
            Public Overridable Property encode As Integer
            Public Overridable Property url As String
            Public Overridable Property test As Integer
            Public Overridable Property mask As String
            Public Overridable Property xtraparams As Dictionary(Of String, String)
        End Class
    End Namespace

    Namespace SMSGateway.ServiceModel.Responses

        Public Partial Class ResponseSmsDto
            Public Overridable Property result As ResultResponseDto
        End Class

        Public Partial Class ResultResponseDto
            Public Overridable Property code As String
            Public Overridable Property message As String
            Public Overridable Property id As String
        End Class
    End Namespace

    Namespace SMSGateway.ServiceModel.Types

        Public Partial Class SendSmsRequest
            Public Overridable Property security As SecurityRequestDto
            Public Overridable Property notify As SmsBodyDto
        End Class
    End Namespace
End Namespace

VB.NET 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>