digitaluapi

SendClickatellSmsRequest

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

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

import 'package:servicestack/servicestack.dart';
import 'dart:collection';

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 SendClickatellSmsRequest implements IConvertible
{
    /**
    * Messages to be Sent
    */
    // @ApiMember(Description="Messages to be Sent", IsRequired=true)
    List<ClickatellMessage>? Messages = [];

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

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

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

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

TypeContext _ctx = TypeContext(library: 'duengageapi.uat.scadsoftware.com', types: <String, TypeInfo> {
    '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>[]),
    'SendClickatellSmsRequest': TypeInfo(TypeOf.Class, create:() => SendClickatellSmsRequest()),
    'List<ClickatellMessage>': TypeInfo(TypeOf.Class, create:() => <ClickatellMessage>[]),
});

Dart SendClickatellSmsRequest 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/clickatell/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,
			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
		}
	}
}