| Requires any of the roles: | Client, Admin, Partner |
| POST | /communication/message/smpp/sms | Sends an SMS to phone numbers provided. |
|---|
import 'package:servicestack/servicestack.dart';
import 'dart:collection';
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 SendSMPPSmsRequest implements IConvertible
{
/**
* Messages to be Sent
*/
// @ApiMember(Description="Messages to be Sent", IsRequired=true)
List<SMPPMessage>? Messages = [];
SendSMPPSmsRequest({this.Messages});
SendSMPPSmsRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Messages = JsonConverters.fromJson(json['Messages'],'List<SMPPMessage>',context!);
return this;
}
Map<String, dynamic> toJson() => {
'Messages': JsonConverters.toJson(Messages,'List<SMPPMessage>',context!)
};
getTypeName() => "SendSMPPSmsRequest";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'duengageapi.uat.scadsoftware.com', types: <String, TypeInfo> {
'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>[]),
'SendSMPPSmsRequest': TypeInfo(TypeOf.Class, create:() => SendSMPPSmsRequest()),
'List<SMPPMessage>': TypeInfo(TypeOf.Class, create:() => <SMPPMessage>[]),
});
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /communication/message/smpp/sms HTTP/1.1
Host: duengageapi.uat.scadsoftware.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<SendSMPPSmsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
<Messages>
<SMPPMessage>
<channel>String</channel>
<clientMessageId>String</clientMessageId>
<content>String</content>
<to>String</to>
</SMPPMessage>
</Messages>
</SendSMPPSmsRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<SMPPMsgResponse 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>
<SMPPResponseMsg>
<accepted>false</accepted>
<apiMessageId>String</apiMessageId>
<error>String</error>
<msg>
<channel>String</channel>
<clientMessageId>String</clientMessageId>
<content>String</content>
<to>String</to>
</msg>
<to>String</to>
</SMPPResponseMsg>
</messages>
</SMPPMsgResponse>