Trendsic Platform Service

<back to all web services

ReceptionistConfigPutRequest

Requires Authentication
The following routes are available for this service:
PUT,OPTIONS/v1/receptionist/config
<?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 ReceptionistConfigResponse implements JsonSerializable
{
    public function __construct(
        /** @var bool|null */
        public ?bool $Enabled=null,
        /** @var string|null */
        public ?string $ToolKey=null,
        /** @var string|null */
        public ?string $Greeting=null,
        /** @var string|null */
        public ?string $EscalationPhone=null,
        /** @var int|null */
        public ?int $CallbackAgentId=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Enabled'])) $this->Enabled = $o['Enabled'];
        if (isset($o['ToolKey'])) $this->ToolKey = $o['ToolKey'];
        if (isset($o['Greeting'])) $this->Greeting = $o['Greeting'];
        if (isset($o['EscalationPhone'])) $this->EscalationPhone = $o['EscalationPhone'];
        if (isset($o['CallbackAgentId'])) $this->CallbackAgentId = $o['CallbackAgentId'];
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Enabled)) $o['Enabled'] = $this->Enabled;
        if (isset($this->ToolKey)) $o['ToolKey'] = $this->ToolKey;
        if (isset($this->Greeting)) $o['Greeting'] = $this->Greeting;
        if (isset($this->EscalationPhone)) $o['EscalationPhone'] = $this->EscalationPhone;
        if (isset($this->CallbackAgentId)) $o['CallbackAgentId'] = $this->CallbackAgentId;
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

class ReceptionistConfigPutRequest implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Greeting=null,
        /** @var string|null */
        public ?string $EscalationPhone=null,
        /** @var int|null */
        public ?int $CallbackAgentId=null,
        /** @var bool|null */
        public ?bool $RegenerateKey=null,
        /** @var bool|null */
        public ?bool $DisableKey=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Greeting'])) $this->Greeting = $o['Greeting'];
        if (isset($o['EscalationPhone'])) $this->EscalationPhone = $o['EscalationPhone'];
        if (isset($o['CallbackAgentId'])) $this->CallbackAgentId = $o['CallbackAgentId'];
        if (isset($o['RegenerateKey'])) $this->RegenerateKey = $o['RegenerateKey'];
        if (isset($o['DisableKey'])) $this->DisableKey = $o['DisableKey'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Greeting)) $o['Greeting'] = $this->Greeting;
        if (isset($this->EscalationPhone)) $o['EscalationPhone'] = $this->EscalationPhone;
        if (isset($this->CallbackAgentId)) $o['CallbackAgentId'] = $this->CallbackAgentId;
        if (isset($this->RegenerateKey)) $o['RegenerateKey'] = $this->RegenerateKey;
        if (isset($this->DisableKey)) $o['DisableKey'] = $this->DisableKey;
        return empty($o) ? new class(){} : $o;
    }
}

PHP ReceptionistConfigPutRequest 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.

PUT /v1/receptionist/config HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ReceptionistConfigPutRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <CallbackAgentId>0</CallbackAgentId>
  <DisableKey>false</DisableKey>
  <EscalationPhone>String</EscalationPhone>
  <Greeting>String</Greeting>
  <RegenerateKey>false</RegenerateKey>
</ReceptionistConfigPutRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ReceptionistConfigResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <CallbackAgentId>0</CallbackAgentId>
  <Enabled>false</Enabled>
  <EscalationPhone>String</EscalationPhone>
  <Greeting>String</Greeting>
  <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>
  <ToolKey>String</ToolKey>
</ReceptionistConfigResponse>