| Requires any of the roles: | Client, Admin, Partner |
| POST | /communication/message/smpp/sms | Sends an SMS to phone numbers provided. |
|---|
export class SMPPMessage
{
public channel: string;
public to: string;
public content: string;
public clientMessageId: string;
public constructor(init?: Partial<SMPPMessage>) { (Object as any).assign(this, init); }
}
export class SMPPResponseMsg
{
public apiMessageId: string;
public accepted: boolean;
public to: string;
public error: string;
public msg: SMPPMessage;
public constructor(init?: Partial<SMPPResponseMsg>) { (Object as any).assign(this, init); }
}
export class SMPPMsgResponse
{
public messages: SMPPResponseMsg[];
public error: string;
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<SMPPMsgResponse>) { (Object as any).assign(this, init); }
}
export class SendSMPPSmsRequest
{
/** @description Messages to be Sent */
// @ApiMember(Description="Messages to be Sent", IsRequired=true)
public Messages: SMPPMessage[] = [];
public constructor(init?: Partial<SendSMPPSmsRequest>) { (Object as any).assign(this, init); }
}
TypeScript SendSMPPSmsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"Messages":[{"channel":"String","to":"String","content":"String","clientMessageId":"String"}]}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}