mirror of https://github.com/vernonkeenan/lib
1508 lines
39 KiB
YAML
1508 lines
39 KiB
YAML
swagger: "2.0"
|
|
info:
|
|
version: 0.0.2
|
|
title: voip
|
|
description: Telnexus VoIP Microservice
|
|
termsOfService: http://telnexus.com/terms/
|
|
contact:
|
|
email: noc@telnexus.com
|
|
license:
|
|
name: Proprietary - Copyright (c) 2012-2020 by Telnexus LLC
|
|
securityDefinitions:
|
|
ApiKeyAuth:
|
|
type: apiKey
|
|
in: header
|
|
name: X-API-Key
|
|
security:
|
|
- ApiKeyAuth: []
|
|
schemes:
|
|
- http
|
|
basePath: /v1
|
|
host: voip.infra.tnxs.net:8080
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
AuthorityResponse:
|
|
description: Telnexus Response with an array of Authority objects
|
|
schema:
|
|
$ref: "#/definitions/AuthorityResponse"
|
|
EndpointResponse:
|
|
description: Telnexus Response with an array of PBX objects
|
|
schema:
|
|
$ref: "#/definitions/EndpointResponse"
|
|
PhoneNumberResponse:
|
|
description: Telnexus Response with an array of PBX objects
|
|
schema:
|
|
$ref: "#/definitions/PhoneNumberResponse"
|
|
VmBoxResponse:
|
|
description: Telnexus Response with an array of PBX objects
|
|
schema:
|
|
$ref: "#/definitions/VmBoxResponse"
|
|
PbxResponse:
|
|
description: Telnexus Response with an array of PBX objects
|
|
schema:
|
|
$ref: "#/definitions/PbxResponse"
|
|
QueueResponse:
|
|
description: Telnexus Response with an array of Queue objects
|
|
schema:
|
|
$ref: "#/definitions/QueueResponse"
|
|
PbxUserResponse:
|
|
description: Telnexus Response with an array of PBX User objects
|
|
schema:
|
|
$ref: "#/definitions/PbxUserResponse"
|
|
AccessForbidden:
|
|
description: "Access forbidden, account lacks access"
|
|
schema:
|
|
$ref: "#/definitions/Error"
|
|
NotFound:
|
|
description: Resource was not found
|
|
schema:
|
|
$ref: "#/definitions/Error"
|
|
ServerError:
|
|
description: Server Internal Error
|
|
schema:
|
|
$ref: "#/definitions/Error"
|
|
Unauthorized:
|
|
description: "Access Unauthorized, invalid API-KEY was used"
|
|
schema:
|
|
$ref: "#/definitions/Error"
|
|
UnprocessableEntity:
|
|
description: "Unprocessable Entity, likely a bad parameter"
|
|
schema:
|
|
$ref: "#/definitions/Error"
|
|
parameters:
|
|
AuthorityRequest:
|
|
description: A request with an array of Authority Objects
|
|
in: body
|
|
name: authorityRequest
|
|
required: true
|
|
schema:
|
|
$ref: "#/definitions/AuthorityRequest"
|
|
EndpointRequest:
|
|
description: An array of new PBX records
|
|
in: body
|
|
name: endpointRequest
|
|
required: true
|
|
schema:
|
|
$ref: "#/definitions/EndpointRequest"
|
|
PbxRequest:
|
|
description: An array of new PBX records
|
|
in: body
|
|
name: pbxRequest
|
|
required: true
|
|
schema:
|
|
$ref: "#/definitions/PbxRequest"
|
|
PbxUserRequest:
|
|
description: An array of new PBX User records
|
|
in: body
|
|
name: pbxUserRequest
|
|
required: true
|
|
schema:
|
|
$ref: "#/definitions/PbxUserRequest"
|
|
PhoneNumberRequest:
|
|
description: An array of new PBX records
|
|
in: body
|
|
name: phoneNumberRequest
|
|
required: true
|
|
schema:
|
|
$ref: "#/definitions/PhoneNumberRequest"
|
|
VmBoxRequest:
|
|
description: An array of new VmBoxes
|
|
in: body
|
|
name: vmBoxRequest
|
|
required: true
|
|
schema:
|
|
$ref: "#/definitions/VmBoxRequest"
|
|
queueRequest:
|
|
description: An array of new Queues
|
|
in: body
|
|
name: queueRequest
|
|
required: true
|
|
schema:
|
|
$ref: "#/definitions/QueueRequest"
|
|
authorityIdQuery:
|
|
description: Telnexus Id of the Authority to be retrieved
|
|
in: query
|
|
name: authorityId
|
|
required: false
|
|
type: string
|
|
queueIdQuery:
|
|
description: Telnexus Id of the Queue to be retrieved
|
|
in: query
|
|
name: queueId
|
|
required: false
|
|
type: string
|
|
endpointIdQuery:
|
|
description: Telnexus Id of the endpoint to be retrieved
|
|
in: query
|
|
name: endpointId
|
|
required: false
|
|
type: string
|
|
limitQuery:
|
|
default: 100
|
|
description:
|
|
"How many objects to return at one time (max 300, default 100)"
|
|
format: int64
|
|
in: query
|
|
name: limit
|
|
required: false
|
|
type: integer
|
|
offsetQuery:
|
|
default: 0
|
|
description: How many objects to skip? (default 0)
|
|
format: int64
|
|
in: query
|
|
name: offset
|
|
required: false
|
|
type: integer
|
|
pbxIdQuery:
|
|
description: Telnexus Id of the PBX to be retrieved
|
|
in: query
|
|
name: pbxId
|
|
required: false
|
|
type: string
|
|
pbxUserIdQuery:
|
|
description: Telnexus Id of the PBX User to be retrieved
|
|
in: query
|
|
name: pbxUserId
|
|
required: false
|
|
type: string
|
|
phoneNumberIdQuery:
|
|
description: Telnexus Id of the Phone Number to be retrieved
|
|
in: query
|
|
name: phoneNumberId
|
|
required: false
|
|
type: string
|
|
vmBoxIdQuery:
|
|
description: Telnexus Id of the vmBox to be retrieved
|
|
in: query
|
|
name: vmBoxId
|
|
required: false
|
|
type: string
|
|
paths:
|
|
/authorities:
|
|
get:
|
|
description: Return a list of available Authorities
|
|
operationId: getAuthorities
|
|
parameters:
|
|
- $ref: "#/parameters/authorityIdQuery"
|
|
- $ref: "#/parameters/limitQuery"
|
|
- $ref: "#/parameters/offsetQuery"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/AuthorityResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"422":
|
|
$ref: "#/responses/UnprocessableEntity"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Get a list of Authorities
|
|
tags:
|
|
- Authority
|
|
post:
|
|
consumes:
|
|
- application/json
|
|
description: Create new Authorities
|
|
operationId: postAuthorities
|
|
parameters:
|
|
- $ref: "#/parameters/AuthorityRequest"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/AuthorityResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"422":
|
|
$ref: "#/responses/UnprocessableEntity"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Add new Authorities
|
|
tags:
|
|
- Authority
|
|
put:
|
|
consumes:
|
|
- application/json
|
|
description:
|
|
Update fields in an Authority record identified by Telnexus Id
|
|
operationId: putAuthorities
|
|
parameters:
|
|
- $ref: "#/parameters/AuthorityRequest"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/AuthorityResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"422":
|
|
$ref: "#/responses/UnprocessableEntity"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Update Authorities
|
|
tags:
|
|
- Authority
|
|
/endpoints:
|
|
get:
|
|
description: Return a list of available Endpoint entities
|
|
operationId: getEndpoints
|
|
parameters:
|
|
- $ref: "#/parameters/endpointIdQuery"
|
|
- $ref: "#/parameters/limitQuery"
|
|
- $ref: "#/parameters/offsetQuery"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/EndpointResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"422":
|
|
$ref: "#/responses/UnprocessableEntity"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Get a list of Endpoints
|
|
tags:
|
|
- Endpoint
|
|
post:
|
|
consumes:
|
|
- application/json
|
|
description: Create new Endpoints
|
|
operationId: postEndpoints
|
|
parameters:
|
|
- $ref: "#/parameters/EndpointRequest"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/EndpointResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"422":
|
|
$ref: "#/responses/UnprocessableEntity"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Add new Endpoints
|
|
tags:
|
|
- Endpoint
|
|
put:
|
|
consumes:
|
|
- application/json
|
|
description:
|
|
Update fields in Endpoint records identified by Telnexus Id
|
|
operationId: putEndpoints
|
|
parameters:
|
|
- $ref: "#/parameters/EndpointRequest"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/EndpointResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"422":
|
|
$ref: "#/responses/UnprocessableEntity"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Update Endpoints
|
|
tags:
|
|
- Endpoint
|
|
/pbxes:
|
|
get:
|
|
description: Return a list of available PBX entities
|
|
operationId: getPBXes
|
|
parameters:
|
|
- $ref: "#/parameters/pbxIdQuery"
|
|
- $ref: "#/parameters/limitQuery"
|
|
- $ref: "#/parameters/offsetQuery"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/PbxResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"422":
|
|
$ref: "#/responses/UnprocessableEntity"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Get a list of PBXes
|
|
tags:
|
|
- Pbx
|
|
post:
|
|
consumes:
|
|
- application/json
|
|
description: Create new PBXes
|
|
operationId: postPBXes
|
|
parameters:
|
|
- $ref: "#/parameters/PbxRequest"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/PbxResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"422":
|
|
$ref: "#/responses/UnprocessableEntity"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Add new PBXes
|
|
tags:
|
|
- Pbx
|
|
put:
|
|
consumes:
|
|
- application/json
|
|
description:
|
|
Update fields in an PBX record identified by Telnexus Id
|
|
operationId: putPBXes
|
|
parameters:
|
|
- $ref: "#/parameters/PbxRequest"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/PbxResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"422":
|
|
$ref: "#/responses/UnprocessableEntity"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Update PBXes
|
|
tags:
|
|
- Pbx
|
|
/pbxusers:
|
|
get:
|
|
description: Return a list of available PBX Users
|
|
operationId: getPBXUsers
|
|
parameters:
|
|
- $ref: "#/parameters/pbxUserIdQuery"
|
|
- $ref: "#/parameters/limitQuery"
|
|
- $ref: "#/parameters/offsetQuery"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/PbxUserResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"422":
|
|
$ref: "#/responses/UnprocessableEntity"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Get a list of Authorities
|
|
tags:
|
|
- PbxUser
|
|
post:
|
|
consumes:
|
|
- application/json
|
|
description: Create new PBXUsers
|
|
operationId: postPBXUsers
|
|
parameters:
|
|
- $ref: "#/parameters/PbxUserRequest"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/PbxUserResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"422":
|
|
$ref: "#/responses/UnprocessableEntity"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Add new PBXUsers
|
|
tags:
|
|
- PbxUser
|
|
put:
|
|
consumes:
|
|
- application/json
|
|
description:
|
|
Update fields in PBXUsers record identified by Telnexus Id
|
|
operationId: PBXUsers
|
|
parameters:
|
|
- $ref: "#/parameters/PbxUserRequest"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/PbxUserResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"422":
|
|
$ref: "#/responses/UnprocessableEntity"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Update PBXUsers
|
|
tags:
|
|
- PbxUser
|
|
/phonenumbers:
|
|
get:
|
|
description: Return a list of available Phone Number entities
|
|
operationId: getPhoneNumbers
|
|
parameters:
|
|
- $ref: "#/parameters/phoneNumberIdQuery"
|
|
- $ref: "#/parameters/limitQuery"
|
|
- $ref: "#/parameters/offsetQuery"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/PhoneNumberResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"422":
|
|
$ref: "#/responses/UnprocessableEntity"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Get a list of Phone Number
|
|
tags:
|
|
- PhoneNumber
|
|
post:
|
|
consumes:
|
|
- application/json
|
|
description: Create new Phone Numbers
|
|
operationId: postPhoneNumbers
|
|
parameters:
|
|
- $ref: "#/parameters/PhoneNumberRequest"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/PhoneNumberResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"422":
|
|
$ref: "#/responses/UnprocessableEntity"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Add new Phone Numbers
|
|
tags:
|
|
- PhoneNumber
|
|
put:
|
|
consumes:
|
|
- application/json
|
|
description:
|
|
Update fields in an Phone Number record identified by Telnexus
|
|
Id
|
|
operationId: putPhoneNumbers
|
|
parameters:
|
|
- $ref: "#/parameters/PhoneNumberRequest"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/PhoneNumberResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"422":
|
|
$ref: "#/responses/UnprocessableEntity"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Update Phone Numbers
|
|
tags:
|
|
- PhoneNumber
|
|
/vmboxes:
|
|
get:
|
|
description: Return a list of available Voice Mail Box entities
|
|
operationId: getVmBoxes
|
|
parameters:
|
|
- $ref: "#/parameters/vmBoxIdQuery"
|
|
- $ref: "#/parameters/limitQuery"
|
|
- $ref: "#/parameters/offsetQuery"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/VmBoxResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"422":
|
|
$ref: "#/responses/UnprocessableEntity"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Get a list of Voice Mail Boxes
|
|
tags:
|
|
- VmBox
|
|
post:
|
|
consumes:
|
|
- application/json
|
|
description: Create new VmBoxes
|
|
operationId: postVmBoxes
|
|
parameters:
|
|
- $ref: "#/parameters/VmBoxRequest"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/VmBoxResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"422":
|
|
$ref: "#/responses/UnprocessableEntity"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Add new Voice Mail Boxes
|
|
tags:
|
|
- VmBox
|
|
put:
|
|
consumes:
|
|
- application/json
|
|
description:
|
|
Update fields in Voice Mail Box records identified by Telnexus
|
|
Id
|
|
operationId: putVmBoxes
|
|
parameters:
|
|
- $ref: "#/parameters/VmBoxRequest"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/VmBoxResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"422":
|
|
$ref: "#/responses/UnprocessableEntity"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Update Voice Mail Boxes
|
|
tags:
|
|
- VmBox
|
|
/queues:
|
|
get:
|
|
description: Return a list of available Queues
|
|
operationId: getQueues
|
|
parameters:
|
|
- $ref: "#/parameters/queueIdQuery"
|
|
- $ref: "#/parameters/limitQuery"
|
|
- $ref: "#/parameters/offsetQuery"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/QueueResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"422":
|
|
$ref: "#/responses/UnprocessableEntity"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Get a list of Queues
|
|
tags:
|
|
- Queue
|
|
post:
|
|
consumes:
|
|
- application/json
|
|
description: Create new Queues
|
|
operationId: postQueues
|
|
parameters:
|
|
- $ref: "#/parameters/queueRequest"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/QueueResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"422":
|
|
$ref: "#/responses/UnprocessableEntity"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Add new Queues
|
|
tags:
|
|
- Queue
|
|
put:
|
|
consumes:
|
|
- application/json
|
|
description:
|
|
Update fields in Queue records identified by Telnexus Id
|
|
operationId: putQueues
|
|
parameters:
|
|
- $ref: "#/parameters/queueRequest"
|
|
responses:
|
|
"200":
|
|
$ref: "#/responses/QueueResponse"
|
|
"401":
|
|
$ref: "#/responses/Unauthorized"
|
|
"403":
|
|
$ref: "#/responses/AccessForbidden"
|
|
"404":
|
|
$ref: "#/responses/NotFound"
|
|
"422":
|
|
$ref: "#/responses/UnprocessableEntity"
|
|
"500":
|
|
$ref: "#/responses/ServerError"
|
|
summary: Update Queues
|
|
tags:
|
|
- Queue
|
|
definitions:
|
|
Endpoint:
|
|
properties:
|
|
AssetID:
|
|
description: Asset ID
|
|
type: string
|
|
CallForwardID:
|
|
description: Call Forwarding Record ID
|
|
type: string
|
|
CallRestrictionID:
|
|
description: Call Restriction Record ID
|
|
type: string
|
|
CallerIdOverride:
|
|
description: Endpoint CNAM Override
|
|
type: string
|
|
ContactID:
|
|
description: Telnexus Contact ID
|
|
type: string
|
|
DeviceType:
|
|
description: Device Type
|
|
type: string
|
|
DialPlan:
|
|
description: Dial Plan
|
|
type: string
|
|
DoNotDisturb:
|
|
description: Do Not Disturb
|
|
type: string
|
|
DoNotDisturbEnabled:
|
|
description: Do Not Disturb Enabled?
|
|
type: boolean
|
|
Enabled:
|
|
description: Endpoint Enabled?
|
|
type: boolean
|
|
EndpointName:
|
|
description: Endpoint Name
|
|
type: string
|
|
ExcludeFromQueues:
|
|
description: Exclude From Queues?
|
|
type: boolean
|
|
ID:
|
|
description: Telnexus Record ID
|
|
type: string
|
|
KazooEndpointID:
|
|
description: Kazoo Endpoint ID
|
|
type: string
|
|
Language:
|
|
description: Endpoint Language Override
|
|
type: string
|
|
MacAddress:
|
|
description: MAC Address
|
|
type: string
|
|
MusicOnHold:
|
|
description: Music On Hold Override
|
|
type: string
|
|
MusicOnHoldMediaID:
|
|
description: Kazoo MOH Media ID
|
|
type: string
|
|
MwiUnassociatedUpdates:
|
|
description: MWI Unassociated Updates?
|
|
type: boolean
|
|
OwnerID:
|
|
description: Kazoo Owner ID
|
|
type: string
|
|
PbxID:
|
|
description: Telnexus PBX ID
|
|
type: string
|
|
PresenceID:
|
|
description: Presence ID
|
|
type: string
|
|
ProvisionID:
|
|
description: Provisioning Record ID
|
|
type: string
|
|
RegisterOverwriteNotify:
|
|
description: Register Overwrite Notify?
|
|
type: boolean
|
|
Ringtones:
|
|
description: Endpoint Ringtones
|
|
type: string
|
|
RingtonesExternal:
|
|
description: Ringtones External
|
|
type: string
|
|
RingtonesInternal:
|
|
description: Ringtones Internal
|
|
type: string
|
|
SipID:
|
|
description: SIP Information Record ID
|
|
type: string
|
|
SuppressUnregisterNotifications:
|
|
description: Suppress Unregister Notifications?
|
|
type: boolean
|
|
Timezone:
|
|
description: Endpoint Timezone Override
|
|
type: string
|
|
type: object
|
|
EndpointRequest:
|
|
description:
|
|
An array of Endpoint objects sent to be processed in a request
|
|
properties:
|
|
Data:
|
|
items:
|
|
$ref: "#/definitions/Endpoint"
|
|
type: array
|
|
type: object
|
|
EndpointResponse:
|
|
description:
|
|
An array of Endpoint objects sent in response to a request
|
|
properties:
|
|
Data:
|
|
items:
|
|
$ref: "#/definitions/Endpoint"
|
|
type: array
|
|
Meta:
|
|
$ref: "#/definitions/ResponseMeta"
|
|
type: object
|
|
Error:
|
|
properties:
|
|
Code:
|
|
format: int32
|
|
type: integer
|
|
Fields:
|
|
type: string
|
|
Message:
|
|
type: string
|
|
type: object
|
|
Pbx:
|
|
properties:
|
|
AccountID:
|
|
description: Telnexus Account ID
|
|
type: string
|
|
BackendID:
|
|
description: Backend ID
|
|
type: string
|
|
BillingContact:
|
|
description: Billing Contact ID
|
|
type: string
|
|
BillingID:
|
|
description: Kazoo Billing ID
|
|
type: string
|
|
BillingMode:
|
|
description: Kazoo Billing Mode
|
|
type: string
|
|
CallRestrictionID:
|
|
description: Call Restriction Record ID
|
|
type: string
|
|
CallerIdEmergencyName:
|
|
description: Caller ID Emergency Name
|
|
type: string
|
|
CallerIdEmergencyNumber:
|
|
description: Caller ID Emergency Number
|
|
type: string
|
|
CallerIdExternalName:
|
|
description: Caller ID External Name
|
|
type: string
|
|
CallerIdExternalNumber:
|
|
description: Caller ID External Number
|
|
type: string
|
|
Created:
|
|
description: Date Created
|
|
type: string
|
|
Enabled:
|
|
description: User Enabled?
|
|
type: boolean
|
|
ID:
|
|
description: Telnexus ID
|
|
type: string
|
|
IsReseller:
|
|
description: Is Account a Reseller?
|
|
type: boolean
|
|
KazooAccountName:
|
|
description: Kazoo Account Name
|
|
type: string
|
|
KazooID:
|
|
description: Kazoo PBX ID
|
|
type: string
|
|
Language:
|
|
description: Language
|
|
type: string
|
|
MusicOnHold:
|
|
description: Default Music On Hold
|
|
type: string
|
|
Name:
|
|
description: PBX Name
|
|
type: string
|
|
Realm:
|
|
description: PBX Realm
|
|
type: string
|
|
ResellerID:
|
|
description: Reseller ID
|
|
type: string
|
|
TechnicalContactID:
|
|
description: Technical Contact
|
|
type: string
|
|
Timezone:
|
|
description: PBX Timezone
|
|
type: string
|
|
type: object
|
|
PbxRequest:
|
|
properties:
|
|
Data:
|
|
items:
|
|
$ref: "#/definitions/Pbx"
|
|
type: array
|
|
type: object
|
|
PbxResponse:
|
|
description: An array of Authority objects
|
|
properties:
|
|
Data:
|
|
items:
|
|
$ref: "#/definitions/Pbx"
|
|
type: array
|
|
Meta:
|
|
$ref: "#/definitions/ResponseMeta"
|
|
type: object
|
|
PbxUser:
|
|
properties:
|
|
CallRestrictionID:
|
|
description: Call Restriction Record ID
|
|
type: string
|
|
CallerID:
|
|
description: CNAM Override
|
|
type: string
|
|
ContactID:
|
|
description: Telnexus Contact ID
|
|
type: string
|
|
Email:
|
|
description: Email Address
|
|
type: string
|
|
Enabled:
|
|
description: Enabled?
|
|
type: boolean
|
|
FaxToEmailEnabled:
|
|
description: Fax To Email Enabled?
|
|
type: boolean
|
|
FirstName:
|
|
description: First Name
|
|
type: string
|
|
ID:
|
|
description: Telnexus ID
|
|
type: string
|
|
Language:
|
|
description: Language
|
|
type: string
|
|
LastName:
|
|
description: Last Name
|
|
type: string
|
|
PbxID:
|
|
description: Telnexus PBX ID
|
|
type: string
|
|
PrivLevel:
|
|
description: Privilege Level
|
|
type: string
|
|
RecordCall:
|
|
description: RecordCall?
|
|
type: boolean
|
|
RequirePasswordUpdate:
|
|
description: Require Passoword Update?
|
|
type: boolean
|
|
Timezone:
|
|
description: Timezone
|
|
type: string
|
|
UserID:
|
|
description: Kazoo User ID
|
|
type: string
|
|
UserName:
|
|
description: Kazoo Username
|
|
type: string
|
|
Verified:
|
|
description: Verified?
|
|
type: boolean
|
|
VmToEmailEnabled:
|
|
description: Voice Mail to Email Enabled?
|
|
type: boolean
|
|
type: object
|
|
PbxUserRequest:
|
|
properties:
|
|
Data:
|
|
items:
|
|
$ref: "#/definitions/PbxUser"
|
|
type: array
|
|
type: object
|
|
PbxUserResponse:
|
|
description: An array of PBX objects
|
|
properties:
|
|
Data:
|
|
items:
|
|
$ref: "#/definitions/PbxUser"
|
|
type: array
|
|
Meta:
|
|
$ref: "#/definitions/ResponseMeta"
|
|
type: object
|
|
PhoneNumber:
|
|
properties:
|
|
AccountID:
|
|
description: Telnexus Account ID
|
|
type: string
|
|
AuthorityID:
|
|
description: AuthorityID
|
|
type: string
|
|
CompanyID:
|
|
description: Telnexus Company ID
|
|
type: string
|
|
ContactID:
|
|
description: Telnexus Contact ID
|
|
type: string
|
|
ContractID:
|
|
description: Telnexus Contract ID
|
|
type: string
|
|
Description:
|
|
description: Description
|
|
type: string
|
|
Extension:
|
|
description: Extension
|
|
type: string
|
|
FaxLine:
|
|
description: Fax Line?
|
|
type: boolean
|
|
ID:
|
|
description: Telnexus Record ID
|
|
type: string
|
|
Indicator:
|
|
description: Indicator
|
|
type: string
|
|
LocalService:
|
|
description: Local Service
|
|
type: boolean
|
|
LocalToll:
|
|
description: Local Toll
|
|
type: boolean
|
|
LongDistance:
|
|
description: Long Distance
|
|
type: boolean
|
|
LosingCarrier:
|
|
description: Losing Carrier
|
|
type: string
|
|
OpportunityID:
|
|
description: Telnexus Opportunity ID
|
|
type: string
|
|
OrderID:
|
|
description: Telnexus Order ID
|
|
type: string
|
|
PhoneNumber:
|
|
description: Phone Number
|
|
type: string
|
|
PortOut:
|
|
description: Is this number to ported out?
|
|
type: boolean
|
|
ProductID:
|
|
description: Telnexus Product ID
|
|
type: string
|
|
QuoteID:
|
|
description: Telnexus Quote ID
|
|
type: string
|
|
Ratecenter:
|
|
description: Rate Center
|
|
type: string
|
|
Safety:
|
|
description: Is this a safety number?
|
|
type: boolean
|
|
Status:
|
|
description: Number Status
|
|
type: string
|
|
SubscriptionID:
|
|
description: Subscription ID
|
|
type: string
|
|
Tollfree:
|
|
description: Tollfree
|
|
type: string
|
|
Type:
|
|
description: Number Type
|
|
type: string
|
|
WholesalerID:
|
|
description: Wholesale Vendor ID
|
|
type: string
|
|
type: object
|
|
PhoneNumberRequest:
|
|
properties:
|
|
Data:
|
|
items:
|
|
$ref: "#/definitions/PhoneNumber"
|
|
type: array
|
|
type: object
|
|
PhoneNumberResponse:
|
|
description: An array of Phone Number objects
|
|
properties:
|
|
Data:
|
|
items:
|
|
$ref: "#/definitions/PhoneNumber"
|
|
type: array
|
|
Meta:
|
|
$ref: "#/definitions/ResponseMeta"
|
|
type: object
|
|
Recipient:
|
|
type: object
|
|
properties:
|
|
ID:
|
|
description: Telnexus Record Identifier
|
|
type: string
|
|
Available:
|
|
type: string
|
|
AvailabilityState:
|
|
type: string
|
|
QueueAvailability:
|
|
type: string
|
|
OfferedCall:
|
|
type: string
|
|
HandlingCall:
|
|
type: string
|
|
WiretappingRecipient:
|
|
type: string
|
|
WiretapMode:
|
|
type: string
|
|
WrapupTimeSeconds:
|
|
type: string
|
|
Node:
|
|
type: string
|
|
Stats:
|
|
type: object
|
|
$ref: "#/definitions/RecipientStats"
|
|
RecipientStats:
|
|
type: object
|
|
properties:
|
|
ID:
|
|
description: Telnexus Record Identifier
|
|
type: string
|
|
TotalCalls:
|
|
type: number
|
|
format: int64
|
|
MissedCalls:
|
|
type: number
|
|
format: int64
|
|
AvgCallTime:
|
|
type: number
|
|
format: float64
|
|
LoginTime:
|
|
type: number
|
|
format: int64
|
|
LastActionTime:
|
|
type: number
|
|
LastHandledTime:
|
|
type: number
|
|
RecipientRequest:
|
|
properties:
|
|
Data:
|
|
items:
|
|
$ref: "#/definitions/Recipient"
|
|
type: array
|
|
type: object
|
|
RecipientResponse:
|
|
description: An array of Recipient objects
|
|
properties:
|
|
Data:
|
|
items:
|
|
$ref: "#/definitions/Recipient"
|
|
type: array
|
|
Meta:
|
|
$ref: "#/definitions/ResponseMeta"
|
|
type: object
|
|
ResponseMeta:
|
|
properties:
|
|
Contact:
|
|
description: Microservice Contact Info
|
|
type: string
|
|
Copyright:
|
|
description: Copyright Info
|
|
type: string
|
|
License:
|
|
description: License Information and Restrictions
|
|
type: string
|
|
operationId:
|
|
description: Operation ID
|
|
type: string
|
|
RequestIP:
|
|
description: Request IP Address
|
|
type: string
|
|
RequestType:
|
|
description: Request Type
|
|
type: string
|
|
RequestURL:
|
|
description: Request URL
|
|
type: string
|
|
ServerInfo:
|
|
description: Data Server Info
|
|
type: string
|
|
ServerResponseTime:
|
|
description: Data Server Response Time (ms)
|
|
type: string
|
|
ServerTimestamp:
|
|
description: Backend Server Timestamp
|
|
type: string
|
|
TelnexusAccount:
|
|
description:
|
|
Telnexus Account Number used for recording transactions
|
|
type: string
|
|
type: object
|
|
Queue:
|
|
type: object
|
|
properties:
|
|
ID:
|
|
description: Telnexus Record Identifier
|
|
type: string
|
|
AgentWrapupTime:
|
|
description:
|
|
Pre-defined wait period applied after an agent handles a
|
|
customer call (in seconds)
|
|
type: integer
|
|
ForceAwayOnReject:
|
|
description:
|
|
If set to true and a recipient rejects a call, they will be
|
|
forced to away state
|
|
type: boolean
|
|
HoldTreatment:
|
|
description:
|
|
Media ID (or appropriate media URI) of media to play while
|
|
caller is on hold.
|
|
type: string
|
|
Name:
|
|
description: A friendly name for the queue
|
|
type: string
|
|
QueueRouter:
|
|
default: route_round_robin
|
|
description:
|
|
The queue router used for routing and delivering calls to
|
|
recipients
|
|
type: string
|
|
QueueType:
|
|
description: The type of queue
|
|
type: string
|
|
RingTimeout:
|
|
description:
|
|
Amount of time in seconds that qubicle will wait while ringing
|
|
for the agent to successfully answer a call.
|
|
type: integer
|
|
TickTime:
|
|
description: The time between delivery ticks in milliseconds
|
|
type: integer
|
|
Timeout:
|
|
description:
|
|
The maximum amount of time in seconds that a call will wait in
|
|
queue.
|
|
type: integer
|
|
TimeoutIfSizeExceeds:
|
|
description:
|
|
If set to a non-zero value the queue will immediately time out
|
|
any call entering the queue over the size
|
|
type: integer
|
|
TimeoutImmediatelyIfEmpty:
|
|
description:
|
|
If set to true and a call enters the queue while it has no
|
|
logged in agents, the call will time out
|
|
type: boolean
|
|
TimoutRedirect:
|
|
description:
|
|
The ID of a queue that the call will be sent to in the event
|
|
of a timeout
|
|
type: string
|
|
QueueRequest:
|
|
properties:
|
|
Data:
|
|
items:
|
|
$ref: "#/definitions/Queue"
|
|
type: array
|
|
type: object
|
|
QueueResponse:
|
|
description: An array of Recipient objects
|
|
properties:
|
|
Data:
|
|
items:
|
|
$ref: "#/definitions/Recipient"
|
|
type: array
|
|
Meta:
|
|
$ref: "#/definitions/ResponseMeta"
|
|
type: object
|
|
VmBox:
|
|
properties:
|
|
CheckIfOwner:
|
|
description: Check if VM owner is owner of endpoint
|
|
type: boolean
|
|
DeleteAfterNotify:
|
|
description: Delete VM after notification
|
|
type: boolean
|
|
ID:
|
|
description: Telnexus Record ID
|
|
type: string
|
|
IsSetup:
|
|
description: Is this VM Box setup?
|
|
type: boolean
|
|
KazooID:
|
|
description: Kazoo Mailbox Id
|
|
type: string
|
|
KazooOwnerID:
|
|
description: Kazoo User Id
|
|
type: string
|
|
MailboxNumber:
|
|
description: Kazoo Mailbox Number
|
|
type: string
|
|
Name:
|
|
description: Mailbox Name
|
|
type: string
|
|
NotConfigurable:
|
|
description: Not Configurable?
|
|
type: boolean
|
|
PbxID:
|
|
description: Telnexus PBX ID
|
|
type: string
|
|
RequirePIN:
|
|
description: Require PIN?
|
|
type: boolean
|
|
SaveAfterNotify:
|
|
description: Save after notify?
|
|
type: boolean
|
|
SkipGreeting:
|
|
description: Skip Greeting?
|
|
type: boolean
|
|
SkipInstructions:
|
|
description: Skip Instructions?
|
|
type: boolean
|
|
type: object
|
|
VmBoxRequest:
|
|
properties:
|
|
Data:
|
|
items:
|
|
$ref: "#/definitions/VmBox"
|
|
type: array
|
|
type: object
|
|
VmBoxResponse:
|
|
description: An array of VmBox objects
|
|
properties:
|
|
Data:
|
|
items:
|
|
$ref: "#/definitions/VmBox"
|
|
type: array
|
|
Meta:
|
|
$ref: "#/definitions/ResponseMeta"
|
|
type: object
|
|
Authority:
|
|
properties:
|
|
AccountID:
|
|
description: Account
|
|
type: string
|
|
AddressLine1:
|
|
description: Address Line 1
|
|
type: string
|
|
AddressLine2:
|
|
description: Address Line 2
|
|
type: string
|
|
BTN:
|
|
description: Billing Telephone Number
|
|
type: string
|
|
City:
|
|
description: City
|
|
type: string
|
|
ContactID:
|
|
description: Contact Name
|
|
type: string
|
|
Country:
|
|
description: Country
|
|
type: string
|
|
CreatedByID:
|
|
description: Created By User ID
|
|
type: string
|
|
CreatedDate:
|
|
description: Created Date
|
|
type: string
|
|
Date:
|
|
description: Authority Date
|
|
type: string
|
|
DateApproved:
|
|
description: Date Approved
|
|
type: string
|
|
ID:
|
|
description: Telnexus Record Identifier
|
|
type: string
|
|
LastModifiedByID:
|
|
description: Last Modified By User ID
|
|
type: string
|
|
LastModifiedDate:
|
|
description: Last Modified Date
|
|
type: string
|
|
LosingCarrier:
|
|
description: Losing Carrier
|
|
type: string
|
|
Name:
|
|
description: Authority Number
|
|
type: string
|
|
NameLine1:
|
|
description: Name Line 1
|
|
type: string
|
|
NameLine2:
|
|
description: Name Line 2
|
|
type: string
|
|
OpportunityID:
|
|
description: Opportunity Name
|
|
type: string
|
|
OrderID:
|
|
description: Order Number
|
|
type: string
|
|
ParentFK:
|
|
description:
|
|
UUID Reference the master record that owns this item
|
|
type: string
|
|
PostalCode:
|
|
description: Zip Code
|
|
type: string
|
|
QuoteID:
|
|
description: Quote Name
|
|
type: string
|
|
Ref:
|
|
description: "Source System identifier for this record, if any"
|
|
type: string
|
|
State:
|
|
description: State
|
|
type: string
|
|
Status:
|
|
description: Status
|
|
type: string
|
|
TemplateID:
|
|
description: ID of the Template for this object instance
|
|
type: string
|
|
TenantID:
|
|
description: Tenant that owns this object instance
|
|
type: string
|
|
TransferDate:
|
|
description: Transfer Date
|
|
type: string
|
|
Type:
|
|
description: Authority Type
|
|
type: string
|
|
type: object
|
|
AuthorityRequest:
|
|
properties:
|
|
Data:
|
|
items:
|
|
$ref: "#/definitions/Authority"
|
|
type: array
|
|
type: object
|
|
AuthorityResponse:
|
|
description: An array of Authority objects
|
|
properties:
|
|
Data:
|
|
items:
|
|
$ref: "#/definitions/Authority"
|
|
type: array
|
|
Meta:
|
|
$ref: "#/definitions/ResponseMeta"
|
|
type: object
|
|
Callflow:
|
|
description:
|
|
Call flows describe steps to take in order to process a phone
|
|
call. They are trees of information related to a phone call such
|
|
as "answer, play file, record file" etc. that are logically
|
|
grouped together and ordered.
|
|
properties:
|
|
ID:
|
|
description: Telnexus Record Identifier
|
|
type: string
|
|
FeatureCode:
|
|
description:
|
|
When the callflow is used as a featurecode this object tracks
|
|
the intended match of the pattern and name of the feature
|
|
properties:
|
|
name:
|
|
type: string
|
|
number:
|
|
type: string
|
|
type: object
|
|
Flags:
|
|
description: Flags set by external applications
|
|
items:
|
|
type: string
|
|
type: array
|
|
Flow:
|
|
$ref: "#/definitions/CallFlowAction"
|
|
description:
|
|
A callflow node defines a module to execute, data to provide
|
|
to that module, and zero or more children to branch to
|
|
# Metaflow:
|
|
# $ref: "#/definitions/metaflows"
|
|
# description:
|
|
# Actions applied to a call outside of the normal callflow,
|
|
# initiated by the caller(s)
|
|
Numbers:
|
|
default: []
|
|
description:
|
|
A list of static numbers that the callflow should execute for
|
|
items:
|
|
maxLength: 36
|
|
minLength: 1
|
|
type: string
|
|
type: array
|
|
uniqueItems: true
|
|
Patterns:
|
|
default: []
|
|
description:
|
|
A list of regular expressions that the callflow should execute
|
|
for, with optional capture groups
|
|
items:
|
|
minLength: 1
|
|
type: string
|
|
type: array
|
|
type: object
|
|
CallFlowAction:
|
|
description:
|
|
Call flows describe steps to take in order to process a phone
|
|
call. They are trees of information related to a phone call such
|
|
as "answer, play file, record file" etc. that are logically
|
|
grouped together and ordered.
|
|
properties:
|
|
ID:
|
|
description: Telnexus Record Identifier
|
|
type: string
|
|
Children:
|
|
description: Children callflows
|
|
type: object
|
|
Data:
|
|
default: {}
|
|
description: The data/arguments of the callflow module
|
|
type: object
|
|
Module:
|
|
description:
|
|
The name of the callflow module to execute at this node
|
|
maxLength: 64
|
|
minLength: 1
|
|
type: string
|
|
type: object
|