digitaluapi

SendSMPPSmsRequest

**Requires Authentication**
Requires any of the roles:	Client, Admin, Partner

The following routes are available for this service:
POST	/communication/message/smpp/sms	Sends an SMS to phone numbers provided.

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports digitaluapi.ServiceModel

Namespace Global

    Namespace digitaluapi.ServiceModel

        Public Partial Class SendSMPPSmsRequest
            '''<Summary>
            '''Messages to be Sent
            '''</Summary>
            <ApiMember(Description:="Messages to be Sent", IsRequired:=true)>
            Public Overridable Property Messages As List(Of SMPPMessage) = New List(Of SMPPMessage)
        End Class

        Public Partial Class SMPPMessage
            Public Overridable Property channel As String
            Public Overridable Property to As String
            Public Overridable Property content As String
            Public Overridable Property clientMessageId As String
        End Class

        Public Partial Class SMPPMsgResponse
            Public Overridable Property messages As List(Of SMPPResponseMsg)
            Public Overridable Property error As String
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class

        Public Partial Class SMPPResponseMsg
            Public Overridable Property apiMessageId As String
            Public Overridable Property accepted As Boolean
            Public Overridable Property to As String
            Public Overridable Property error As String
            Public Overridable Property msg As SMPPMessage
        End Class
    End Namespace
End Namespace

VB.NET SendSMPPSmsRequest 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 /communication/message/smpp/sms HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SendSMPPSmsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <Messages>
    <SMPPMessage>
      <channel>String</channel>
      <clientMessageId>String</clientMessageId>
      <content>String</content>
      <to>String</to>
    </SMPPMessage>
  </Messages>
</SendSMPPSmsRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SMPPMsgResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta 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:Meta>
  </ResponseStatus>
  <error>String</error>
  <messages>
    <SMPPResponseMsg>
      <accepted>false</accepted>
      <apiMessageId>String</apiMessageId>
      <error>String</error>
      <msg>
        <channel>String</channel>
        <clientMessageId>String</clientMessageId>
        <content>String</content>
        <to>String</to>
      </msg>
      <to>String</to>
    </SMPPResponseMsg>
  </messages>
</SMPPMsgResponse>