digitaluapi

SendSMPPSmsRequest

**Requires Authentication**
Requires any of the roles:	Client, Admin, Partner

The following routes are available for this service:
POST	/communication/message/smpp/sms	Sends 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 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 SendSMPPSmsRequest implements JsonSerializable
{
    public function __construct(
        /** @description Messages to be Sent */
        // @ApiMember(Description="Messages to be Sent", IsRequired=true)
        /** @var array<SMPPMessage>|null */
        public ?array $Messages=null
    ) {
    }

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

PHP SendSMPPSmsRequest DTOs

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

HTTP + 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>