lib/swagger/kazoo-telnexus.yaml

1344 lines
37 KiB
YAML
Raw Normal View History

2021-07-31 03:05:02 +00:00
swagger: "2.0"
info:
version: 0.0.1
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-Auth-Token
security:
- ApiKeyAuth: []
schemes:
- https
basePath: /v2
host: api.zswitch.net:8443
consumes:
- application/json
produces:
- application/json
responses:
GetDeviceResponse:
description: Kazoo response
schema:
$ref: "#/definitions/GetDeviceResponse"
GetNumberResponse:
description: Kazoo response
schema:
$ref: "#/definitions/GetNumberResponse"
GetAccountGroupResponse:
description: Kazoo response
schema:
$ref: "#/definitions/GetAccountGroupResponse"
GetAccountMediaResponse:
description: Kazoo response
schema:
$ref: "#/definitions/GetAccountMediaResponse"
GetAccountCallflowResponse:
description: Kazoo response
schema:
$ref: "#/definitions/GetAccountCallflowResponse"
GetAccountVmBoxResponse:
description: Kazoo response
schema:
$ref: "#/definitions/GetAccountVmBoxResponse"
GetAccountUserResponse:
description: Kazoo response
schema:
$ref: "#/definitions/GetAccountUserResponse"
GetAccountTimeRuleResponse:
description: Kazoo response
schema:
$ref: "#/definitions/GetAccountTimeRuleResponse"
GetKazooNumberResponse:
description: Kazoo response
schema:
$ref: "#/definitions/GetKazooNumberResponse"
GetAccountResponse:
description: Kazoo response
schema:
$ref: "#/definitions/GetAccountResponse"
GetAccountCdrResponse:
description: Kazoo response
schema:
$ref: "#/definitions/GetAccountCdrResponse"
GetAccountMenusResponse:
description: Kazoo response
schema:
$ref: "#/definitions/GetAccountMenusResponse"
GetAccountDescendentResponse:
description: Kazoo response
schema:
$ref: "#/definitions/GetAccountDescendentResponse"
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:
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
startDateQuery:
type: number
format: int64
in: query
name: created_from
required: true
endDateQuery:
type: number
format: int64
in: query
name: created_to
required: true
accountIdPath:
type: string
in: path
name: accountId
required: true
userIdPath:
type: string
in: path
name: userId
required: true
prefixQuery:
name: prefix
type: number
format: int32
in: query
required: false
quantityQuery:
name: quantity
type: number
format: int32
in: query
required: false
paths:
/accounts/{accountId}:
get:
operationId: getAccounts
tags:
- Account
parameters:
- $ref: "#/parameters/accountIdPath"
responses:
"200":
$ref: "#/responses/GetAccountResponse"
"401":
$ref: "#/responses/Unauthorized"
"404":
$ref: "#/responses/NotFound"
/accounts/{accountId}/descendents:
get:
operationId: getAccountDescendents
tags:
- Account
parameters:
- $ref: "#/parameters/accountIdPath"
responses:
"200":
$ref: "#/responses/GetAccountDescendentResponse"
"401":
$ref: "#/responses/Unauthorized"
"404":
$ref: "#/responses/NotFound"
/accounts/{accountId}/users/{userId}/devices:
get:
operationId: getUserDevices
tags:
- Device
parameters:
- $ref: "#/parameters/accountIdPath"
- $ref: "#/parameters/userIdPath"
responses:
"200":
$ref: "#/responses/GetDeviceResponse"
"401":
$ref: "#/responses/Unauthorized"
"404":
$ref: "#/responses/NotFound"
/accounts/{accountId}/users:
get:
operationId: getAccountUsers
tags:
- User
parameters:
- $ref: "#/parameters/accountIdPath"
responses:
"200":
$ref: "#/responses/GetAccountUserResponse"
"401":
$ref: "#/responses/Unauthorized"
"404":
$ref: "#/responses/NotFound"
/accounts/{accountId}/vmboxes:
get:
operationId: getAccountVmBoxes
tags:
- User
parameters:
- $ref: "#/parameters/accountIdPath"
responses:
"200":
$ref: "#/responses/GetAccountVmBoxResponse"
"401":
$ref: "#/responses/Unauthorized"
"404":
$ref: "#/responses/NotFound"
/accounts/{accountId}/devices:
get:
operationId: getAccountDevices
tags:
- Device
parameters:
- $ref: "#/parameters/accountIdPath"
responses:
"200":
$ref: "#/responses/GetDeviceResponse"
"401":
$ref: "#/responses/Unauthorized"
"404":
$ref: "#/responses/NotFound"
/accounts/{accountId}/media:
get:
operationId: getAccountMedia
tags:
- Media
parameters:
- $ref: "#/parameters/accountIdPath"
responses:
"200":
$ref: "#/responses/GetAccountMediaResponse"
"401":
$ref: "#/responses/Unauthorized"
"404":
$ref: "#/responses/NotFound"
/accounts/{accountId}/temporal_rules:
get:
operationId: getAccountTimeRules
tags:
- TimeRule
parameters:
- $ref: "#/parameters/accountIdPath"
responses:
"200":
$ref: "#/responses/GetAccountTimeRuleResponse"
"401":
$ref: "#/responses/Unauthorized"
"404":
$ref: "#/responses/NotFound"
/accounts/{accountId}/menus:
get:
operationId: getAccountMenus
tags:
- Menu
parameters:
- $ref: "#/parameters/accountIdPath"
responses:
"200":
$ref: "#/responses/GetAccountMenusResponse"
"401":
$ref: "#/responses/Unauthorized"
"404":
$ref: "#/responses/NotFound"
/accounts/{accountId}/phone_numebers:
get:
operationId: getAccountNumbers
tags:
- PhoneNumber
parameters:
- $ref: "#/parameters/accountIdPath"
responses:
"200":
$ref: "#/responses/GetNumberResponse"
"401":
$ref: "#/responses/Unauthorized"
"404":
$ref: "#/responses/NotFound"
/phone_numebers:
get:
operationId: getKazooNumbers
tags:
- PhoneNumber
parameters:
- $ref: "#/parameters/prefixQuery"
- $ref: "#/parameters/quantityQuery"
responses:
"200":
$ref: "#/responses/GetKazooNumberResponse"
"401":
$ref: "#/responses/Unauthorized"
"404":
$ref: "#/responses/NotFound"
/accounts/{accountId}/groups:
get:
operationId: getAccountGroups
tags:
- Group
parameters:
- $ref: "#/parameters/accountIdPath"
responses:
"200":
$ref: "#/responses/GetAccountGroupResponse"
"401":
$ref: "#/responses/Unauthorized"
"404":
$ref: "#/responses/NotFound"
/accounts/{accountId}/callflows:
get:
operationId: getAccountCallflows
tags:
- CallFlow
parameters:
- $ref: "#/parameters/accountIdPath"
responses:
"200":
$ref: "#/responses/GetAccountCallflowResponse"
"401":
$ref: "#/responses/Unauthorized"
"404":
$ref: "#/responses/NotFound"
/accounts/{accountId}/cdrs:
get:
operationId: getAccountCDRs
tags:
- cdr
parameters:
- $ref: "#/parameters/accountIdPath"
- $ref: "#/parameters/startDateQuery"
- $ref: "#/parameters/endDateQuery"
responses:
"200":
$ref: "#/responses/GetAccountCdrResponse"
"401":
$ref: "#/responses/Unauthorized"
"404":
$ref: "#/responses/NotFound"
definitions:
Error:
properties:
code:
format: int32
type: integer
fields:
type: string
message:
type: string
type: object
GetAccountCdrResponse:
properties:
auth_token:
type: string
data:
items:
properties:
authorizing_id:
example: f9627ff1bcca2d112931ee00dcfdb0c6
type: string
billing_seconds:
example: 0
type: number
bridge_id:
example: 1967142278_134071066@67.231.5.176
type: string
call_id:
example: 2b35a5ec-43a1-11ea-99b1-ed64c60fd1ac
type: string
call_priority:
example: ""
type: string
call_type:
example: ""
type: string
callee_id_name:
example: Telnexus
type: string
callee_id_number:
example: "+15108597000"
type: string
caller_id_name:
example: Unavailable
type: string
caller_id_number:
example: "+17045943795"
type: string
calling_from:
example: "+17045943795"
type: string
cost:
example: "0"
type: string
datetime:
example: "2020-01-30 20:43:28"
type: string
dialed_number:
example: user_jaemid
type: string
direction:
example: outbound
type: string
duration_seconds:
example: 15
type: number
from:
example: +17045943795@e0f5f0.s.zswitch.net
type: string
hangup_cause:
example: ORIGINATOR_CANCEL
type: string
id:
example: 202001-2b35a5ec-43a1-11ea-99b1-ed64c60fd1ac
type: string
interaction_id:
example: 63747636207-cc274afb
type: string
iso_8601:
example: "2020-01-30"
type: string
iso_8601_combined:
example: "2020-01-30T20:43:28Z"
type: string
media_server:
example: fs004.ord.p.zswitch.net
type: string
other_leg_call_id:
example: 1967142278_134071066@67.231.5.176
type: string
owner_id:
example: c0a881b0dfbc7fc574cb67dcaf10879f
type: string
rate:
example: "0.0"
type: string
rate_name:
example: ""
type: string
recording_url:
example: ""
type: string
request:
example: user_jaemid@e0f5f0.s.zswitch.net
type: string
rfc_1036:
example: "Thu, 30 Jan 2020 20:43:28 GMT"
type: string
timestamp:
example: "63747636208"
type: string
to:
example: user_jaemid@e0f5f0.s.zswitch.net
type: string
unix_timestamp:
example: "1580417008"
type: string
type: object
type: array
node:
example: dqZFtHthbelyE8MI6vU-LA
type: string
page_size:
example: "534"
type: string
request_id:
example: e7897c563fb45f3b377046d9b54c3cb5
type: string
start_key:
example: g2wAAAACbgUAAOqn1w5oAWpq
type: string
status:
example: success
type: string
timestamp:
example: "2020-05-07T01:06:49Z"
type: string
version:
example: 4.3.103
type: string
GetAccountCallflowResponse:
properties:
auth_token:
example: >-
eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImM2M2I1NjY5YmE0NTQzZWVmMTE5OTc3ZTUyNDYxYzRlIn0.eyJpc3MiOiJrYXpvbyIsImlkZW50aXR5X3NpZyI6InJUMW5DNnNOOHNKQWp4blBSSk1LVE5Ed1ZEQWZwek9sSFBnb0FYTHgtQU0iLCJhY2NvdW50X2lkIjoiYTY2ZjJiN2E0MDk0NGI3NDRkY2M2M2NhNmYxMGY0N2EiLCJvd25lcl9pZCI6IjUwOTE2MWZmMmE1NzZiZDZhYmU1YjhjNzVmNmIxNWYwIiwibWV0aG9kIjoiY2JfdXNlcl9hdXRoIiwiZXhwIjoxNTg4ODE0OTcwfQ.cW38X_JKe_bToQ19LzPY1U4aqjf96cFSwkszhqMhdpoR2Kq5JuPxkuCWoG6q49lwpIHb_9mZyoYBG83eLnYkamcORoejyUDb0ob79VKMBAUHAlXPkMNz7H2apLEHp0O8bdxr8ymh0Il9I4nAZSVnPkufQpx8L41Oy_ovU0vHS0jb2dSeXsySO0qcrCsoR9psTtqvB1GZBCEO8S_9EJKpYaT3o-Kio8uHZh7HgCD3NCUbfW8emfE6omTFIzIY7FTwXM_4kaMbWTUv09nN7iIpxJw2r_2drT-V5K8GFXZLAvm_1CqtLOMTYb26i3Iae3-zh9GPANSU3O0fq79kKupHfw
type: string
data:
items:
properties:
featurecode:
properties:
name:
example: park_and_retrieve
type: string
number:
example: "3"
type: string
type: object
id:
example: ff059d91a6fe0d16ced1ef6ca1f2bc52
type: string
modules:
example:
- park
items:
type: string
type: array
name:
example: 2004 - Vern iPad
type: string
numbers:
example:
- "2004"
items:
type: string
type: array
patterns:
example:
- '^\*3([0-9]*)$'
items:
type: string
type: array
type: object
type: array
node:
example: dqZFtHthbelyE8MI6vU-LA
type: string
page_size:
example: 34
type: number
request_id:
example: 3aa5241a8f3150258750425ce3c5c767
type: string
revision:
example: c10c73dd4f798fb595267e1d1c4eb9ff
type: string
status:
example: success
type: string
timestamp:
example: "2020-05-07T00:53:40Z"
type: string
version:
example: 4.3.103
type: string
GetAccountDescendentResponse:
properties:
auth_token:
example: >-
eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImM2M2I1NjY5YmE0NTQzZWVmMTE5OTc3ZTUyNDYxYzRlIn0.eyJpc3MiOiJrYXpvbyIsImlkZW50aXR5X3NpZyI6InJUMW5DNnNOOHNKQWp4blBSSk1LVE5Ed1ZEQWZwek9sSFBnb0FYTHgtQU0iLCJhY2NvdW50X2lkIjoiYTY2ZjJiN2E0MDk0NGI3NDRkY2M2M2NhNmYxMGY0N2EiLCJvd25lcl9pZCI6IjUwOTE2MWZmMmE1NzZiZDZhYmU1YjhjNzVmNmIxNWYwIiwibWV0aG9kIjoiY2JfdXNlcl9hdXRoIiwiZXhwIjoxNTg4ODA3NjcyfQ.rsxUwAef3JnHzTc4eckxIx_RToGbNsKr3WVUoVDEPQ7slKLxhpfDTrNqXQ_kou-1646Z539YQCQGRsB5One4BfEDAfhAmH63d6jKwEU49yQUiZCBn8tbuzN4iiZmYn6z8wmqUQHO2KA3fo6IKrjggs3t1EK8iG05se4ltS21ZVQ-C0HVvvENoERu9iKEcM2SeKhl9Ucl3cqQpWRKBN9BEvTKpuXqM_Bkf2FiczQ3TJQ2SS0YJTYjoIKnOLHfM4H59ZcPwnTh0S3zplJ8e6dQv6t020x0gVYdA_U9EseIGhNQTtMEAztwleZJwdpBh6kiDxJb9-l4ENX4kFtvxsH4QQ
type: string
data:
items:
properties:
id:
example: 7cebd991bd99ffd909dbb08a7d8e2db4
type: string
name:
example: Affinity
type: string
realm:
example: b5df22.s.zswitch.net
type: string
tree:
example:
- fb7cc960d5037466992af0e9504d0b27
- d4804caa6d7a78c83ff2bc7fdf646398
- 33776f3f94eb642c81e199cf5f1059ae
- a66f2b7a40944b744dcc63ca6f10f47a
items:
type: string
type: array
type: object
type: array
node:
example: dqZFtHthbelyE8MI6vU-LA
type: string
page_size:
example: 48
type: number
request_id:
example: 0035dec0e0e4c486e3bcd4502cf6a95d
type: string
revision:
example: b3a4cb72580c7c2f93572a6ef2748b74
type: string
start_key:
example: g20AAAAA
type: string
status:
example: success
type: string
timestamp:
example: "2020-05-06T23:01:48Z"
type: string
version:
example: 4.3.103
type: string
type: object
GetAccountResponse:
properties:
auth_token:
example: >-
eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImM2M2I1NjY5YmE0NTQzZWVmMTE5OTc3ZTUyNDYxYzRlIn0.eyJpc3MiOiJrYXpvbyIsImlkZW50aXR5X3NpZyI6InJUMW5DNnNOOHNKQWp4blBSSk1LVE5Ed1ZEQWZwek9sSFBnb0FYTHgtQU0iLCJhY2NvdW50X2lkIjoiYTY2ZjJiN2E0MDk0NGI3NDRkY2M2M2NhNmYxMGY0N2EiLCJvd25lcl9pZCI6IjUwOTE2MWZmMmE1NzZiZDZhYmU1YjhjNzVmNmIxNWYwIiwibWV0aG9kIjoiY2JfdXNlcl9hdXRoIiwiZXhwIjoxNTg4ODA3NjcyfQ.rsxUwAef3JnHzTc4eckxIx_RToGbNsKr3WVUoVDEPQ7slKLxhpfDTrNqXQ_kou-1646Z539YQCQGRsB5One4BfEDAfhAmH63d6jKwEU49yQUiZCBn8tbuzN4iiZmYn6z8wmqUQHO2KA3fo6IKrjggs3t1EK8iG05se4ltS21ZVQ-C0HVvvENoERu9iKEcM2SeKhl9Ucl3cqQpWRKBN9BEvTKpuXqM_Bkf2FiczQ3TJQ2SS0YJTYjoIKnOLHfM4H59ZcPwnTh0S3zplJ8e6dQv6t020x0gVYdA_U9EseIGhNQTtMEAztwleZJwdpBh6kiDxJb9-l4ENX4kFtvxsH4QQ
type: string
data:
properties:
available_apps:
example:
- voip
- cluster
- userportal
- accounts
- developer
- pbxs
- numbers
items:
type: string
type: array
billing_id:
example: a66f2b7a40944b744dcc63ca6f10f47a
type: string
billing_mode:
example: manual
type: string
call_restriction:
properties:
caribbean:
properties:
action:
example: inherit
type: string
type: object
did_us:
properties:
action:
example: inherit
type: string
type: object
directory:
properties:
action:
example: inherit
type: string
type: object
emergency:
properties:
action:
example: inherit
type: string
type: object
international:
properties:
action:
example: inherit
type: string
type: object
toll_us:
properties:
action:
example: inherit
type: string
type: object
tollfree_us:
properties:
action:
example: inherit
type: string
type: object
unknown:
properties:
action:
example: inherit
type: string
type: object
type: object
caller_id:
properties:
emergency:
properties:
name:
example: Telnexus
type: string
number:
example: "+15109911114"
type: string
type: object
external:
properties:
name:
example: Telnexus
type: string
number:
example: "+15109911114"
type: string
type: object
type: object
contact:
properties:
billing:
properties:
email:
example: noc@telnexus.com
type: string
name:
example: ""
type: string
number:
example: "5108597000"
type: string
type: object
technical:
properties:
email:
example: noc@telnexus.com
type: string
number:
example: "5108497000"
type: string
type: object
type: object
created:
example: 63552627756
format: int64
type: number
descendants_count:
example: 48
type: number
enabled:
example: true
type: boolean
format_from_uri:
example: false
type: boolean
id:
example: a66f2b7a40944b744dcc63ca6f10f47a
type: string
is_reseller:
example: false
type: boolean
language:
example: en-us
type: string
media:
properties:
bypass_media:
example: auto
type: string
type: object
name:
example: Telnexus Direct
type: string
notification_preference:
example: teletype
type: string
notifications:
properties:
fax_to_email:
properties:
service_name:
example: support@telnexus.com
type: string
service_provider:
example: support@telnexus.com
type: string
service_url:
example: telnexus.com
type: string
support_email:
example: support@telnexus.com
type: string
support_number:
example: 510-991-1114
type: string
type: object
low_balance:
properties:
sent_low_balance:
example: false
type: boolean
type: object
voicemail_to_email:
properties:
service_name:
example: support@telnexus.com
type: string
service_provider:
example: support@telnexus.com
type: string
service_url:
example: telnexus.com
type: string
support_email:
example: support@telnexus.com
type: string
support_number:
example: 510-991-1114
type: string
type: object
type: object
provision:
properties:
admin_password:
type: string
type: object
realm:
example: f5b70e.s.zswitch.net
type: string
reseller_id:
example: 33776f3f94eb642c81e199cf5f1059ae
type: string
superduper_admin:
example: false
type: boolean
timezone:
example: America/Los_Angeles
type: string
ui_metadata:
properties:
origin:
example: accounts
type: string
ui:
example: monster-ui
type: string
version:
example: 4.1-56
type: string
type: object
ui_restrictions:
properties:
myaccount:
properties:
account:
properties:
show_tab:
example: true
type: boolean
type: object
balance:
properties:
show_credit:
example: true
type: boolean
show_header:
example: true
type: boolean
show_minutes:
example: true
type: boolean
show_tab:
example: true
type: boolean
type: object
billing:
properties:
show_tab:
example: true
type: boolean
type: object
errorTracker:
properties:
show_tab:
example: true
type: boolean
type: object
inbound:
properties:
show_tab:
example: true
type: boolean
type: object
outbound:
properties:
show_tab:
example: true
type: boolean
type: object
service_plan:
properties:
show_tab:
example: true
type: boolean
type: object
transactions:
properties:
show_tab:
example: true
type: boolean
type: object
twoway:
properties:
show_tab:
example: true
type: boolean
type: object
user:
properties:
show_tab:
example: true
type: boolean
type: object
type: object
type: object
wnm_allow_additions:
example: false
type: boolean
type: object
node:
example: dqZFtHthbelyE8MI6vU-LA
type: string
request_id:
example: 1bea6f4e37f65627452f9798d8398385
type: string
revision:
example: 270-8664316349384947d416dc00285fb532
type: string
status:
example: success
type: string
timestamp:
example: "2020-05-06T22:42:58Z"
type: string
version:
example: 4.3.103
type: string
type: object
GetDeviceResponse:
properties:
page_size:
type: number
example: 4
data:
type: array
items:
type: object
properties:
id:
type: string
example: "f9627ff1bcca2d112931ee00dcfdb0c6"
name:
type: string
example: "2007 - Vern iPhone Personal"
username:
type: string
example: "user_jaemid"
mac_address:
type: string
example: string
owner_id:
type: string
example: "c0a881b0dfbc7fc574cb67dcaf10879f"
enabled:
type: "boolean"
example: true
device_type:
type: string
example: "softphone"
revision:
type: string
example: "794a8debed3fca4330ba2373cd703773"
timestamp:
type: string
example: "2020-05-07T01:20:21Z"
version:
type: string
example: "4.3.103"
node:
type: string
example: "dqZFtHthbelyE8MI6vU-LA"
request_id:
type: string
example: "29c9cccc07016866243a9dbd9481c88a"
status:
type: string
example: "success"
auth_token:
type: string
GetAccountGroupResponse:
properties:
page_size:
type: number
example: 3
data:
type: array
items:
type: object
properties:
id:
type: string
example: "e9e0627a0d41c4be4e8fa65a6d4777aa"
name:
type: string
example: "Berkeley Office"
endpoints:
type: number
example: 5
revision:
type: string
example: "ac7c6fde786a11c16c4dd265eccb9aa5"
timestamp:
type: string
example: "2020-05-07T01:36:50Z"
version:
type: string
example: "4.3.103"
node:
type: string
example: "dqZFtHthbelyE8MI6vU-LA"
request_id:
type: string
example: "22d1269690b8a553106e929bd8923a55"
status:
type: string
example: "success"
auth_token:
type: string
GetAccountMediaResponse:
properties:
page_size:
type: number
example: 49
data:
type: array
items:
type: object
properties:
id:
type: string
example: "fea26d66047257e74c132092b149e533"
name:
type: string
example: "test"
media_source:
type: string
example: "tts"
language:
type: string
example: "en-us"
is_prompt:
type: "boolean"
example: false
revision:
type: string
example: "b74319c4b8fb8cdba510362fa98facf0"
timestamp:
type: string
example: "2020-05-07T01:41:49Z"
version:
type: string
example: "4.3.103"
node:
type: string
example: "dqZFtHthbelyE8MI6vU-LA"
request_id:
type: string
example: "6e6dc6f474d1aa1689ac27a3c0605b38"
status:
type: string
example: "success"
auth_token:
type: string
GetAccountMenusResponse:
properties:
page_size:
type: number
example: 18
data:
type: array
items:
type: object
properties:
id:
type: string
example: "fe46dd5b556ce876ce693b2d49b6402d"
name:
type: string
example: "RecordingStudio"
revision:
type: string
example: "d512f1f2cff2684eec3825938f23275b"
timestamp:
type: string
example: "2020-05-07T01:53:07Z"
version:
type: string
example: "4.3.103"
node:
type: string
example: "dqZFtHthbelyE8MI6vU-LA"
request_id:
type: string
example: "36c57100bce810968df34f77465e974a"
status:
type: string
example: "success"
auth_token:
type: string
GetNumberResponse:
properties:
page_size:
type: number
example: 117
data:
properties:
numbers:
properties:
numberitem:
properties:
state:
type: string
example: "in_service"
features:
type: array
items:
type: string
example:
- "local"
assigned_to:
type: string
example: "a66f2b7a40944b744dcc63ca6f10f47a"
created:
type: number
example: 63714718327
updated:
type: number
example: 63755492918
features_available:
type: array
items:
type: string
example:
- "cnam"
- "e911"
- "force_outbound"
- "port"
- "prepend"
- "ringback"
type: object
type: object
cascade_quantity:
type: number
example: 61
type: object
revision:
type: string
example: "7c9f4f30f97ba288bad4f0f620e9e0bc"
timestamp:
type: string
example: "2020-05-07T01:56:53Z"
version:
type: string
example: "4.3.103"
node:
type: string
example: "dqZFtHthbelyE8MI6vU-LA"
request_id:
type: string
example: "a73973839c028f42519105681482b64f"
status:
type: string
example: "success"
auth_token:
type: string
GetKazooNumberResponse:
properties:
data:
type: array
items:
type: object
properties:
number:
type: string
example: "+15183486324"
state:
type: string
example: "discovery"
timestamp:
type: string
example: "2020-05-07T02:30:03Z"
version:
type: string
example: "4.3.103"
node:
type: string
example: "dqZFtHthbelyE8MI6vU-LA"
request_id:
type: string
example: "b310489bd3933c740590b2dcec953de8"
status:
type: string
example: "success"
auth_token:
type: string
GetAccountTimeRuleResponse:
properties:
page_size:
type: number
example: 1
data:
type: array
items:
type: object
properties:
id:
type: string
example: "1c3939fd0afcdadaa2986bc61c787d03"
name:
type: string
example: "Business Hours"
revision:
type: string
example: "b694bae5e001d52cf40637b618bc6bfb"
timestamp:
type: string
example: "2020-05-07T02:43:06Z"
version:
type: string
example: "4.3.103"
node:
type: string
example: "dqZFtHthbelyE8MI6vU-LA"
request_id:
type: string
example: "7372ec1ec4dc316cd0a8cf6786defde6"
status:
type: string
example: "success"
auth_token:
type: string
GetAccountUserResponse:
properties:
page_size:
type: number
example: 4
data:
type: array
items:
type: object
properties:
id:
type: string
example: "8c571470fef7db363994c8427c07b7bb"
features:
type: array
items:
type: string
example:
- "vm_to_email"
username:
type: string
example: "phil"
email:
type: string
example: "reception@telnexus.com"
first_name:
type: string
example: "Phil"
last_name:
type: string
example: "Cranepool"
priv_level:
type: string
example: "user"
timezone:
type: string
example: "America/Los_Angeles"
revision:
type: string
example: "c989520cf895f314b32d163d3b59d723"
timestamp:
type: string
example: "2020-05-07T02:44:28Z"
version:
type: string
example: "4.3.103"
node:
type: string
example: "dqZFtHthbelyE8MI6vU-LA"
request_id:
type: string
example: "c11b939a99b181b3a09b7770c4e49302"
status:
type: string
example: "success"
auth_token:
type: string
GetAccountVmBoxResponse:
properties:
page_size:
type: number
example: 5
data:
type: array
items:
type: object
properties:
id:
type: string
example: "cbd3606fea91c9b834c5a1fc0efa1098"
name:
type: string
example: "2005 - Bill VM"
mailbox:
type: string
example: "2005"
owner_id:
type: string
example: "f95626ebc2db4fd1a2b5ac5f6b11f7a3"
messages:
type: number
example: 12
revision:
type: string
example: "171c5eb1c826f66fe16cfb0669f55994"
timestamp:
type: string
example: "2020-05-07T02:52:10Z"
version:
type: string
example: "4.3.103"
node:
type: string
example: "dqZFtHthbelyE8MI6vU-LA"
request_id:
type: string
example: "0452de0d2fbef2cbccafaf7b3894bc0b"
status:
type: string
example: "success"
auth_token:
type: string