Evo Voice

ProvisionCogito

Ensures that a SIP trunk is provisioned for Cogito and that a corresponding outbound SIP trunk is also created on the LiveKit side

**Requires Authentication**
Requires any of the roles:	SystemAdministrator, Manager, Customer

The following routes are available for this service:
POST	/endpoints/cogito/provision

<?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 ProvisionCogitoResponse implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $sipTrunkId=null,
        /** @var bool|null */
        public ?bool $createdNewSipTrunk=null,
        /** @var bool|null */
        public ?bool $createdLiveKitTrunk=null
    ) {
    }

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

/** @description Ensures that a SIP trunk is provisioned for Cogito and that a corresponding outbound SIP trunk is also created on the LiveKit side */
// @Api(Description="Ensures that a SIP trunk is provisioned for Cogito and that a corresponding outbound SIP trunk is also created on the LiveKit side")
class ProvisionCogito implements JsonSerializable
{
    public function __construct(
        /** @description The ID of the account to associate the number with */
        // @ApiMember(Description="The ID of the account to associate the number with")
        /** @var string|null */
        public ?string $accountId=null
    ) {
    }

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

PHP ProvisionCogito 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 /endpoints/cogito/provision HTTP/1.1 
Host: evovoice.io 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ProvisionCogito xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Endpoints">
  <AccountId>String</AccountId>
</ProvisionCogito>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ProvisionCogitoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Endpoints">
  <CreatedLiveKitTrunk>false</CreatedLiveKitTrunk>
  <CreatedNewSipTrunk>false</CreatedNewSipTrunk>
  <SipTrunkId>String</SipTrunkId>
</ProvisionCogitoResponse>