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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Messages: 
	[
		{
			channel: String,
			to: String,
			content: String,
			clientMessageId: String
		}
	]
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	messages: 
	[
		{
			apiMessageId: String,
			accepted: False,
			to: String,
			error: String,
			hasError: False,
			msg: 
			{
				channel: String,
				to: String,
				content: String,
				clientMessageId: String
			}
		}
	],
	error: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}