digitaluapi

SendGrandcomSmsRequest

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

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

namespace digitaluapi.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type GrandcomMessage() = 
        member val channel:String = null with get,set
        member val to:String = null with get,set
        member val content:String = null with get,set
        member val clientMessageId:String = null with get,set

    [<AllowNullLiteral>]
    type GrandcomResponseMsg() = 
        member val apiMessageId:String = null with get,set
        member val accepted:Boolean = new Boolean() with get,set
        member val to:String = null with get,set
        member val error:String = null with get,set
        member val hasError:Boolean = new Boolean() with get,set
        member val msg:GrandcomMessage = null with get,set

    [<AllowNullLiteral>]
    type GrandcomMsgResponse() = 
        member val messages:ResizeArray<GrandcomResponseMsg> = null with get,set
        member val error:String = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type SendGrandcomSmsRequest() = 
        ///<summary>
        ///Messages to be Sent
        ///</summary>
        [<ApiMember(Description="Messages to be Sent", IsRequired=true)>]
        member val Messages:ResizeArray<GrandcomMessage> = null with get,set

F# SendGrandcomSmsRequest 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/grandcom/sms HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

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

<GrandcomMsgResponse 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>
    <GrandcomResponseMsg>
      <accepted>false</accepted>
      <apiMessageId>String</apiMessageId>
      <error>String</error>
      <hasError>false</hasError>
      <msg>
        <channel>String</channel>
        <clientMessageId>String</clientMessageId>
        <content>String</content>
        <to>String</to>
      </msg>
      <to>String</to>
    </GrandcomResponseMsg>
  </messages>
</GrandcomMsgResponse>