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.

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using digitaluapi.ServiceModel;

namespace digitaluapi.ServiceModel
{
    public partial class ClickatellMessage
    {
        public virtual string channel { get; set; }
        public virtual string to { get; set; }
        public virtual string content { get; set; }
        public virtual string clientMessageId { get; set; }
    }

    public partial class ClickatellMessageResponse
    {
        public virtual List<ClickatellResponsesMsg> messages { get; set; }
        public virtual string error { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    public partial class ClickatellResponsesMsg
    {
        public virtual string apiMessageId { get; set; }
        public virtual bool accepted { get; set; }
        public virtual string to { get; set; }
        public virtual string error { get; set; }
        public virtual ClickatellMessage msg { get; set; }
    }

    public partial class GrandcomMessage
    {
        public virtual string channel { get; set; }
        public virtual string to { get; set; }
        public virtual string content { get; set; }
        public virtual string clientMessageId { get; set; }
    }

    public partial class GrandcomMsgResponse
    {
        public virtual List<GrandcomResponseMsg> messages { get; set; }
        public virtual string error { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    public partial class GrandcomResponseMsg
    {
        public virtual string apiMessageId { get; set; }
        public virtual bool accepted { get; set; }
        public virtual string to { get; set; }
        public virtual string error { get; set; }
        public virtual bool hasError { get; set; }
        public virtual GrandcomMessage msg { get; set; }
    }

    public partial class SendSmsRequest
    {
        ///<summary>
        ///Messages to be Sent
        ///</summary>
        [ApiMember(Description="Messages to be Sent", IsRequired=true)]
        public virtual List<SmsMessage> Messages { get; set; } = [];
    }

    public partial class SMPPMessage
    {
        public virtual string channel { get; set; }
        public virtual string to { get; set; }
        public virtual string content { get; set; }
        public virtual string clientMessageId { get; set; }
    }

    public partial class SMPPMsgResponse
    {
        public virtual List<SMPPResponseMsg> messages { get; set; }
        public virtual string error { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    public partial class SMPPResponseMsg
    {
        public virtual string apiMessageId { get; set; }
        public virtual bool accepted { get; set; }
        public virtual string to { get; set; }
        public virtual string error { get; set; }
        public virtual SMPPMessage msg { get; set; }
    }

    public partial class SmsMessage
    {
        public virtual string channel { get; set; }
        public virtual string to { get; set; }
        public virtual string content { get; set; }
        public virtual string clientMessageId { get; set; }
    }

    public partial class SmsMsgResponse
    {
        public virtual GrandcomMsgResponse grandcomMsgResponse { get; set; }
        public virtual ClickatellMessageResponse clickatellMsgResponse { get; set; }
        public virtual SMPPMsgResponse SMPPMsgResponse { get; set; }
        public virtual string error { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# SendSmsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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

{"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"}}}