| Requires any of the roles: | Client, Admin, Partner |
| POST | /communication/message/clickatell/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 SendClickatellSmsRequest
{
///<summary>
///Messages to be Sent
///</summary>
[ApiMember(Description="Messages to be Sent", IsRequired=true)]
public virtual List<ClickatellMessage> Messages { get; set; } = [];
}
}
C# SendClickatellSmsRequest 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/clickatell/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"}}}