SARK V6 API

back to SARK contents

sark6api

sark6api is fairly vanilla OAS API so it should be familiar to anyone who uses modern api's in their work. It allows you to programmatically do (almost) anything you can do at the SARK V6 browser. Why would you want to do that? Well maybe you have an idea for an extension to SARK, maybe you want to rewrite all or parts of the SARK browser and incorporate it into a package of your own. Maybe you want to control a remote SARK from a management layer. All of these things are possible with the API.

sark6api can be installed onto buster (Debian 10) or bionic (Ubuntu 18). Only 64 bit architectures are supported for both X86 and ARM.

It was tested with Postman 7.2 and developed on Vagrant Homestead running Ubuntu 18.04. sark6api uses the Laravel 7 API framework.

Requirements

• PHP 7.2.5 or higher
• PHP Composer
• Laravel 7
• GiT
• SARK V6.0.1-50 or higher

Before you begin

If you haven't used Postman before then it would be a good idea to familiarise yourself with it before you begin. Postman is a general purpose API testing tool which is easy to use (at least for what we want to do). It runs as an app on OSX or Windows and there is also a version for Ubuntu desktop. It makes testing and exploring API's a breeze. In my view it's essential for this kind of work.

WARNING

The initial release of sark6api works as a "trusted" peer. It has no security of its own so you must use fixed IP's and secure firewall rules to keep it safe from baddies. So, for now, that means NO dynamic IP clients (unless via VPN). We are working on an OAuth security blanket and it will be ready as soon as we can get it out the door but you can test with sark6api as-is, as long as you observe point-to-point security using the host SARK or edge firewall rules.

The sark6api runs at port 44300 (HTTPS).

Installation

You will need a SARKV6 host running on buster or bionic. Doesn't matter what the underlying platform is so you can run it on metal or in virtual as the muse takes you.

Update your existing deb packages

sudo apt update
sudo apt upgrade

NB - this will bring your SARK V6 up to the latest release.

GiT should already be installed as part of the sark6 install. If not then you can do

sudo apt install git

There are a few PHP extensions you may need over and above what gets dragged along with SARK. However, my Vagrant Homestead dev box doesn't appear to have any of them and chugs along OK so YMMV.

• BCMath PHP Extension (php-bcmath)
• Ctype PHP Extension (php-ctype)
• Fileinfo PHP extension (php-fileinfo)
• Tokenizer PHP Extension (php-tokenizer)
• zip (php-zip)

I'm not sure about these because my Vagrant Homestead dev box doesn't appear to have any of them except php-zip yet it chugs along OK so YMMV. So, lets install zip

apt install php-zip

Next, you can install composer. Composer is the PHP package manager. You can think of it a bit like the Debian package manager but with a lot of stuff in it just for PHP. It has more or less become the tool of choice for GiT PHP developers to package their code and we need it to enable the Laravel API framework.

apt install composer

You will also need a regular user account on the box. It doesn't much matter what you choose, it's just an anchor to install the code.

adduser s6api

logout and back in and su to the new account

sudo su - s6api

OK, we're now in out new user and ready to install laravel.

Next we need to add the composer bin to our path

export PATH=$PATH:$HOME/.config/composer/vendor/bin

So far so good. Now we have to create a wrapper directory and clone the api into it

mkdir www
cd www
git clone https://github.com/aelintra/sark6api.git

Next we use composer to add the required Laravel dependencies (which aren't on the Git image)

cd sark6api
composer install

Next we have to add a .env file for Laravel. Create a file called .env in sark6api and paste this into it

APP_NAME=Laravel
APP_ENV=local
APP_KEY=
APP_DEBUG=true
APP_URL=http://localhost

LOG_CHANNEL=stack

DB_CONNECTION=sqlite

BROADCAST_DRIVER=log
CACHE_DRIVER=file
QUEUE_CONNECTION=sync
SESSION_DRIVER=file
SESSION_LIFETIME=120

REDIS_HOST=127.0.0.1
REDIS_PASSWORD=null
REDIS_PORT=6379

MAIL_MAILER=smtp
MAIL_HOST=smtp.mailtrap.io
MAIL_PORT=2525
MAIL_USERNAME=null
MAIL_PASSWORD=null
MAIL_ENCRYPTION=null
MAIL_FROM_ADDRESS=null
MAIL_FROM_NAME="${APP_NAME}"

AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=
AWS_DEFAULT_REGION=us-east-1
AWS_BUCKET=

PUSHER_APP_ID=
PUSHER_APP_KEY=
PUSHER_APP_SECRET=
PUSHER_APP_CLUSTER=mt1

MIX_PUSHER_APP_KEY="${PUSHER_APP_KEY}"
MIX_PUSHER_APP_CLUSTER="${PUSHER_APP_CLUSTER}"

Now generate an encryption key

php artisan key:generate

Methods

SARK6API uses the methods GET,POST,PUT,DELETE

GET is used for retrieval but there are some exceptions, in particular where it is used to issue commands of some description

POST is used to create NEW instances

PUT is used for idempotent operations, usually updates to instance variables

DELETE is used to remove/destroy an instance

Method notation

A method will take the form

METHOD /{endpoint}/{instance?}/{parameter?}

Where a variable ends with a question mark (?) it means the variable is optional. e.g.

GET /agents/{agent?}

Thus you can issue

GET /agents

or

GET /agents/1021

The first example above will return ALL agents, the second will return agent 1021

A POST/PUT BODY will be shown in Laravel validation notation. e.g.

Body

'pkey' = 'required|integer|min:1000|max:9999';

'cluster' = 'required|exists:cluster';

'name' = 'required|alpha_dash';

'passwd' = 'required|integer|min:1000|max:9999';

Most validators are self explanatory but you can find full information in the Laravel Documentation here:- https://laravel.com/docs/7.x/validation#available-validation-rules.

In the POST BODY, only the REQUIRED variables are listed. i.e the minimum you need to supply to get the instance created.
In the PUT BODY, all of the update-able variables are listed.

You can freely supply non-required variables during a POST if you wish but you MUST provide ALL of the REQUIRED variables or the Method will fail.

Return Codes

sark6api will return a standard HTTP status code after every execution. For more information see here:- https://www.restapitutorial.com/httpstatuscodes.html Additionally, when required sark6api will return error messages in JSON format

Agents

POST /agents

Body

'pkey' = 'required|integer|min:1000|max:9999';

'cluster' = 'required|exists:cluster';

'name' = 'required|alpha_dash';

'passwd' = 'required|integer|min:1000|max:9999';

PUT /agents/{agent}

Body

'cluster' => 'exists:cluster,pkey',

'name' => 'alpha_dash',

'passwd' => 'integer',

'queue1' => 'exists:queue|nullable',

'queue2' => 'exists:queue|nullable',

'queue3' => 'exists:queue|nullable',

'queue4' => 'exists:queue|nullable',

'queue5' => 'exists:queue|nullable',

'queue6' => 'exists:queue|nullable'

Asterisk AMI

SARK6API gives you access to a range of blocking functions of the Asterisk AMI (if you want to access non-blocking AMI streams then you can look at something like PAMI). Most of the AMI functions use GET. They return either a single instance or an instance list. AMI method Originate uses POST and two of the database functions use PUT. AMI functions are case sensitive for consistency with the Asterisk AMI documentation.

GET

Instance List AMI Functions

GET /astamis/

Agents

ConfbridgeListRooms

CoreShowChannels

ExtensionStateList

IAXpeers

IAXregistry

ListCommands

QueueStatus

QueueSummary

SIPpeers

SIPshowregistry

Status

VoicemailUsersList

Instance AMI Functions

GET /astamis/

CoreSettings

CoreStatus

DBget/{id}/{key}

ExtensionState/{id}{context?}

MailboxCount/{id}

MailboxStatus/{id}

QueueStatus/{id}

QueueSummary/{id}

Reload

SIPshowpeer/{id}

POST /astamis/originate

originate a new bridge

Body

• target = 'required|integer';
• ringback = 'required|numeric';
• context= alpha_dash';
• clid = 'numeric';

Backups

GET /backups

return a list of available backups on the server

GET /backups/{backup}

Download an existing backup from the server

GET /backups/new

Request a new backup be taken and saved in the backup set

POST /backups

Upload a local zipped backup to the backup set on the server

Body

'uploadzip' => 'required|file|mimetypes:application/zip'

PUT /backups/{backup}

Restore an existing backup from the backup set to the live system. Choose which elements of the backup set you want to restore by setting the corresponding element to true (N.B. this is JSON true - i.e. no quotes)

Body

'restoredb' => 'boolean',

'restoreasterisk' => 'boolean',

'restoreusergreeting' => 'boolean',

'restorevmail' => 'boolean',

'restoreldap' => 'boolean'

Class of Service

There are three elements to CoS.

• A rule (cosrule) which defines a particular dialplan set to be tested
• A closed instance of an egress rule (cosclose) which applies to a particular endpoint(extension)
• An open instance of an egress rule (cosopen) which applies to a particular endpoint(extension)

Class of service instances are accessed using the extension number as the key (NOT the Class of Service key)

coscloses

GET /coscloses

returns a list of the cosrule/extension intersections from the database

POST /coscloses/{cosclose}

create a new cosclose instance

Body

'IPphone_pkey' => 'exists:ipphone,pkey',

'COS_pkey' => 'exists:cos,pkey'

cosopens

GET /cosopens

returns a list of the cosrule/extension intersections from the database

POST /cosopenes/{cosopen}

create a new cosopen instance

Body

'IPphone_pkey' => 'exists:ipphone,pkey',

'COS_pkey' => 'exists:cos,pkey'

cosrules

GET /cosrules

returns a list of the cosrules from the database

POST /cosrules/{cosrule}

create a new cosrule instance

Body

'pkey' => 'required|alpha_dashy',

'dialplan' => 'required'

Custom Apps

GET /customapps/{customapp?}

Return a list or instance of a custom app

POST /customapps

Create a new custom app

Body

'pkey' => 'required'

'cluster' => 'required'

'desc' => 'string|nullable',

'extcode' => 'string|nullable',

'span' => 'in:Internal,External,Both,Neither',

'striptags' => 'in:YES,NO'

PUT /customapps/{customapp}

update a custom app

Body

'cluster' => 'exists:cluster,pkey',

'desc' => 'string|nullable',

'extcode' => 'string|nullable',

'span' => 'in:Internal,External,Both,Neither',

'striptags' => 'in:YES,NO'

Recurring Timers (Daytimers)

POST /daytimers

Create a new daytimer

Body

'cluster' => 'required|exists:cluster,pkey',

'datemonth' => 'in:*,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31',

'dayofweek' => 'in:*,mon,tue,wed,thu,fri,sat,sun',

'desc' => 'string',

'month' => 'in:*,jan,feb,mar,apr,may,jun,jul,aug,sep,oct,nov,dec',

'timespan' => [

'regex:/^\*|(2[0-3]|[01][0-9]):([0-5][0-9])\-(2[0-3]|[01][0-9]):([0-5][0-9])$/'

]

PUT /daytimers/{daytimer}

update a timer

Body

'cluster' => 'required|exists:cluster,pkey',

'datemonth' => 'in:*,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31',

'dayofweek' => 'in:*,mon,tue,wed,thu,fri,sat,sun',

'desc' => 'string',

'month' => 'in:*,jan,feb,mar,apr,may,jun,jul,aug,sep,oct,nov,dec',

'timespan' => [

'regex:/^\*|(2[0-3]|[01][0-9]):([0-5][0-9])\-(2[0-3]|[01][0-9]):([0-5][0-9])$/'

]

Destinations

Destinations provides a list of all currently valid destinations within the database. It has only one method.

Extensions

Extensions have some extra functions to deal with multiple extension types and runtime information

GET /extensions/{extension?}

Return a list or instance of an extension

GET /extensions/{extension}/runtime

Returns runtime information about the extension from the PBX (i.e. CFIM, CFBS, ringdelay)

POST /extensions/mailbox

Create a new mailbox instance

Body

'pkey' => 'required',

'cluster' => 'required|exists:cluster,pkey'

POST /extensions/provisioned

Create a new SARK provisioned instance

Body

'pkey' => 'required',

'cluster' => 'required|exists:cluster,pkey'

'macaddr' => 'required|regex:/^[0-9a-fA-F]{12}$/'

POST /extensions/unprovisioned

Create a new uprovisioned instance

Body

'pkey' => 'required',

'cluster' => 'required|exists:cluster,pkey'

PUT /extensions/{extension}

Update an instance

Body

'active' => 'in:YES,NO',

'callbackto' => 'in:desk,cell',

'callerid' => 'integer|nullable',

'cellphone' => 'integer|nullable',

'celltwin' => 'in:ON,OFF',

'cluster' => 'exists:cluster,pkey',

'devicerec' => 'in:None,OTR,OTRR,Inbound.Outbound,Both',

'dvrvmail' => 'exists:ipphone,pkey|nullable',

'location' => 'in:local,remote',

'protocol' => 'in:IPV4,IPV6',

'provision' => 'string|nullable',

'provisionwith' => 'in:IP,FQDN',

'sndcreds' => 'in:No,Once,Always',

'transport' => 'in:udp,tcp,tls',

'vmailfwd' => 'email|nullable'

PUT /extensions/{extension}/runtime

Update runtime information for an instance

Body

'cfim' =>

['regex:/^\+?\d+$/'],

['nullable'],

'cfbs' =>

['regex:/^\+?\d+$/'],

['nullable'],

'ringdelay' => 'integer|nullable'

Firewalls

SARK uses the Shorewall firewall to protect its resources. The API operates on the entire ruleset as a simple array. GET will return the rules, POST will update the rules and validate them (using shorewall itself) and PUT will restart the firewall.

GET /firewalls/ipv4

return the IPV4 firewall rules

POST /firewalls/ipv4

Upload a rules array to the server and validate it.

Body

'rules' => 'required'

PUT /firewalls/{ipv4

Restart the IPV4 firewall

GET /firewalls/ipv6

return the IPV6 firewall rules

POST /firewalls/ipv6

Upload a rules array to the server and validate it.

Body

'rules' => 'required'

PUT /firewalls/ipv6

Restart the IPV6 firewall

Greetings

GET /greetings

Returns a list of greetings

GET /greetings/{greeting}

Download a greeting

POST /greetings

Upload a new greeting

Body

'greeting' => 'required|file|mimes:wav,mpeg'

DELETE /greetings/{greeting}

Delete a greeting

Non Recurring Timers (Holidaytimers)

GET /holidaytimers{holidaytimer?}

Return a list or instance of HolidayTimer

POST /holidaytimers

Create a new Holidaytimer

Body

'cluster' => 'exists:cluster,pkey',

'route' => 'string',

'desc' => 'string',

'stime' => 'digits:10|nullable',

'etime' => 'digits:10|nullable'

PUT /holidaytimers/{holidaytimer}

update a timer

Body

'cluster' => 'exists:cluster,pkey',

'route' => 'string',

'desc' => 'string',

'stime' => 'digits:10|nullable',

'etime' => 'digits:10|nullable'

Inbound Routes

Inbound routes (DDI's or DiD's) control the initial ingress into the PBX core

GET /inboundroutes/{inboundroute?}

Return a list or instance of InboundRoute

POST /inboundroutes

Create a new inboundroute

Body

'pkey' => 'required'

'carrier' => 'required|in:DiD,CLID'

'cluster' => 'required|exists:cluster'

'trunkname' => 'required'

PUT /inboundroutes/{inboundroute}

update an inboundroute

Body

'active' => 'in:YES,NO',

'alertinfo' => 'string',

'carrier' => 'in:DiD,CLID',

'closeroute' => 'string',

'cluster' => 'exists:cluster,pkey',

'description' => 'alpha_num',

'disa' => 'in:DISA,CALLBACK|nullable',

'disapass' => 'alpha_num|nullable',

'inprefix' => 'integer|nullable',

'moh' => 'in:ON,OFF',

'openroute' => 'string',

'swoclip' => 'in:YES,NO',

'tag' => 'alpha_num|nullable',

IVRs

IVRs optionally control ACD into the PBX core

GET /ivrs/{ivr?}

Return a list or instance of Ivr

POST /ivrs

Create a new ivr

Body

'pkey' => 'required'

'cluster' => 'required|exists:cluster'

PUT /ivrs/{ivr}

update anivr

Body

'alert0' => 'string|nullable',

'alert1' => 'string|nullable',

'alert2' => 'string|nullable',

'alert3' => 'string|nullable',

'alert4' => 'string|nullable',

'alert5' => 'string|nullable',

'alert6' => 'string|nullable',

'alert7' => 'string|nullable',

'alert8' => 'string|nullable',

'alert9' => 'string|nullable',

'alert10' => 'string|nullable',

'alert11' => 'string|nullable',

'description' => 'string|nullable',

'cluster' => 'exists:cluster,pkey',

'greetnum' => 'integer',

'listenforext' => 'in:YES,NO',

'option0' => 'string|nullable',

'option1' => 'string|nullable',

'option2' => 'string|nullable',

'option3' => 'string|nullable',

'option4' => 'string|nullable',

'option5' => 'string|nullable',

'option6' => 'string|nullable',

'option7' => 'string|nullable',

'option8' => 'string|nullable',

'option9' => 'string|nullable',

'option10' => 'string|nullable',

'option11' => 'string|nullable',

'tag0' => 'string|nullable',

'tag1' => 'string|nullable',

'tag2' => 'string|nullable',

'tag3' => 'string|nullable',

'tag4' => 'string|nullable',

'tag5' => 'string|nullable',

'tag6' => 'string|nullable',

'tag7' => 'string|nullable',

'tag8' => 'string|nullable',

'tag9' => 'string|nullable',

'tag10' => 'string|nullable',

'tag11' => 'string|nullable',

'timeout' => 'operator',

Logs/CDRs

Here is a placeholder for general logs. In the initial out it only has a method to retrieve CDR.

GET /logs/cdrs/{limit}

Download the CDR log. If {limit} is specified, download the last {limit} rows

Queues

Queues optionally control ACD into the PBX core

GET /queues{queue?}

Return a list or instance of Queue

POST /queues

Create a new queue

Body

'pkey' => 'required'

'cluster' => 'required|exists:cluster'

PUT /queues/{queue}

update a queue

Body

'conf' => 'string',

'cluster' => 'exists:cluster,pkey',

'devicerec' => 'in:None,OTR,OTRR,Inbound',

'greetnum' => 'regex:/^usergreeting\d{4}$',

'options' => 'alpha',

Snapshots

A snapshot is an instance of the SARK db.

GET /snapshots

return a list of available snapshots on the server

GET /snapshots/{snapshot}

Download an existing snapshot from the server

GET /snapshots/new

Request a new snapshot be taken and saved in the snapshot set

POST /snapshots

Upload a local snapshot to the snapshot set on the server

Body

'uploadsnap' => 'required|file|mimetypes:application/zip'

PUT /backups/{backup}

Restore an existing snapshot from the snapshot set to the live system.

Ring Groups

GET /ringgroups/{ringgroup?}

return a list or instance of ringgroup

POST /ringgroup

Create a new ringgroup

Body

'pkey' => 'required'

'cluster' = 'required|exists:cluster,'

'outcome' = 'required;

PUT /ringgroups/{ringgroup}

Update an existing ringgroup

Body

'cluster' => 'exists:cluster,pkey',

'devicerec' => 'in:default,None,OTR,OTRR,Inbound.Outbound,Both',

'dialparamshunt' => 'alpha|nullable',

'dialparamsring' => 'alpha|nullable',

'divert' => 'integer|nullable',

'greeting' => [

'regex:/^usergreeting\d{4}$/',

'nullable'

],

'grouptype' => 'in:Ring,Hunt,Alias,Page',

'longdesc' => 'string|nullable',

'obeydnd' => 'in:YES,NO|nullable',

'out' => [

'regex:/^[@A-Za-z0-9-_\/\s]{2,1024}$/',

'nullable'

],

'outcome' => 'string',

'pagegroup' => 'integer',

'ringdelay' => 'integer',

'speedalert' => 'string'

Routes

GET /routes/{route?}

return a list or instance of ringgroup

POST /route

Create a new route

Body

'pkey' => 'required'

'cluster' = 'required|exists:cluster,'

'outcome' = 'required;

PUT /routes/{route}

Update an existing route

Body

'active' => 'in:YES,NO',

'auth' => 'in:YES,NO',

'cluster' => 'exists:cluster,pkey',

'desc' => 'alpha_dash',

'dialplan' => 'string',

'path1' => 'exists:lineio,pkey|nullable',

'path2' => 'exists:lineio,pkey|nullable',

'path3' => 'exists:lineio,pkey|nullable',

'path4' => 'exists:lineio,pkey|nullable',

'strategy' => 'in:hunt,balance'

System Commands

System commands use the GET method

GET /syscommands/{command}

Available Commands

commit

reboot

pbxrunstate

pbxstart

pbxstop

Globals

Globals are system wide variables which control PBX default behaviours. They cannot be created or deleted.

GET /globals

return a list of global settings

PUT /globals

update Global settings

Body

'ABSTIMEOUT' => 'integer',

'ACL' => 'in:NO,YES',

'AGENTSTART' => 'integer',

'ALERT' => 'email',

'ALLOWHASHXFER' => 'in:enabled,disabled',

'BLINDBUSY' => 'integer|nullable',

'BOUNCEALERT' => 'integer|nullable',

'CALLPARKING' => 'in:NO,YES',

'CALLRECORD1' => 'in:None,OTR,OTRR,Inbound.Outbound,Both',

'CAMPONQONOFF' => 'in:OFF,ON',

'CAMPONQOPT' => 'string|nullable',

'CFWDEXTRNRULE' => 'in:enabled,disabled',

'CFWDPROGRESS' => 'in:enabled,disabled',

'CFWDANSWER' => 'in:enabled,disabled',

'CLUSTER' => 'in:ON,OFF',

'CONFTYPE' => 'in:simple,hosted',

'COSSTART' => 'in:ON,OFF',

'COUNTRYCODE' => 'alpha|size:2',

'EURL' => 'regex:/^(https?:\/\/)?([\da-z\.-]+)\.([a-z\.]{2,6})([\/\w \.-]*)*\/?$/',

'EMERGENCY' => 'digits:3',

'FQDN' => 'regex:/^(?!:\/\/)(?=.{1,255}$)((.{1,63}\.){1,127}(?![0-9]*$)[a-z0-9-]+\.?)$/i',

'FQDNINSPECT' => 'in:NO,YES',

'FQDNPROV' => 'in:NO,YES',

'INTRINGDELAY' => 'integer',

'IVRKEYWAIT' => 'integer|nullable',

'IVRDIGITWAIT' => 'integer|nullable',

'LACL' => 'in:NO,YES',

'LDAPBASE' => 'string|nullable',

'LDAPOU' => 'string|nullable',

'LDAPUSER' => 'string|nullable',

'LDAPPASS' => 'string|nullable',

'LEASEHDTIME' => 'integer',

'LOCALIP' => 'ip',

'LOGLEVEL' => 'integer',

'LOGSIPDISPSIZE' => 'integer',

'LOGSIPNUMFILES' => 'integer',

'LOGSIPFILESIZE' => 'integer',

'LTERM' => 'in:NO,YES',

'MAXIN' => 'integer',

'MIXMONITOR' => 'in:NO,YES',

'MONITOROUT' => 'string',

'MONITORSTAGE' => 'string',

'MONITORTYPE' => 'in:monitor,mixmonitor',

'NATDEFAULT' => 'in:local,remote',

'OPERATOR' => 'integer',

'PWDLEN' => 'integer',

'PLAYBEEP' => 'in:YES.NO',

'PLAYBUSY' => 'in:YES,NO',

'PLAYCONGESTED' => 'in:YES,NO',

'PLAYTRANSFER' => 'in:YES,NO',

'RECFINALDEST' => 'string',

'RECLIMIT' => 'integer',

'RECQDITHER' => 'integer',

'RECQSEARCHLIM' => 'integer',

'RINGDELAY' => 'integer',

'SESSIONTIMOUT' => 'integer',

'SENDEDOMAIN' => 'in:YES,NO',

'SIPIAXSTART' => 'integer',

'SIPFLOOD' => 'in:NO,YES',

'SPYPASS' => 'integer',

'SUPEMAIL' => 'email|nullable',

'SYSOP' => 'integer',

'SYSPASS' => 'integer',

'TLSPORT' => 'integer',

'USEROTP' => 'string',

'USERCREATE' => 'in:NO,YES',

'VDELAY' => 'integer',

'VMAILAGE' => 'integer',

'VOICEINSTR' => 'in:YES,NO',

'VOIPMAX' => 'integer',

'VXT' => 'in:0,1',

'ZTP' => 'in:disabled,enabled'

Templates

Templates are used to create provisioning streams

GET /templates/{template?}

Return a list or instance of Template

POST /templates

Create a new template

Body

'pkey' => 'required'

technology' => 'required|in:SIP,Descriptor,BLF Template';

PUT /templatess/{template}

update a template

Body

'blfkeyname' => 'exists:device,pkey|nullable',

'desc' => 'string',

'provision' => 'string|nullable',

'technology' => 'in:SIP,Descriptor,BLF Template',

====DELETE //templatess/{template}

Delete a template. Only user created templates can be deleted. System templates can not.

Tenants

Tenants are used to define classes of PBX resources. Usually, but not always, they are customers. For historical reasons, Tenants are internally referred to as clusters.

GET /tenants/{tenants?}

Return a list or instance of Tenant

POST /tenants

Create a new tenant

Body

'pkey' => 'required'

'description' => 'string|required'

PUT /tenants/{tenant}

update a tenant

Body

'abstimeout' => 'integer',

'clusterclid' => 'integer|nullable',

'callgroup' => 'integer|nullable',

'chanmax' => 'integer',

'description' => 'string',

'include' => 'string|nullable',

'localarea' => 'integer,nullable',

'localdplan' => [

'regex:/^\s*(_?(XZN[0-9])\.?)\s*$',

'nullable'

],

'masteroclo' => 'in:AUTO,CLOSED',

'operator' => 'integer',

'pickupgroup' => 'integer|nullable'

====DELETE /tenants/{tenant}

A tenant can only be deleted if it has no dependencies

Trunks

Trunks are used to define peers. Mostly you can think of them as axes of egress from the PBX (Ingress is usually defined by DDI/DiD abstractions)

GET /trunks/{trunk?}

Return a list or instance of Trunk

POST /trunks

Create a new trunk

Body

'pkey' => 'required'

'carrier' => 'required|in:GeneralSIP,GeneralIAX2'

'cluster' => 'required|exists:cluster,' . $request->cluster

'username' => 'required'

'host' => 'required'

PUT /trunks/{trunk}

update a trunk

Body

'active' => 'in:YES,NO',

'alertinfo' => 'string',

'callerid' => 'integer',

'callprogress' => 'in:ON,OFF',

'cluster' => 'exists:cluster,pkey',

'description' => 'alpha_num',

'devicerec' => 'in:None,OTR,OTRR,Inbound.Outbound,Both',

'disa' => 'in:DISA,CALLBACK|nullable',

'disapass' => 'alpha_num|nullable',

'host' => 'string',

'inprefix' => 'integer|nullable',

'match' => 'integer|nullable',

'moh' => 'in:ON,OFF',

'password' => 'alpha_num|nullable',

'peername' => 'string',

'register' => 'string|nullable',

'sipiaxpeer' => 'string',

'sipiaxuser' => 'string',

'swoclip' => 'in:YES,NO',

'tag' => 'alpha_num|nullable',

'transform' => [

'regex:/$(\d+?:\d+?\s*)+',

'nullable'

],

'trunkname' => 'alpha_num',