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.

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class SendGrandcomSmsRequest
{
    /**
    * Messages to be Sent
    */
    @ApiMember(Description="Messages to be Sent", IsRequired=true)
    open var Messages:ArrayList<GrandcomMessage> = ArrayList<GrandcomMessage>()
}

open class GrandcomMessage
{
    open var channel:String? = null
    open var to:String? = null
    open var content:String? = null
    open var clientMessageId:String? = null
}

open class GrandcomMsgResponse
{
    open var messages:ArrayList<GrandcomResponseMsg>? = null
    open var error:String? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class GrandcomResponseMsg
{
    open var apiMessageId:String? = null
    open var accepted:Boolean? = null
    open var to:String? = null
    open var error:String? = null
    open var hasError:Boolean? = null
    open var msg:GrandcomMessage? = null
}

Kotlin 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
		}
	}
}