digitaluapi

<back to all web services

SendSmsRequest

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
POST/communication/message/smsSends an SMS to phone numbers provided.
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class SmsMessage implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $channel=null,
        /** @var string|null */
        public ?string $to=null,
        /** @var string|null */
        public ?string $content=null,
        /** @var string|null */
        public ?string $clientMessageId=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['channel'])) $this->channel = $o['channel'];
        if (isset($o['to'])) $this->to = $o['to'];
        if (isset($o['content'])) $this->content = $o['content'];
        if (isset($o['clientMessageId'])) $this->clientMessageId = $o['clientMessageId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->channel)) $o['channel'] = $this->channel;
        if (isset($this->to)) $o['to'] = $this->to;
        if (isset($this->content)) $o['content'] = $this->content;
        if (isset($this->clientMessageId)) $o['clientMessageId'] = $this->clientMessageId;
        return empty($o) ? new class(){} : $o;
    }
}

class SendSmsRequest implements JsonSerializable
{
    public function __construct(
        /** @description Messages to be Sent */
        // @ApiMember(Description="Messages to be Sent", IsRequired=true)
        /** @var array<SmsMessage>|null */
        public ?array $Messages=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Messages'])) $this->Messages = JsonConverters::fromArray('SmsMessage', $o['Messages']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Messages)) $o['Messages'] = JsonConverters::toArray('SmsMessage', $this->Messages);
        return empty($o) ? new class(){} : $o;
    }
}

class GrandcomMessage implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $channel=null,
        /** @var string|null */
        public ?string $to=null,
        /** @var string|null */
        public ?string $content=null,
        /** @var string|null */
        public ?string $clientMessageId=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['channel'])) $this->channel = $o['channel'];
        if (isset($o['to'])) $this->to = $o['to'];
        if (isset($o['content'])) $this->content = $o['content'];
        if (isset($o['clientMessageId'])) $this->clientMessageId = $o['clientMessageId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->channel)) $o['channel'] = $this->channel;
        if (isset($this->to)) $o['to'] = $this->to;
        if (isset($this->content)) $o['content'] = $this->content;
        if (isset($this->clientMessageId)) $o['clientMessageId'] = $this->clientMessageId;
        return empty($o) ? new class(){} : $o;
    }
}

class GrandcomResponseMsg implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $apiMessageId=null,
        /** @var bool|null */
        public ?bool $accepted=null,
        /** @var string|null */
        public ?string $to=null,
        /** @var string|null */
        public ?string $error=null,
        /** @var bool|null */
        public ?bool $hasError=null,
        /** @var GrandcomMessage|null */
        public ?GrandcomMessage $msg=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['apiMessageId'])) $this->apiMessageId = $o['apiMessageId'];
        if (isset($o['accepted'])) $this->accepted = $o['accepted'];
        if (isset($o['to'])) $this->to = $o['to'];
        if (isset($o['error'])) $this->error = $o['error'];
        if (isset($o['hasError'])) $this->hasError = $o['hasError'];
        if (isset($o['msg'])) $this->msg = JsonConverters::from('GrandcomMessage', $o['msg']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->apiMessageId)) $o['apiMessageId'] = $this->apiMessageId;
        if (isset($this->accepted)) $o['accepted'] = $this->accepted;
        if (isset($this->to)) $o['to'] = $this->to;
        if (isset($this->error)) $o['error'] = $this->error;
        if (isset($this->hasError)) $o['hasError'] = $this->hasError;
        if (isset($this->msg)) $o['msg'] = JsonConverters::to('GrandcomMessage', $this->msg);
        return empty($o) ? new class(){} : $o;
    }
}

class GrandcomMsgResponse implements JsonSerializable
{
    public function __construct(
        /** @var array<GrandcomResponseMsg>|null */
        public ?array $messages=null,
        /** @var string|null */
        public ?string $error=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['messages'])) $this->messages = JsonConverters::fromArray('GrandcomResponseMsg', $o['messages']);
        if (isset($o['error'])) $this->error = $o['error'];
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->messages)) $o['messages'] = JsonConverters::toArray('GrandcomResponseMsg', $this->messages);
        if (isset($this->error)) $o['error'] = $this->error;
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

class ClickatellMessage implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $channel=null,
        /** @var string|null */
        public ?string $to=null,
        /** @var string|null */
        public ?string $content=null,
        /** @var string|null */
        public ?string $clientMessageId=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['channel'])) $this->channel = $o['channel'];
        if (isset($o['to'])) $this->to = $o['to'];
        if (isset($o['content'])) $this->content = $o['content'];
        if (isset($o['clientMessageId'])) $this->clientMessageId = $o['clientMessageId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->channel)) $o['channel'] = $this->channel;
        if (isset($this->to)) $o['to'] = $this->to;
        if (isset($this->content)) $o['content'] = $this->content;
        if (isset($this->clientMessageId)) $o['clientMessageId'] = $this->clientMessageId;
        return empty($o) ? new class(){} : $o;
    }
}

class ClickatellResponsesMsg implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $apiMessageId=null,
        /** @var bool|null */
        public ?bool $accepted=null,
        /** @var string|null */
        public ?string $to=null,
        /** @var string|null */
        public ?string $error=null,
        /** @var ClickatellMessage|null */
        public ?ClickatellMessage $msg=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['apiMessageId'])) $this->apiMessageId = $o['apiMessageId'];
        if (isset($o['accepted'])) $this->accepted = $o['accepted'];
        if (isset($o['to'])) $this->to = $o['to'];
        if (isset($o['error'])) $this->error = $o['error'];
        if (isset($o['msg'])) $this->msg = JsonConverters::from('ClickatellMessage', $o['msg']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->apiMessageId)) $o['apiMessageId'] = $this->apiMessageId;
        if (isset($this->accepted)) $o['accepted'] = $this->accepted;
        if (isset($this->to)) $o['to'] = $this->to;
        if (isset($this->error)) $o['error'] = $this->error;
        if (isset($this->msg)) $o['msg'] = JsonConverters::to('ClickatellMessage', $this->msg);
        return empty($o) ? new class(){} : $o;
    }
}

class ClickatellMessageResponse implements JsonSerializable
{
    public function __construct(
        /** @var array<ClickatellResponsesMsg>|null */
        public ?array $messages=null,
        /** @var string|null */
        public ?string $error=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['messages'])) $this->messages = JsonConverters::fromArray('ClickatellResponsesMsg', $o['messages']);
        if (isset($o['error'])) $this->error = $o['error'];
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->messages)) $o['messages'] = JsonConverters::toArray('ClickatellResponsesMsg', $this->messages);
        if (isset($this->error)) $o['error'] = $this->error;
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

class SMPPMessage implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $channel=null,
        /** @var string|null */
        public ?string $to=null,
        /** @var string|null */
        public ?string $content=null,
        /** @var string|null */
        public ?string $clientMessageId=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['channel'])) $this->channel = $o['channel'];
        if (isset($o['to'])) $this->to = $o['to'];
        if (isset($o['content'])) $this->content = $o['content'];
        if (isset($o['clientMessageId'])) $this->clientMessageId = $o['clientMessageId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->channel)) $o['channel'] = $this->channel;
        if (isset($this->to)) $o['to'] = $this->to;
        if (isset($this->content)) $o['content'] = $this->content;
        if (isset($this->clientMessageId)) $o['clientMessageId'] = $this->clientMessageId;
        return empty($o) ? new class(){} : $o;
    }
}

class SMPPResponseMsg implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $apiMessageId=null,
        /** @var bool|null */
        public ?bool $accepted=null,
        /** @var string|null */
        public ?string $to=null,
        /** @var string|null */
        public ?string $error=null,
        /** @var SMPPMessage|null */
        public ?SMPPMessage $msg=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['apiMessageId'])) $this->apiMessageId = $o['apiMessageId'];
        if (isset($o['accepted'])) $this->accepted = $o['accepted'];
        if (isset($o['to'])) $this->to = $o['to'];
        if (isset($o['error'])) $this->error = $o['error'];
        if (isset($o['msg'])) $this->msg = JsonConverters::from('SMPPMessage', $o['msg']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->apiMessageId)) $o['apiMessageId'] = $this->apiMessageId;
        if (isset($this->accepted)) $o['accepted'] = $this->accepted;
        if (isset($this->to)) $o['to'] = $this->to;
        if (isset($this->error)) $o['error'] = $this->error;
        if (isset($this->msg)) $o['msg'] = JsonConverters::to('SMPPMessage', $this->msg);
        return empty($o) ? new class(){} : $o;
    }
}

class SMPPMsgResponse implements JsonSerializable
{
    public function __construct(
        /** @var array<SMPPResponseMsg>|null */
        public ?array $messages=null,
        /** @var string|null */
        public ?string $error=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['messages'])) $this->messages = JsonConverters::fromArray('SMPPResponseMsg', $o['messages']);
        if (isset($o['error'])) $this->error = $o['error'];
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->messages)) $o['messages'] = JsonConverters::toArray('SMPPResponseMsg', $this->messages);
        if (isset($this->error)) $o['error'] = $this->error;
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

class SmsMsgResponse implements JsonSerializable
{
    public function __construct(
        /** @var GrandcomMsgResponse|null */
        public ?GrandcomMsgResponse $grandcomMsgResponse=null,
        /** @var ClickatellMessageResponse|null */
        public ?ClickatellMessageResponse $clickatellMsgResponse=null,
        /** @var SMPPMsgResponse|null */
        public ?SMPPMsgResponse $SMPPMsgResponse=null,
        /** @var string|null */
        public ?string $error=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['grandcomMsgResponse'])) $this->grandcomMsgResponse = JsonConverters::from('GrandcomMsgResponse', $o['grandcomMsgResponse']);
        if (isset($o['clickatellMsgResponse'])) $this->clickatellMsgResponse = JsonConverters::from('ClickatellMessageResponse', $o['clickatellMsgResponse']);
        if (isset($o['SMPPMsgResponse'])) $this->SMPPMsgResponse = JsonConverters::from('SMPPMsgResponse', $o['SMPPMsgResponse']);
        if (isset($o['error'])) $this->error = $o['error'];
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->grandcomMsgResponse)) $o['grandcomMsgResponse'] = JsonConverters::to('GrandcomMsgResponse', $this->grandcomMsgResponse);
        if (isset($this->clickatellMsgResponse)) $o['clickatellMsgResponse'] = JsonConverters::to('ClickatellMessageResponse', $this->clickatellMsgResponse);
        if (isset($this->SMPPMsgResponse)) $o['SMPPMsgResponse'] = JsonConverters::to('SMPPMsgResponse', $this->SMPPMsgResponse);
        if (isset($this->error)) $o['error'] = $this->error;
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

PHP SendSmsRequest DTOs

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

HTTP + CSV

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/csv
Content-Type: text/csv
Content-Length: length

{"Messages":[{"channel":"String","to":"String","content":"String","clientMessageId":"String"}]}

HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}