digitaluapi

SendSmsRequest

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

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

import 'package:servicestack/servicestack.dart';

class SmsMessage implements IConvertible
{
    String? channel;
    String? to;
    String? content;
    String? clientMessageId;

    SmsMessage({this.channel,this.to,this.content,this.clientMessageId});
    SmsMessage.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        channel = json['channel'];
        to = json['to'];
        content = json['content'];
        clientMessageId = json['clientMessageId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'channel': channel,
        'to': to,
        'content': content,
        'clientMessageId': clientMessageId
    };

    getTypeName() => "SmsMessage";
    TypeContext? context = _ctx;
}

class SendSmsRequest implements IConvertible
{
    /**
    * Messages to be Sent
    */
    // @ApiMember(Description="Messages to be Sent", IsRequired=true)
    List<SmsMessage>? Messages = [];

    SendSmsRequest({this.Messages});
    SendSmsRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Messages = JsonConverters.fromJson(json['Messages'],'List<SmsMessage>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Messages': JsonConverters.toJson(Messages,'List<SmsMessage>',context!)
    };

    getTypeName() => "SendSmsRequest";
    TypeContext? context = _ctx;
}

class GrandcomMessage implements IConvertible
{
    String? channel;
    String? to;
    String? content;
    String? clientMessageId;

    GrandcomMessage({this.channel,this.to,this.content,this.clientMessageId});
    GrandcomMessage.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        channel = json['channel'];
        to = json['to'];
        content = json['content'];
        clientMessageId = json['clientMessageId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'channel': channel,
        'to': to,
        'content': content,
        'clientMessageId': clientMessageId
    };

    getTypeName() => "GrandcomMessage";
    TypeContext? context = _ctx;
}

class GrandcomResponseMsg implements IConvertible
{
    String? apiMessageId;
    bool? accepted;
    String? to;
    String? error;
    bool? hasError;
    GrandcomMessage? msg;

    GrandcomResponseMsg({this.apiMessageId,this.accepted,this.to,this.error,this.hasError,this.msg});
    GrandcomResponseMsg.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        apiMessageId = json['apiMessageId'];
        accepted = json['accepted'];
        to = json['to'];
        error = json['error'];
        hasError = json['hasError'];
        msg = JsonConverters.fromJson(json['msg'],'GrandcomMessage',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'apiMessageId': apiMessageId,
        'accepted': accepted,
        'to': to,
        'error': error,
        'hasError': hasError,
        'msg': JsonConverters.toJson(msg,'GrandcomMessage',context!)
    };

    getTypeName() => "GrandcomResponseMsg";
    TypeContext? context = _ctx;
}

class GrandcomMsgResponse implements IConvertible
{
    List<GrandcomResponseMsg>? messages;
    String? error;
    ResponseStatus? ResponseStatus;

    GrandcomMsgResponse({this.messages,this.error,this.ResponseStatus});
    GrandcomMsgResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        messages = JsonConverters.fromJson(json['messages'],'List<GrandcomResponseMsg>',context!);
        error = json['error'];
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'messages': JsonConverters.toJson(messages,'List<GrandcomResponseMsg>',context!),
        'error': error,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "GrandcomMsgResponse";
    TypeContext? context = _ctx;
}

class ClickatellMessage implements IConvertible
{
    String? channel;
    String? to;
    String? content;
    String? clientMessageId;

    ClickatellMessage({this.channel,this.to,this.content,this.clientMessageId});
    ClickatellMessage.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        channel = json['channel'];
        to = json['to'];
        content = json['content'];
        clientMessageId = json['clientMessageId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'channel': channel,
        'to': to,
        'content': content,
        'clientMessageId': clientMessageId
    };

    getTypeName() => "ClickatellMessage";
    TypeContext? context = _ctx;
}

class ClickatellResponsesMsg implements IConvertible
{
    String? apiMessageId;
    bool? accepted;
    String? to;
    String? error;
    ClickatellMessage? msg;

    ClickatellResponsesMsg({this.apiMessageId,this.accepted,this.to,this.error,this.msg});
    ClickatellResponsesMsg.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        apiMessageId = json['apiMessageId'];
        accepted = json['accepted'];
        to = json['to'];
        error = json['error'];
        msg = JsonConverters.fromJson(json['msg'],'ClickatellMessage',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'apiMessageId': apiMessageId,
        'accepted': accepted,
        'to': to,
        'error': error,
        'msg': JsonConverters.toJson(msg,'ClickatellMessage',context!)
    };

    getTypeName() => "ClickatellResponsesMsg";
    TypeContext? context = _ctx;
}

class ClickatellMessageResponse implements IConvertible
{
    List<ClickatellResponsesMsg>? messages;
    String? error;
    ResponseStatus? ResponseStatus;

    ClickatellMessageResponse({this.messages,this.error,this.ResponseStatus});
    ClickatellMessageResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        messages = JsonConverters.fromJson(json['messages'],'List<ClickatellResponsesMsg>',context!);
        error = json['error'];
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'messages': JsonConverters.toJson(messages,'List<ClickatellResponsesMsg>',context!),
        'error': error,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "ClickatellMessageResponse";
    TypeContext? context = _ctx;
}

class SMPPMessage implements IConvertible
{
    String? channel;
    String? to;
    String? content;
    String? clientMessageId;

    SMPPMessage({this.channel,this.to,this.content,this.clientMessageId});
    SMPPMessage.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        channel = json['channel'];
        to = json['to'];
        content = json['content'];
        clientMessageId = json['clientMessageId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'channel': channel,
        'to': to,
        'content': content,
        'clientMessageId': clientMessageId
    };

    getTypeName() => "SMPPMessage";
    TypeContext? context = _ctx;
}

class SMPPResponseMsg implements IConvertible
{
    String? apiMessageId;
    bool? accepted;
    String? to;
    String? error;
    SMPPMessage? msg;

    SMPPResponseMsg({this.apiMessageId,this.accepted,this.to,this.error,this.msg});
    SMPPResponseMsg.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        apiMessageId = json['apiMessageId'];
        accepted = json['accepted'];
        to = json['to'];
        error = json['error'];
        msg = JsonConverters.fromJson(json['msg'],'SMPPMessage',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'apiMessageId': apiMessageId,
        'accepted': accepted,
        'to': to,
        'error': error,
        'msg': JsonConverters.toJson(msg,'SMPPMessage',context!)
    };

    getTypeName() => "SMPPResponseMsg";
    TypeContext? context = _ctx;
}

class SMPPMsgResponse implements IConvertible
{
    List<SMPPResponseMsg>? messages;
    String? error;
    ResponseStatus? ResponseStatus;

    SMPPMsgResponse({this.messages,this.error,this.ResponseStatus});
    SMPPMsgResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        messages = JsonConverters.fromJson(json['messages'],'List<SMPPResponseMsg>',context!);
        error = json['error'];
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'messages': JsonConverters.toJson(messages,'List<SMPPResponseMsg>',context!),
        'error': error,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "SMPPMsgResponse";
    TypeContext? context = _ctx;
}

class SmsMsgResponse implements IConvertible
{
    GrandcomMsgResponse? grandcomMsgResponse;
    ClickatellMessageResponse? clickatellMsgResponse;
    SMPPMsgResponse? SMPPMsgResponse;
    String? error;
    ResponseStatus? ResponseStatus;

    SmsMsgResponse({this.grandcomMsgResponse,this.clickatellMsgResponse,this.SMPPMsgResponse,this.error,this.ResponseStatus});
    SmsMsgResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        grandcomMsgResponse = JsonConverters.fromJson(json['grandcomMsgResponse'],'GrandcomMsgResponse',context!);
        clickatellMsgResponse = JsonConverters.fromJson(json['clickatellMsgResponse'],'ClickatellMessageResponse',context!);
        SMPPMsgResponse = JsonConverters.fromJson(json['SMPPMsgResponse'],'SMPPMsgResponse',context!);
        error = json['error'];
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'grandcomMsgResponse': JsonConverters.toJson(grandcomMsgResponse,'GrandcomMsgResponse',context!),
        'clickatellMsgResponse': JsonConverters.toJson(clickatellMsgResponse,'ClickatellMessageResponse',context!),
        'SMPPMsgResponse': JsonConverters.toJson(SMPPMsgResponse,'SMPPMsgResponse',context!),
        'error': error,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "SmsMsgResponse";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'duengageapi.uat.scadsoftware.com', types: <String, TypeInfo> {
    'SmsMessage': TypeInfo(TypeOf.Class, create:() => SmsMessage()),
    'SendSmsRequest': TypeInfo(TypeOf.Class, create:() => SendSmsRequest()),
    'List<SmsMessage>': TypeInfo(TypeOf.Class, create:() => <SmsMessage>[]),
    'GrandcomMessage': TypeInfo(TypeOf.Class, create:() => GrandcomMessage()),
    'GrandcomResponseMsg': TypeInfo(TypeOf.Class, create:() => GrandcomResponseMsg()),
    'GrandcomMsgResponse': TypeInfo(TypeOf.Class, create:() => GrandcomMsgResponse()),
    'List<GrandcomResponseMsg>': TypeInfo(TypeOf.Class, create:() => <GrandcomResponseMsg>[]),
    'ClickatellMessage': TypeInfo(TypeOf.Class, create:() => ClickatellMessage()),
    'ClickatellResponsesMsg': TypeInfo(TypeOf.Class, create:() => ClickatellResponsesMsg()),
    'ClickatellMessageResponse': TypeInfo(TypeOf.Class, create:() => ClickatellMessageResponse()),
    'List<ClickatellResponsesMsg>': TypeInfo(TypeOf.Class, create:() => <ClickatellResponsesMsg>[]),
    'SMPPMessage': TypeInfo(TypeOf.Class, create:() => SMPPMessage()),
    'SMPPResponseMsg': TypeInfo(TypeOf.Class, create:() => SMPPResponseMsg()),
    'SMPPMsgResponse': TypeInfo(TypeOf.Class, create:() => SMPPMsgResponse()),
    'List<SMPPResponseMsg>': TypeInfo(TypeOf.Class, create:() => <SMPPResponseMsg>[]),
    'SmsMsgResponse': TypeInfo(TypeOf.Class, create:() => SmsMsgResponse()),
});

Dart SendSmsRequest 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/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

{
	grandcomMsgResponse: 
	{
		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
			}
		}
	},
	clickatellMsgResponse: 
	{
		messages: 
		[
			{
				apiMessageId: String,
				accepted: False,
				to: String,
				error: String,
				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
			}
		}
	},
	SMPPMsgResponse: 
	{
		messages: 
		[
			{
				apiMessageId: String,
				accepted: False,
				to: String,
				error: String,
				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
			}
		}
	},
	error: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}