openapi: 3.0.4 info: title: XAPI description: This OData service is located at /xapi/v1 version: 1.0.0 x-ms-generated-by: toolName: Microsoft.OpenApi.OData toolVersion: 1.0.9.0 servers: - url: /xapi/v1 paths: /ActiveCalls: description: Provides operations to manage the collection of ActiveCall entities. get: tags: - ActiveCalls summary: Get entities from ActiveCalls operationId: ListActiveCall parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.ActiveCallCollectionResponse' default: $ref: '#/components/responses/error' '/ActiveCalls({Id})/Pbx.DropCall': description: Provides operations to call the DropCall method. post: tags: - ActiveCalls summary: Invoke action DropCall operationId: DropCall parameters: - name: Id in: path description: The unique identifier of ActiveCall required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: ActiveCall responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.IActionResult' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /ActivityLog/Pbx.GetFilter(): description: Provides operations to call the GetFilter method. get: tags: - ActivityLog summary: Invoke function GetFilter operationId: GetFilter responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.ActivityLogsFilter' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ActivityLog/Pbx.GetLogs(startDate={startDate},endDate={endDate},extension={extension},call={call},severity={severity})': description: Provides operations to call the GetLogs method. get: tags: - ActivityLog summary: Invoke function GetLogs operationId: GetLogs parameters: - name: startDate in: path description: 'Usage: startDate={startDate}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: endDate in: path description: 'Usage: endDate={endDate}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: extension in: path description: 'Usage: extension={extension}' required: true schema: type: string nullable: true - name: call in: path description: 'Usage: call={call}' required: true schema: type: string nullable: true - name: severity in: path description: 'Usage: severity={severity}' required: true schema: type: string nullable: true - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of ActivityLogEvent type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.ActivityLogEvent' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /ActivityLog/Pbx.PurgeLogs: description: Provides operations to call the PurgeLogs method. post: tags: - ActivityLog summary: Invoke action PurgeLogs operationId: PurgeLogs responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /AISettings: description: Provides operations to manage the AISettings singleton. get: tags: - AISettings summary: Get AISettings operationId: GetAISettings parameters: - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.AISettings' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - AISettings summary: Update AISettings operationId: UpdateAISettings requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.AISettings' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /AISettings/Pbx.GetAIResources(): description: Provides operations to call the GetAIResources method. get: tags: - AISettings summary: Invoke function GetAIResources operationId: GetAIResources responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.AIResources' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/AISettings/Pbx.GetAITemplateContents(id={id})': description: Provides operations to call the GetAITemplateContents method. get: tags: - AISettings summary: Invoke function GetAITemplateContents operationId: GetAITemplateContents parameters: - name: id in: path description: 'Usage: id={id}' required: true schema: type: string nullable: true responses: '200': description: Success content: application/json: schema: type: object properties: value: type: string default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/AISettings/Pbx.GetVectorStores(limit={limit},after={after})': description: Provides operations to call the GetVectorStores method. get: tags: - AISettings summary: Invoke function GetVectorStores operationId: GetVectorStores parameters: - name: limit in: path description: 'Usage: limit={limit}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 - name: after in: path description: 'Usage: after={after}' required: true schema: type: string responses: '200': description: Success content: application/json: schema: allOf: - $ref: '#/components/schemas/Pbx.VectorStores' nullable: true default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/AISettings/Pbx.GetVectorStoreFiles(id={id},limit={limit},after={after})': description: Provides operations to call the GetVectorStoreFiles method. get: tags: - AISettings summary: Invoke function GetVectorStoreFiles operationId: GetVectorStoreFiles parameters: - name: id in: path description: 'Usage: id={id}' required: true schema: type: string nullable: true - name: limit in: path description: 'Usage: limit={limit}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 - name: after in: path description: 'Usage: after={after}' required: true schema: type: string responses: '200': description: Success content: application/json: schema: allOf: - $ref: '#/components/schemas/Pbx.VectorStoreFiles' nullable: true default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/AISettings/Pbx.GetVectorStore(id={id})': description: Provides operations to call the GetVectorStore method. get: tags: - AISettings summary: Invoke function GetVectorStore operationId: GetVectorStore parameters: - name: id in: path description: 'Usage: id={id}' required: true schema: type: string nullable: true responses: '200': description: Success content: application/json: schema: allOf: - $ref: '#/components/schemas/Pbx.VectorStore' nullable: true default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /AISettings/Pbx.CreateVectorStore: description: Provides operations to call the CreateVectorStore method. post: tags: - AISettings summary: Invoke action CreateVectorStore operationId: CreateVectorStore requestBody: description: Action parameters content: application/json: schema: title: AISettingsCreateVectorStoreRequestBody type: object properties: model: $ref: '#/components/schemas/Pbx.VectorStore' required: true responses: '200': description: Success content: application/json: schema: allOf: - $ref: '#/components/schemas/Pbx.VectorStore' nullable: true default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /AISettings/Pbx.UpdateVectorStore: description: Provides operations to call the UpdateVectorStore method. post: tags: - AISettings summary: Invoke action UpdateVectorStore operationId: UpdateVectorStore requestBody: description: Action parameters content: application/json: schema: title: AISettingsUpdateVectorStoreRequestBody type: object properties: model: $ref: '#/components/schemas/Pbx.VectorStore' required: true responses: '200': description: Success content: application/json: schema: allOf: - $ref: '#/components/schemas/Pbx.VectorStore' nullable: true default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /AISettings/Pbx.DeleteVectorStore: description: Provides operations to call the DeleteVectorStore method. post: tags: - AISettings summary: Invoke action DeleteVectorStore operationId: DeleteVectorStore requestBody: description: Action parameters content: application/json: schema: title: AISettingsDeleteVectorStoreRequestBody type: object properties: id: type: string nullable: true required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /AISettings/Pbx.DeleteVectorStoreFile: description: Provides operations to call the DeleteVectorStoreFile method. post: tags: - AISettings summary: Invoke action DeleteVectorStoreFile operationId: DeleteVectorStoreFile requestBody: description: Action parameters content: application/json: schema: title: AISettingsDeleteVectorStoreFileRequestBody type: object properties: fileid: type: string nullable: true vectorid: type: string nullable: true required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /AISettings/Pbx.DeleteOpenAiFile: description: Provides operations to call the DeleteOpenAiFile method. post: tags: - AISettings summary: Invoke action DeleteOpenAiFile operationId: DeleteOpenAiFile requestBody: description: Action parameters content: application/json: schema: title: AISettingsDeleteOpenAiFileRequestBody type: object properties: fileid: type: string nullable: true required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /AISettings/Pbx.AddVectorStoreFiles: description: Provides operations to call the AddVectorStoreFiles method. post: tags: - AISettings summary: Invoke action AddVectorStoreFiles operationId: AddVectorStoreFiles requestBody: description: Action parameters content: application/json: schema: title: AISettingsAddVectorStoreFilesRequestBody type: object properties: model: $ref: '#/components/schemas/Pbx.AddVectorStoreFiles' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /AmazonIntegrationSettings: description: Provides operations to manage the AmazonIntegrationSettings singleton. get: tags: - AmazonIntegrationSettings summary: Get AmazonIntegrationSettings operationId: GetAmazonIntegrationSettings parameters: - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.AmazonIntegrationSettings' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - AmazonIntegrationSettings summary: Update AmazonIntegrationSettings operationId: UpdateAmazonIntegrationSettings requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.AmazonIntegrationSettings' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /AmazonIntegrationSettings/Pbx.GenerateIamPolicyFile(): description: Provides operations to call the GenerateIamPolicyFile method. get: tags: - AmazonIntegrationSettings summary: Invoke function GenerateIamPolicyFile operationId: GenerateIamPolicyFile responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.IActionResult' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /AntiHackingSettings: description: Provides operations to manage the AntiHackingSettings singleton. get: tags: - AntiHackingSettings summary: Get AntiHackingSettings operationId: GetAntiHackingSettings parameters: - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.AntiHackingSettings' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - AntiHackingSettings summary: Update AntiHackingSettings operationId: UpdateAntiHackingSettings requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.AntiHackingSettings' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /Backups: description: Provides operations to manage the collection of Backups entities. get: tags: - Backups summary: Get entities from Backups operationId: ListBackups parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.BackupsCollectionResponse' default: $ref: '#/components/responses/error' '/Backups({FileName})/Pbx.GetBackupExtras()': description: Provides operations to call the GetBackupExtras method. get: tags: - Backups summary: Invoke function GetBackupExtras operationId: GetBackupExtras parameters: - name: FileName in: path description: The unique identifier of Backups required: true schema: type: string x-ms-docs-key-type: Backups responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.BackupExtras' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/Backups({FileName})': description: Provides operations to manage the collection of Backups entities. delete: tags: - Backups summary: Delete entity from Backups operationId: DeleteBackups parameters: - name: FileName in: path description: The unique identifier of Backups required: true schema: type: string x-ms-docs-key-type: Backups - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/Backups({FileName})/Pbx.Restore': description: Provides operations to call the Restore method. post: tags: - Backups summary: Invoke action Restore operationId: Restore parameters: - name: FileName in: path description: The unique identifier of Backups required: true schema: type: string x-ms-docs-key-type: Backups requestBody: description: Action parameters content: application/json: schema: title: BackupsBackupsRestoreRequestBody type: object properties: footprint: type: integer format: int64 password: type: string required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Backups/Pbx.Backup: description: Provides operations to call the Backup method. post: tags: - Backups summary: Invoke action Backup operationId: Backup requestBody: description: Action parameters content: application/json: schema: title: BackupsBackupRequestBody type: object properties: description: $ref: '#/components/schemas/Pbx.CreateBackup' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Backups/Pbx.GetCanCreateBackup(): description: Provides operations to call the GetCanCreateBackup method. get: tags: - Backups summary: Invoke function GetCanCreateBackup operationId: GetCanCreateBackup responses: '200': description: Success content: application/json: schema: type: object properties: value: type: boolean default: false default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /Backups/Pbx.GetBackupSettings(): description: Provides operations to call the GetBackupSettings method. get: tags: - Backups summary: Invoke function GetBackupSettings operationId: GetBackupSettings responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.BackupSettings' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /Backups/Pbx.GetBackupFailoverSettings(): description: Provides operations to call the GetBackupFailoverSettings method. get: tags: - Backups summary: Invoke function GetBackupFailoverSettings operationId: GetBackupFailoverSettings responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.BackupFailoverSettings' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /Backups/Pbx.SetBackupFailoverSettings: description: Provides operations to call the SetBackupFailoverSettings method. post: tags: - Backups summary: Invoke action SetBackupFailoverSettings operationId: SetBackupFailoverSettings requestBody: description: Action parameters content: application/json: schema: title: BackupsSetBackupFailoverSettingsRequestBody type: object properties: settings: $ref: '#/components/schemas/Pbx.BackupFailoverSettings' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Backups/Pbx.GetFailoverScripts(): description: Provides operations to call the GetFailoverScripts method. get: tags: - Backups summary: Invoke function GetFailoverScripts operationId: GetFailoverScripts parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' responses: '200': description: Success content: application/json: schema: type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.FailoverScriptFile' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /Backups/Pbx.SetBackupSettings: description: Provides operations to call the SetBackupSettings method. post: tags: - Backups summary: Invoke action SetBackupSettings operationId: SetBackupSettings requestBody: description: Action parameters content: application/json: schema: title: BackupsSetBackupSettingsRequestBody type: object properties: settings: $ref: '#/components/schemas/Pbx.BackupSettings' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Backups/Pbx.GetBackupRepositorySettings(): description: Provides operations to call the GetBackupRepositorySettings method. get: tags: - Backups summary: Invoke function GetBackupRepositorySettings operationId: GetBackupRepositorySettings responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.BackupRepositorySettings' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /Backups/Pbx.SetBackupRepositorySettings: description: Provides operations to call the SetBackupRepositorySettings method. post: tags: - Backups summary: Invoke action SetBackupRepositorySettings operationId: SetBackupRepositorySettings requestBody: description: Action parameters content: application/json: schema: title: BackupsSetBackupRepositorySettingsRequestBody type: object properties: settings: $ref: '#/components/schemas/Pbx.BackupRepositorySettings' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Backups/Pbx.GetRestoreSettings(): description: Provides operations to call the GetRestoreSettings method. get: tags: - Backups summary: Invoke function GetRestoreSettings operationId: GetRestoreSettings responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.RestoreSettings' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /Backups/Pbx.SetRestoreSettings: description: Provides operations to call the SetRestoreSettings method. post: tags: - Backups summary: Invoke action SetRestoreSettings operationId: SetRestoreSettings requestBody: description: Action parameters content: application/json: schema: title: BackupsSetRestoreSettingsRequestBody type: object properties: settings: $ref: '#/components/schemas/Pbx.RestoreSettings' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Backups/Pbx.GetLocalBackupSize(): description: Provides operations to call the GetLocalBackupSize method. get: tags: - Backups summary: Invoke function GetLocalBackupSize operationId: GetLocalBackupSize responses: '200': description: Success content: application/json: schema: type: object properties: value: type: integer format: int64 default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /Backups/Pbx.PurgeLocalBackups: description: Provides operations to call the PurgeLocalBackups method. post: tags: - Backups summary: Invoke action PurgeLocalBackups operationId: PurgeLocalBackups responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /BlackListNumbers: description: Provides operations to manage the collection of BlackListNumber entities. get: tags: - BlackListNumbers summary: Get entities from BlackListNumbers operationId: ListBlackListNumber parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.BlackListNumberCollectionResponse' default: $ref: '#/components/responses/error' post: tags: - BlackListNumbers summary: Add new entity to BlackListNumbers operationId: CreateBlackListNumber requestBody: description: New entity content: application/json: schema: $ref: '#/components/schemas/Pbx.BlackListNumber' required: true responses: '201': description: Created entity content: application/json: schema: $ref: '#/components/schemas/Pbx.BlackListNumber' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/BlackListNumbers({Id})': description: Provides operations to manage the collection of BlackListNumber entities. get: tags: - BlackListNumbers summary: Get entity from BlackListNumbers by key operationId: GetBlackListNumber parameters: - name: Id in: path description: The unique identifier of BlackListNumber required: true schema: type: string x-ms-docs-key-type: BlackListNumber - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.BlackListNumber' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - BlackListNumbers summary: Update entity in BlackListNumbers operationId: UpdateBlackListNumber parameters: - name: Id in: path description: The unique identifier of BlackListNumber required: true schema: type: string x-ms-docs-key-type: BlackListNumber requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.BlackListNumber' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - BlackListNumbers summary: Delete entity from BlackListNumbers operationId: DeleteBlackListNumber parameters: - name: Id in: path description: The unique identifier of BlackListNumber required: true schema: type: string x-ms-docs-key-type: BlackListNumber - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /BlackListNumbers/Pbx.BulkNumbersDelete: description: Provides operations to call the BulkNumbersDelete method. post: tags: - BlackListNumbers summary: Invoke action BulkNumbersDelete operationId: BulkNumbersDelete requestBody: description: Action parameters content: application/json: schema: title: BlackListNumbersBulkNumbersDeleteRequestBody type: object properties: ids: type: array items: type: string required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Blocklist: description: Provides operations to manage the collection of BlocklistAddr entities. get: tags: - Blocklist summary: Get entities from Blocklist operationId: ListBlocklistAddr parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.BlocklistAddrCollectionResponse' default: $ref: '#/components/responses/error' post: tags: - Blocklist summary: Add new entity to Blocklist operationId: CreateBlocklistAddr requestBody: description: New entity content: application/json: schema: $ref: '#/components/schemas/Pbx.BlocklistAddr' required: true responses: '201': description: Created entity content: application/json: schema: $ref: '#/components/schemas/Pbx.BlocklistAddr' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/Blocklist({Id})': description: Provides operations to manage the collection of BlocklistAddr entities. get: tags: - Blocklist summary: Get entity from Blocklist by key operationId: GetBlocklistAddr parameters: - name: Id in: path description: The unique identifier of BlocklistAddr required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: BlocklistAddr - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.BlocklistAddr' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - Blocklist summary: Update entity in Blocklist operationId: UpdateBlocklistAddr parameters: - name: Id in: path description: The unique identifier of BlocklistAddr required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: BlocklistAddr requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.BlocklistAddr' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - Blocklist summary: Delete entity from Blocklist operationId: DeleteBlocklistAddr parameters: - name: Id in: path description: The unique identifier of BlocklistAddr required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: BlocklistAddr - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /Blocklist/Pbx.BulkIpsDelete: description: Provides operations to call the BulkIpsDelete method. post: tags: - Blocklist summary: Invoke action BulkIpsDelete operationId: BulkIpsDelete requestBody: description: Action parameters content: application/json: schema: title: BlocklistBulkIpsDeleteRequestBody type: object properties: ids: type: array items: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /CallCostSettings: description: Provides operations to manage the collection of CallCostSettings entities. get: tags: - CallCostSettings summary: Get entities from CallCostSettings operationId: ListCallCostSettings parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.CallCostSettingsCollectionResponse' default: $ref: '#/components/responses/error' /CallCostSettings/Pbx.UpdateCost: description: Provides operations to call the UpdateCost method. post: tags: - CallCostSettings summary: Invoke action UpdateCost operationId: UpdateCost requestBody: description: Action parameters content: application/json: schema: title: CallCostSettingsUpdateCostRequestBody type: object properties: costs: type: array items: $ref: '#/components/schemas/Pbx.CallCostSettings' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /CallCostSettings/Pbx.ExportCallCosts(): description: Provides operations to call the ExportCallCosts method. get: tags: - CallCostSettings summary: Invoke function ExportCallCosts operationId: ExportCallCosts responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.IActionResult' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/CallFlowApps({Id})': description: Provides operations to manage the collection of CallFlowApp entities. get: tags: - CallFlowApps summary: Get entity from CallFlowApps by key operationId: GetCallFlowApp parameters: - name: Id in: path description: The unique identifier of CallFlowApp required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: CallFlowApp - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.CallFlowApp' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - CallFlowApps summary: Update entity in CallFlowApps operationId: UpdateCallFlowApp parameters: - name: Id in: path description: The unique identifier of CallFlowApp required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: CallFlowApp requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.CallFlowApp' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - CallFlowApps summary: Delete entity from CallFlowApps operationId: DeleteCallFlowApp parameters: - name: Id in: path description: The unique identifier of CallFlowApp required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: CallFlowApp - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /CallFlowApps: description: Provides operations to manage the collection of CallFlowApp entities. get: tags: - CallFlowApps summary: Get entities from CallFlowApps operationId: ListCallFlowApp parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.CallFlowAppCollectionResponse' default: $ref: '#/components/responses/error' post: tags: - CallFlowApps summary: Add new entity to CallFlowApps operationId: CreateCallFlowApp requestBody: description: New entity content: application/json: schema: $ref: '#/components/schemas/Pbx.CallFlowApp' required: true responses: '201': description: Created entity content: application/json: schema: $ref: '#/components/schemas/Pbx.CallFlowApp' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/CallFlowApps({Id})/Pbx.GetFiles()': description: Provides operations to call the GetFiles method. get: tags: - CallFlowApps summary: Invoke function GetFiles operationId: GetFiles parameters: - name: Id in: path description: The unique identifier of CallFlowApp required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: CallFlowApp - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' responses: '200': description: Success content: application/json: schema: type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: type: string default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/CallFlowApps({Id})/Pbx.DeleteFile': description: Provides operations to call the DeleteFile method. post: tags: - CallFlowApps summary: Invoke action DeleteFile operationId: DeleteFile parameters: - name: Id in: path description: The unique identifier of CallFlowApp required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: CallFlowApp requestBody: description: Action parameters content: application/json: schema: title: CallFlowAppsCallFlowAppDeleteFileRequestBody type: object properties: filename: type: string required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /CallFlowScripts: description: Provides operations to manage the collection of CallFlowScript entities. get: tags: - CallFlowScripts summary: Get entities from CallFlowScripts operationId: ListCallFlowScript parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.CallFlowScriptCollectionResponse' default: $ref: '#/components/responses/error' /CallHistoryView/Pbx.DownloadCallHistory(): description: Provides operations to call the DownloadCallHistory method. get: tags: - CallHistoryView summary: Invoke function DownloadCallHistory operationId: DownloadCallHistory parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of CallHistoryView type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.CallHistoryView' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /CallHistoryView: description: Provides operations to manage the collection of CallHistoryView entities. get: tags: - CallHistoryView summary: Get entities from CallHistoryView operationId: ListCallHistoryView parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.CallHistoryViewCollectionResponse' default: $ref: '#/components/responses/error' /CallParkingSettings: description: Provides operations to manage the CallParkingSettings singleton. get: tags: - CallParkingSettings summary: Get CallParkingSettings operationId: GetCallParkingSettings parameters: - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.CallParkingSettings' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - CallParkingSettings summary: Update CallParkingSettings operationId: UpdateCallParkingSettings requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.CallParkingSettings' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /CallTypesSettings: description: Provides operations to manage the CallTypesSettings singleton. get: tags: - CallTypesSettings summary: Get CallTypesSettings operationId: GetCallTypesSettings parameters: - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.CallTypesSettings' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - CallTypesSettings summary: Update CallTypesSettings operationId: UpdateCallTypesSettings requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.CallTypesSettings' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /CDRSettings: description: Provides operations to manage the CDRSettings singleton. get: tags: - CDRSettings summary: Get CDRSettings operationId: GetCDRSettings parameters: - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.CDRSettings' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - CDRSettings summary: Update CDRSettings operationId: UpdateCDRSettings requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.CDRSettings' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /ChatHistoryView: description: Provides operations to manage the collection of ChatHistoryView entities. get: tags: - ChatHistoryView summary: Get entities from ChatHistoryView operationId: ListChatHistoryView parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.ChatHistoryViewCollectionResponse' default: $ref: '#/components/responses/error' '/ChatHistoryView/Pbx.DownloadChatHistory(clientTimeZone={clientTimeZone})': description: Provides operations to call the DownloadChatHistory method. get: tags: - ChatHistoryView summary: Invoke function DownloadChatHistory operationId: DownloadChatHistory parameters: - name: clientTimeZone in: path description: 'Usage: clientTimeZone={clientTimeZone}' required: true schema: type: string nullable: true - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of ChatHistoryView type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.ChatHistoryView' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /ChatLogSettings: description: Provides operations to manage the ChatLogSettings singleton. get: tags: - ChatLogSettings summary: Get ChatLogSettings operationId: GetChatLogSettings parameters: - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.ChatLogSettings' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - ChatLogSettings summary: Update ChatLogSettings operationId: UpdateChatLogSettings requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.ChatLogSettings' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /ChatMessagesHistoryView: description: Provides operations to manage the collection of ChatMessagesHistoryView entities. get: tags: - ChatMessagesHistoryView summary: Get entities from ChatMessagesHistoryView operationId: ListChatMessagesHistoryView parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.ChatMessagesHistoryViewCollectionResponse' default: $ref: '#/components/responses/error' '/ChatMessagesHistoryView/Pbx.DownloadChatMessagesHistory(clientTimeZone={clientTimeZone})': description: Provides operations to call the DownloadChatMessagesHistory method. get: tags: - ChatMessagesHistoryView summary: Invoke function DownloadChatMessagesHistory operationId: DownloadChatMessagesHistory parameters: - name: clientTimeZone in: path description: 'Usage: clientTimeZone={clientTimeZone}' required: true schema: type: string nullable: true - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of ChatMessagesHistoryView type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.ChatMessagesHistoryView' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /CodecsSettings: description: Provides operations to manage the CodecsSettings singleton. get: tags: - CodecsSettings summary: Get CodecsSettings operationId: GetCodecsSettings parameters: - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.CodecsSettings' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - CodecsSettings summary: Update CodecsSettings operationId: UpdateCodecsSettings requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.CodecsSettings' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /ConferenceSettings/Pbx.GetWebMeetingZones(): description: Provides operations to call the GetWebMeetingZones method. get: tags: - ConferenceSettings summary: Invoke function GetWebMeetingZones operationId: GetWebMeetingZones parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' responses: '200': description: Success content: application/json: schema: type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: type: string default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /ConferenceSettings/Pbx.GenerateApiKey(): description: Provides operations to call the GenerateApiKey method. get: tags: - ConferenceSettings summary: Invoke function GenerateApiKey operationId: GenerateApiKey responses: '200': description: Success content: application/json: schema: type: object properties: value: type: string default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /ConferenceSettings/Pbx.DeleteApiKey: description: Provides operations to call the DeleteApiKey method. post: tags: - ConferenceSettings summary: Invoke action DeleteApiKey operationId: DeleteApiKey responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /ConferenceSettings: description: Provides operations to manage the ConferenceSettings singleton. get: tags: - ConferenceSettings summary: Get ConferenceSettings operationId: GetConferenceSettings parameters: - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.ConferenceSettings' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - ConferenceSettings summary: Update ConferenceSettings operationId: UpdateConferenceSettings requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.ConferenceSettings' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /ConferenceSettings/Pbx.GetMCURequestStatus(): description: Provides operations to call the GetMCURequestStatus method. get: tags: - ConferenceSettings summary: Invoke function GetMCURequestStatus operationId: GetMCURequestStatus responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.MCURequestStatus' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /ConferenceSettings/Pbx.GetOnboardMcuData(): description: Provides operations to call the GetOnboardMcuData method. get: tags: - ConferenceSettings summary: Invoke function GetOnboardMcuData operationId: GetOnboardMcuData parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' responses: '200': description: Success content: application/json: schema: type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.OnBoardMcuData' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /ConferenceSettings/Pbx.GetOnboardMeetings(): description: Provides operations to call the GetOnboardMeetings method. get: tags: - ConferenceSettings summary: Invoke function GetOnboardMeetings operationId: GetOnboardMeetings parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' responses: '200': description: Success content: application/json: schema: type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.OnBoardMeeting' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /ConferenceSettings/Pbx.GetMCURows(): description: Provides operations to call the GetMCURows method. get: tags: - ConferenceSettings summary: Invoke function GetMCURows operationId: GetMCURows parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' responses: '200': description: Success content: application/json: schema: type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.OnBoardMcuRow' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ConferenceSettings/Pbx.GetMCURow(guid={guid})': description: Provides operations to call the GetMCURow method. get: tags: - ConferenceSettings summary: Invoke function GetMCURow operationId: GetMCURow parameters: - name: guid in: path description: 'Usage: guid={guid}' required: true schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.OnBoardMcuRow' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /ConferenceSettings/Pbx.UpdateMCURequestStatus: description: Provides operations to call the UpdateMCURequestStatus method. post: tags: - ConferenceSettings summary: Invoke action UpdateMCURequestStatus operationId: UpdateMCURequestStatus requestBody: description: Action parameters content: application/json: schema: title: ConferenceSettingsUpdateMCURequestStatusRequestBody type: object properties: request: $ref: '#/components/schemas/Pbx.MCURequestStatus' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /ConsoleRestrictions: description: Provides operations to manage the ConsoleRestrictions singleton. get: tags: - ConsoleRestrictions summary: Get ConsoleRestrictions operationId: GetConsoleRestrictions parameters: - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.ConsoleRestrictions' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - ConsoleRestrictions summary: Update ConsoleRestrictions operationId: UpdateConsoleRestrictions requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.ConsoleRestrictions' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/Contacts/Pbx.GetContactsByNumber(number={number})': description: Provides operations to call the GetContactsByNumber method. get: tags: - Contacts summary: Invoke function GetContactsByNumber operationId: GetContactsByNumber parameters: - name: number in: path description: 'Usage: number={number}' required: true schema: type: string - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of Contact type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.Contact' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /Contacts/Pbx.CreateContactByNumber: description: Provides operations to call the CreateContactByNumber method. post: tags: - Contacts summary: Invoke action CreateContactByNumber operationId: CreateContactByNumber requestBody: description: Action parameters content: application/json: schema: title: ContactsCreateContactByNumberRequestBody type: object properties: contact: $ref: '#/components/schemas/Pbx.Contact' number: type: string required: true responses: '200': description: Success content: application/json: schema: allOf: - $ref: '#/components/schemas/Pbx.Contact' nullable: true default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Contacts: description: Provides operations to manage the collection of Contact entities. get: tags: - Contacts summary: Get entities from Contacts operationId: ListContact parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.ContactCollectionResponse' default: $ref: '#/components/responses/error' post: tags: - Contacts summary: Add new entity to Contacts operationId: CreateContact requestBody: description: New entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Contact' required: true responses: '201': description: Created entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Contact' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /Contacts/Pbx.SetDirSearchSettings: description: Provides operations to call the SetDirSearchSettings method. post: tags: - Contacts summary: Invoke action SetDirSearchSettings operationId: SetDirSearchSettings requestBody: description: Action parameters content: application/json: schema: title: ContactsSetDirSearchSettingsRequestBody type: object properties: dirSearchSettings: $ref: '#/components/schemas/Pbx.ContactsDirSearchSettings' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Contacts/Pbx.GetDirSearchSettings(): description: Provides operations to call the GetDirSearchSettings method. get: tags: - Contacts summary: Invoke function GetDirSearchSettings operationId: GetDirSearchSettings responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.ContactsDirSearchSettings' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /Contacts/Pbx.DeleteContactsById: description: Provides operations to call the DeleteContactsById method. post: tags: - Contacts summary: Invoke action DeleteContactsById operationId: DeleteContactsById requestBody: description: Action parameters content: application/json: schema: title: ContactsDeleteContactsByIdRequestBody type: object properties: ids: type: array items: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Contacts/Pbx.DeleteDepartmentContactsByType: description: Provides operations to call the DeleteDepartmentContactsByType method. post: tags: - Contacts summary: Invoke action DeleteDepartmentContactsByType operationId: DeleteDepartmentContactsByType requestBody: description: Action parameters content: application/json: schema: title: ContactsDeleteDepartmentContactsByTypeRequestBody type: object properties: contactSource: $ref: '#/components/schemas/Pbx.ContactSource' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Contacts/Pbx.DeletePersonalContactsByType: description: Provides operations to call the DeletePersonalContactsByType method. post: tags: - Contacts summary: Invoke action DeletePersonalContactsByType operationId: DeletePersonalContactsByType requestBody: description: Action parameters content: application/json: schema: title: ContactsDeletePersonalContactsByTypeRequestBody type: object properties: contactSource: $ref: '#/components/schemas/Pbx.ContactSource' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Contacts/Pbx.DeleteContactsByType: description: Provides operations to call the DeleteContactsByType method. post: tags: - Contacts summary: Invoke action DeleteContactsByType operationId: DeleteContactsByType requestBody: description: Action parameters content: application/json: schema: title: ContactsDeleteContactsByTypeRequestBody type: object properties: contactSource: $ref: '#/components/schemas/Pbx.ContactSource' number: type: string nullable: true required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action '/Contacts({Id})': description: Provides operations to manage the collection of Contact entities. get: tags: - Contacts summary: Get entity from Contacts by key operationId: GetContact parameters: - name: Id in: path description: The unique identifier of Contact required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: Contact - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Contact' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - Contacts summary: Update entity in Contacts operationId: UpdateContact parameters: - name: Id in: path description: The unique identifier of Contact required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: Contact requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.Contact' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - Contacts summary: Delete entity from Contacts operationId: DeleteContact parameters: - name: Id in: path description: The unique identifier of Contact required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: Contact - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /Countries: description: Provides operations to manage the collection of Country entities. get: tags: - Countries summary: Get entities from Countries operationId: ListCountry parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.CountryCollectionResponse' default: $ref: '#/components/responses/error' /CountryCodes: description: Provides operations to manage the CountryCodes singleton. get: tags: - CountryCodes summary: Get CountryCodes operationId: GetCountryCodes parameters: - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.CountryCodes' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - CountryCodes summary: Update CountryCodes operationId: UpdateCountryCodes requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.CountryCodes' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /CrmIntegration: description: Provides operations to manage the CrmIntegration singleton. get: tags: - CrmIntegration summary: Get CrmIntegration operationId: GetCrmIntegration parameters: - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.CrmIntegration' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - CrmIntegration summary: Update CrmIntegration operationId: UpdateCrmIntegration requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.CrmIntegration' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /CrmIntegration/Pbx.Test: description: Provides operations to call the Test method. post: tags: - CrmIntegration summary: Invoke action Test operationId: Test requestBody: description: Action parameters content: application/json: schema: title: CrmIntegrationTestRequestBody type: object properties: number: type: string required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.CrmTestResult' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /CrmIntegration/Pbx.DeleteCrmContacts: description: Provides operations to call the DeleteCrmContacts method. post: tags: - CrmIntegration summary: Invoke action DeleteCrmContacts operationId: DeleteCrmContacts responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /CrmIntegration/Pbx.SetOAuthState: description: Provides operations to call the SetOAuthState method. post: tags: - CrmIntegration summary: Invoke action SetOAuthState operationId: SetOAuthState requestBody: description: Action parameters content: application/json: schema: title: CrmIntegrationSetOAuthStateRequestBody type: object properties: state: $ref: '#/components/schemas/Pbx.OauthStateParam' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.OauthState' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action '/CrmIntegration/Pbx.GetOAuth(variable={variable})': description: Provides operations to call the GetOAuth method. get: tags: - CrmIntegration summary: Invoke function GetOAuth operationId: GetOAuth parameters: - name: variable in: path description: 'Usage: variable={variable}' required: true schema: type: string responses: '200': description: Success content: application/json: schema: allOf: - $ref: '#/components/schemas/Pbx.CrmChoice' nullable: true default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/CrmIntegration/Pbx.GetCrmTemplateSource(name={name})': description: Provides operations to call the GetCrmTemplateSource method. get: tags: - CrmIntegration summary: Invoke function GetCrmTemplateSource operationId: GetCrmTemplateSource parameters: - name: name in: path description: 'Usage: name={name}' required: true schema: type: string responses: '200': description: Success content: application/json: schema: allOf: - $ref: '#/components/schemas/Pbx.CrmTemplateSource' nullable: true default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /CrmTemplates/Pbx.GeCrmtTemplates(): description: Provides operations to call the GeCrmtTemplates method. get: tags: - CrmTemplates summary: Invoke function GeCrmtTemplates operationId: GeCrmtTemplates parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of CrmTemplate type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.CrmTemplate' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/CrmTemplates({Name})': description: Provides operations to manage the collection of CrmTemplate entities. get: tags: - CrmTemplates summary: Get entity from CrmTemplates by key operationId: GetCrmTemplate parameters: - name: Name in: path description: The unique identifier of CrmTemplate required: true schema: type: string x-ms-docs-key-type: CrmTemplate - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.CrmTemplate' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - CrmTemplates summary: Delete entity from CrmTemplates operationId: DeleteCrmTemplate parameters: - name: Name in: path description: The unique identifier of CrmTemplate required: true schema: type: string x-ms-docs-key-type: CrmTemplate - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /CustomPrompts: description: Provides operations to manage the collection of CustomPrompt entities. get: tags: - CustomPrompts summary: Get entities from CustomPrompts operationId: ListCustomPrompt parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.CustomPromptCollectionResponse' default: $ref: '#/components/responses/error' /CustomPrompts/Pbx.MakeCallRecordCustomPrompt: description: Provides operations to call the MakeCallRecordCustomPrompt method. post: tags: - CustomPrompts summary: Invoke action MakeCallRecordCustomPrompt operationId: MakeCallRecordCustomPrompt requestBody: description: Action parameters content: application/json: schema: title: CustomPromptsMakeCallRecordCustomPromptRequestBody type: object properties: dn: type: string filename: type: string required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action '/CustomPrompts({Filename})': description: Provides operations to manage the collection of CustomPrompt entities. delete: tags: - CustomPrompts summary: Delete entity from CustomPrompts operationId: DeleteCustomPrompt parameters: - name: Filename in: path description: The unique identifier of CustomPrompt required: true schema: type: string x-ms-docs-key-type: CustomPrompt - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /DataConnectorSettings: description: Provides operations to manage the DataConnectorSettings singleton. get: tags: - DataConnectorSettings summary: Get DataConnectorSettings operationId: GetDataConnectorSettings parameters: - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.DataConnectorSettings' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - DataConnectorSettings summary: Update DataConnectorSettings operationId: UpdateDataConnectorSettings requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.DataConnectorSettings' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /DataConnectorSettings/Pbx.Synchronize: description: Provides operations to call the Synchronize method. post: tags: - DataConnectorSettings summary: Invoke action Synchronize operationId: Synchronize responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /DataConnectorSettings/Pbx.TestDataConnector: description: Provides operations to call the TestDataConnector method. post: tags: - DataConnectorSettings summary: Invoke action TestDataConnector operationId: TestDataConnector responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Defs: description: Provides operations to manage the Defs singleton. get: tags: - Defs summary: Get Defs operationId: GetDefs parameters: - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Defs' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /Defs/Codecs: description: Provides operations to manage the Codecs property of the Pbx.Defs entity. get: tags: - Defs summary: Get Codecs from Defs operationId: ListCodecs parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.CodecCollectionResponse' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /Defs/GatewayParameters: description: Provides operations to manage the GatewayParameters property of the Pbx.Defs entity. get: tags: - Defs summary: Get GatewayParameters from Defs operationId: ListGatewayParameters parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.GatewayParameterCollectionResponse' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /Defs/GatewayParameterValues: description: Provides operations to manage the GatewayParameterValues property of the Pbx.Defs entity. get: tags: - Defs summary: Get GatewayParameterValues from Defs operationId: ListGatewayParameterValues parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.GatewayParameterValueCollectionResponse' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /Defs/TimeZones: description: Provides operations to manage the TimeZones property of the Pbx.Defs entity. get: tags: - Defs summary: Get TimeZones from Defs operationId: ListTimeZones parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.TimeZoneCollectionResponse' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /Defs/Pbx.GetSystemParameters(): description: Provides operations to call the GetSystemParameters method. get: tags: - Defs summary: Invoke function GetSystemParameters operationId: GetSystemParameters responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.SystemParameters' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /Defs/Pbx.GetLicenseParameters(): description: Provides operations to call the GetLicenseParameters method. get: tags: - Defs summary: Invoke function GetLicenseParameters operationId: GetLicenseParameters responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.License' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /Defs/Pbx.HasSystemOwner(): description: Provides operations to call the HasSystemOwner method. get: tags: - Defs summary: Invoke function HasSystemOwner operationId: HasSystemOwner responses: '200': description: Success content: application/json: schema: type: object properties: value: type: boolean default: false default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /Defs/Pbx.GetRoutes: description: Provides operations to call the GetRoutes method. post: tags: - Defs summary: Invoke action GetRoutes operationId: GetRoutes requestBody: description: Action parameters content: application/json: schema: title: DefsGetRoutesRequestBody type: object properties: ids: type: array items: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 required: true responses: '200': description: Success content: application/json: schema: type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.SetRouteRequest' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Defs/Pbx.SendEmail: description: Provides operations to call the SendEmail method. post: tags: - Defs summary: Invoke action SendEmail operationId: SendEmail requestBody: description: Action parameters content: application/json: schema: title: DefsSendEmailRequestBody type: object properties: sendEmail: $ref: '#/components/schemas/Pbx.SendEmail' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /DeviceInfos: description: Provides operations to manage the collection of DeviceInfo entities. get: tags: - DeviceInfos summary: Get entities from DeviceInfos operationId: ListDeviceInfo parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.DeviceInfoCollectionResponse' default: $ref: '#/components/responses/error' '/DeviceInfos({Id})': description: Provides operations to manage the collection of DeviceInfo entities. get: tags: - DeviceInfos summary: Get entity from DeviceInfos by key operationId: GetDeviceInfo parameters: - name: Id in: path description: The unique identifier of DeviceInfo required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: DeviceInfo - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.DeviceInfo' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - DeviceInfos summary: Delete entity from DeviceInfos operationId: DeleteDeviceInfo parameters: - name: Id in: path description: The unique identifier of DeviceInfo required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: DeviceInfo - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/DeviceInfos({Id})/Pbx.Provision': description: Provides operations to call the Provision method. post: tags: - DeviceInfos summary: Invoke action Provision operationId: Provision parameters: - name: Id in: path description: The unique identifier of DeviceInfo required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: DeviceInfo requestBody: description: Action parameters content: application/json: schema: title: DeviceInfosDeviceInfoProvisionRequestBody type: object properties: reprovision: type: boolean default: false userId: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /DialCodeSettings: description: Provides operations to manage the DialCodeSettings singleton. get: tags: - DialCodeSettings summary: Get DialCodeSettings operationId: GetDialCodeSettings parameters: - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.DialCodeSettings' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - DialCodeSettings summary: Update DialCodeSettings operationId: UpdateDialCodeSettings requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.DialCodeSettings' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /DidNumbers: description: Provides operations to manage the collection of DidNumber entities. get: tags: - DidNumbers summary: Get entities from DidNumbers operationId: ListDidNumber parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.DidNumberCollectionResponse' default: $ref: '#/components/responses/error' '/DNProperties/Pbx.GetPropertiesByDn(dnNumber={dnNumber})': description: Provides operations to call the GetPropertiesByDn method. get: tags: - DNProperties summary: Invoke function GetPropertiesByDn operationId: GetPropertiesByDn parameters: - name: dnNumber in: path description: 'Usage: dnNumber={dnNumber}' required: true schema: type: string - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of DNProperty type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.DNProperty' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /DNProperties/Pbx.CreateDNProperty: description: Provides operations to call the CreateDNProperty method. post: tags: - DNProperties summary: Invoke action CreateDNProperty operationId: CreateDNProperty requestBody: description: Action parameters content: application/json: schema: title: DNPropertiesCreateDNPropertyRequestBody type: object properties: dnNumber: type: string property: $ref: '#/components/schemas/Pbx.DNProperty' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /DNProperties/Pbx.UpdateDNProperty: description: Provides operations to call the UpdateDNProperty method. post: tags: - DNProperties summary: Invoke action UpdateDNProperty operationId: UpdateDNProperty requestBody: description: Action parameters content: application/json: schema: title: DNPropertiesUpdateDNPropertyRequestBody type: object properties: dnNumber: type: string property: $ref: '#/components/schemas/Pbx.DNProperty' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /DNProperties/Pbx.DeleteDNProperty: description: Provides operations to call the DeleteDNProperty method. post: tags: - DNProperties summary: Invoke action DeleteDNProperty operationId: DeleteDNProperty requestBody: description: Action parameters content: application/json: schema: title: DNPropertiesDeleteDNPropertyRequestBody type: object properties: dnNumber: type: string propertyName: type: string required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action '/DNProperties/Pbx.GetDNPropertyByName(dnNumber={dnNumber},name={name})': description: Provides operations to call the GetDNPropertyByName method. get: tags: - DNProperties summary: Invoke function GetDNPropertyByName operationId: GetDNPropertyByName parameters: - name: dnNumber in: path description: 'Usage: dnNumber={dnNumber}' required: true schema: type: string - name: name in: path description: 'Usage: name={name}' required: true schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.DNProperty' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /E164Settings: description: Provides operations to manage the E164Settings singleton. get: tags: - E164Settings summary: Get E164Settings operationId: GetE164Settings parameters: - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.E164Settings' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - E164Settings summary: Update E164Settings operationId: UpdateE164Settings requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.E164Settings' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /EmailTemplate: description: Provides operations to manage the collection of EmailTemplate entities. get: tags: - EmailTemplate summary: Get entities from EmailTemplate operationId: ListEmailTemplate parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.EmailTemplateCollectionResponse' default: $ref: '#/components/responses/error' '/EmailTemplate({TemplatePath})': description: Provides operations to manage the collection of EmailTemplate entities. get: tags: - EmailTemplate summary: Get entity from EmailTemplate by key operationId: GetEmailTemplate parameters: - name: TemplatePath in: path description: The unique identifier of EmailTemplate required: true schema: type: string x-ms-docs-key-type: EmailTemplate - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.EmailTemplate' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - EmailTemplate summary: Update entity in EmailTemplate operationId: UpdateEmailTemplate parameters: - name: TemplatePath in: path description: The unique identifier of EmailTemplate required: true schema: type: string x-ms-docs-key-type: EmailTemplate requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.EmailTemplate' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/EmailTemplate({TemplatePath})/Pbx.SetDefault': description: Provides operations to call the SetDefault method. post: tags: - EmailTemplate summary: Invoke action SetDefault operationId: SetDefault parameters: - name: TemplatePath in: path description: The unique identifier of EmailTemplate required: true schema: type: string x-ms-docs-key-type: EmailTemplate responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /EmergencyGeoLocations: description: Provides operations to manage the collection of EmergencyGeoLocation entities. get: tags: - EmergencyGeoLocations summary: Get entities from EmergencyGeoLocations operationId: ListEmergencyGeoLocation parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.EmergencyGeoLocationCollectionResponse' default: $ref: '#/components/responses/error' /EmergencyGeoLocations/Pbx.Update: description: Provides operations to call the Update method. post: tags: - EmergencyGeoLocations summary: Invoke action Update operationId: Update requestBody: description: Action parameters content: application/json: schema: title: EmergencyGeoLocationsUpdateRequestBody type: object properties: locations: type: array items: $ref: '#/components/schemas/Pbx.EmergencyGeoLocation' required: true responses: '200': description: Success content: application/json: schema: allOf: - $ref: '#/components/schemas/Pbx.IActionResult' nullable: true default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /EmergencyNotificationsSettings: description: Provides operations to manage the EmergencyNotificationsSettings singleton. get: tags: - EmergencyNotificationsSettings summary: Get EmergencyNotificationsSettings operationId: GetEmergencyNotificationsSettings parameters: - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.EmergencyNotificationsSettings' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - EmergencyNotificationsSettings summary: Update EmergencyNotificationsSettings operationId: UpdateEmergencyNotificationsSettings requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.EmergencyNotificationsSettings' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /EventLogs: description: Provides operations to manage the collection of EventLog entities. get: tags: - EventLogs summary: Get entities from EventLogs operationId: ListEventLog parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.EventLogCollectionResponse' default: $ref: '#/components/responses/error' /EventLogs/Pbx.DownloadEventLogs(): description: Provides operations to call the DownloadEventLogs method. get: tags: - EventLogs summary: Invoke function DownloadEventLogs operationId: DownloadEventLogs parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of EventLog type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.EventLog' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /EventLogs/Pbx.PurgeEventLog: description: Provides operations to call the PurgeEventLog method. post: tags: - EventLogs summary: Invoke action PurgeEventLog operationId: PurgeEventLog responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action '/Fax(Number={Number})': description: Provides operations to manage the collection of Fax entities. get: tags: - Fax summary: Get entity from Fax by key (Number) operationId: GetFaxByNumber parameters: - name: Number in: path description: Alternate key of Fax required: true schema: type: string nullable: true - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Fax' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /Fax/Pbx.InitFax(): description: Provides operations to call the InitFax method. get: tags: - Fax summary: Invoke function InitFax operationId: InitFax responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.Fax' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /Fax: description: Provides operations to manage the collection of Fax entities. get: tags: - Fax summary: Get entities from Fax operationId: ListFax parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.FaxCollectionResponse' default: $ref: '#/components/responses/error' post: tags: - Fax summary: Add new entity to Fax operationId: CreateFax requestBody: description: New entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Fax' required: true responses: '201': description: Created entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Fax' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/Fax({Id})': description: Provides operations to manage the collection of Fax entities. get: tags: - Fax summary: Get entity from Fax by key operationId: GetFax parameters: - name: Id in: path description: The unique identifier of Fax required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: Fax - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Fax' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - Fax summary: Update entity in Fax operationId: UpdateFax parameters: - name: Id in: path description: The unique identifier of Fax required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: Fax requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.Fax' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - Fax summary: Delete entity from Fax operationId: DeleteFax parameters: - name: Id in: path description: The unique identifier of Fax required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: Fax - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /Fax/Pbx.BulkFaxDelete: description: Provides operations to call the BulkFaxDelete method. post: tags: - Fax summary: Invoke action BulkFaxDelete operationId: BulkFaxDelete requestBody: description: Action parameters content: application/json: schema: title: FaxBulkFaxDeleteRequestBody type: object properties: ids: type: array items: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /FaxServerSettings: description: Provides operations to manage the FaxServerSettings singleton. get: tags: - FaxServerSettings summary: Get FaxServerSettings operationId: GetFaxServerSettings parameters: - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.FaxServerSettings' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - FaxServerSettings summary: Update FaxServerSettings operationId: UpdateFaxServerSettings requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.FaxServerSettings' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /FaxServerSettings/Pbx.GetFaxFilesSize(): description: Provides operations to call the GetFaxFilesSize method. get: tags: - FaxServerSettings summary: Invoke function GetFaxFilesSize operationId: GetFaxFilesSize responses: '200': description: Success content: application/json: schema: type: object properties: value: type: integer format: int64 default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /FaxServerSettings/Pbx.CleanUpFax: description: Provides operations to call the CleanUpFax method. post: tags: - FaxServerSettings summary: Invoke action CleanUpFax operationId: CleanUpFax responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Firewall: description: Provides operations to manage the FirewallState singleton. get: tags: - Firewall summary: Get Firewall operationId: GetFirewallState parameters: - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.FirewallState' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /Firewall/Pbx.GetLastResult(): description: Provides operations to call the GetLastResult method. get: tags: - Firewall summary: Invoke function GetLastResult operationId: GetLastResult responses: '200': description: Success content: application/json: schema: type: object properties: value: type: boolean default: false default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /Firewall/Pbx.StartCheck: description: Provides operations to call the StartCheck method. post: tags: - Firewall summary: Invoke action StartCheck operationId: StartCheck responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Firewall/Pbx.StopCheck: description: Provides operations to call the StopCheck method. post: tags: - Firewall summary: Invoke action StopCheck operationId: StopCheck responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Firmwares: description: Provides operations to manage the collection of Firmware entities. get: tags: - Firmwares summary: Get entities from Firmwares operationId: ListFirmware parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.FirmwareCollectionResponse' default: $ref: '#/components/responses/error' '/Firmwares({Id})': description: Provides operations to manage the collection of Firmware entities. delete: tags: - Firmwares summary: Delete entity from Firmwares operationId: DeleteFirmware parameters: - name: Id in: path description: The unique identifier of Firmware required: true schema: type: string x-ms-docs-key-type: Firmware - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/Firmwares({Id})/Pbx.PushFirmwareForPhones': description: Provides operations to call the PushFirmwareForPhones method. post: tags: - Firmwares summary: Invoke action PushFirmwareForPhones operationId: PushFirmwareForPhones parameters: - name: Id in: path description: The unique identifier of Firmware required: true schema: type: string x-ms-docs-key-type: Firmware responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Firmwares/Pbx.GetFirmwareState(): description: Provides operations to call the GetFirmwareState method. get: tags: - Firmwares summary: Invoke function GetFirmwareState operationId: GetFirmwareState responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.FirmwareState' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /Firmwares/Pbx.CleanUp: description: Provides operations to call the CleanUp method. post: tags: - Firmwares summary: Invoke action CleanUp operationId: CleanUp responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.IActionResult' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Fxs: description: Provides operations to manage the collection of Fxs entities. get: tags: - Fxs summary: Get entities from Fxs operationId: ListFxs parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.FxsCollectionResponse' default: $ref: '#/components/responses/error' post: tags: - Fxs summary: Add new entity to Fxs operationId: CreateFxs requestBody: description: New entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Fxs' required: true responses: '201': description: Created entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Fxs' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/Fxs({MacAddress})': description: Provides operations to manage the collection of Fxs entities. get: tags: - Fxs summary: Get entity from Fxs by key operationId: GetFxs parameters: - name: MacAddress in: path description: The unique identifier of Fxs required: true schema: type: string x-ms-docs-key-type: Fxs - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Fxs' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - Fxs summary: Update entity in Fxs operationId: UpdateFxs parameters: - name: MacAddress in: path description: The unique identifier of Fxs required: true schema: type: string x-ms-docs-key-type: Fxs requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.Fxs' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - Fxs summary: Delete entity from Fxs operationId: DeleteFxs parameters: - name: MacAddress in: path description: The unique identifier of Fxs required: true schema: type: string x-ms-docs-key-type: Fxs - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/Fxs({MacAddress})/Pbx.RegenerateWebCredentials': description: Provides operations to call the RegenerateWebCredentials method. post: tags: - Fxs summary: Invoke action RegenerateWebCredentials operationId: RegenerateWebCredentials parameters: - name: MacAddress in: path description: The unique identifier of Fxs required: true schema: type: string x-ms-docs-key-type: Fxs responses: '200': description: Success content: application/json: schema: allOf: - $ref: '#/components/schemas/Pbx.Fxs' nullable: true default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /FxsTemplates: description: Provides operations to manage the collection of FxsTemplate entities. get: tags: - FxsTemplates summary: Get entities from FxsTemplates operationId: ListFxsTemplate parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.FxsTemplateCollectionResponse' default: $ref: '#/components/responses/error' post: tags: - FxsTemplates summary: Add new entity to FxsTemplates operationId: CreateFxsTemplate requestBody: description: New entity content: application/json: schema: $ref: '#/components/schemas/Pbx.FxsTemplate' required: true responses: '201': description: Created entity content: application/json: schema: $ref: '#/components/schemas/Pbx.FxsTemplate' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/FxsTemplates({Id})': description: Provides operations to manage the collection of FxsTemplate entities. get: tags: - FxsTemplates summary: Get entity from FxsTemplates by key operationId: GetFxsTemplate parameters: - name: Id in: path description: The unique identifier of FxsTemplate required: true schema: type: string x-ms-docs-key-type: FxsTemplate - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.FxsTemplate' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - FxsTemplates summary: Update entity in FxsTemplates operationId: UpdateFxsTemplate parameters: - name: Id in: path description: The unique identifier of FxsTemplate required: true schema: type: string x-ms-docs-key-type: FxsTemplate requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.FxsTemplate' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - FxsTemplates summary: Delete entity from FxsTemplates operationId: DeleteFxsTemplate parameters: - name: Id in: path description: The unique identifier of FxsTemplate required: true schema: type: string x-ms-docs-key-type: FxsTemplate - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /GeneralSettingsForApps: description: Provides operations to manage the GeneralSettingsForApps singleton. get: tags: - GeneralSettingsForApps summary: Get GeneralSettingsForApps operationId: GetGeneralSettingsForApps parameters: - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.GeneralSettingsForApps' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - GeneralSettingsForApps summary: Update GeneralSettingsForApps operationId: UpdateGeneralSettingsForApps requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.GeneralSettingsForApps' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /GeneralSettingsForPbx: description: Provides operations to manage the GeneralSettingsForPbx singleton. get: tags: - GeneralSettingsForPbx summary: Get GeneralSettingsForPbx operationId: GetGeneralSettingsForPbx parameters: - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.GeneralSettingsForPbx' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - GeneralSettingsForPbx summary: Update GeneralSettingsForPbx operationId: UpdateGeneralSettingsForPbx requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.GeneralSettingsForPbx' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /GoogleSettings: description: Provides operations to manage the GoogleSettings singleton. get: tags: - GoogleSettings summary: Get GoogleSettings operationId: GetGoogleSettings parameters: - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.GoogleSettings' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - GoogleSettings summary: Update GoogleSettings operationId: UpdateGoogleSettings requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.GoogleSettings' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /GoogleSettings/Pbx.GetGoogleUsers: description: Provides operations to call the GetGoogleUsers method. post: tags: - GoogleSettings summary: Invoke action GetGoogleUsers operationId: GetGoogleUsers requestBody: description: Action parameters content: application/json: schema: title: GoogleSettingsGetGoogleUsersRequestBody type: object properties: options: allOf: - $ref: '#/components/schemas/Pbx.UsersRequestOptions' nullable: true required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.ExternalAccountsPage' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action '/Groups({Id})': description: Provides operations to manage the collection of Group entities. get: tags: - Groups summary: Get entity from Groups by key operationId: GetGroup parameters: - name: Id in: path description: The unique identifier of Group required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: Group - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Group' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - Groups summary: Update entity in Groups operationId: UpdateGroup parameters: - name: Id in: path description: The unique identifier of Group required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: Group requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.Group' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - Groups summary: Delete entity from Groups operationId: DeleteGroup parameters: - name: Id in: path description: The unique identifier of Group required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: Group - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /Groups: description: Provides operations to manage the collection of Group entities. get: tags: - Groups summary: Get entities from Groups operationId: ListGroup parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.GroupCollectionResponse' default: $ref: '#/components/responses/error' post: tags: - Groups summary: Add new entity to Groups operationId: CreateGroup requestBody: description: New entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Group' required: true responses: '201': description: Created entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Group' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/Groups({Id})/Pbx.GetRestrictions()': description: Provides operations to call the GetRestrictions method. get: tags: - Groups summary: Invoke function GetRestrictions operationId: GetRestrictions parameters: - name: Id in: path description: The unique identifier of Group required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: Group responses: '200': $ref: '#/components/responses/GetRestrictionsResponse' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /Groups/Pbx.DeleteCompanyByNumber: description: Provides operations to call the DeleteCompanyByNumber method. post: tags: - Groups summary: Invoke action DeleteCompanyByNumber operationId: DeleteCompanyByNumber requestBody: description: Action parameters content: application/json: schema: title: GroupsDeleteCompanyByNumberRequestBody type: object properties: number: type: string required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Groups/Pbx.DeleteCompanyById: description: Provides operations to call the DeleteCompanyById method. post: tags: - Groups summary: Invoke action DeleteCompanyById operationId: DeleteCompanyById requestBody: description: Action parameters content: application/json: schema: title: GroupsDeleteCompanyByIdRequestBody type: object properties: id: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action '/Groups({Id})/Members': description: Provides operations to manage the Members property of the Pbx.Group entity. get: tags: - Groups summary: Get Members from Groups operationId: ListMembers parameters: - name: Id in: path description: The unique identifier of Group required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: Group - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.UserGroupCollectionResponse' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/Groups({Id})/Rights': description: Provides operations to manage the Rights property of the Pbx.Group entity. get: tags: - Groups summary: Get Rights from Groups operationId: ListRights parameters: - name: Id in: path description: The unique identifier of Group required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: Group - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.RightsCollectionResponse' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /Groups/Pbx.ReplaceGroupLicenseKey: description: Provides operations to call the ReplaceGroupLicenseKey method. post: tags: - Groups summary: Invoke action ReplaceGroupLicenseKey operationId: ReplaceGroupLicenseKey requestBody: description: Action parameters content: application/json: schema: title: GroupsReplaceGroupLicenseKeyRequestBody type: object properties: groupId: type: string licenseKey: type: string required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Groups/Pbx.LinkGroupPartner: description: Provides operations to call the LinkGroupPartner method. post: tags: - Groups summary: Invoke action LinkGroupPartner operationId: LinkGroupPartner requestBody: description: Action parameters content: application/json: schema: title: GroupsLinkGroupPartnerRequestBody type: object properties: groupId: type: string resellerId: type: string required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Groups/Pbx.UnlinkGroupPartner: description: Provides operations to call the UnlinkGroupPartner method. post: tags: - Groups summary: Invoke action UnlinkGroupPartner operationId: UnlinkGroupPartner responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Holidays: description: Provides operations to manage the collection of Holiday entities. get: tags: - Holidays summary: Get entities from Holidays operationId: ListHoliday parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.HolidayCollectionResponse' default: $ref: '#/components/responses/error' post: tags: - Holidays summary: Add new entity to Holidays operationId: CreateHoliday requestBody: description: New entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Holiday' required: true responses: '201': description: Created entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Holiday' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/Holidays({Id})': description: Provides operations to manage the collection of Holiday entities. get: tags: - Holidays summary: Get entity from Holidays by key operationId: GetHoliday parameters: - name: Id in: path description: The unique identifier of Holiday required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: Holiday - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Holiday' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - Holidays summary: Update entity in Holidays operationId: UpdateHoliday parameters: - name: Id in: path description: The unique identifier of Holiday required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: Holiday requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.Holiday' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - Holidays summary: Delete entity from Holidays operationId: DeleteHoliday parameters: - name: Id in: path description: The unique identifier of Holiday required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: Holiday - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /HotelServices: description: Provides operations to manage the HotelServices singleton. get: tags: - HotelServices summary: Get HotelServices operationId: GetHotelServices parameters: - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.HotelServices' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - HotelServices summary: Update HotelServices operationId: UpdateHotelServices requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.HotelServices' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /InboundRules: description: Provides operations to manage the collection of InboundRule entities. get: tags: - InboundRules summary: Get entities from InboundRules operationId: ListInboundRule parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.InboundRuleCollectionResponse' default: $ref: '#/components/responses/error' post: tags: - InboundRules summary: Add new entity to InboundRules operationId: CreateInboundRule requestBody: description: New entity content: application/json: schema: $ref: '#/components/schemas/Pbx.InboundRule' required: true responses: '201': description: Created entity content: application/json: schema: $ref: '#/components/schemas/Pbx.InboundRule' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/InboundRules({Id})': description: Provides operations to manage the collection of InboundRule entities. get: tags: - InboundRules summary: Get entity from InboundRules by key operationId: GetInboundRule parameters: - name: Id in: path description: The unique identifier of InboundRule required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: InboundRule - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.InboundRule' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - InboundRules summary: Update entity in InboundRules operationId: UpdateInboundRule parameters: - name: Id in: path description: The unique identifier of InboundRule required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: InboundRule requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.InboundRule' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - InboundRules summary: Delete entity from InboundRules operationId: DeleteInboundRule parameters: - name: Id in: path description: The unique identifier of InboundRule required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: InboundRule - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /InboundRules/Pbx.BulkInboundRulesDelete: description: Provides operations to call the BulkInboundRulesDelete method. post: tags: - InboundRules summary: Invoke action BulkInboundRulesDelete operationId: BulkInboundRulesDelete requestBody: description: Action parameters content: application/json: schema: title: InboundRulesBulkInboundRulesDeleteRequestBody type: object properties: ids: type: array items: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /InboundRules/Pbx.ExportCallerIdRules(): description: Provides operations to call the ExportCallerIdRules method. get: tags: - InboundRules summary: Invoke function ExportCallerIdRules operationId: ExportCallerIdRules parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of InboundRule type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.InboundRule' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /LastCdrAndChatMessageTimestamp: description: Provides operations to manage the collection of LastCdrAndChatMessageTimestamp entities. get: tags: - LastCdrAndChatMessageTimestamp summary: Get entities from LastCdrAndChatMessageTimestamp operationId: ListLastCdrAndChatMessageTimestamp parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.LastCdrAndChatMessageTimestampCollectionResponse' default: $ref: '#/components/responses/error' /LicenseStatus/Pbx.RefreshLicenseStatus: description: Provides operations to call the RefreshLicenseStatus method. post: tags: - LicenseStatus summary: Invoke action RefreshLicenseStatus operationId: RefreshLicenseStatus responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /LicenseStatus: description: Provides operations to manage the LicenseStatus singleton. get: tags: - LicenseStatus summary: Get LicenseStatus operationId: GetLicenseStatus parameters: - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.LicenseStatus' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /LicenseStatus/Pbx.UnlinkPartner: description: Provides operations to call the UnlinkPartner method. post: tags: - LicenseStatus summary: Invoke action UnlinkPartner operationId: UnlinkPartner responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /LicenseStatus/Pbx.LinkPartner: description: Provides operations to call the LinkPartner method. post: tags: - LicenseStatus summary: Invoke action LinkPartner operationId: LinkPartner requestBody: description: Action parameters content: application/json: schema: title: LicenseStatusLinkPartnerRequestBody type: object properties: resellerId: type: string required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action '/LicenseStatus/Pbx.PartnerInfo(resellerId={resellerId})': description: Provides operations to call the PartnerInfo method. get: tags: - LicenseStatus summary: Invoke function PartnerInfo operationId: PartnerInfo parameters: - name: resellerId in: path description: 'Usage: resellerId={resellerId}' required: true schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.ResellerInfo' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /LicenseStatus/Pbx.ReplaceLicenseKey: description: Provides operations to call the ReplaceLicenseKey method. post: tags: - LicenseStatus summary: Invoke action ReplaceLicenseKey operationId: ReplaceLicenseKey requestBody: description: Action parameters content: application/json: schema: title: LicenseStatusReplaceLicenseKeyRequestBody type: object properties: licenseKey: type: string required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /LicenseStatus/Pbx.EditLicenseInfo: description: Provides operations to call the EditLicenseInfo method. post: tags: - LicenseStatus summary: Invoke action EditLicenseInfo operationId: EditLicenseInfo requestBody: description: Action parameters content: application/json: schema: title: LicenseStatusEditLicenseInfoRequestBody type: object properties: licenseParams: $ref: '#/components/schemas/Pbx.XLicenseParams' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /LoggingSettings: description: Provides operations to manage the LoggingSettings singleton. get: tags: - LoggingSettings summary: Get LoggingSettings operationId: GetLoggingSettings parameters: - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.LoggingSettings' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - LoggingSettings summary: Update LoggingSettings operationId: UpdateLoggingSettings requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.LoggingSettings' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /MailSettings: description: Provides operations to manage the MailSettings singleton. get: tags: - MailSettings summary: Get MailSettings operationId: GetMailSettings parameters: - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.MailSettings' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - MailSettings summary: Update MailSettings operationId: UpdateMailSettings requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.MailSettings' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /MailSettings/Pbx.TestEmail: description: Provides operations to call the TestEmail method. post: tags: - MailSettings summary: Invoke action TestEmail operationId: TestEmail requestBody: description: Action parameters content: application/json: schema: title: MailSettingsTestEmailRequestBody type: object properties: email: type: string settings: $ref: '#/components/schemas/Pbx.MailSettings' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.TestResult' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Microsoft365Integration/Pbx.TestSubscription(): description: Provides operations to call the TestSubscription method. get: tags: - Microsoft365Integration summary: Invoke function TestSubscription operationId: TestSubscription responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.Microsoft365SubscriptionTestResult' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /Microsoft365Integration: description: Provides operations to manage the Microsoft365Integration singleton. get: tags: - Microsoft365Integration summary: Get Microsoft365Integration operationId: GetMicrosoft365Integration parameters: - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Microsoft365Integration' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - Microsoft365Integration summary: Update Microsoft365Integration operationId: UpdateMicrosoft365Integration requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.Microsoft365Integration' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /Microsoft365Integration/Pbx.AuthorizePresence: description: Provides operations to call the AuthorizePresence method. post: tags: - Microsoft365Integration summary: Invoke action AuthorizePresence operationId: AuthorizePresence requestBody: description: Action parameters content: application/json: schema: title: Microsoft365IntegrationAuthorizePresenceRequestBody type: object properties: accessToken: type: string required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Microsoft365Integration/Pbx.TestPresence: description: Provides operations to call the TestPresence method. post: tags: - Microsoft365Integration summary: Invoke action TestPresence operationId: TestPresence responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Microsoft365Integration/Pbx.DeauthorizePresence: description: Provides operations to call the DeauthorizePresence method. post: tags: - Microsoft365Integration summary: Invoke action DeauthorizePresence operationId: DeauthorizePresence responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Microsoft365Integration/Pbx.GetMicrosoftAccessToken(): description: Provides operations to call the GetMicrosoftAccessToken method. get: tags: - Microsoft365Integration summary: Invoke function GetMicrosoftAccessToken operationId: GetMicrosoftAccessToken responses: '200': description: Success content: application/json: schema: type: object properties: value: type: string default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /Microsoft365Integration/Pbx.GetMicrosoft365Directory(): description: Provides operations to call the GetMicrosoft365Directory method. get: tags: - Microsoft365Integration summary: Invoke function GetMicrosoft365Directory operationId: GetMicrosoft365Directory responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.Microsoft365Status' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /Microsoft365Integration/Pbx.GetM365Users: description: Provides operations to call the GetM365Users method. post: tags: - Microsoft365Integration summary: Invoke action GetM365Users operationId: GetM365Users requestBody: description: Action parameters content: application/json: schema: title: Microsoft365IntegrationGetM365UsersRequestBody type: object properties: options: allOf: - $ref: '#/components/schemas/Pbx.UsersRequestOptions' nullable: true required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.ExternalAccountsPage' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Microsoft365Integration/Pbx.GetM365Groups: description: Provides operations to call the GetM365Groups method. post: tags: - Microsoft365Integration summary: Invoke action GetM365Groups operationId: GetM365Groups requestBody: description: Action parameters content: application/json: schema: title: Microsoft365IntegrationGetM365GroupsRequestBody type: object properties: options: allOf: - $ref: '#/components/schemas/Pbx.GroupsRequestOptions' nullable: true required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.ExternalGroupsPage' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Microsoft365Integration/Pbx.GetUsersByPrincipalNames: description: Provides operations to call the GetUsersByPrincipalNames method. post: tags: - Microsoft365Integration summary: Invoke action GetUsersByPrincipalNames operationId: GetUsersByPrincipalNames requestBody: description: Action parameters content: application/json: schema: title: Microsoft365IntegrationGetUsersByPrincipalNamesRequestBody type: object properties: principalNames: type: array items: type: string required: true responses: '200': description: Success content: application/json: schema: type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.ExternalAccount' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Microsoft365TeamsIntegration: description: Provides operations to manage the Microsoft365TeamsIntegration singleton. get: tags: - Microsoft365TeamsIntegration summary: Get Microsoft365TeamsIntegration operationId: GetMicrosoft365TeamsIntegration parameters: - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Microsoft365TeamsIntegration' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - Microsoft365TeamsIntegration summary: Update Microsoft365TeamsIntegration operationId: UpdateMicrosoft365TeamsIntegration requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.Microsoft365TeamsIntegration' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/Microsoft365TeamsIntegration/Pbx.CheckFqdnRecord(fqdn={fqdn})': description: Provides operations to call the CheckFqdnRecord method. get: tags: - Microsoft365TeamsIntegration summary: Invoke function CheckFqdnRecord operationId: CheckFqdnRecord parameters: - name: fqdn in: path description: 'Usage: fqdn={fqdn}' required: true schema: type: string responses: '200': description: Success content: application/json: schema: type: object properties: value: type: boolean default: false default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /Microsoft365TeamsIntegration/Pbx.GetDialPlanScript(): description: Provides operations to call the GetDialPlanScript method. get: tags: - Microsoft365TeamsIntegration summary: Invoke function GetDialPlanScript operationId: GetDialPlanScript responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.IActionResult' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /Microsoft365TeamsIntegration/Pbx.GetMapUsersScript(): description: Provides operations to call the GetMapUsersScript method. get: tags: - Microsoft365TeamsIntegration summary: Invoke function GetMapUsersScript operationId: GetMapUsersScript responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.IActionResult' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /Microsoft365TeamsIntegration/Pbx.CheckMapUsersScript(): description: Provides operations to call the CheckMapUsersScript method. get: tags: - Microsoft365TeamsIntegration summary: Invoke function CheckMapUsersScript operationId: CheckMapUsersScript responses: '200': description: Success content: application/json: schema: type: object properties: value: type: boolean default: false default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /MusicOnHoldSettings: description: Provides operations to manage the MusicOnHoldSettings singleton. get: tags: - MusicOnHoldSettings summary: Get MusicOnHoldSettings operationId: GetMusicOnHoldSettings parameters: - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.MusicOnHoldSettings' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - MusicOnHoldSettings summary: Update MusicOnHoldSettings operationId: UpdateMusicOnHoldSettings requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.MusicOnHoldSettings' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /MyGroup: description: Provides operations to manage the Group singleton. get: tags: - MyGroup summary: Get MyGroup operationId: GetMyGroup parameters: - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Group' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - MyGroup summary: Update MyGroup operationId: UpdateMyGroup requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.Group' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /MyGroup/Members: description: Provides operations to manage the Members property of the Pbx.Group entity. get: tags: - MyGroup summary: Get Members from MyGroup operationId: ListMyGroupMembers parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.UserGroupCollectionResponse' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /MyGroup/Rights: description: Provides operations to manage the Rights property of the Pbx.Group entity. get: tags: - MyGroup summary: Get Rights from MyGroup operationId: ListMyGroupRights parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.RightsCollectionResponse' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /MyGroup/Pbx.GetRestrictions(): description: Provides operations to call the GetRestrictions method. get: tags: - MyGroup summary: Invoke function GetRestrictions operationId: GetMyGroupRestrictions responses: '200': $ref: '#/components/responses/GetRestrictionsResponse' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /MyGroup/Pbx.ReplaceMyGroupLicenseKey: description: Provides operations to call the ReplaceMyGroupLicenseKey method. post: tags: - MyGroup summary: Invoke action ReplaceMyGroupLicenseKey operationId: ReplaceMyGroupLicenseKey requestBody: $ref: '#/components/requestBodies/ReplaceMyGroupLicenseKeyRequestBody' responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action '/MyGroup/Pbx.GetMyGroupPartnerInfo(resellerId={resellerId})': description: Provides operations to call the GetMyGroupPartnerInfo method. get: tags: - MyGroup summary: Invoke function GetMyGroupPartnerInfo operationId: GetMyGroupPartnerInfo parameters: - name: resellerId in: path description: 'Usage: resellerId={resellerId}' required: true schema: type: string responses: '200': $ref: '#/components/responses/GetMyGroupPartnerInfoResponse' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /MyGroup/Pbx.UnlinkMyGroupPartner: description: Provides operations to call the UnlinkMyGroupPartner method. post: tags: - MyGroup summary: Invoke action UnlinkMyGroupPartner operationId: UnlinkMyGroupPartner responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /MyGroup/Pbx.LinkMyGroupPartner: description: Provides operations to call the LinkMyGroupPartner method. post: tags: - MyGroup summary: Invoke action LinkMyGroupPartner operationId: LinkMyGroupPartner requestBody: $ref: '#/components/requestBodies/LinkMyGroupPartnerRequestBody' responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /MyTokens: description: Provides operations to manage the collection of RefreshToken entities. get: tags: - MyTokens summary: Get entities from MyTokens operationId: ListRefreshToken parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.RefreshTokenCollectionResponse' default: $ref: '#/components/responses/error' '/MyTokens({Id})/Pbx.RevokeToken': description: Provides operations to call the RevokeToken method. post: tags: - MyTokens summary: Invoke action RevokeToken operationId: RevokeToken parameters: - name: Id in: path description: The unique identifier of RefreshToken required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: RefreshToken responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /MyUser: description: Provides operations to manage the User singleton. get: tags: - MyUser summary: Get MyUser operationId: GetMyUser parameters: - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.User' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - MyUser summary: Update MyUser operationId: UpdateMyUser requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.User' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /MyUser/Groups: description: Provides operations to manage the Groups property of the Pbx.DN entity. get: tags: - MyUser summary: Get Groups from MyUser operationId: ListMyUserGroups parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.UserGroupCollectionResponse' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /MyUser/ForwardingProfiles: description: Provides operations to manage the ForwardingProfiles property of the Pbx.User entity. get: tags: - MyUser summary: Get ForwardingProfiles from MyUser operationId: ListMyUserForwardingProfiles parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.ForwardingProfileCollectionResponse' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /MyUser/Greetings: description: Provides operations to manage the Greetings property of the Pbx.User entity. get: tags: - MyUser summary: Get Greetings from MyUser operationId: ListMyUserGreetings parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.GreetingCollectionResponse' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /MyUser/Pbx.GenerateProvLink(): description: Provides operations to call the GenerateProvLink method. get: tags: - MyUser summary: Invoke function GenerateProvLink operationId: MyUserGenerateProvLink responses: '200': $ref: '#/components/responses/GenerateProvLinkResponse' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /NetworkInterfaces: description: Provides operations to manage the collection of NetworkInterface entities. get: tags: - NetworkInterfaces summary: Get entities from NetworkInterfaces operationId: ListNetworkInterface parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.NetworkInterfaceCollectionResponse' default: $ref: '#/components/responses/error' /NetworkSettings: description: Provides operations to manage the NetworkSettings singleton. get: tags: - NetworkSettings summary: Get NetworkSettings operationId: GetNetworkSettings parameters: - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.NetworkSettings' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - NetworkSettings summary: Update NetworkSettings operationId: UpdateNetworkSettings requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.NetworkSettings' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /NetworkSettings/Pbx.GetIfaces(): description: Provides operations to call the GetIfaces method. get: tags: - NetworkSettings summary: Invoke function GetIfaces operationId: GetIfaces parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' responses: '200': description: Success content: application/json: schema: type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: type: string default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /NotificationSettings: description: Provides operations to manage the NotificationSettings singleton. get: tags: - NotificationSettings summary: Get NotificationSettings operationId: GetNotificationSettings parameters: - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.NotificationSettings' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - NotificationSettings summary: Update NotificationSettings operationId: UpdateNotificationSettings requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.NotificationSettings' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /OfficeHours: description: Provides operations to manage the OfficeHours singleton. get: tags: - OfficeHours summary: Get OfficeHours operationId: GetOfficeHours parameters: - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.OfficeHours' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - OfficeHours summary: Update OfficeHours operationId: UpdateOfficeHours requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.OfficeHours' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/OutboundRules({Id})': description: Provides operations to manage the collection of OutboundRule entities. get: tags: - OutboundRules summary: Get entity from OutboundRules by key operationId: GetOutboundRule parameters: - name: Id in: path description: The unique identifier of OutboundRule required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: OutboundRule - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.OutboundRule' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - OutboundRules summary: Update entity in OutboundRules operationId: UpdateOutboundRule parameters: - name: Id in: path description: The unique identifier of OutboundRule required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: OutboundRule requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.OutboundRule' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - OutboundRules summary: Delete entity from OutboundRules operationId: DeleteOutboundRule parameters: - name: Id in: path description: The unique identifier of OutboundRule required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: OutboundRule - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /OutboundRules: description: Provides operations to manage the collection of OutboundRule entities. get: tags: - OutboundRules summary: Get entities from OutboundRules operationId: ListOutboundRule parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.OutboundRuleCollectionResponse' default: $ref: '#/components/responses/error' post: tags: - OutboundRules summary: Add new entity to OutboundRules operationId: CreateOutboundRule requestBody: description: New entity content: application/json: schema: $ref: '#/components/schemas/Pbx.OutboundRule' required: true responses: '201': description: Created entity content: application/json: schema: $ref: '#/components/schemas/Pbx.OutboundRule' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /OutboundRules/Pbx.GetEmergencyOutboundRules(): description: Provides operations to call the GetEmergencyOutboundRules method. get: tags: - OutboundRules summary: Invoke function GetEmergencyOutboundRules operationId: GetEmergencyOutboundRules parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of OutboundRule type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.OutboundRule' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /OutboundRules/Pbx.Purge: description: Provides operations to call the Purge method. post: tags: - OutboundRules summary: Invoke action Purge operationId: Purge requestBody: description: Action parameters content: application/json: schema: title: OutboundRulesPurgeRequestBody type: object properties: purgeObject: allOf: - $ref: '#/components/schemas/Pbx.XOutboundRulePurge' nullable: true required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /OutboundRules/Pbx.MoveUpDown: description: Provides operations to call the MoveUpDown method. post: tags: - OutboundRules summary: Invoke action MoveUpDown operationId: MoveUpDown requestBody: description: Action parameters content: application/json: schema: title: OutboundRulesMoveUpDownRequestBody type: object properties: id: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 up: type: boolean default: false required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action '/Parameters/Pbx.GetParameterByName(name={name})': description: Provides operations to call the GetParameterByName method. get: tags: - Parameters summary: Invoke function GetParameterByName operationId: GetParameterByName parameters: - name: name in: path description: 'Usage: name={name}' required: true schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.Parameter' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /Parameters: description: Provides operations to manage the collection of Parameter entities. get: tags: - Parameters summary: Get entities from Parameters operationId: ListParameter parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.ParameterCollectionResponse' default: $ref: '#/components/responses/error' post: tags: - Parameters summary: Add new entity to Parameters operationId: CreateParameter requestBody: description: New entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Parameter' required: true responses: '201': description: Created entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Parameter' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/Parameters({Id})': description: Provides operations to manage the collection of Parameter entities. get: tags: - Parameters summary: Get entity from Parameters by key operationId: GetParameter parameters: - name: Id in: path description: The unique identifier of Parameter required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: Parameter - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Parameter' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - Parameters summary: Update entity in Parameters operationId: UpdateParameter parameters: - name: Id in: path description: The unique identifier of Parameter required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: Parameter requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.Parameter' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - Parameters summary: Delete entity from Parameters operationId: DeleteParameter parameters: - name: Id in: path description: The unique identifier of Parameter required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: Parameter - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/Parkings(Number={Number})': description: Provides operations to manage the collection of Parking entities. get: tags: - Parkings summary: Get entity from Parkings by key (Number) operationId: GetParkingByNumber parameters: - name: Number in: path description: Alternate key of Parking required: true schema: type: string nullable: true - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Parking' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/Parkings({Id})/Groups': description: Provides operations to manage the Groups property of the Pbx.DN entity. get: tags: - Parkings summary: Get Groups from Parkings operationId: ListParkingGroups parameters: - name: Id in: path description: The unique identifier of Parking required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: Parking - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.UserGroupCollectionResponse' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /Parkings: description: Provides operations to manage the collection of Parking entities. get: tags: - Parkings summary: Get entities from Parkings operationId: ListParking parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.ParkingCollectionResponse' default: $ref: '#/components/responses/error' post: tags: - Parkings summary: Add new entity to Parkings operationId: CreateParking requestBody: description: New entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Parking' required: true responses: '201': description: Created entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Parking' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/Parkings({Id})': description: Provides operations to manage the collection of Parking entities. get: tags: - Parkings summary: Get entity from Parkings by key operationId: GetParking parameters: - name: Id in: path description: The unique identifier of Parking required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: Parking - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Parking' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - Parkings summary: Update entity in Parkings operationId: UpdateParking parameters: - name: Id in: path description: The unique identifier of Parking required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: Parking requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.Parking' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - Parkings summary: Delete entity from Parkings operationId: DeleteParking parameters: - name: Id in: path description: The unique identifier of Parking required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: Parking - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /Peers: description: Provides operations to manage the collection of Peer entities. get: tags: - Peers summary: Get entities from Peers operationId: ListPeer parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.PeerCollectionResponse' default: $ref: '#/components/responses/error' '/Peers(Number={Number})': description: Provides operations to manage the collection of Peer entities. get: tags: - Peers summary: Get entity from Peers by key (Number) operationId: GetPeerByNumber parameters: - name: Number in: path description: Alternate key of Peer required: true schema: type: string nullable: true - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Peer' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /Peers/Pbx.GetReportPeers(): description: Provides operations to call the GetReportPeers method. get: tags: - Peers summary: Invoke function GetReportPeers operationId: GetReportPeers parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of Peer type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.Peer' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /Peers/Pbx.RetreivePeersByNumbers: description: Provides operations to call the RetreivePeersByNumbers method. post: tags: - Peers summary: Invoke action RetreivePeersByNumbers operationId: RetreivePeersByNumbers requestBody: description: Action parameters content: application/json: schema: title: PeersRetreivePeersByNumbersRequestBody type: object properties: peersRequest: $ref: '#/components/schemas/Pbx.RetreivePeersRequest' required: true responses: '200': description: Success content: application/json: schema: title: Collection of Peer type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.Peer' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /PhoneBookSettings: description: Provides operations to manage the PhoneBookSettings singleton. get: tags: - PhoneBookSettings summary: Get PhoneBookSettings operationId: GetPhoneBookSettings parameters: - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.PhoneBookSettings' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - PhoneBookSettings summary: Update PhoneBookSettings operationId: UpdatePhoneBookSettings requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.PhoneBookSettings' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /PhoneLogos: description: Provides operations to manage the collection of PhoneLogo entities. get: tags: - PhoneLogos summary: Get entities from PhoneLogos operationId: ListPhoneLogo parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.PhoneLogoCollectionResponse' default: $ref: '#/components/responses/error' '/PhoneLogos({Filename})': description: Provides operations to manage the collection of PhoneLogo entities. delete: tags: - PhoneLogos summary: Delete entity from PhoneLogos operationId: DeletePhoneLogo parameters: - name: Filename in: path description: The unique identifier of PhoneLogo required: true schema: type: string x-ms-docs-key-type: PhoneLogo - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /PhonesSettings: description: Provides operations to manage the PhonesSettings singleton. get: tags: - PhonesSettings summary: Get PhonesSettings operationId: GetPhonesSettings parameters: - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.PhonesSettings' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - PhonesSettings summary: Update PhonesSettings operationId: UpdatePhonesSettings requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.PhonesSettings' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /PhoneTemplates: description: Provides operations to manage the collection of PhoneTemplate entities. get: tags: - PhoneTemplates summary: Get entities from PhoneTemplates operationId: ListPhoneTemplate parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.PhoneTemplateCollectionResponse' default: $ref: '#/components/responses/error' post: tags: - PhoneTemplates summary: Add new entity to PhoneTemplates operationId: CreatePhoneTemplate requestBody: description: New entity content: application/json: schema: $ref: '#/components/schemas/Pbx.PhoneTemplate' required: true responses: '201': description: Created entity content: application/json: schema: $ref: '#/components/schemas/Pbx.PhoneTemplate' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/PhoneTemplates({Id})': description: Provides operations to manage the collection of PhoneTemplate entities. get: tags: - PhoneTemplates summary: Get entity from PhoneTemplates by key operationId: GetPhoneTemplate parameters: - name: Id in: path description: The unique identifier of PhoneTemplate required: true schema: type: string x-ms-docs-key-type: PhoneTemplate - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.PhoneTemplate' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - PhoneTemplates summary: Update entity in PhoneTemplates operationId: UpdatePhoneTemplate parameters: - name: Id in: path description: The unique identifier of PhoneTemplate required: true schema: type: string x-ms-docs-key-type: PhoneTemplate requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.PhoneTemplate' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - PhoneTemplates summary: Delete entity from PhoneTemplates operationId: DeletePhoneTemplate parameters: - name: Id in: path description: The unique identifier of PhoneTemplate required: true schema: type: string x-ms-docs-key-type: PhoneTemplate - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /Playlists: description: Provides operations to manage the collection of Playlist entities. get: tags: - Playlists summary: Get entities from Playlists operationId: ListPlaylist parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.PlaylistCollectionResponse' default: $ref: '#/components/responses/error' post: tags: - Playlists summary: Add new entity to Playlists operationId: CreatePlaylist requestBody: description: New entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Playlist' required: true responses: '201': description: Created entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Playlist' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/Playlists({Name})': description: Provides operations to manage the collection of Playlist entities. get: tags: - Playlists summary: Get entity from Playlists by key operationId: GetPlaylist parameters: - name: Name in: path description: The unique identifier of Playlist required: true schema: type: string x-ms-docs-key-type: Playlist - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Playlist' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - Playlists summary: Update entity in Playlists operationId: UpdatePlaylist parameters: - name: Name in: path description: The unique identifier of Playlist required: true schema: type: string x-ms-docs-key-type: Playlist requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.Playlist' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - Playlists summary: Delete entity from Playlists operationId: DeletePlaylist parameters: - name: Name in: path description: The unique identifier of Playlist required: true schema: type: string x-ms-docs-key-type: Playlist - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /Playlists/Pbx.DeletePlaylistFile: description: Provides operations to call the DeletePlaylistFile method. post: tags: - Playlists summary: Invoke action DeletePlaylistFile operationId: DeletePlaylistFile requestBody: description: Action parameters content: application/json: schema: title: PlaylistsDeletePlaylistFileRequestBody type: object properties: fileName: type: string playlistKey: type: string required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action '/Playlists/Pbx.DownloadPlaylistFile(playlistKey={playlistKey},fileName={fileName})': description: Provides operations to call the DownloadPlaylistFile method. get: tags: - Playlists summary: Invoke function DownloadPlaylistFile operationId: DownloadPlaylistFile parameters: - name: playlistKey in: path description: 'Usage: playlistKey={playlistKey}' required: true schema: type: string - name: fileName in: path description: 'Usage: fileName={fileName}' required: true schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.IActionResult' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /PromptSets: description: Provides operations to manage the collection of PromptSet entities. get: tags: - PromptSets summary: Get entities from PromptSets operationId: ListPromptSet parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.PromptSetCollectionResponse' default: $ref: '#/components/responses/error' '/PromptSets({Id})': description: Provides operations to manage the collection of PromptSet entities. get: tags: - PromptSets summary: Get entity from PromptSets by key operationId: GetPromptSet parameters: - name: Id in: path description: The unique identifier of PromptSet required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: PromptSet - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.PromptSet' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - PromptSets summary: Update entity in PromptSets operationId: UpdatePromptSet parameters: - name: Id in: path description: The unique identifier of PromptSet required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: PromptSet requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.PromptSet' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - PromptSets summary: Delete entity from PromptSets operationId: DeletePromptSet parameters: - name: Id in: path description: The unique identifier of PromptSet required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: PromptSet - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /PromptSets/Pbx.GetActive(): description: Provides operations to call the GetActive method. get: tags: - PromptSets summary: Invoke function GetActive operationId: GetActive responses: '200': description: Success content: application/json: schema: allOf: - $ref: '#/components/schemas/Pbx.PromptSet' nullable: true default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/PromptSets({Id})/Prompts': description: Provides operations to manage the Prompts property of the Pbx.PromptSet entity. get: tags: - PromptSets summary: Get Prompts from PromptSets operationId: ListPrompts parameters: - name: Id in: path description: The unique identifier of PromptSet required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: PromptSet - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.PromptCollectionResponse' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/PromptSets({Id})/Pbx.SetActive': description: Provides operations to call the SetActive method. post: tags: - PromptSets summary: Invoke action SetActive operationId: SetActive parameters: - name: Id in: path description: The unique identifier of PromptSet required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: PromptSet responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action '/PromptSets({Id})/Pbx.SetAlternatePronunciation': description: Provides operations to call the SetAlternatePronunciation method. post: tags: - PromptSets summary: Invoke action SetAlternatePronunciation operationId: SetAlternatePronunciation parameters: - name: Id in: path description: The unique identifier of PromptSet required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: PromptSet requestBody: description: Action parameters content: application/json: schema: title: PromptSetsPromptSetSetAlternatePronunciationRequestBody type: object properties: alternatePronunciation: type: boolean default: false required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action '/PromptSets({Id})/Pbx.Copy': description: Provides operations to call the Copy method. post: tags: - PromptSets summary: Invoke action Copy operationId: Copy parameters: - name: Id in: path description: The unique identifier of PromptSet required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: PromptSet requestBody: description: Action parameters content: application/json: schema: title: PromptSetsPromptSetCopyRequestBody type: object properties: overrides: $ref: '#/components/schemas/Pbx.PromptSet' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.PromptSet' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action '/PromptSets({Id})/Pbx.PlayPrompt': description: Provides operations to call the PlayPrompt method. post: tags: - PromptSets summary: Invoke action PlayPrompt operationId: PlayPrompt parameters: - name: Id in: path description: The unique identifier of PromptSet required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: PromptSet requestBody: description: Action parameters content: application/json: schema: title: PromptSetsPromptSetPlayPromptRequestBody type: object properties: extension: type: string promptId: type: string required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action '/PromptSets({Id})/Pbx.RecordPrompt': description: Provides operations to call the RecordPrompt method. post: tags: - PromptSets summary: Invoke action RecordPrompt operationId: RecordPrompt parameters: - name: Id in: path description: The unique identifier of PromptSet required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: PromptSet requestBody: description: Action parameters content: application/json: schema: title: PromptSetsPromptSetRecordPromptRequestBody type: object properties: extension: type: string promptId: type: string required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /PurgeCalls: description: Provides operations to call the PurgeCalls method. post: tags: - PurgeSettings summary: Invoke actionImport PurgeCalls operationId: PurgeCalls requestBody: description: Action parameters content: application/json: schema: title: ActionImportPurgeCallsRequestBody type: object properties: period: $ref: '#/components/schemas/Pbx.PurgeSettings' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: actionImport /PurgeChats: description: Provides operations to call the PurgeChats method. post: tags: - PurgeSettings summary: Invoke actionImport PurgeChats operationId: PurgeChats requestBody: description: Action parameters content: application/json: schema: title: ActionImportPurgeChatsRequestBody type: object properties: period: $ref: '#/components/schemas/Pbx.PurgeSettings' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: actionImport /PurgeAllLogs: description: Provides operations to call the PurgeAllLogs method. post: tags: - PurgeSettings summary: Invoke actionImport PurgeAllLogs operationId: PurgeAllLogs responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: actionImport '/Queues({Id})': description: Provides operations to manage the collection of Queue entities. get: tags: - Queues summary: Get entity from Queues by key operationId: GetQueue parameters: - name: Id in: path description: The unique identifier of Queue required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: Queue - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Queue' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - Queues summary: Update entity in Queues operationId: UpdateQueue parameters: - name: Id in: path description: The unique identifier of Queue required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: Queue requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.Queue' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - Queues summary: Delete entity from Queues operationId: DeleteQueue parameters: - name: Id in: path description: The unique identifier of Queue required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: Queue - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/Queues(Number={Number})': description: Provides operations to manage the collection of Queue entities. get: tags: - Queues summary: Get entity from Queues by key (Number) operationId: GetQueueByNumber parameters: - name: Number in: path description: Alternate key of Queue required: true schema: type: string nullable: true - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Queue' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /Queues: description: Provides operations to manage the collection of Queue entities. get: tags: - Queues summary: Get entities from Queues operationId: ListQueue parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.QueueCollectionResponse' default: $ref: '#/components/responses/error' post: tags: - Queues summary: Add new entity to Queues operationId: CreateQueue requestBody: description: New entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Queue' required: true responses: '201': description: Created entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Queue' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/Queues({Id})/Agents': description: Provides operations to manage the Agents property of the Pbx.Queue entity. get: tags: - Queues summary: Get Agents from Queues operationId: ListAgents parameters: - name: Id in: path description: The unique identifier of Queue required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: Queue - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.QueueAgentCollectionResponse' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/Queues({Id})/Managers': description: Provides operations to manage the Managers property of the Pbx.Queue entity. get: tags: - Queues summary: Get Managers from Queues operationId: ListManagers parameters: - name: Id in: path description: The unique identifier of Queue required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: Queue - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.QueueManagerCollectionResponse' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/Queues({Id})/Pbx.ResetQueueStatistics': description: Provides operations to call the ResetQueueStatistics method. post: tags: - Queues summary: Invoke action ResetQueueStatistics operationId: ResetQueueStatistics parameters: - name: Id in: path description: The unique identifier of Queue required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: Queue responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Queues/Pbx.GetFirstAvailableQueueNumber(): description: Provides operations to call the GetFirstAvailableQueueNumber method. get: tags: - Queues summary: Invoke function GetFirstAvailableQueueNumber operationId: GetFirstAvailableQueueNumber responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.FirstAvailableNumber' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/Receptionists(Number={Number})': description: Provides operations to manage the collection of Receptionist entities. get: tags: - Receptionists summary: Get entity from Receptionists by key (Number) operationId: GetReceptionistByNumber parameters: - name: Number in: path description: Alternate key of Receptionist required: true schema: type: string nullable: true - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Receptionist' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/Receptionists({Id})/Forwards': description: Provides operations to manage the Forwards property of the Pbx.Receptionist entity. get: tags: - Receptionists summary: Get Forwards from Receptionists operationId: ListForwards parameters: - name: Id in: path description: The unique identifier of Receptionist required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: Receptionist - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.ReceptionistForwardCollectionResponse' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /Receptionists/Pbx.GetFirstAvailableReceptionistNumber(): description: Provides operations to call the GetFirstAvailableReceptionistNumber method. get: tags: - Receptionists summary: Invoke function GetFirstAvailableReceptionistNumber operationId: GetFirstAvailableReceptionistNumber responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.FirstAvailableNumber' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /Receptionists: description: Provides operations to manage the collection of Receptionist entities. get: tags: - Receptionists summary: Get entities from Receptionists operationId: ListReceptionist parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.ReceptionistCollectionResponse' default: $ref: '#/components/responses/error' post: tags: - Receptionists summary: Add new entity to Receptionists operationId: CreateReceptionist requestBody: description: New entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Receptionist' required: true responses: '201': description: Created entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Receptionist' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/Receptionists({Id})': description: Provides operations to manage the collection of Receptionist entities. get: tags: - Receptionists summary: Get entity from Receptionists by key operationId: GetReceptionist parameters: - name: Id in: path description: The unique identifier of Receptionist required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: Receptionist - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Receptionist' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - Receptionists summary: Update entity in Receptionists operationId: UpdateReceptionist parameters: - name: Id in: path description: The unique identifier of Receptionist required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: Receptionist requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.Receptionist' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - Receptionists summary: Delete entity from Receptionists operationId: DeleteReceptionist parameters: - name: Id in: path description: The unique identifier of Receptionist required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: Receptionist - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /Recordings: description: Provides operations to manage the collection of Recording entities. get: tags: - Recordings summary: Get entities from Recordings operationId: ListRecording parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.RecordingCollectionResponse' default: $ref: '#/components/responses/error' '/Recordings/Pbx.DownloadRecording(recId={recId})': description: Provides operations to call the DownloadRecording method. get: tags: - Recordings summary: Invoke function DownloadRecording operationId: DownloadRecording parameters: - name: recId in: path description: 'Usage: recId={recId}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.IActionResult' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/Recordings/Pbx.DownloadRecordingByName(recName={recName})': description: Provides operations to call the DownloadRecordingByName method. get: tags: - Recordings summary: Invoke function DownloadRecordingByName operationId: DownloadRecordingByName parameters: - name: recName in: path description: 'Usage: recName={recName}' required: true schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.IActionResult' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /Recordings/Pbx.GetRecordingRepositorySettings(): description: Provides operations to call the GetRecordingRepositorySettings method. get: tags: - Recordings summary: Invoke function GetRecordingRepositorySettings operationId: GetRecordingRepositorySettings responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.RecordingRepositorySettings' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /Recordings/Pbx.SetRecordingRepositorySettings: description: Provides operations to call the SetRecordingRepositorySettings method. post: tags: - Recordings summary: Invoke action SetRecordingRepositorySettings operationId: SetRecordingRepositorySettings requestBody: description: Action parameters content: application/json: schema: title: RecordingsSetRecordingRepositorySettingsRequestBody type: object properties: settings: $ref: '#/components/schemas/Pbx.RecordingRepositorySettings' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Recordings/Pbx.PurgeLocal: description: Provides operations to call the PurgeLocal method. post: tags: - Recordings summary: Invoke action PurgeLocal operationId: PurgeLocal responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Recordings/Pbx.PurgeArchive: description: Provides operations to call the PurgeArchive method. post: tags: - Recordings summary: Invoke action PurgeArchive operationId: PurgeArchive responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Recordings/Pbx.Archive: description: Provides operations to call the Archive method. post: tags: - Recordings summary: Invoke action Archive operationId: Archive responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Recordings/Pbx.BulkRecordingsDelete: description: Provides operations to call the BulkRecordingsDelete method. post: tags: - Recordings summary: Invoke action BulkRecordingsDelete operationId: BulkRecordingsDelete requestBody: description: Action parameters content: application/json: schema: title: RecordingsBulkRecordingsDeleteRequestBody type: object properties: ids: type: array items: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Recordings/Pbx.BulkRecordingsArchive: description: Provides operations to call the BulkRecordingsArchive method. post: tags: - Recordings summary: Invoke action BulkRecordingsArchive operationId: BulkRecordingsArchive requestBody: description: Action parameters content: application/json: schema: title: RecordingsBulkRecordingsArchiveRequestBody type: object properties: ids: type: array items: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Recordings/Pbx.TranscribeRecordings: description: Provides operations to call the TranscribeRecordings method. post: tags: - Recordings summary: Invoke action TranscribeRecordings operationId: TranscribeRecordings requestBody: description: Action parameters content: application/json: schema: title: RecordingsTranscribeRecordingsRequestBody type: object properties: ids: type: array items: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /SystemStatus/Pbx.GetRemoteAccessStatus(): description: Provides operations to call the GetRemoteAccessStatus method. get: tags: - SystemStatus summary: Invoke function GetRemoteAccessStatus operationId: GetRemoteAccessStatus responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.RemoteAccessStatus' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /SystemStatus/Pbx.RevokeRemoteAccess: description: Provides operations to call the RevokeRemoteAccess method. post: tags: - SystemStatus summary: Invoke action RevokeRemoteAccess operationId: RevokeRemoteAccess responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /SystemStatus/Pbx.IsRequestHelpEnabled(): description: Provides operations to call the IsRequestHelpEnabled method. get: tags: - SystemStatus summary: Invoke function IsRequestHelpEnabled operationId: IsRequestHelpEnabled responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.CreateTicket' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /SystemStatus/Pbx.RequestHelp: description: Provides operations to call the RequestHelp method. post: tags: - SystemStatus summary: Invoke action RequestHelp operationId: RequestHelp requestBody: description: Action parameters content: application/json: schema: title: SystemStatusRequestHelpRequestBody type: object properties: description: allOf: - $ref: '#/components/schemas/Pbx.RequestHelp' nullable: true required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action '/SystemStatus/Pbx.GetRequestHelpLink(grantPeriodDays={grantPeriodDays})': description: Provides operations to call the GetRequestHelpLink method. get: tags: - SystemStatus summary: Invoke function GetRequestHelpLink operationId: GetRequestHelpLink parameters: - name: grantPeriodDays in: path description: 'Usage: grantPeriodDays={grantPeriodDays}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 responses: '200': description: Success content: application/json: schema: type: object properties: value: type: string default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /SystemStatus: description: Provides operations to manage the SystemStatus singleton. get: tags: - SystemStatus summary: Get SystemStatus operationId: GetSystemStatus parameters: - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.SystemStatus' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /SystemStatus/Pbx.SystemExtensions(): description: Provides operations to call the SystemExtensions method. get: tags: - SystemStatus summary: Invoke function SystemExtensions operationId: SystemExtensions parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' responses: '200': description: Success content: application/json: schema: type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.SystemExtensionStatus' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /SystemStatus/Pbx.SystemDatabaseInformation(): description: Provides operations to call the SystemDatabaseInformation method. get: tags: - SystemStatus summary: Invoke function SystemDatabaseInformation operationId: SystemDatabaseInformation responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.SystemDatabaseInformation' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /SystemStatus/Pbx.GetVersionType(): description: Provides operations to call the GetVersionType method. get: tags: - SystemStatus summary: Invoke function GetVersionType operationId: GetVersionType responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.VersionUpdateType' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /SystemStatus/Pbx.SetChatLogStatus: description: Provides operations to call the SetChatLogStatus method. post: tags: - SystemStatus summary: Invoke action SetChatLogStatus operationId: SetChatLogStatus requestBody: description: Action parameters content: application/json: schema: title: SystemStatusSetChatLogStatusRequestBody type: object properties: enable: type: boolean default: false required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /SystemStatus/Pbx.StartDBMaintenance: description: Provides operations to call the StartDBMaintenance method. post: tags: - SystemStatus summary: Invoke action StartDBMaintenance operationId: StartDBMaintenance responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /SystemStatus/Pbx.SystemHealthStatus(): description: Provides operations to call the SystemHealthStatus method. get: tags: - SystemStatus summary: Invoke function SystemHealthStatus operationId: SystemHealthStatus responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.SystemHealthStatus' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /SystemStatus/Pbx.APIToken(): description: Provides operations to call the APIToken method. get: tags: - SystemStatus summary: Invoke function APIToken operationId: APIToken responses: '200': description: Success content: application/json: schema: type: object properties: value: type: string default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /SystemStatus/Pbx.SetMultiCompanyMode: description: Provides operations to call the SetMultiCompanyMode method. post: tags: - SystemStatus summary: Invoke action SetMultiCompanyMode operationId: SetMultiCompanyMode requestBody: description: Action parameters content: application/json: schema: title: SystemStatusSetMultiCompanyModeRequestBody type: object properties: enable: type: boolean default: false required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /SystemStatus/Pbx.SystemTelemetry(): description: Provides operations to call the SystemTelemetry method. get: tags: - SystemStatus summary: Invoke function SystemTelemetry operationId: SystemTelemetry parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of SystemTelemetry type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.SystemTelemetry' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /SystemStatus/Pbx.ServiceTelemetry(): description: Provides operations to call the ServiceTelemetry method. get: tags: - SystemStatus summary: Invoke function ServiceTelemetry operationId: ServiceTelemetry parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of ProcessTelemetry type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.ProcessTelemetry' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /SystemStatus/Pbx.NetworkTelemetry(): description: Provides operations to call the NetworkTelemetry method. get: tags: - SystemStatus summary: Invoke function NetworkTelemetry operationId: NetworkTelemetry parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of NetworkTelemetry type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.NetworkTelemetry' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/SystemStatus/Pbx.MyPhoneRequestIdTelemetry(startDate={startDate},endDate={endDate})': description: Provides operations to call the MyPhoneRequestIdTelemetry method. get: tags: - SystemStatus summary: Invoke function MyPhoneRequestIdTelemetry operationId: MyPhoneRequestIdTelemetry parameters: - name: startDate in: path description: 'Usage: startDate={startDate}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: endDate in: path description: 'Usage: endDate={endDate}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of MyPhoneRequestStats type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.MyPhoneRequestStats' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /RemoteArchivingSettings: description: Provides operations to manage the RemoteArchivingSettings singleton. get: tags: - RemoteArchivingSettings summary: Get RemoteArchivingSettings operationId: GetRemoteArchivingSettings parameters: - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.RemoteArchivingSettings' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - RemoteArchivingSettings summary: Update RemoteArchivingSettings operationId: UpdateRemoteArchivingSettings requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.RemoteArchivingSettings' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /RemoteArchivingSettings/Pbx.ArchiveRecordings: description: Provides operations to call the ArchiveRecordings method. post: tags: - RemoteArchivingSettings summary: Invoke action ArchiveRecordings operationId: ArchiveRecordings responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /RemoteArchivingSettings/Pbx.ArchiveChats: description: Provides operations to call the ArchiveChats method. post: tags: - RemoteArchivingSettings summary: Invoke action ArchiveChats operationId: ArchiveChats responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /RemoteArchivingSettings/Pbx.ArchiveFaxes: description: Provides operations to call the ArchiveFaxes method. post: tags: - RemoteArchivingSettings summary: Invoke action ArchiveFaxes operationId: ArchiveFaxes responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /RemoteArchivingSettings/Pbx.ArchiveVoicemail: description: Provides operations to call the ArchiveVoicemail method. post: tags: - RemoteArchivingSettings summary: Invoke action ArchiveVoicemail operationId: ArchiveVoicemail responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action '/ReportAbandonedChatsStatistics/Pbx.GetAbandonedChatsStatisticsData(queueDnStr={queueDnStr},startDt={startDt},endDt={endDt},participantType={participantType})': description: Provides operations to call the GetAbandonedChatsStatisticsData method. get: tags: - ReportAbandonedChatsStatistics summary: Invoke function GetAbandonedChatsStatisticsData operationId: GetAbandonedChatsStatisticsData parameters: - name: queueDnStr in: path description: 'Usage: queueDnStr={queueDnStr}' required: true schema: type: string nullable: true - name: startDt in: path description: 'Usage: startDt={startDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: endDt in: path description: 'Usage: endDt={endDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: participantType in: path description: 'Usage: participantType={participantType}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of AbandonedChatsStatistics type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.AbandonedChatsStatistics' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportAbandonedChatsStatistics/Pbx.DownloadAbandonedChatsStatistics(queueDnStr={queueDnStr},startDt={startDt},endDt={endDt},participantType={participantType},clientTimeZone={clientTimeZone})': description: Provides operations to call the DownloadAbandonedChatsStatistics method. get: tags: - ReportAbandonedChatsStatistics summary: Invoke function DownloadAbandonedChatsStatistics operationId: DownloadAbandonedChatsStatistics parameters: - name: queueDnStr in: path description: 'Usage: queueDnStr={queueDnStr}' required: true schema: type: string nullable: true - name: startDt in: path description: 'Usage: startDt={startDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: endDt in: path description: 'Usage: endDt={endDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: participantType in: path description: 'Usage: participantType={participantType}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 - name: clientTimeZone in: path description: 'Usage: clientTimeZone={clientTimeZone}' required: true schema: type: string nullable: true - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of AbandonedChatsStatistics type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.AbandonedChatsStatistics' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportAbandonedQueueCalls/Pbx.GetAbandonedQueueCallsData(periodFrom={periodFrom},periodTo={periodTo},queueDns={queueDns},waitInterval={waitInterval})': description: Provides operations to call the GetAbandonedQueueCallsData method. get: tags: - ReportAbandonedQueueCalls summary: Invoke function GetAbandonedQueueCallsData operationId: GetAbandonedQueueCallsData parameters: - name: periodFrom in: path description: 'Usage: periodFrom={periodFrom}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: periodTo in: path description: 'Usage: periodTo={periodTo}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: queueDns in: path description: 'Usage: queueDns={queueDns}' required: true schema: type: string nullable: true - name: waitInterval in: path description: 'Usage: waitInterval={waitInterval}' required: true schema: type: string nullable: true - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of AbandonedQueueCalls type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.AbandonedQueueCalls' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportAbandonedQueueCalls/Pbx.DownloadAbandonedQueueCalls(periodFrom={periodFrom},periodTo={periodTo},queueDns={queueDns},waitInterval={waitInterval},clientTimeZone={clientTimeZone})': description: Provides operations to call the DownloadAbandonedQueueCalls method. get: tags: - ReportAbandonedQueueCalls summary: Invoke function DownloadAbandonedQueueCalls operationId: DownloadAbandonedQueueCalls parameters: - name: periodFrom in: path description: 'Usage: periodFrom={periodFrom}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: periodTo in: path description: 'Usage: periodTo={periodTo}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: queueDns in: path description: 'Usage: queueDns={queueDns}' required: true schema: type: string nullable: true - name: waitInterval in: path description: 'Usage: waitInterval={waitInterval}' required: true schema: type: string nullable: true - name: clientTimeZone in: path description: 'Usage: clientTimeZone={clientTimeZone}' required: true schema: type: string nullable: true - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of AbandonedQueueCalls type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.AbandonedQueueCalls' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportAgentLoginHistory/Pbx.GetAgentLoginHistoryData(clientTimeZone={clientTimeZone},startDt={startDt},endDt={endDt},queueDnStr={queueDnStr},agentDnStr={agentDnStr})': description: Provides operations to call the GetAgentLoginHistoryData method. get: tags: - ReportAgentLoginHistory summary: Invoke function GetAgentLoginHistoryData operationId: GetAgentLoginHistoryData parameters: - name: clientTimeZone in: path description: 'Usage: clientTimeZone={clientTimeZone}' required: true schema: type: string nullable: true - name: startDt in: path description: 'Usage: startDt={startDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: endDt in: path description: 'Usage: endDt={endDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: queueDnStr in: path description: 'Usage: queueDnStr={queueDnStr}' required: true schema: type: string nullable: true - name: agentDnStr in: path description: 'Usage: agentDnStr={agentDnStr}' required: true schema: type: string nullable: true - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of AgentLoginHistory type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.AgentLoginHistory' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportAgentLoginHistory/Pbx.DownloadAgentLoginHistory(clientTimeZone={clientTimeZone},startDt={startDt},endDt={endDt},queueDnStr={queueDnStr},agentDnStr={agentDnStr})': description: Provides operations to call the DownloadAgentLoginHistory method. get: tags: - ReportAgentLoginHistory summary: Invoke function DownloadAgentLoginHistory operationId: DownloadAgentLoginHistory parameters: - name: clientTimeZone in: path description: 'Usage: clientTimeZone={clientTimeZone}' required: true schema: type: string nullable: true - name: startDt in: path description: 'Usage: startDt={startDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: endDt in: path description: 'Usage: endDt={endDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: queueDnStr in: path description: 'Usage: queueDnStr={queueDnStr}' required: true schema: type: string nullable: true - name: agentDnStr in: path description: 'Usage: agentDnStr={agentDnStr}' required: true schema: type: string nullable: true - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of AgentLoginHistory type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.AgentLoginHistory' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportAgentsInQueueStatistics/Pbx.GetAgentsInQueueStatisticsData(queueDnStr={queueDnStr},startDt={startDt},endDt={endDt},waitInterval={waitInterval})': description: Provides operations to call the GetAgentsInQueueStatisticsData method. get: tags: - ReportAgentsInQueueStatistics summary: Invoke function GetAgentsInQueueStatisticsData operationId: GetAgentsInQueueStatisticsData parameters: - name: queueDnStr in: path description: 'Usage: queueDnStr={queueDnStr}' required: true schema: type: string nullable: true - name: startDt in: path description: 'Usage: startDt={startDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: endDt in: path description: 'Usage: endDt={endDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: waitInterval in: path description: 'Usage: waitInterval={waitInterval}' required: true schema: type: string nullable: true - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of AgentsInQueueStatistics type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.AgentsInQueueStatistics' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportAgentsInQueueStatistics/Pbx.DownloadAgentsInQueueStatistics(queueDnStr={queueDnStr},startDt={startDt},endDt={endDt},waitInterval={waitInterval})': description: Provides operations to call the DownloadAgentsInQueueStatistics method. get: tags: - ReportAgentsInQueueStatistics summary: Invoke function DownloadAgentsInQueueStatistics operationId: DownloadAgentsInQueueStatistics parameters: - name: queueDnStr in: path description: 'Usage: queueDnStr={queueDnStr}' required: true schema: type: string nullable: true - name: startDt in: path description: 'Usage: startDt={startDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: endDt in: path description: 'Usage: endDt={endDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: waitInterval in: path description: 'Usage: waitInterval={waitInterval}' required: true schema: type: string nullable: true - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of AgentsInQueueStatistics type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.AgentsInQueueStatistics' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /ReportAuditLog/Pbx.GetAuditLogData(): description: Provides operations to call the GetAuditLogData method. get: tags: - ReportAuditLog summary: Invoke function GetAuditLogData operationId: GetAuditLogData parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of AuditLog type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.AuditLog' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportAuditLog/Pbx.DownloadAuditLog(clientTimeZone={clientTimeZone})': description: Provides operations to call the DownloadAuditLog method. get: tags: - ReportAuditLog summary: Invoke function DownloadAuditLog operationId: DownloadAuditLog parameters: - name: clientTimeZone in: path description: 'Usage: clientTimeZone={clientTimeZone}' required: true schema: type: string nullable: true - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of AuditLog type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.AuditLog' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportAverageQueueWaitingTime/Pbx.GetAverageQueueWaitingTimeData(chartDate={chartDate},chartBy={chartBy},queueDnStr={queueDnStr},waitInterval={waitInterval},clientTimeZone={clientTimeZone})': description: Provides operations to call the GetAverageQueueWaitingTimeData method. get: tags: - ReportAverageQueueWaitingTime summary: Invoke function GetAverageQueueWaitingTimeData operationId: GetAverageQueueWaitingTimeData parameters: - name: chartDate in: path description: 'Usage: chartDate={chartDate}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: chartBy in: path description: 'Usage: chartBy={chartBy}' required: true schema: type: string nullable: true - name: queueDnStr in: path description: 'Usage: queueDnStr={queueDnStr}' required: true schema: type: string nullable: true - name: waitInterval in: path description: 'Usage: waitInterval={waitInterval}' required: true schema: type: string nullable: true - name: clientTimeZone in: path description: 'Usage: clientTimeZone={clientTimeZone}' required: true schema: type: string nullable: true - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of TimeReportData type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.TimeReportData' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportAverageQueueWaitingTime/Pbx.DownloadAverageQueueWaitingTimeReport(chartDate={chartDate},chartBy={chartBy},queueDnStr={queueDnStr},waitInterval={waitInterval},clientTimeZone={clientTimeZone})': description: Provides operations to call the DownloadAverageQueueWaitingTimeReport method. get: tags: - ReportAverageQueueWaitingTime summary: Invoke function DownloadAverageQueueWaitingTimeReport operationId: DownloadAverageQueueWaitingTimeReport parameters: - name: chartDate in: path description: 'Usage: chartDate={chartDate}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: chartBy in: path description: 'Usage: chartBy={chartBy}' required: true schema: type: string nullable: true - name: queueDnStr in: path description: 'Usage: queueDnStr={queueDnStr}' required: true schema: type: string nullable: true - name: waitInterval in: path description: 'Usage: waitInterval={waitInterval}' required: true schema: type: string nullable: true - name: clientTimeZone in: path description: 'Usage: clientTimeZone={clientTimeZone}' required: true schema: type: string nullable: true - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of TimeReportData type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.TimeReportData' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportBreachesSla/Pbx.GetBreachesSlaData(queueDnStr={queueDnStr},startDt={startDt},endDt={endDt},waitInterval={waitInterval})': description: Provides operations to call the GetBreachesSlaData method. get: tags: - ReportBreachesSla summary: Invoke function GetBreachesSlaData operationId: GetBreachesSlaData parameters: - name: queueDnStr in: path description: 'Usage: queueDnStr={queueDnStr}' required: true schema: type: string nullable: true - name: startDt in: path description: 'Usage: startDt={startDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: endDt in: path description: 'Usage: endDt={endDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: waitInterval in: path description: 'Usage: waitInterval={waitInterval}' required: true schema: type: string nullable: true - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of BreachesSla type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.BreachesSla' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportBreachesSla/Pbx.DownloadBreachesSla(queueDnStr={queueDnStr},startDt={startDt},endDt={endDt},waitInterval={waitInterval},clientTimeZone={clientTimeZone})': description: Provides operations to call the DownloadBreachesSla method. get: tags: - ReportBreachesSla summary: Invoke function DownloadBreachesSla operationId: DownloadBreachesSla parameters: - name: queueDnStr in: path description: 'Usage: queueDnStr={queueDnStr}' required: true schema: type: string nullable: true - name: startDt in: path description: 'Usage: startDt={startDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: endDt in: path description: 'Usage: endDt={endDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: waitInterval in: path description: 'Usage: waitInterval={waitInterval}' required: true schema: type: string nullable: true - name: clientTimeZone in: path description: 'Usage: clientTimeZone={clientTimeZone}' required: true schema: type: string nullable: true - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of BreachesSla type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.BreachesSla' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportCallCostByExtensionGroup/Pbx.GetCallCostByExtensionGroupData(periodFrom={periodFrom},periodTo={periodTo},groupFilter={groupFilter},callClass={callClass})': description: Provides operations to call the GetCallCostByExtensionGroupData method. get: tags: - ReportCallCostByExtensionGroup summary: Invoke function GetCallCostByExtensionGroupData operationId: GetCallCostByExtensionGroupData parameters: - name: periodFrom in: path description: 'Usage: periodFrom={periodFrom}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: periodTo in: path description: 'Usage: periodTo={periodTo}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: groupFilter in: path description: 'Usage: groupFilter={groupFilter}' required: true schema: type: string nullable: true - name: callClass in: path description: 'Usage: callClass={callClass}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of CallCostByExtensionGroup type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.CallCostByExtensionGroup' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportCallCostByExtensionGroup/Pbx.DownloadCallCostByExtensionGroup(periodFrom={periodFrom},periodTo={periodTo},groupFilter={groupFilter},callClass={callClass},clientTimeZone={clientTimeZone})': description: Provides operations to call the DownloadCallCostByExtensionGroup method. get: tags: - ReportCallCostByExtensionGroup summary: Invoke function DownloadCallCostByExtensionGroup operationId: DownloadCallCostByExtensionGroup parameters: - name: periodFrom in: path description: 'Usage: periodFrom={periodFrom}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: periodTo in: path description: 'Usage: periodTo={periodTo}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: groupFilter in: path description: 'Usage: groupFilter={groupFilter}' required: true schema: type: string nullable: true - name: callClass in: path description: 'Usage: callClass={callClass}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 - name: clientTimeZone in: path description: 'Usage: clientTimeZone={clientTimeZone}' required: true schema: type: string nullable: true - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of CallCostByExtensionGroup type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.CallCostByExtensionGroup' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportCallDistribution/Pbx.GetCallDistribution(clientTimeZone={clientTimeZone},periodFrom={periodFrom},periodTo={periodTo},groupNumber={groupNumber},extensionDns={extensionDns},waitInterval={waitInterval},includeQueueCalls={includeQueueCalls},callArea={callArea},groupingType={groupingType})': description: Provides operations to call the GetCallDistribution method. get: tags: - ReportCallDistribution summary: Invoke function GetCallDistribution operationId: GetCallDistribution parameters: - name: clientTimeZone in: path description: 'Usage: clientTimeZone={clientTimeZone}' required: true schema: type: string nullable: true - name: periodFrom in: path description: 'Usage: periodFrom={periodFrom}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: periodTo in: path description: 'Usage: periodTo={periodTo}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: groupNumber in: path description: 'Usage: groupNumber={groupNumber}' required: true schema: type: string nullable: true - name: extensionDns in: path description: 'Usage: extensionDns={extensionDns}' required: true schema: type: string nullable: true - name: waitInterval in: path description: 'Usage: waitInterval={waitInterval}' required: true schema: type: string nullable: true - name: includeQueueCalls in: path description: 'Usage: includeQueueCalls={includeQueueCalls}' required: true schema: type: boolean default: false - name: callArea in: path description: 'Usage: callArea={callArea}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 - name: groupingType in: path description: 'Usage: groupingType={groupingType}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of CallDistribution type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.CallDistribution' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportCallDistribution/Pbx.DownloadGetGetCallDistribution(clientTimeZone={clientTimeZone},periodFrom={periodFrom},periodTo={periodTo},groupNumber={groupNumber},extensionDns={extensionDns},waitInterval={waitInterval},includeQueueCalls={includeQueueCalls},callArea={callArea},groupingType={groupingType})': description: Provides operations to call the DownloadGetGetCallDistribution method. get: tags: - ReportCallDistribution summary: Invoke function DownloadGetGetCallDistribution operationId: DownloadGetGetCallDistribution parameters: - name: clientTimeZone in: path description: 'Usage: clientTimeZone={clientTimeZone}' required: true schema: type: string nullable: true - name: periodFrom in: path description: 'Usage: periodFrom={periodFrom}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: periodTo in: path description: 'Usage: periodTo={periodTo}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: groupNumber in: path description: 'Usage: groupNumber={groupNumber}' required: true schema: type: string nullable: true - name: extensionDns in: path description: 'Usage: extensionDns={extensionDns}' required: true schema: type: string nullable: true - name: waitInterval in: path description: 'Usage: waitInterval={waitInterval}' required: true schema: type: string nullable: true - name: includeQueueCalls in: path description: 'Usage: includeQueueCalls={includeQueueCalls}' required: true schema: type: boolean default: false - name: callArea in: path description: 'Usage: callArea={callArea}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 - name: groupingType in: path description: 'Usage: groupingType={groupingType}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of CallDistribution type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.CallDistribution' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportCallLogData/Pbx.GetCallLogData(periodFrom={periodFrom},periodTo={periodTo},sourceType={sourceType},sourceFilter={sourceFilter},destinationType={destinationType},destinationFilter={destinationFilter},callsType={callsType},callTimeFilterType={callTimeFilterType},callTimeFilterFrom={callTimeFilterFrom},callTimeFilterTo={callTimeFilterTo},hidePcalls={hidePcalls})': description: Provides operations to call the GetCallLogData method. get: tags: - ReportCallLogData summary: Invoke function GetCallLogData operationId: GetCallLogData parameters: - name: periodFrom in: path description: 'Usage: periodFrom={periodFrom}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: periodTo in: path description: 'Usage: periodTo={periodTo}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: sourceType in: path description: 'Usage: sourceType={sourceType}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 - name: sourceFilter in: path description: 'Usage: sourceFilter={sourceFilter}' required: true schema: type: string nullable: true - name: destinationType in: path description: 'Usage: destinationType={destinationType}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 - name: destinationFilter in: path description: 'Usage: destinationFilter={destinationFilter}' required: true schema: type: string nullable: true - name: callsType in: path description: 'Usage: callsType={callsType}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 - name: callTimeFilterType in: path description: 'Usage: callTimeFilterType={callTimeFilterType}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 - name: callTimeFilterFrom in: path description: 'Usage: callTimeFilterFrom={callTimeFilterFrom}' required: true schema: type: string nullable: true - name: callTimeFilterTo in: path description: 'Usage: callTimeFilterTo={callTimeFilterTo}' required: true schema: type: string nullable: true - name: hidePcalls in: path description: 'Usage: hidePcalls={hidePcalls}' required: true schema: type: boolean default: false - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of CallLogData type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.CallLogData' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportCallLogData/Pbx.GetOldCallLogData(periodFrom={periodFrom},periodTo={periodTo},sourceType={sourceType},sourceFilter={sourceFilter},destinationType={destinationType},destinationFilter={destinationFilter},callsType={callsType},callTimeFilterType={callTimeFilterType},callTimeFilterFrom={callTimeFilterFrom},callTimeFilterTo={callTimeFilterTo},hidePcalls={hidePcalls})': description: Provides operations to call the GetOldCallLogData method. get: tags: - ReportCallLogData summary: Invoke function GetOldCallLogData operationId: GetOldCallLogData parameters: - name: periodFrom in: path description: 'Usage: periodFrom={periodFrom}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: periodTo in: path description: 'Usage: periodTo={periodTo}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: sourceType in: path description: 'Usage: sourceType={sourceType}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 - name: sourceFilter in: path description: 'Usage: sourceFilter={sourceFilter}' required: true schema: type: string nullable: true - name: destinationType in: path description: 'Usage: destinationType={destinationType}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 - name: destinationFilter in: path description: 'Usage: destinationFilter={destinationFilter}' required: true schema: type: string nullable: true - name: callsType in: path description: 'Usage: callsType={callsType}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 - name: callTimeFilterType in: path description: 'Usage: callTimeFilterType={callTimeFilterType}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 - name: callTimeFilterFrom in: path description: 'Usage: callTimeFilterFrom={callTimeFilterFrom}' required: true schema: type: string nullable: true - name: callTimeFilterTo in: path description: 'Usage: callTimeFilterTo={callTimeFilterTo}' required: true schema: type: string nullable: true - name: hidePcalls in: path description: 'Usage: hidePcalls={hidePcalls}' required: true schema: type: boolean default: false - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of CallLogData type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.CallLogData' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportCallLogData/Pbx.DownloadCallLog(periodFrom={periodFrom},periodTo={periodTo},sourceType={sourceType},sourceFilter={sourceFilter},destinationType={destinationType},destinationFilter={destinationFilter},callsType={callsType},callTimeFilterType={callTimeFilterType},callTimeFilterFrom={callTimeFilterFrom},callTimeFilterTo={callTimeFilterTo},hidePcalls={hidePcalls},clientTimeZone={clientTimeZone})': description: Provides operations to call the DownloadCallLog method. get: tags: - ReportCallLogData summary: Invoke function DownloadCallLog operationId: DownloadCallLog parameters: - name: periodFrom in: path description: 'Usage: periodFrom={periodFrom}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: periodTo in: path description: 'Usage: periodTo={periodTo}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: sourceType in: path description: 'Usage: sourceType={sourceType}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 - name: sourceFilter in: path description: 'Usage: sourceFilter={sourceFilter}' required: true schema: type: string nullable: true - name: destinationType in: path description: 'Usage: destinationType={destinationType}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 - name: destinationFilter in: path description: 'Usage: destinationFilter={destinationFilter}' required: true schema: type: string nullable: true - name: callsType in: path description: 'Usage: callsType={callsType}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 - name: callTimeFilterType in: path description: 'Usage: callTimeFilterType={callTimeFilterType}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 - name: callTimeFilterFrom in: path description: 'Usage: callTimeFilterFrom={callTimeFilterFrom}' required: true schema: type: string nullable: true - name: callTimeFilterTo in: path description: 'Usage: callTimeFilterTo={callTimeFilterTo}' required: true schema: type: string nullable: true - name: hidePcalls in: path description: 'Usage: hidePcalls={hidePcalls}' required: true schema: type: boolean default: false - name: clientTimeZone in: path description: 'Usage: clientTimeZone={clientTimeZone}' required: true schema: type: string nullable: true - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of CallLogData type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.CallLogData' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportCallLogData/Pbx.GetCallQualityReport(cdrId={cdrId},srcNumber={srcNumber},dstNumber={dstNumber},srcCallerId={srcCallerId},dstCallerId={dstCallerId})': description: Provides operations to call the GetCallQualityReport method. get: tags: - ReportCallLogData summary: Invoke function GetCallQualityReport operationId: GetCallQualityReport parameters: - name: cdrId in: path description: 'Usage: cdrId={cdrId}' required: true schema: type: string - name: srcNumber in: path description: 'Usage: srcNumber={srcNumber}' required: true schema: type: string - name: dstNumber in: path description: 'Usage: dstNumber={dstNumber}' required: true schema: type: string - name: srcCallerId in: path description: 'Usage: srcCallerId={srcCallerId}' required: true schema: type: string nullable: true - name: dstCallerId in: path description: 'Usage: dstCallerId={dstCallerId}' required: true schema: type: string nullable: true responses: '200': description: Success content: application/json: schema: allOf: - $ref: '#/components/schemas/Pbx.QualityReport' nullable: true default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportCallLogData/Pbx.GetOldCallQualityReport(call_id={call_id},srcNumber={srcNumber},dstNumber={dstNumber},srcCallerId={srcCallerId},dstCallerId={dstCallerId})': description: Provides operations to call the GetOldCallQualityReport method. get: tags: - ReportCallLogData summary: Invoke function GetOldCallQualityReport operationId: GetOldCallQualityReport parameters: - name: call_id in: path description: 'Usage: call_id={call_id}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 - name: srcNumber in: path description: 'Usage: srcNumber={srcNumber}' required: true schema: type: string - name: dstNumber in: path description: 'Usage: dstNumber={dstNumber}' required: true schema: type: string - name: srcCallerId in: path description: 'Usage: srcCallerId={srcCallerId}' required: true schema: type: string nullable: true - name: dstCallerId in: path description: 'Usage: dstCallerId={dstCallerId}' required: true schema: type: string nullable: true responses: '200': description: Success content: application/json: schema: allOf: - $ref: '#/components/schemas/Pbx.QualityReport' nullable: true default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportDetailedQueueStatistics/Pbx.GetDetailedQueueStatisticsData(queueDnStr={queueDnStr},startDt={startDt},endDt={endDt},waitInterval={waitInterval})': description: Provides operations to call the GetDetailedQueueStatisticsData method. get: tags: - ReportDetailedQueueStatistics summary: Invoke function GetDetailedQueueStatisticsData operationId: GetDetailedQueueStatisticsData parameters: - name: queueDnStr in: path description: 'Usage: queueDnStr={queueDnStr}' required: true schema: type: string nullable: true - name: startDt in: path description: 'Usage: startDt={startDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: endDt in: path description: 'Usage: endDt={endDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: waitInterval in: path description: 'Usage: waitInterval={waitInterval}' required: true schema: type: string nullable: true - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of DetailedQueueStatistics type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.DetailedQueueStatistics' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportDetailedQueueStatistics/Pbx.DownloadDetailedQueueStatistics(queueDnStr={queueDnStr},startDt={startDt},endDt={endDt},waitInterval={waitInterval})': description: Provides operations to call the DownloadDetailedQueueStatistics method. get: tags: - ReportDetailedQueueStatistics summary: Invoke function DownloadDetailedQueueStatistics operationId: DownloadDetailedQueueStatistics parameters: - name: queueDnStr in: path description: 'Usage: queueDnStr={queueDnStr}' required: true schema: type: string nullable: true - name: startDt in: path description: 'Usage: startDt={startDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: endDt in: path description: 'Usage: endDt={endDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: waitInterval in: path description: 'Usage: waitInterval={waitInterval}' required: true schema: type: string nullable: true - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of DetailedQueueStatistics type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.DetailedQueueStatistics' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportExtensionsStatisticsByRingGroups/Pbx.GetExtensionsStatisticsByRingGroupsData(periodFrom={periodFrom},periodTo={periodTo},ringGroupDns={ringGroupDns})': description: Provides operations to call the GetExtensionsStatisticsByRingGroupsData method. get: tags: - ReportExtensionsStatisticsByRingGroups summary: Invoke function GetExtensionsStatisticsByRingGroupsData operationId: GetExtensionsStatisticsByRingGroupsData parameters: - name: periodFrom in: path description: 'Usage: periodFrom={periodFrom}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: periodTo in: path description: 'Usage: periodTo={periodTo}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: ringGroupDns in: path description: 'Usage: ringGroupDns={ringGroupDns}' required: true schema: type: string nullable: true - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of ExtensionsStatisticsByRingGroups type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.ExtensionsStatisticsByRingGroups' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportExtensionsStatisticsByRingGroups/Pbx.DownloadExtensionsStatisticsByRingGroups(periodFrom={periodFrom},periodTo={periodTo},ringGroupDns={ringGroupDns})': description: Provides operations to call the DownloadExtensionsStatisticsByRingGroups method. get: tags: - ReportExtensionsStatisticsByRingGroups summary: Invoke function DownloadExtensionsStatisticsByRingGroups operationId: DownloadExtensionsStatisticsByRingGroups parameters: - name: periodFrom in: path description: 'Usage: periodFrom={periodFrom}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: periodTo in: path description: 'Usage: periodTo={periodTo}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: ringGroupDns in: path description: 'Usage: ringGroupDns={ringGroupDns}' required: true schema: type: string nullable: true - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of ExtensionsStatisticsByRingGroups type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.ExtensionsStatisticsByRingGroups' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportExtensionStatisticsByGroup/Pbx.GetExtensionStatisticsByGroupData(groupNumber={groupNumber},periodFrom={periodFrom},periodTo={periodTo},callArea={callArea})': description: Provides operations to call the GetExtensionStatisticsByGroupData method. get: tags: - ReportExtensionStatisticsByGroup summary: Invoke function GetExtensionStatisticsByGroupData operationId: GetExtensionStatisticsByGroupData parameters: - name: groupNumber in: path description: 'Usage: groupNumber={groupNumber}' required: true schema: type: string nullable: true - name: periodFrom in: path description: 'Usage: periodFrom={periodFrom}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: periodTo in: path description: 'Usage: periodTo={periodTo}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: callArea in: path description: 'Usage: callArea={callArea}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of ReportExtensionStatisticsByGroup type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.ReportExtensionStatisticsByGroup' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportExtensionStatisticsByGroup/Pbx.DownloadExtensionStatisticsByGroup(groupNumber={groupNumber},periodFrom={periodFrom},periodTo={periodTo},callArea={callArea})': description: Provides operations to call the DownloadExtensionStatisticsByGroup method. get: tags: - ReportExtensionStatisticsByGroup summary: Invoke function DownloadExtensionStatisticsByGroup operationId: DownloadExtensionStatisticsByGroup parameters: - name: groupNumber in: path description: 'Usage: groupNumber={groupNumber}' required: true schema: type: string nullable: true - name: periodFrom in: path description: 'Usage: periodFrom={periodFrom}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: periodTo in: path description: 'Usage: periodTo={periodTo}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: callArea in: path description: 'Usage: callArea={callArea}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of ReportExtensionStatisticsByGroup type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.ReportExtensionStatisticsByGroup' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportExtensionStatistics/Pbx.GetExtensionStatisticsData(periodFrom={periodFrom},periodTo={periodTo},extensionFilter={extensionFilter},callArea={callArea})': description: Provides operations to call the GetExtensionStatisticsData method. get: tags: - ReportExtensionStatistics summary: Invoke function GetExtensionStatisticsData operationId: GetExtensionStatisticsData parameters: - name: periodFrom in: path description: 'Usage: periodFrom={periodFrom}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: periodTo in: path description: 'Usage: periodTo={periodTo}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: extensionFilter in: path description: 'Usage: extensionFilter={extensionFilter}' required: true schema: type: string nullable: true - name: callArea in: path description: 'Usage: callArea={callArea}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of ExtensionStatistics type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.ExtensionStatistics' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportExtensionStatistics/Pbx.DownloadExtensionStatistics(periodFrom={periodFrom},periodTo={periodTo},extensionFilter={extensionFilter},callArea={callArea})': description: Provides operations to call the DownloadExtensionStatistics method. get: tags: - ReportExtensionStatistics summary: Invoke function DownloadExtensionStatistics operationId: DownloadExtensionStatistics parameters: - name: periodFrom in: path description: 'Usage: periodFrom={periodFrom}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: periodTo in: path description: 'Usage: periodTo={periodTo}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: extensionFilter in: path description: 'Usage: extensionFilter={extensionFilter}' required: true schema: type: string nullable: true - name: callArea in: path description: 'Usage: callArea={callArea}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of ExtensionStatistics type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.ExtensionStatistics' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /ReportInboundRules/Pbx.GetInboundRulesData(): description: Provides operations to call the GetInboundRulesData method. get: tags: - ReportInboundRules summary: Invoke function GetInboundRulesData operationId: GetInboundRulesData parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of InboundRuleReport type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.InboundRuleReport' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /ReportInboundRules/Pbx.DownloadInboundRules(): description: Provides operations to call the DownloadInboundRules method. get: tags: - ReportInboundRules summary: Invoke function DownloadInboundRules operationId: DownloadInboundRules parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of InboundRuleReport type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.InboundRuleReport' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportQueueAgentsChatStatistics/Pbx.GetQueueAgentsChatStatisticsData(queueDnStr={queueDnStr},startDt={startDt},endDt={endDt},participantType={participantType})': description: Provides operations to call the GetQueueAgentsChatStatisticsData method. get: tags: - ReportQueueAgentsChatStatistics summary: Invoke function GetQueueAgentsChatStatisticsData operationId: GetQueueAgentsChatStatisticsData parameters: - name: queueDnStr in: path description: 'Usage: queueDnStr={queueDnStr}' required: true schema: type: string nullable: true - name: startDt in: path description: 'Usage: startDt={startDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: endDt in: path description: 'Usage: endDt={endDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: participantType in: path description: 'Usage: participantType={participantType}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of QueueAgentsChatStatistics type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.QueueAgentsChatStatistics' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportQueueAgentsChatStatistics/Pbx.DownloadQueueAgentsChatStatistics(queueDnStr={queueDnStr},startDt={startDt},endDt={endDt},participantType={participantType})': description: Provides operations to call the DownloadQueueAgentsChatStatistics method. get: tags: - ReportQueueAgentsChatStatistics summary: Invoke function DownloadQueueAgentsChatStatistics operationId: DownloadQueueAgentsChatStatistics parameters: - name: queueDnStr in: path description: 'Usage: queueDnStr={queueDnStr}' required: true schema: type: string nullable: true - name: startDt in: path description: 'Usage: startDt={startDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: endDt in: path description: 'Usage: endDt={endDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: participantType in: path description: 'Usage: participantType={participantType}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of QueueAgentsChatStatistics type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.QueueAgentsChatStatistics' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportQueueAgentsChatStatisticsTotals/Pbx.GetQueueAgentsChatStatisticsTotalsData(queueDnStr={queueDnStr},startDt={startDt},endDt={endDt},participantType={participantType})': description: Provides operations to call the GetQueueAgentsChatStatisticsTotalsData method. get: tags: - ReportQueueAgentsChatStatisticsTotals summary: Invoke function GetQueueAgentsChatStatisticsTotalsData operationId: GetQueueAgentsChatStatisticsTotalsData parameters: - name: queueDnStr in: path description: 'Usage: queueDnStr={queueDnStr}' required: true schema: type: string nullable: true - name: startDt in: path description: 'Usage: startDt={startDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: endDt in: path description: 'Usage: endDt={endDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: participantType in: path description: 'Usage: participantType={participantType}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of QueueAgentsChatStatisticsTotals type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.QueueAgentsChatStatisticsTotals' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportQueueAgentsChatStatisticsTotals/Pbx.DownloadQueueAgentsChatStatisticsTotals(queueDnStr={queueDnStr},startDt={startDt},endDt={endDt},participantType={participantType})': description: Provides operations to call the DownloadQueueAgentsChatStatisticsTotals method. get: tags: - ReportQueueAgentsChatStatisticsTotals summary: Invoke function DownloadQueueAgentsChatStatisticsTotals operationId: DownloadQueueAgentsChatStatisticsTotals parameters: - name: queueDnStr in: path description: 'Usage: queueDnStr={queueDnStr}' required: true schema: type: string nullable: true - name: startDt in: path description: 'Usage: startDt={startDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: endDt in: path description: 'Usage: endDt={endDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: participantType in: path description: 'Usage: participantType={participantType}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of QueueAgentsChatStatisticsTotals type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.QueueAgentsChatStatisticsTotals' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportQueueAnsweredCallsByWaitTime/Pbx.GetQueueAnsweredCallsByWaitTimeData(queueDnStr={queueDnStr},startDt={startDt},endDt={endDt},answerInterval={answerInterval})': description: Provides operations to call the GetQueueAnsweredCallsByWaitTimeData method. get: tags: - ReportQueueAnsweredCallsByWaitTime summary: Invoke function GetQueueAnsweredCallsByWaitTimeData operationId: GetQueueAnsweredCallsByWaitTimeData parameters: - name: queueDnStr in: path description: 'Usage: queueDnStr={queueDnStr}' required: true schema: type: string nullable: true - name: startDt in: path description: 'Usage: startDt={startDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: endDt in: path description: 'Usage: endDt={endDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: answerInterval in: path description: 'Usage: answerInterval={answerInterval}' required: true schema: type: string nullable: true - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of QueueAnsweredCallsByWaitTime type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.QueueAnsweredCallsByWaitTime' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportQueueAnsweredCallsByWaitTime/Pbx.DownloadQueueAnsweredCallsByWaitTime(queueDnStr={queueDnStr},startDt={startDt},endDt={endDt},answerInterval={answerInterval},clientTimeZone={clientTimeZone})': description: Provides operations to call the DownloadQueueAnsweredCallsByWaitTime method. get: tags: - ReportQueueAnsweredCallsByWaitTime summary: Invoke function DownloadQueueAnsweredCallsByWaitTime operationId: DownloadQueueAnsweredCallsByWaitTime parameters: - name: queueDnStr in: path description: 'Usage: queueDnStr={queueDnStr}' required: true schema: type: string nullable: true - name: startDt in: path description: 'Usage: startDt={startDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: endDt in: path description: 'Usage: endDt={endDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: answerInterval in: path description: 'Usage: answerInterval={answerInterval}' required: true schema: type: string nullable: true - name: clientTimeZone in: path description: 'Usage: clientTimeZone={clientTimeZone}' required: true schema: type: string nullable: true - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of QueueAnsweredCallsByWaitTime type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.QueueAnsweredCallsByWaitTime' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportQueueAnUnCalls/Pbx.GetQueueAnUnCallsData(chartDate={chartDate},chartBy={chartBy},queueDnStr={queueDnStr},clientTimeZone={clientTimeZone},waitInterval={waitInterval})': description: Provides operations to call the GetQueueAnUnCallsData method. get: tags: - ReportQueueAnUnCalls summary: Invoke function GetQueueAnUnCallsData operationId: GetQueueAnUnCallsData parameters: - name: chartDate in: path description: 'Usage: chartDate={chartDate}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: chartBy in: path description: 'Usage: chartBy={chartBy}' required: true schema: type: string nullable: true - name: queueDnStr in: path description: 'Usage: queueDnStr={queueDnStr}' required: true schema: type: string nullable: true - name: clientTimeZone in: path description: 'Usage: clientTimeZone={clientTimeZone}' required: true schema: type: string nullable: true - name: waitInterval in: path description: 'Usage: waitInterval={waitInterval}' required: true schema: type: string nullable: true - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of TimeReportData type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.TimeReportData' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportQueueAnUnCalls/Pbx.DownloadQueueAnUnCallsReport(chartDate={chartDate},chartBy={chartBy},queueDnStr={queueDnStr},clientTimeZone={clientTimeZone},waitInterval={waitInterval})': description: Provides operations to call the DownloadQueueAnUnCallsReport method. get: tags: - ReportQueueAnUnCalls summary: Invoke function DownloadQueueAnUnCallsReport operationId: DownloadQueueAnUnCallsReport parameters: - name: chartDate in: path description: 'Usage: chartDate={chartDate}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: chartBy in: path description: 'Usage: chartBy={chartBy}' required: true schema: type: string nullable: true - name: queueDnStr in: path description: 'Usage: queueDnStr={queueDnStr}' required: true schema: type: string nullable: true - name: clientTimeZone in: path description: 'Usage: clientTimeZone={clientTimeZone}' required: true schema: type: string nullable: true - name: waitInterval in: path description: 'Usage: waitInterval={waitInterval}' required: true schema: type: string nullable: true - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of TimeReportData type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.TimeReportData' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportQueueCallbacks/Pbx.GetQueueCallbacksData(queueDnStr={queueDnStr},startDt={startDt},endDt={endDt})': description: Provides operations to call the GetQueueCallbacksData method. get: tags: - ReportQueueCallbacks summary: Invoke function GetQueueCallbacksData operationId: GetQueueCallbacksData parameters: - name: queueDnStr in: path description: 'Usage: queueDnStr={queueDnStr}' required: true schema: type: string nullable: true - name: startDt in: path description: 'Usage: startDt={startDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: endDt in: path description: 'Usage: endDt={endDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of QueueCallbacks type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.QueueCallbacks' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportQueueCallbacks/Pbx.DownloadQueueCallbacks(queueDnStr={queueDnStr},startDt={startDt},endDt={endDt})': description: Provides operations to call the DownloadQueueCallbacks method. get: tags: - ReportQueueCallbacks summary: Invoke function DownloadQueueCallbacks operationId: DownloadQueueCallbacks parameters: - name: queueDnStr in: path description: 'Usage: queueDnStr={queueDnStr}' required: true schema: type: string nullable: true - name: startDt in: path description: 'Usage: startDt={startDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: endDt in: path description: 'Usage: endDt={endDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of QueueCallbacks type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.QueueCallbacks' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportQueueChatPerformance/Pbx.GetQueueChatPerformanceData(queueDnStr={queueDnStr},startDt={startDt},endDt={endDt},participantType={participantType})': description: Provides operations to call the GetQueueChatPerformanceData method. get: tags: - ReportQueueChatPerformance summary: Invoke function GetQueueChatPerformanceData operationId: GetQueueChatPerformanceData parameters: - name: queueDnStr in: path description: 'Usage: queueDnStr={queueDnStr}' required: true schema: type: string nullable: true - name: startDt in: path description: 'Usage: startDt={startDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: endDt in: path description: 'Usage: endDt={endDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: participantType in: path description: 'Usage: participantType={participantType}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of QueueChatPerformance type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.QueueChatPerformance' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportQueueChatPerformance/Pbx.DownloadQueueChatPerformance(queueDnStr={queueDnStr},startDt={startDt},endDt={endDt},participantType={participantType})': description: Provides operations to call the DownloadQueueChatPerformance method. get: tags: - ReportQueueChatPerformance summary: Invoke function DownloadQueueChatPerformance operationId: DownloadQueueChatPerformance parameters: - name: queueDnStr in: path description: 'Usage: queueDnStr={queueDnStr}' required: true schema: type: string nullable: true - name: startDt in: path description: 'Usage: startDt={startDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: endDt in: path description: 'Usage: endDt={endDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: participantType in: path description: 'Usage: participantType={participantType}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of QueueChatPerformance type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.QueueChatPerformance' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportQueueFailedCallbacks/Pbx.GetQueueFailedCallbacksData(queueDnStr={queueDnStr},startDt={startDt},endDt={endDt})': description: Provides operations to call the GetQueueFailedCallbacksData method. get: tags: - ReportQueueFailedCallbacks summary: Invoke function GetQueueFailedCallbacksData operationId: GetQueueFailedCallbacksData parameters: - name: queueDnStr in: path description: 'Usage: queueDnStr={queueDnStr}' required: true schema: type: string nullable: true - name: startDt in: path description: 'Usage: startDt={startDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: endDt in: path description: 'Usage: endDt={endDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of QueueFailedCallbacks type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.QueueFailedCallbacks' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportQueueFailedCallbacks/Pbx.DownloadQueueFailedCallbacks(queueDnStr={queueDnStr},startDt={startDt},endDt={endDt},clientTimeZone={clientTimeZone})': description: Provides operations to call the DownloadQueueFailedCallbacks method. get: tags: - ReportQueueFailedCallbacks summary: Invoke function DownloadQueueFailedCallbacks operationId: DownloadQueueFailedCallbacks parameters: - name: queueDnStr in: path description: 'Usage: queueDnStr={queueDnStr}' required: true schema: type: string nullable: true - name: startDt in: path description: 'Usage: startDt={startDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: endDt in: path description: 'Usage: endDt={endDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: clientTimeZone in: path description: 'Usage: clientTimeZone={clientTimeZone}' required: true schema: type: string nullable: true - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of QueueFailedCallbacks type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.QueueFailedCallbacks' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportQueuePerformanceOverview/Pbx.GetQueuePerformanceOverviewData(periodFrom={periodFrom},periodTo={periodTo},queueDns={queueDns},waitInterval={waitInterval})': description: Provides operations to call the GetQueuePerformanceOverviewData method. get: tags: - ReportQueuePerformanceOverview summary: Invoke function GetQueuePerformanceOverviewData operationId: GetQueuePerformanceOverviewData parameters: - name: periodFrom in: path description: 'Usage: periodFrom={periodFrom}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: periodTo in: path description: 'Usage: periodTo={periodTo}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: queueDns in: path description: 'Usage: queueDns={queueDns}' required: true schema: type: string nullable: true - name: waitInterval in: path description: 'Usage: waitInterval={waitInterval}' required: true schema: type: string nullable: true - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of QueuePerformanceOverview type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.QueuePerformanceOverview' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportQueuePerformanceOverview/Pbx.DownloadQueuePerformanceOverview(periodFrom={periodFrom},periodTo={periodTo},queueDns={queueDns},waitInterval={waitInterval})': description: Provides operations to call the DownloadQueuePerformanceOverview method. get: tags: - ReportQueuePerformanceOverview summary: Invoke function DownloadQueuePerformanceOverview operationId: DownloadQueuePerformanceOverview parameters: - name: periodFrom in: path description: 'Usage: periodFrom={periodFrom}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: periodTo in: path description: 'Usage: periodTo={periodTo}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: queueDns in: path description: 'Usage: queueDns={queueDns}' required: true schema: type: string nullable: true - name: waitInterval in: path description: 'Usage: waitInterval={waitInterval}' required: true schema: type: string nullable: true - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of QueuePerformanceOverview type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.QueuePerformanceOverview' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportQueuePerformanceTotals/Pbx.GetQueuePerformanceTotalsData(periodFrom={periodFrom},periodTo={periodTo},queueDns={queueDns},waitInterval={waitInterval})': description: Provides operations to call the GetQueuePerformanceTotalsData method. get: tags: - ReportQueuePerformanceTotals summary: Invoke function GetQueuePerformanceTotalsData operationId: GetQueuePerformanceTotalsData parameters: - name: periodFrom in: path description: 'Usage: periodFrom={periodFrom}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: periodTo in: path description: 'Usage: periodTo={periodTo}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: queueDns in: path description: 'Usage: queueDns={queueDns}' required: true schema: type: string nullable: true - name: waitInterval in: path description: 'Usage: waitInterval={waitInterval}' required: true schema: type: string nullable: true - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of QueuePerformanceTotals type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.QueuePerformanceTotals' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportQueuePerformanceTotals/Pbx.DownloadQueuePerformanceTotals(periodFrom={periodFrom},periodTo={periodTo},queueDns={queueDns},waitInterval={waitInterval})': description: Provides operations to call the DownloadQueuePerformanceTotals method. get: tags: - ReportQueuePerformanceTotals summary: Invoke function DownloadQueuePerformanceTotals operationId: DownloadQueuePerformanceTotals parameters: - name: periodFrom in: path description: 'Usage: periodFrom={periodFrom}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: periodTo in: path description: 'Usage: periodTo={periodTo}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: queueDns in: path description: 'Usage: queueDns={queueDns}' required: true schema: type: string nullable: true - name: waitInterval in: path description: 'Usage: waitInterval={waitInterval}' required: true schema: type: string nullable: true - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of QueuePerformanceTotals type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.QueuePerformanceTotals' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportRingGroupStatistics/Pbx.GetRingGroupStatisticsData(periodFrom={periodFrom},periodTo={periodTo},ringGroupDns={ringGroupDns})': description: Provides operations to call the GetRingGroupStatisticsData method. get: tags: - ReportRingGroupStatistics summary: Invoke function GetRingGroupStatisticsData operationId: GetRingGroupStatisticsData parameters: - name: periodFrom in: path description: 'Usage: periodFrom={periodFrom}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: periodTo in: path description: 'Usage: periodTo={periodTo}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: ringGroupDns in: path description: 'Usage: ringGroupDns={ringGroupDns}' required: true schema: type: string nullable: true - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of RingGroupStatistics type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.RingGroupStatistics' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportRingGroupStatistics/Pbx.DownloadRingGroupStatistics(periodFrom={periodFrom},periodTo={periodTo},ringGroupDns={ringGroupDns})': description: Provides operations to call the DownloadRingGroupStatistics method. get: tags: - ReportRingGroupStatistics summary: Invoke function DownloadRingGroupStatistics operationId: DownloadRingGroupStatistics parameters: - name: periodFrom in: path description: 'Usage: periodFrom={periodFrom}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: periodTo in: path description: 'Usage: periodTo={periodTo}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: ringGroupDns in: path description: 'Usage: ringGroupDns={ringGroupDns}' required: true schema: type: string nullable: true - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of RingGroupStatistics type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.RingGroupStatistics' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportStatisticSla/Pbx.GetStatisticSlaData(queueDnStr={queueDnStr},startDt={startDt},endDt={endDt},waitInterval={waitInterval})': description: Provides operations to call the GetStatisticSlaData method. get: tags: - ReportStatisticSla summary: Invoke function GetStatisticSlaData operationId: GetStatisticSlaData parameters: - name: queueDnStr in: path description: 'Usage: queueDnStr={queueDnStr}' required: true schema: type: string nullable: true - name: startDt in: path description: 'Usage: startDt={startDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: endDt in: path description: 'Usage: endDt={endDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: waitInterval in: path description: 'Usage: waitInterval={waitInterval}' required: true schema: type: string nullable: true - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of StatisticSla type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.StatisticSla' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportStatisticSla/Pbx.DownloadStatisticSla(queueDnStr={queueDnStr},startDt={startDt},endDt={endDt},waitInterval={waitInterval})': description: Provides operations to call the DownloadStatisticSla method. get: tags: - ReportStatisticSla summary: Invoke function DownloadStatisticSla operationId: DownloadStatisticSla parameters: - name: queueDnStr in: path description: 'Usage: queueDnStr={queueDnStr}' required: true schema: type: string nullable: true - name: startDt in: path description: 'Usage: startDt={startDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: endDt in: path description: 'Usage: endDt={endDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: waitInterval in: path description: 'Usage: waitInterval={waitInterval}' required: true schema: type: string nullable: true - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of StatisticSla type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.StatisticSla' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportTeamQueueGeneralStatistics/Pbx.GetTeamQueueGeneralStatisticsData(queueDnStr={queueDnStr},startDt={startDt},endDt={endDt},waitInterval={waitInterval})': description: Provides operations to call the GetTeamQueueGeneralStatisticsData method. get: tags: - ReportTeamQueueGeneralStatistics summary: Invoke function GetTeamQueueGeneralStatisticsData operationId: GetTeamQueueGeneralStatisticsData parameters: - name: queueDnStr in: path description: 'Usage: queueDnStr={queueDnStr}' required: true schema: type: string nullable: true - name: startDt in: path description: 'Usage: startDt={startDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: endDt in: path description: 'Usage: endDt={endDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: waitInterval in: path description: 'Usage: waitInterval={waitInterval}' required: true schema: type: string nullable: true - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of TeamQueueGeneralStatistics type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.TeamQueueGeneralStatistics' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportTeamQueueGeneralStatistics/Pbx.DownloadTeamQueueGeneralStatistics(queueDnStr={queueDnStr},startDt={startDt},endDt={endDt},waitInterval={waitInterval})': description: Provides operations to call the DownloadTeamQueueGeneralStatistics method. get: tags: - ReportTeamQueueGeneralStatistics summary: Invoke function DownloadTeamQueueGeneralStatistics operationId: DownloadTeamQueueGeneralStatistics parameters: - name: queueDnStr in: path description: 'Usage: queueDnStr={queueDnStr}' required: true schema: type: string nullable: true - name: startDt in: path description: 'Usage: startDt={startDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: endDt in: path description: 'Usage: endDt={endDt}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: waitInterval in: path description: 'Usage: waitInterval={waitInterval}' required: true schema: type: string nullable: true - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of TeamQueueGeneralStatistics type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.TeamQueueGeneralStatistics' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /ScheduledReports: description: Provides operations to manage the collection of ScheduledReport entities. get: tags: - ScheduledReports summary: Get entities from ScheduledReports operationId: ListScheduledReport parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.ScheduledReportCollectionResponse' default: $ref: '#/components/responses/error' post: tags: - ScheduledReports summary: Add new entity to ScheduledReports operationId: CreateScheduledReport requestBody: description: New entity content: application/json: schema: $ref: '#/components/schemas/Pbx.ScheduledReport' required: true responses: '201': description: Created entity content: application/json: schema: $ref: '#/components/schemas/Pbx.ScheduledReport' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/ScheduledReports({Id})': description: Provides operations to manage the collection of ScheduledReport entities. get: tags: - ScheduledReports summary: Get entity from ScheduledReports by key operationId: GetScheduledReport parameters: - name: Id in: path description: The unique identifier of ScheduledReport required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: ScheduledReport - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.ScheduledReport' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - ScheduledReports summary: Update entity in ScheduledReports operationId: UpdateScheduledReport parameters: - name: Id in: path description: The unique identifier of ScheduledReport required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: ScheduledReport requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.ScheduledReport' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - ScheduledReports summary: Delete entity from ScheduledReports operationId: DeleteScheduledReport parameters: - name: Id in: path description: The unique identifier of ScheduledReport required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: ScheduledReport - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/RingGroups(Number={Number})': description: Provides operations to manage the collection of RingGroup entities. get: tags: - RingGroups summary: Get entity from RingGroups by key (Number) operationId: GetRingGroupByNumber parameters: - name: Number in: path description: Alternate key of RingGroup required: true schema: type: string nullable: true - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.RingGroup' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/RingGroups({Id})': description: Provides operations to manage the collection of RingGroup entities. get: tags: - RingGroups summary: Get entity from RingGroups by key operationId: GetRingGroup parameters: - name: Id in: path description: The unique identifier of RingGroup required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: RingGroup - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.RingGroup' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - RingGroups summary: Update entity in RingGroups operationId: UpdateRingGroup parameters: - name: Id in: path description: The unique identifier of RingGroup required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: RingGroup requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.RingGroup' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - RingGroups summary: Delete entity from RingGroups operationId: DeleteRingGroup parameters: - name: Id in: path description: The unique identifier of RingGroup required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: RingGroup - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /RingGroups: description: Provides operations to manage the collection of RingGroup entities. get: tags: - RingGroups summary: Get entities from RingGroups operationId: ListRingGroup parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.RingGroupCollectionResponse' default: $ref: '#/components/responses/error' post: tags: - RingGroups summary: Add new entity to RingGroups operationId: CreateRingGroup requestBody: description: New entity content: application/json: schema: $ref: '#/components/schemas/Pbx.RingGroup' required: true responses: '201': description: Created entity content: application/json: schema: $ref: '#/components/schemas/Pbx.RingGroup' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/RingGroups({Id})/Members': description: Provides operations to manage the Members property of the Pbx.RingGroup entity. get: tags: - RingGroups summary: Get Members from RingGroups operationId: ListRingGroupMembers parameters: - name: Id in: path description: The unique identifier of RingGroup required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: RingGroup - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.RingGroupMemberCollectionResponse' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /RingGroups/Pbx.GetFirstAvailableRingGroupNumber(): description: Provides operations to call the GetFirstAvailableRingGroupNumber method. get: tags: - RingGroups summary: Invoke function GetFirstAvailableRingGroupNumber operationId: GetFirstAvailableRingGroupNumber responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.FirstAvailableNumber' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/Sbcs({Name})': description: Provides operations to manage the collection of Sbc entities. get: tags: - Sbcs summary: Get entity from Sbcs by key operationId: GetSbc parameters: - name: Name in: path description: The unique identifier of Sbc required: true schema: maxLength: 12 type: string x-ms-docs-key-type: Sbc - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Sbc' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - Sbcs summary: Update entity in Sbcs operationId: UpdateSbc parameters: - name: Name in: path description: The unique identifier of Sbc required: true schema: maxLength: 12 type: string x-ms-docs-key-type: Sbc requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.Sbc' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - Sbcs summary: Delete entity from Sbcs operationId: DeleteSbc parameters: - name: Name in: path description: The unique identifier of Sbc required: true schema: maxLength: 12 type: string x-ms-docs-key-type: Sbc - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /Sbcs: description: Provides operations to manage the collection of Sbc entities. get: tags: - Sbcs summary: Get entities from Sbcs operationId: ListSbc parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.SbcCollectionResponse' default: $ref: '#/components/responses/error' post: tags: - Sbcs summary: Add new entity to Sbcs operationId: CreateSbc requestBody: description: New entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Sbc' required: true responses: '201': description: Created entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Sbc' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/Sbcs({Name})/Pbx.PushConfig': description: Provides operations to call the PushConfig method. post: tags: - Sbcs summary: Invoke action PushConfig operationId: PushConfig parameters: - name: Name in: path description: The unique identifier of Sbc required: true schema: maxLength: 12 type: string x-ms-docs-key-type: Sbc responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /SecureSipSettings: description: Provides operations to manage the SecureSipSettings singleton. get: tags: - SecureSipSettings summary: Get SecureSipSettings operationId: GetSecureSipSettings parameters: - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.SecureSipSettings' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - SecureSipSettings summary: Update SecureSipSettings operationId: UpdateSecureSipSettings requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.SecureSipSettings' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /SecurityTokens: description: Provides operations to manage the collection of RefreshToken entities. get: tags: - SecurityTokens summary: Get entities from SecurityTokens operationId: ListSecurityRefreshToken parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.RefreshTokenCollectionResponse' default: $ref: '#/components/responses/error' '/SecurityTokens({Id})/Pbx.RevokeToken': description: Provides operations to call the RevokeToken method. post: tags: - SecurityTokens summary: Invoke action RevokeToken operationId: RevokeSecurityToken parameters: - name: Id in: path description: The unique identifier of RefreshToken required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: RefreshToken responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action '/ServicePrincipals({Id})': description: Provides operations to manage the collection of ServicePrincipal entities. get: tags: - ServicePrincipals summary: Get entity from ServicePrincipals by key operationId: GetServicePrincipal parameters: - name: Id in: path description: The unique identifier of ServicePrincipal required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: ServicePrincipal - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.ServicePrincipal' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - ServicePrincipals summary: Update entity in ServicePrincipals operationId: UpdateServicePrincipal parameters: - name: Id in: path description: The unique identifier of ServicePrincipal required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: ServicePrincipal requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.ServicePrincipal' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - ServicePrincipals summary: Delete entity from ServicePrincipals operationId: DeleteServicePrincipal parameters: - name: Id in: path description: The unique identifier of ServicePrincipal required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: ServicePrincipal - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /ServicePrincipals: description: Provides operations to manage the collection of ServicePrincipal entities. get: tags: - ServicePrincipals summary: Get entities from ServicePrincipals operationId: ListServicePrincipal parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.ServicePrincipalCollectionResponse' default: $ref: '#/components/responses/error' post: tags: - ServicePrincipals summary: Add new entity to ServicePrincipals operationId: CreateServicePrincipal requestBody: description: New entity content: application/json: schema: $ref: '#/components/schemas/Pbx.ServicePrincipal' required: true responses: '201': description: Created entity content: application/json: schema: $ref: '#/components/schemas/Pbx.ServicePrincipal' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/ServicePrincipals({Id})/Pbx.GenerateAppToken': description: Provides operations to call the GenerateAppToken method. post: tags: - ServicePrincipals summary: Invoke action GenerateAppToken operationId: GenerateAppToken parameters: - name: Id in: path description: The unique identifier of ServicePrincipal required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: ServicePrincipal responses: '200': description: Success content: application/json: schema: type: object properties: value: type: string default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Services: description: Provides operations to manage the collection of ServiceInfo entities. get: tags: - Services summary: Get entities from Services operationId: ListServiceInfo parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.ServiceInfoCollectionResponse' default: $ref: '#/components/responses/error' /Services/Pbx.GarbageCollect: description: Provides operations to call the GarbageCollect method. post: tags: - Services summary: Invoke action GarbageCollect operationId: GarbageCollect requestBody: description: Action parameters content: application/json: schema: title: ServicesGarbageCollectRequestBody type: object properties: options: $ref: '#/components/schemas/Pbx.GarbageCollect' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Services/Pbx.Start: description: Provides operations to call the Start method. post: tags: - Services summary: Invoke action Start operationId: Start requestBody: description: Action parameters content: application/json: schema: title: ServicesStartRequestBody type: object properties: options: $ref: '#/components/schemas/Pbx.XServiceManageOptions' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Services/Pbx.Stop: description: Provides operations to call the Stop method. post: tags: - Services summary: Invoke action Stop operationId: Stop requestBody: description: Action parameters content: application/json: schema: title: ServicesStopRequestBody type: object properties: options: $ref: '#/components/schemas/Pbx.XServiceManageOptions' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Services/Pbx.Enable: description: Provides operations to call the Enable method. post: tags: - Services summary: Invoke action Enable operationId: Enable requestBody: description: Action parameters content: application/json: schema: title: ServicesEnableRequestBody type: object properties: options: $ref: '#/components/schemas/Pbx.XServiceManageOptions' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Services/Pbx.Disable: description: Provides operations to call the Disable method. post: tags: - Services summary: Invoke action Disable operationId: Disable requestBody: description: Action parameters content: application/json: schema: title: ServicesDisableRequestBody type: object properties: options: $ref: '#/components/schemas/Pbx.XServiceManageOptions' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Services/Pbx.Restart: description: Provides operations to call the Restart method. post: tags: - Services summary: Invoke action Restart operationId: Restart requestBody: description: Action parameters content: application/json: schema: title: ServicesRestartRequestBody type: object properties: options: $ref: '#/components/schemas/Pbx.XServiceManageOptions' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Services/Pbx.RestartOperatingSystem: description: Provides operations to call the RestartOperatingSystem method. post: tags: - Services summary: Invoke action RestartOperatingSystem operationId: RestartOperatingSystem responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /SipDevices: description: Provides operations to manage the collection of SipDevice entities. get: tags: - SipDevices summary: Get entities from SipDevices operationId: ListSipDevice parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.SipDeviceCollectionResponse' default: $ref: '#/components/responses/error' '/SipDevices({Id})/Pbx.PushFirmware': description: Provides operations to call the PushFirmware method. post: tags: - SipDevices summary: Invoke action PushFirmware operationId: PushFirmware parameters: - name: Id in: path description: The unique identifier of SipDevice required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: SipDevice requestBody: description: Action parameters content: application/json: schema: title: SipDevicesSipDevicePushFirmwareRequestBody type: object properties: firmwareId: type: string required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /SyslogSettings: description: Provides operations to manage the SyslogSettings singleton. get: tags: - SyslogSettings summary: Get SyslogSettings operationId: GetSyslogSettings parameters: - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.SyslogSettings' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - SyslogSettings summary: Update SyslogSettings operationId: UpdateSyslogSettings requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.SyslogSettings' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /SyslogSettings/Pbx.TestConnection: description: Provides operations to call the TestConnection method. post: tags: - SyslogSettings summary: Invoke action TestConnection operationId: TestConnection requestBody: description: Action parameters content: application/json: schema: title: SyslogSettingsTestConnectionRequestBody type: object properties: config: $ref: '#/components/schemas/Pbx.SyslogSettings' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /GetDirectoryInfo: description: Provides operations to call the GetDirectoryInfo method. post: tags: - Directories summary: Invoke actionImport GetDirectoryInfo operationId: GetDirectoryInfo requestBody: description: Action parameters content: application/json: schema: title: ActionImportGetDirectoryInfoRequestBody type: object properties: parameters: $ref: '#/components/schemas/Pbx.DirectoryParameters' required: true responses: '200': description: Success content: application/json: schema: allOf: - $ref: '#/components/schemas/Pbx.SystemDirectory' nullable: true default: $ref: '#/components/responses/error' x-ms-docs-operation-type: actionImport /TenantProperties: description: Provides operations to manage the collection of Property entities. get: tags: - TenantProperties summary: Get entities from TenantProperties operationId: ListProperty parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.PropertyCollectionResponse' default: $ref: '#/components/responses/error' post: tags: - TenantProperties summary: Add new entity to TenantProperties operationId: CreateProperty requestBody: description: New entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Property' required: true responses: '201': description: Created entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Property' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/TenantProperties({Name})': description: Provides operations to manage the collection of Property entities. get: tags: - TenantProperties summary: Get entity from TenantProperties by key operationId: GetProperty parameters: - name: Name in: path description: The unique identifier of Property required: true schema: type: string x-ms-docs-key-type: Property - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Property' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - TenantProperties summary: Update entity in TenantProperties operationId: UpdateProperty parameters: - name: Name in: path description: The unique identifier of Property required: true schema: type: string x-ms-docs-key-type: Property requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.Property' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - TenantProperties summary: Delete entity from TenantProperties operationId: DeleteProperty parameters: - name: Name in: path description: The unique identifier of Property required: true schema: type: string x-ms-docs-key-type: Property - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /Trunks/Pbx.GetFirstAvailableTrunkNumber(): description: Provides operations to call the GetFirstAvailableTrunkNumber method. get: tags: - Trunks summary: Invoke function GetFirstAvailableTrunkNumber operationId: GetFirstAvailableTrunkNumber responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.FirstAvailableNumber' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/Trunks({Id})': description: Provides operations to manage the collection of Trunk entities. get: tags: - Trunks summary: Get entity from Trunks by key operationId: GetTrunk parameters: - name: Id in: path description: The unique identifier of Trunk required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: Trunk - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Trunk' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - Trunks summary: Update entity in Trunks operationId: UpdateTrunk parameters: - name: Id in: path description: The unique identifier of Trunk required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: Trunk requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.Trunk' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - Trunks summary: Delete entity from Trunks operationId: DeleteTrunk parameters: - name: Id in: path description: The unique identifier of Trunk required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: Trunk - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /Trunks/Pbx.InitMasterBridge(): description: Provides operations to call the InitMasterBridge method. get: tags: - Trunks summary: Invoke function InitMasterBridge operationId: InitMasterBridge responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.Trunk' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /Trunks/Pbx.InitSlaveBridge(): description: Provides operations to call the InitSlaveBridge method. get: tags: - Trunks summary: Invoke function InitSlaveBridge operationId: InitSlaveBridge responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.Trunk' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/Trunks/Pbx.InitTrunk(template={template})': description: Provides operations to call the InitTrunk method. get: tags: - Trunks summary: Invoke function InitTrunk operationId: InitTrunk parameters: - name: template in: path description: 'Usage: template={template}' required: true schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.Trunk' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/Trunks({Id})/Pbx.ExportTrunk()': description: Provides operations to call the ExportTrunk method. get: tags: - Trunks summary: Invoke function ExportTrunk operationId: ExportTrunk parameters: - name: Id in: path description: The unique identifier of Trunk required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: Trunk responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.IActionResult' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /Trunks/Pbx.RefreshRegistration: description: Provides operations to call the RefreshRegistration method. post: tags: - Trunks summary: Invoke action RefreshRegistration operationId: RefreshRegistration requestBody: description: Action parameters content: application/json: schema: title: TrunksRefreshRegistrationRequestBody type: object properties: id: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Trunks/Pbx.SetRoutes: description: Provides operations to call the SetRoutes method. post: tags: - Trunks summary: Invoke action SetRoutes operationId: SetRoutes requestBody: description: Action parameters content: application/json: schema: title: TrunksSetRoutesRequestBody type: object properties: routes: $ref: '#/components/schemas/Pbx.SetRouteRequest' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action '/Trunks(Number={Number})': description: Provides operations to manage the collection of Trunk entities. get: tags: - Trunks summary: Get entity from Trunks by key (Number) operationId: GetTrunkByNumber parameters: - name: Number in: path description: Alternate key of Trunk required: true schema: type: string nullable: true - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Trunk' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/Trunks({Id})/Pbx.RunAnalysis': description: Provides operations to call the RunAnalysis method. post: tags: - Trunks summary: Invoke action RunAnalysis operationId: RunAnalysis parameters: - name: Id in: path description: The unique identifier of Trunk required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: Trunk responses: '200': description: Success content: application/json: schema: type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.TrunkReport' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action '/Trunks({Id})/Pbx.TestInboundCall': description: Provides operations to call the TestInboundCall method. post: tags: - Trunks summary: Invoke action TestInboundCall operationId: TestInboundCall parameters: - name: Id in: path description: The unique identifier of Trunk required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: Trunk responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.TrunkTestResult' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action '/Trunks({Id})/Pbx.TestOutboundCall': description: Provides operations to call the TestOutboundCall method. post: tags: - Trunks summary: Invoke action TestOutboundCall operationId: TestOutboundCall parameters: - name: Id in: path description: The unique identifier of Trunk required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: Trunk requestBody: description: Action parameters content: application/json: schema: title: TrunksTrunkTestOutboundCallRequestBody type: object properties: contact: type: string destination: type: string required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.TrunkTestResult' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Trunks: description: Provides operations to manage the collection of Trunk entities. get: tags: - Trunks summary: Get entities from Trunks operationId: ListTrunk parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.TrunkCollectionResponse' default: $ref: '#/components/responses/error' post: tags: - Trunks summary: Add new entity to Trunks operationId: CreateTrunk requestBody: description: New entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Trunk' required: true responses: '201': description: Created entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Trunk' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /Trunks/Pbx.GetProviderPhones: description: Provides operations to call the GetProviderPhones method. post: tags: - Trunks summary: Invoke action GetProviderPhones operationId: GetProviderPhones requestBody: description: Action parameters content: application/json: schema: title: TrunksGetProviderPhonesRequestBody type: object properties: model: $ref: '#/components/schemas/Pbx.GetProviderPhones' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.ProviderPhones' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Trunks/Pbx.FinalizeTrunkProvisioning: description: Provides operations to call the FinalizeTrunkProvisioning method. post: tags: - Trunks summary: Invoke action FinalizeTrunkProvisioning operationId: FinalizeTrunkProvisioning requestBody: description: Action parameters content: application/json: schema: title: TrunksFinalizeTrunkProvisioningRequestBody type: object properties: model: $ref: '#/components/schemas/Pbx.CreateTrunk' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.Trunk' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /TrunkTemplates: description: Provides operations to manage the collection of TrunkTemplate entities. get: tags: - TrunkTemplates summary: Get entities from TrunkTemplates operationId: ListTrunkTemplate parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.TrunkTemplateCollectionResponse' default: $ref: '#/components/responses/error' post: tags: - TrunkTemplates summary: Add new entity to TrunkTemplates operationId: CreateTrunkTemplate requestBody: description: New entity content: application/json: schema: $ref: '#/components/schemas/Pbx.TrunkTemplate' required: true responses: '201': description: Created entity content: application/json: schema: $ref: '#/components/schemas/Pbx.TrunkTemplate' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/TrunkTemplates({Id})': description: Provides operations to manage the collection of TrunkTemplate entities. get: tags: - TrunkTemplates summary: Get entity from TrunkTemplates by key operationId: GetTrunkTemplate parameters: - name: Id in: path description: The unique identifier of TrunkTemplate required: true schema: type: string x-ms-docs-key-type: TrunkTemplate - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.TrunkTemplate' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - TrunkTemplates summary: Update entity in TrunkTemplates operationId: UpdateTrunkTemplate parameters: - name: Id in: path description: The unique identifier of TrunkTemplate required: true schema: type: string x-ms-docs-key-type: TrunkTemplate requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.TrunkTemplate' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - TrunkTemplates summary: Delete entity from TrunkTemplates operationId: DeleteTrunkTemplate parameters: - name: Id in: path description: The unique identifier of TrunkTemplate required: true schema: type: string x-ms-docs-key-type: TrunkTemplate - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /GetUpdateSettings(): description: Provides operations to call the GetUpdateSettings method. get: tags: - Updates summary: Invoke functionImport GetUpdateSettings operationId: GetUpdateSettings responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.UpdateSettings' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: functionImport /SetUpdateSettings: description: Provides operations to call the SetUpdateSettings method. post: tags: - Updates summary: Invoke actionImport SetUpdateSettings operationId: SetUpdateSettings requestBody: description: Action parameters content: application/json: schema: title: ActionImportSetUpdateSettingsRequestBody type: object properties: settings: $ref: '#/components/schemas/Pbx.UpdateSettings' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: actionImport /HasDebianUpgrade(): description: Provides operations to call the HasDebianUpgrade method. get: tags: - Updates summary: Invoke functionImport HasDebianUpgrade operationId: HasDebianUpgrade responses: '200': description: Success content: application/json: schema: type: object properties: value: type: boolean default: false default: $ref: '#/components/responses/error' x-ms-docs-operation-type: functionImport /UpgradeDebian: description: Provides operations to call the UpgradeDebian method. post: tags: - Updates summary: Invoke actionImport UpgradeDebian operationId: UpgradeDebian responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: actionImport /GetUpdates(): description: Provides operations to call the GetUpdates method. get: tags: - Updates summary: Invoke functionImport GetUpdates operationId: GetUpdates responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.UpdateList' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: functionImport /GetPromptSetUpdates(): description: Provides operations to call the GetPromptSetUpdates method. get: tags: - Updates summary: Invoke functionImport GetPromptSetUpdates operationId: GetPromptSetUpdates responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.UpdateList' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: functionImport /GetClientCrmUpdates(): description: Provides operations to call the GetClientCrmUpdates method. get: tags: - Updates summary: Invoke functionImport GetClientCrmUpdates operationId: GetClientCrmUpdates responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.UpdateList' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: functionImport /GetServerCrmUpdates(): description: Provides operations to call the GetServerCrmUpdates method. get: tags: - Updates summary: Invoke functionImport GetServerCrmUpdates operationId: GetServerCrmUpdates responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.UpdateList' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: functionImport /InstallUpdates: description: Provides operations to call the InstallUpdates method. post: tags: - Updates summary: Invoke actionImport InstallUpdates operationId: InstallUpdates requestBody: description: Action parameters content: application/json: schema: title: ActionImportInstallUpdatesRequestBody type: object properties: install: $ref: '#/components/schemas/Pbx.InstallUpdates' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: actionImport /GetUpdatesStats(): description: Provides operations to call the GetUpdatesStats method. get: tags: - Updates summary: Invoke functionImport GetUpdatesStats operationId: GetUpdatesStats responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.UpdatesStats' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: functionImport '/Users(Number={Number})': description: Provides operations to manage the collection of User entities. get: tags: - Users summary: Get entity from Users by key (Number) operationId: GetUserByNumber parameters: - name: Number in: path description: Alternate key of User required: true schema: type: string nullable: true - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.User' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/Users({Id})/Pbx.HasDuplicatedEmail()': description: Provides operations to call the HasDuplicatedEmail method. get: tags: - Users summary: Invoke function HasDuplicatedEmail operationId: HasDuplicatedEmail parameters: - name: Id in: path description: The unique identifier of User required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: User responses: '200': $ref: '#/components/responses/HasDuplicatedEmailResponse' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /Users/Pbx.GetDuplicatedEmails: description: Provides operations to call the GetDuplicatedEmails method. post: tags: - Users summary: Invoke action GetDuplicatedEmails operationId: GetDuplicatedEmails requestBody: description: Action parameters content: application/json: schema: title: UsersGetDuplicatedEmailsRequestBody type: object properties: emails: type: array items: type: string required: true responses: '200': description: Success content: application/json: schema: type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: type: string default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Users/Pbx.GetFirstAvailableExtensionNumber(): description: Provides operations to call the GetFirstAvailableExtensionNumber method. get: tags: - Users summary: Invoke function GetFirstAvailableExtensionNumber operationId: GetFirstAvailableExtensionNumber responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.FirstAvailableNumber' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /Users/Pbx.GetFirstAvailableHotdeskingNumber(): description: Provides operations to call the GetFirstAvailableHotdeskingNumber method. get: tags: - Users summary: Invoke function GetFirstAvailableHotdeskingNumber operationId: GetFirstAvailableHotdeskingNumber responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.FirstAvailableNumber' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/Users({Id})/Pbx.SendWelcomeEmail': description: Provides operations to call the SendWelcomeEmail method. post: tags: - Users summary: Invoke action SendWelcomeEmail operationId: SendWelcomeEmail parameters: - name: Id in: path description: The unique identifier of User required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: User responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action '/Users({Id})/Groups': description: Provides operations to manage the Groups property of the Pbx.DN entity. get: tags: - Users summary: Get Groups from Users operationId: ListGroups parameters: - name: Id in: path description: The unique identifier of User required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: User - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.UserGroupCollectionResponse' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/Users({Id})/ForwardingProfiles': description: Provides operations to manage the ForwardingProfiles property of the Pbx.User entity. get: tags: - Users summary: Get ForwardingProfiles from Users operationId: ListForwardingProfiles parameters: - name: Id in: path description: The unique identifier of User required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: User - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.ForwardingProfileCollectionResponse' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/Users({Id})/Pbx.GetPhoneSecret()': description: Provides operations to call the GetPhoneSecret method. get: tags: - Users summary: Invoke function GetPhoneSecret operationId: GetPhoneSecret parameters: - name: Id in: path description: The unique identifier of User required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: User responses: '200': $ref: '#/components/responses/GetPhoneSecretResponse' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/Users({Id})/Pbx.Regenerate': description: Provides operations to call the Regenerate method. post: tags: - Users summary: Invoke action Regenerate operationId: Regenerate parameters: - name: Id in: path description: The unique identifier of User required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: User requestBody: $ref: '#/components/requestBodies/RegenerateRequestBody' responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Users/Pbx.RegeneratePasswords: description: Provides operations to call the RegeneratePasswords method. post: tags: - Users summary: Invoke action RegeneratePasswords operationId: RegeneratePasswords requestBody: description: Action parameters content: application/json: schema: title: UsersRegeneratePasswordsRequestBody type: object properties: Ids: type: array items: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 opts: $ref: '#/components/schemas/Pbx.RegenerateOptions' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Users/Pbx.ExportExtensions(): description: Provides operations to call the ExportExtensions method. get: tags: - Users summary: Invoke function ExportExtensions operationId: ExportExtensions parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of User type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.User' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/Users/Pbx.GetPhoneRegistrar(mac={mac})': description: Provides operations to call the GetPhoneRegistrar method. get: tags: - Users summary: Invoke function GetPhoneRegistrar operationId: GetPhoneRegistrar parameters: - name: mac in: path description: 'Usage: mac={mac}' required: true schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.PhoneRegistrar' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /Users/Pbx.BulkUpdate: description: Provides operations to call the BulkUpdate method. post: tags: - Users summary: Invoke action BulkUpdate operationId: BulkUpdate requestBody: description: Action parameters content: application/json: schema: title: UsersBulkUpdateRequestBody type: object properties: ids: type: array items: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 user: $ref: '#/components/schemas/Pbx.User' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Users/Pbx.GetPhoneRegistrars: description: Provides operations to call the GetPhoneRegistrars method. post: tags: - Users summary: Invoke action GetPhoneRegistrars operationId: GetPhoneRegistrars requestBody: description: Action parameters content: application/json: schema: title: UsersGetPhoneRegistrarsRequestBody type: object properties: macs: type: array items: type: string required: true responses: '200': description: Success content: application/json: schema: type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.PhoneRegistrar' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Users/Pbx.RebootPhone: description: Provides operations to call the RebootPhone method. post: tags: - Users summary: Invoke action RebootPhone operationId: RebootPhone requestBody: description: Action parameters content: application/json: schema: title: UsersRebootPhoneRequestBody type: object properties: mac: type: string required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Users/Pbx.ReprovisionPhone: description: Provides operations to call the ReprovisionPhone method. post: tags: - Users summary: Invoke action ReprovisionPhone operationId: ReprovisionPhone requestBody: description: Action parameters content: application/json: schema: title: UsersReprovisionPhoneRequestBody type: object properties: mac: type: string required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Users/Pbx.UpgradePhone: description: Provides operations to call the UpgradePhone method. post: tags: - Users summary: Invoke action UpgradePhone operationId: UpgradePhone requestBody: description: Action parameters content: application/json: schema: title: UsersUpgradePhoneRequestBody type: object properties: mac: type: string useragent: type: string version: type: string required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action '/Users({Id})/Pbx.GenerateProvLink()': description: Provides operations to call the GenerateProvLink method. get: tags: - Users summary: Invoke function GenerateProvLink operationId: GenerateProvLink parameters: - name: Id in: path description: The unique identifier of User required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: User responses: '200': $ref: '#/components/responses/GenerateProvLinkResponse' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/Users({Id})': description: Provides operations to manage the collection of User entities. get: tags: - Users summary: Get entity from Users by key operationId: GetUser parameters: - name: Id in: path description: The unique identifier of User required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: User - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.User' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - Users summary: Update entity in Users operationId: UpdateUser parameters: - name: Id in: path description: The unique identifier of User required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: User requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.User' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - Users summary: Delete entity from Users operationId: DeleteUser parameters: - name: Id in: path description: The unique identifier of User required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: User - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/Users({Id})/Greetings': description: Provides operations to manage the Greetings property of the Pbx.User entity. get: tags: - Users summary: Get Greetings from Users operationId: ListGreetings parameters: - name: Id in: path description: The unique identifier of User required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: User - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.GreetingCollectionResponse' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/Users({Id})/Pbx.MakeCallUserRecordGreeting': description: Provides operations to call the MakeCallUserRecordGreeting method. post: tags: - Users summary: Invoke action MakeCallUserRecordGreeting operationId: MakeCallUserRecordGreeting parameters: - name: Id in: path description: The unique identifier of User required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: User requestBody: $ref: '#/components/requestBodies/MakeCallUserRecordGreetingRequestBody' responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action '/Users/Pbx.DownloadGreeting(userId={userId},fileName={fileName})': description: Provides operations to call the DownloadGreeting method. get: tags: - Users summary: Invoke function DownloadGreeting operationId: DownloadGreeting parameters: - name: userId in: path description: 'Usage: userId={userId}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 - name: fileName in: path description: 'Usage: fileName={fileName}' required: true schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.IActionResult' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /Users/Pbx.BatchDelete: description: Provides operations to call the BatchDelete method. post: tags: - Users summary: Invoke action BatchDelete operationId: BatchDelete requestBody: description: Action parameters content: application/json: schema: title: UsersBatchDeleteRequestBody type: object properties: ids: type: array items: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 required: true responses: '200': description: Success content: application/json: schema: type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.UserDeleteError' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Users/Pbx.MakeCall: description: Provides operations to call the MakeCall method. post: tags: - Users summary: Invoke action MakeCall operationId: MakeCall requestBody: description: Action parameters content: application/json: schema: title: UsersMakeCallRequestBody type: object properties: contact: type: string nullable: true destination: type: string dn: type: string nullable: true testCall: type: boolean default: false nullable: true required: true responses: '200': description: Success content: application/json: schema: allOf: - $ref: '#/components/schemas/Pbx.CallControlResultResponse' nullable: true default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action '/Users({Id})/Pbx.SetMonitorStatus': description: Provides operations to call the SetMonitorStatus method. post: tags: - Users summary: Invoke action SetMonitorStatus operationId: SetMonitorStatus parameters: - name: Id in: path description: The unique identifier of User required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 x-ms-docs-key-type: User requestBody: $ref: '#/components/requestBodies/SetMonitorStatusRequestBody' responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Users/Pbx.InstallFirmware: description: Provides operations to call the InstallFirmware method. post: tags: - Users summary: Invoke action InstallFirmware operationId: InstallFirmware requestBody: description: Action parameters content: application/json: schema: title: UsersInstallFirmwareRequestBody type: object properties: phone: $ref: '#/components/schemas/Pbx.InstallFirmware' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Users/Pbx.MultiUserUpdate: description: Provides operations to call the MultiUserUpdate method. post: tags: - Users summary: Invoke action MultiUserUpdate operationId: MultiUserUpdate requestBody: description: Action parameters content: application/json: schema: title: UsersMultiUserUpdateRequestBody type: object properties: ids: type: array items: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 user: $ref: '#/components/schemas/Pbx.MultiEditUserData' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Users/Pbx.ReprovisionAllPhones: description: Provides operations to call the ReprovisionAllPhones method. post: tags: - Users summary: Invoke action ReprovisionAllPhones operationId: ReprovisionAllPhones requestBody: description: Action parameters content: application/json: schema: title: UsersReprovisionAllPhonesRequestBody type: object properties: ids: type: array items: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Users/Pbx.GetMultiEditGreetings: description: Provides operations to call the GetMultiEditGreetings method. post: tags: - Users summary: Invoke action GetMultiEditGreetings operationId: GetMultiEditGreetings requestBody: description: Action parameters content: application/json: schema: title: UsersGetMultiEditGreetingsRequestBody type: object properties: ids: type: array items: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 required: true responses: '200': description: Success content: application/json: schema: type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.GreetingFile' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Users/Pbx.MultiDeleteGreeting: description: Provides operations to call the MultiDeleteGreeting method. post: tags: - Users summary: Invoke action MultiDeleteGreeting operationId: MultiDeleteGreeting requestBody: description: Action parameters content: application/json: schema: title: UsersMultiDeleteGreetingRequestBody type: object properties: filename: type: string ids: type: array items: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /Users: description: Provides operations to manage the collection of User entities. get: tags: - Users summary: Get entities from Users operationId: ListUser parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.UserCollectionResponse' default: $ref: '#/components/responses/error' post: tags: - Users summary: Add new entity to Users operationId: CreateUser requestBody: description: New entity content: application/json: schema: $ref: '#/components/schemas/Pbx.User' required: true responses: '201': description: Created entity content: application/json: schema: $ref: '#/components/schemas/Pbx.User' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /VoicemailSettings/Pbx.GetTranscribeLanguages(): description: Provides operations to call the GetTranscribeLanguages method. get: tags: - VoicemailSettings summary: Invoke function GetTranscribeLanguages operationId: GetTranscribeLanguages parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' responses: '200': description: Success content: application/json: schema: type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.LanguageItem' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /VoicemailSettings: description: Provides operations to manage the VoicemailSettings singleton. get: tags: - VoicemailSettings summary: Get VoicemailSettings operationId: GetVoicemailSettings parameters: - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.VoicemailSettings' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - VoicemailSettings summary: Update VoicemailSettings operationId: UpdateVoicemailSettings requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.VoicemailSettings' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /VoicemailSettings/Pbx.DeleteAllUserVoicemails: description: Provides operations to call the DeleteAllUserVoicemails method. post: tags: - VoicemailSettings summary: Invoke action DeleteAllUserVoicemails operationId: DeleteAllUserVoicemails responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action '/VoicemailSettings/Pbx.GetConverterRequestStatus(strict={strict})': description: Provides operations to call the GetConverterRequestStatus method. get: tags: - VoicemailSettings summary: Invoke function GetConverterRequestStatus operationId: GetConverterRequestStatus parameters: - name: strict in: path description: 'Usage: strict={strict}' required: true schema: type: boolean default: false responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.OnBoardUICommand' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /VoicemailSettings/Pbx.CreateConverterConfiguration: description: Provides operations to call the CreateConverterConfiguration method. post: tags: - VoicemailSettings summary: Invoke action CreateConverterConfiguration operationId: CreateConverterConfiguration responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /VoicemailSettings/Pbx.DeleteConverterConfiguration: description: Provides operations to call the DeleteConverterConfiguration method. post: tags: - VoicemailSettings summary: Invoke action DeleteConverterConfiguration operationId: DeleteConverterConfiguration requestBody: description: Action parameters content: application/json: schema: title: VoicemailSettingsDeleteConverterConfigurationRequestBody type: object properties: id: type: string required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /VoicemailSettings/Pbx.GetConnectedConvertersData(): description: Provides operations to call the GetConnectedConvertersData method. get: tags: - VoicemailSettings summary: Invoke function GetConnectedConvertersData operationId: GetConnectedConvertersData parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' responses: '200': description: Success content: application/json: schema: type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.OnBoardConverterData' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /VoicemailSettings/Pbx.GetConfiguredConverters(): description: Provides operations to call the GetConfiguredConverters method. get: tags: - VoicemailSettings summary: Invoke function GetConfiguredConverters operationId: GetConfiguredConverters parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' responses: '200': description: Success content: application/json: schema: type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.OnBoardConverterRow' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function /WebsiteLinks: description: Provides operations to manage the collection of Weblink entities. get: tags: - WebsiteLinks summary: Get entities from WebsiteLinks operationId: ListWeblink parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': $ref: '#/components/responses/Pbx.WeblinkCollectionResponse' default: $ref: '#/components/responses/error' post: tags: - WebsiteLinks summary: Add new entity to WebsiteLinks operationId: CreateWeblink requestBody: description: New entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Weblink' required: true responses: '201': description: Created entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Weblink' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /WebsiteLinks/Pbx.ValidateLink: description: Provides operations to call the ValidateLink method. post: tags: - WebsiteLinks summary: Invoke action ValidateLink operationId: ValidateLink requestBody: description: Action parameters content: application/json: schema: title: WebsiteLinksValidateLinkRequestBody type: object properties: model: $ref: '#/components/schemas/Pbx.ChatLinkNameValidation' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action /WebsiteLinks/Pbx.BulkLinksDelete: description: Provides operations to call the BulkLinksDelete method. post: tags: - WebsiteLinks summary: Invoke action BulkLinksDelete operationId: BulkLinksDelete requestBody: description: Action parameters content: application/json: schema: title: WebsiteLinksBulkLinksDeleteRequestBody type: object properties: ids: type: array items: type: string required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: action '/WebsiteLinks({Link})': description: Provides operations to manage the collection of Weblink entities. get: tags: - WebsiteLinks summary: Get entity from WebsiteLinks by key operationId: GetWeblink parameters: - name: Link in: path description: The unique identifier of Weblink required: true schema: type: string x-ms-docs-key-type: Weblink - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Retrieved entity content: application/json: schema: $ref: '#/components/schemas/Pbx.Weblink' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - WebsiteLinks summary: Update entity in WebsiteLinks operationId: UpdateWeblink parameters: - name: Link in: path description: The unique identifier of Weblink required: true schema: type: string x-ms-docs-key-type: Weblink requestBody: description: New property values content: application/json: schema: $ref: '#/components/schemas/Pbx.Weblink' required: true responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - WebsiteLinks summary: Delete entity from WebsiteLinks operationId: DeleteWeblink parameters: - name: Link in: path description: The unique identifier of Weblink required: true schema: type: string x-ms-docs-key-type: Weblink - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success default: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation '/ReportChatLog/Pbx.GetChatLog(periodFrom={periodFrom},periodTo={periodTo},fromType={fromType},fromExtension={fromExtension},fromText={fromText},toType={toType},toExtension={toExtension},toText={toText},chatType={chatType},participantType={participantType})': description: Provides operations to call the GetChatLog method. get: tags: - ReportChatLog summary: Invoke function GetChatLog operationId: GetChatLog parameters: - name: periodFrom in: path description: 'Usage: periodFrom={periodFrom}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: periodTo in: path description: 'Usage: periodTo={periodTo}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: fromType in: path description: 'Usage: fromType={fromType}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 - name: fromExtension in: path description: 'Usage: fromExtension={fromExtension}' required: true schema: type: string nullable: true - name: fromText in: path description: 'Usage: fromText={fromText}' required: true schema: type: string nullable: true - name: toType in: path description: 'Usage: toType={toType}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 - name: toExtension in: path description: 'Usage: toExtension={toExtension}' required: true schema: type: string nullable: true - name: toText in: path description: 'Usage: toText={toText}' required: true schema: type: string nullable: true - name: chatType in: path description: 'Usage: chatType={chatType}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 - name: participantType in: path description: 'Usage: participantType={participantType}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of ChatHistoryView type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.ChatHistoryView' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportChatLog/Pbx.DownloadChatLog(clientTimeZone={clientTimeZone},periodFrom={periodFrom},periodTo={periodTo},fromType={fromType},fromExtension={fromExtension},fromText={fromText},toType={toType},toExtension={toExtension},toText={toText},chatType={chatType},participantType={participantType})': description: Provides operations to call the DownloadChatLog method. get: tags: - ReportChatLog summary: Invoke function DownloadChatLog operationId: DownloadChatLog parameters: - name: clientTimeZone in: path description: 'Usage: clientTimeZone={clientTimeZone}' required: true schema: type: string nullable: true - name: periodFrom in: path description: 'Usage: periodFrom={periodFrom}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: periodTo in: path description: 'Usage: periodTo={periodTo}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: fromType in: path description: 'Usage: fromType={fromType}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 - name: fromExtension in: path description: 'Usage: fromExtension={fromExtension}' required: true schema: type: string nullable: true - name: fromText in: path description: 'Usage: fromText={fromText}' required: true schema: type: string nullable: true - name: toType in: path description: 'Usage: toType={toType}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 - name: toExtension in: path description: 'Usage: toExtension={toExtension}' required: true schema: type: string nullable: true - name: toText in: path description: 'Usage: toText={toText}' required: true schema: type: string nullable: true - name: chatType in: path description: 'Usage: chatType={chatType}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 - name: participantType in: path description: 'Usage: participantType={participantType}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of ChatHistoryView type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.ChatHistoryView' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportInboundCalls/Pbx.GetInboundCalls(periodFrom={periodFrom},periodTo={periodTo},trunkDns={trunkDns},callsType={callsType})': description: Provides operations to call the GetInboundCalls method. get: tags: - ReportInboundCalls summary: Invoke function GetInboundCalls operationId: GetInboundCalls parameters: - name: periodFrom in: path description: 'Usage: periodFrom={periodFrom}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: periodTo in: path description: 'Usage: periodTo={periodTo}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: trunkDns in: path description: 'Usage: trunkDns={trunkDns}' required: true schema: type: string nullable: true - name: callsType in: path description: 'Usage: callsType={callsType}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of InboundCall type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.InboundCall' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportInboundCalls/Pbx.DownloadGetInboundCalls(periodFrom={periodFrom},periodTo={periodTo},trunkDns={trunkDns},callsType={callsType},clientTimeZone={clientTimeZone})': description: Provides operations to call the DownloadGetInboundCalls method. get: tags: - ReportInboundCalls summary: Invoke function DownloadGetInboundCalls operationId: DownloadGetInboundCalls parameters: - name: periodFrom in: path description: 'Usage: periodFrom={periodFrom}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: periodTo in: path description: 'Usage: periodTo={periodTo}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: trunkDns in: path description: 'Usage: trunkDns={trunkDns}' required: true schema: type: string nullable: true - name: callsType in: path description: 'Usage: callsType={callsType}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 - name: clientTimeZone in: path description: 'Usage: clientTimeZone={clientTimeZone}' required: true schema: type: string nullable: true - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of InboundCall type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.InboundCall' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportOutboundCalls/Pbx.GetOutboundCalls(periodFrom={periodFrom},periodTo={periodTo},trunkDns={trunkDns},callsType={callsType})': description: Provides operations to call the GetOutboundCalls method. get: tags: - ReportOutboundCalls summary: Invoke function GetOutboundCalls operationId: GetOutboundCalls parameters: - name: periodFrom in: path description: 'Usage: periodFrom={periodFrom}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: periodTo in: path description: 'Usage: periodTo={periodTo}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: trunkDns in: path description: 'Usage: trunkDns={trunkDns}' required: true schema: type: string nullable: true - name: callsType in: path description: 'Usage: callsType={callsType}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of OutboundCall type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.OutboundCall' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportOutboundCalls/Pbx.DownloadGetOutboundCalls(periodFrom={periodFrom},periodTo={periodTo},trunkDns={trunkDns},callsType={callsType},clientTimeZone={clientTimeZone})': description: Provides operations to call the DownloadGetOutboundCalls method. get: tags: - ReportOutboundCalls summary: Invoke function DownloadGetOutboundCalls operationId: DownloadGetOutboundCalls parameters: - name: periodFrom in: path description: 'Usage: periodFrom={periodFrom}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: periodTo in: path description: 'Usage: periodTo={periodTo}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: trunkDns in: path description: 'Usage: trunkDns={trunkDns}' required: true schema: type: string nullable: true - name: callsType in: path description: 'Usage: callsType={callsType}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 - name: clientTimeZone in: path description: 'Usage: clientTimeZone={clientTimeZone}' required: true schema: type: string nullable: true - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of OutboundCall type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.OutboundCall' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportUserActivity/Pbx.GetUserActivity(clientTimeZone={clientTimeZone},periodFrom={periodFrom},periodTo={periodTo},groupNumber={groupNumber},extensionDns={extensionDns},waitInterval={waitInterval},includeQueueCalls={includeQueueCalls},callArea={callArea},groupingType={groupingType})': description: Provides operations to call the GetUserActivity method. get: tags: - ReportUserActivity summary: Invoke function GetUserActivity operationId: GetUserActivity parameters: - name: clientTimeZone in: path description: 'Usage: clientTimeZone={clientTimeZone}' required: true schema: type: string nullable: true - name: periodFrom in: path description: 'Usage: periodFrom={periodFrom}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: periodTo in: path description: 'Usage: periodTo={periodTo}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: groupNumber in: path description: 'Usage: groupNumber={groupNumber}' required: true schema: type: string nullable: true - name: extensionDns in: path description: 'Usage: extensionDns={extensionDns}' required: true schema: type: string nullable: true - name: waitInterval in: path description: 'Usage: waitInterval={waitInterval}' required: true schema: type: string nullable: true - name: includeQueueCalls in: path description: 'Usage: includeQueueCalls={includeQueueCalls}' required: true schema: type: boolean default: false - name: callArea in: path description: 'Usage: callArea={callArea}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 - name: groupingType in: path description: 'Usage: groupingType={groupingType}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of UserActivity type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.UserActivity' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function '/ReportUserActivity/Pbx.DownloadGetUserActivity(clientTimeZone={clientTimeZone},periodFrom={periodFrom},periodTo={periodTo},groupNumber={groupNumber},extensionDns={extensionDns},waitInterval={waitInterval},includeQueueCalls={includeQueueCalls},callArea={callArea},groupingType={groupingType})': description: Provides operations to call the DownloadGetUserActivity method. get: tags: - ReportUserActivity summary: Invoke function DownloadGetUserActivity operationId: DownloadGetUserActivity parameters: - name: clientTimeZone in: path description: 'Usage: clientTimeZone={clientTimeZone}' required: true schema: type: string nullable: true - name: periodFrom in: path description: 'Usage: periodFrom={periodFrom}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: periodTo in: path description: 'Usage: periodTo={periodTo}' required: true schema: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time - name: groupNumber in: path description: 'Usage: groupNumber={groupNumber}' required: true schema: type: string nullable: true - name: extensionDns in: path description: 'Usage: extensionDns={extensionDns}' required: true schema: type: string nullable: true - name: waitInterval in: path description: 'Usage: waitInterval={waitInterval}' required: true schema: type: string nullable: true - name: includeQueueCalls in: path description: 'Usage: includeQueueCalls={includeQueueCalls}' required: true schema: type: boolean default: false - name: callArea in: path description: 'Usage: callArea={callArea}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 - name: groupingType in: path description: 'Usage: groupingType={groupingType}' required: true schema: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $select in: query description: Select properties to be returned explode: false schema: uniqueItems: true type: array items: type: string - name: $orderby in: query description: Order items by property values explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities explode: false schema: uniqueItems: true type: array items: type: string responses: '200': description: Success content: application/json: schema: title: Collection of UserActivity type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.UserActivity' default: $ref: '#/components/responses/error' x-ms-docs-operation-type: function components: schemas: Pbx.ODataErrors.ODataError: required: - error type: object properties: error: $ref: '#/components/schemas/Pbx.ODataErrors.MainError' Pbx.ODataErrors.MainError: required: - code - message type: object properties: code: type: string details: type: array items: $ref: '#/components/schemas/Pbx.ODataErrors.ErrorDetails' innerError: $ref: '#/components/schemas/Pbx.ODataErrors.InnerError' message: type: string x-ms-primary-error-message: true target: type: string nullable: true Pbx.ODataErrors.ErrorDetails: required: - code - message type: object properties: code: type: string message: type: string target: type: string nullable: true Pbx.ODataErrors.InnerError: type: object description: The structure of this object is service-specific ODataCountResponse: type: integer format: int64 StringCollectionResponse: title: Collection of string type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: type: string ReferenceUpdate: type: object properties: '@odata.id': type: string '@odata.type': type: string nullable: true ReferenceCreate: type: object properties: '@odata.id': type: string additionalProperties: type: object ReferenceNumeric: enum: - '-INF' - INF - NaN type: string nullable: true x-enum-varnames: - NEGATIVE_INFINITY - INFINITY - NAN BaseCollectionPaginationCountResponse: title: Base collection pagination and count responses type: object properties: '@odata.count': type: number format: int64 nullable: true Pbx.CallFlowScript: title: CallFlowScript type: object properties: Description: type: string nullable: true Help: type: string nullable: true Id: type: string Versions: type: array items: type: string Pbx.DN: title: DN type: object properties: Groups: type: array items: $ref: '#/components/schemas/Pbx.UserGroup' x-ms-navigationProperty: true Id: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 Number: type: string nullable: true TranscriptionMode: allOf: - $ref: '#/components/schemas/Pbx.TranscriptionType' nullable: true Pbx.Receptionist: allOf: - $ref: '#/components/schemas/Pbx.DN' - title: Receptionist type: object properties: BreakRoute: allOf: - $ref: '#/components/schemas/Pbx.Route' nullable: true Forwards: type: array items: $ref: '#/components/schemas/Pbx.ReceptionistForward' x-ms-navigationProperty: true ForwardSmsTo: type: string nullable: true HolidaysRoute: allOf: - $ref: '#/components/schemas/Pbx.Route' nullable: true InvalidKeyForwardDN: type: string nullable: true IsRegistered: type: boolean nullable: true IVRType: allOf: - $ref: '#/components/schemas/Pbx.IVRType' nullable: true Name: type: string nullable: true OutOfOfficeRoute: allOf: - $ref: '#/components/schemas/Pbx.Route' nullable: true PromptFilename: type: string nullable: true PromptSet: type: string nullable: true Timeout: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true TimeoutForwardDN: type: string nullable: true TimeoutForwardPeerType: allOf: - $ref: '#/components/schemas/Pbx.PeerType' nullable: true TimeoutForwardType: allOf: - $ref: '#/components/schemas/Pbx.IVRForwardType' nullable: true TransferEnable: type: boolean nullable: true UseMSExchange: type: boolean nullable: true Pbx.FirstAvailableNumber: title: FirstAvailableNumber type: object properties: Number: type: string nullable: true Pbx.BlackListNumber: title: BlackListNumber type: object properties: CallerId: type: string Description: type: string nullable: true Id: type: string Pbx.BlocklistAddr: title: BlocklistAddr type: object properties: AddedBy: allOf: - $ref: '#/components/schemas/Pbx.AddedBy' nullable: true BlockType: allOf: - $ref: '#/components/schemas/Pbx.BlockType' nullable: true Description: type: string nullable: true ExpiresAt: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time nullable: true Id: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 IPAddrMask: type: string nullable: true Pbx.ClickToCall: allOf: - $ref: '#/components/schemas/Pbx.DN' - title: ClickToCall type: object properties: CallUsEnableChat: type: boolean nullable: true CallUsEnablePhone: type: boolean nullable: true CallUsEnableVideo: type: boolean nullable: true CallUsRequirement: allOf: - $ref: '#/components/schemas/Pbx.Authentication' nullable: true ClickToCallId: type: string nullable: true Pbx.RingGroup: allOf: - $ref: '#/components/schemas/Pbx.ClickToCall' - title: RingGroup type: object properties: BreakRoute: allOf: - $ref: '#/components/schemas/Pbx.Route' nullable: true ForwardNoAnswer: allOf: - $ref: '#/components/schemas/Pbx.Destination' nullable: true GreetingFile: type: string nullable: true HolidaysRoute: allOf: - $ref: '#/components/schemas/Pbx.Route' nullable: true IsRegistered: type: boolean nullable: true Members: type: array items: $ref: '#/components/schemas/Pbx.RingGroupMember' x-ms-navigationProperty: true MulticastAddress: type: string nullable: true MulticastCodec: type: string nullable: true MulticastPacketTime: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true MulticastPort: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Name: type: string nullable: true OutOfOfficeRoute: allOf: - $ref: '#/components/schemas/Pbx.Route' nullable: true RingStrategy: allOf: - $ref: '#/components/schemas/Pbx.StrategyType' nullable: true RingTime: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true VMEmailList: type: string nullable: true VMEmailOptions: allOf: - $ref: '#/components/schemas/Pbx.VMEmailOptionsType' nullable: true Pbx.Contact: title: Contact type: object properties: Business: type: string nullable: true Business2: type: string nullable: true BusinessFax: type: string nullable: true CompanyName: type: string nullable: true ContactType: allOf: - $ref: '#/components/schemas/Pbx.ContactSource' nullable: true Department: type: string nullable: true Email: type: string nullable: true FirstName: type: string nullable: true Home: type: string nullable: true Id: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 LastName: type: string nullable: true Mobile2: type: string nullable: true Other: type: string nullable: true Pager: type: string nullable: true PhoneNumber: type: string nullable: true Tag: type: string nullable: true Title: type: string nullable: true Pbx.ContactsDirSearchSettings: title: ContactsDirSearchSettings type: object properties: ExchangeCalendarProfileSwitching: type: boolean nullable: true ExchangeEmailAddresses: type: array items: type: string ExchangeFolders: type: array items: type: string ExchangePassword: allOf: - $ref: '#/components/schemas/Pbx.ConcealedPassword' nullable: true ExchangeServerUrl: type: string nullable: true ExchangeUser: type: string nullable: true Pbx.Queue: allOf: - $ref: '#/components/schemas/Pbx.ClickToCall' - title: Queue type: object properties: AgentAvailabilityMode: type: boolean nullable: true Agents: type: array items: $ref: '#/components/schemas/Pbx.QueueAgent' x-ms-navigationProperty: true AnnouncementInterval: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true AnnounceQueuePosition: type: boolean nullable: true BreakRoute: allOf: - $ref: '#/components/schemas/Pbx.Route' nullable: true CallbackEnableTime: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true CallbackPrefix: type: string nullable: true EnableIntro: type: boolean nullable: true ForwardNoAnswer: allOf: - $ref: '#/components/schemas/Pbx.Destination' nullable: true GreetingFile: type: string nullable: true HolidaysRoute: allOf: - $ref: '#/components/schemas/Pbx.Route' nullable: true IntroFile: type: string nullable: true IsRegistered: type: boolean nullable: true Managers: type: array items: $ref: '#/components/schemas/Pbx.QueueManager' x-ms-navigationProperty: true MasterTimeout: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true MaxCallersInQueue: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Name: type: string nullable: true NotifyCodes: type: array items: $ref: '#/components/schemas/Pbx.QueueNotifyCode' OnHoldFile: type: string nullable: true OutOfOfficeRoute: allOf: - $ref: '#/components/schemas/Pbx.Route' nullable: true PlayFullPrompt: type: boolean nullable: true PollingStrategy: allOf: - $ref: '#/components/schemas/Pbx.PollingStrategyType' nullable: true PriorityQueue: type: boolean nullable: true PromptSet: type: string nullable: true Recording: allOf: - $ref: '#/components/schemas/Pbx.QueueRecording' nullable: true ResetQueueStatisticsSchedule: allOf: - $ref: '#/components/schemas/Pbx.ResetQueueStatisticsSchedule' nullable: true ResetStatisticsScheduleEnabled: type: boolean nullable: true RingTimeout: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true SLATime: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true TypeOfChatOwnershipType: allOf: - $ref: '#/components/schemas/Pbx.TypeOfChatOwnershipType' nullable: true VMEmailList: type: string nullable: true VMEmailOptions: allOf: - $ref: '#/components/schemas/Pbx.VMEmailOptionsType' nullable: true WrapUpTime: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Pbx.User: allOf: - $ref: '#/components/schemas/Pbx.ClickToCall' - title: User type: object properties: AccessPassword: type: string nullable: true AgentSettings: allOf: - $ref: '#/components/schemas/Pbx.AgentSettings' nullable: true AIAgent: type: boolean nullable: true AllowLanOnly: type: boolean nullable: true AllowOwnRecordings: type: boolean nullable: true AuthID: type: string nullable: true AuthPassword: type: string nullable: true Blfs: maxLength: 20480 type: string nullable: true BlockTunnel: type: boolean nullable: true BreakTime: allOf: - $ref: '#/components/schemas/Pbx.Schedule' nullable: true CallScreening: type: boolean nullable: true ContactImage: type: string nullable: true CurrentProfileName: type: string nullable: true DatevEnabled: type: boolean nullable: true DeskphonePassword: type: string nullable: true DisplayName: type: string nullable: true EmailAddress: type: string nullable: true EmergencyAdditionalInfo: type: string nullable: true EmergencyLocationId: type: string nullable: true Enable2FA: type: boolean nullable: true Enabled: type: boolean nullable: true EnableHotdesking: type: boolean nullable: true FirstName: type: string nullable: true ForwardingExceptions: type: array items: $ref: '#/components/schemas/Pbx.ExtensionRule' x-ms-navigationProperty: true ForwardingProfiles: type: array items: $ref: '#/components/schemas/Pbx.ForwardingProfile' x-ms-navigationProperty: true GoogleCalendarEnabled: type: boolean nullable: true GoogleContactsEnabled: type: boolean nullable: true GoogleSignInEnabled: type: boolean nullable: true Greetings: type: array items: $ref: '#/components/schemas/Pbx.Greeting' x-ms-navigationProperty: true HideInPhonebook: type: boolean nullable: true HotdeskingAssignment: type: string nullable: true Hours: allOf: - $ref: '#/components/schemas/Pbx.Schedule' nullable: true Internal: type: boolean nullable: true IsRegistered: type: boolean nullable: true Language: type: string nullable: true LastName: type: string nullable: true Mobile: type: string nullable: true MS365CalendarEnabled: type: boolean nullable: true MS365ContactsEnabled: type: boolean nullable: true MS365SignInEnabled: type: boolean nullable: true MS365TeamsEnabled: type: boolean nullable: true MyPhoneAllowDeleteRecordings: type: boolean nullable: true MyPhoneHideForwardings: type: boolean nullable: true MyPhonePush: type: boolean nullable: true MyPhoneShowRecordings: type: boolean nullable: true OfficeHoursProps: type: array items: $ref: '#/components/schemas/Pbx.OfficeHoursBits' OutboundCallerID: type: string nullable: true PbxDeliversAudio: type: boolean nullable: true Phones: type: array items: $ref: '#/components/schemas/Pbx.Phone' x-ms-navigationProperty: true PinProtected: type: boolean nullable: true PinProtectTimeout: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true PrimaryGroupId: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true PromptSet: type: string nullable: true QueueStatus: allOf: - $ref: '#/components/schemas/Pbx.QueueStatusType' nullable: true RecordCalls: type: boolean nullable: true RecordEmailNotify: type: boolean nullable: true RecordExternalCallsOnly: type: boolean nullable: true Require2FA: type: boolean nullable: true SendEmailMissedCalls: type: boolean nullable: true SIPID: type: string nullable: true SRTPMode: allOf: - $ref: '#/components/schemas/Pbx.SRTPModeType' nullable: true Tags: type: array items: $ref: '#/components/schemas/Pbx.UserTag' VMDisablePinAuth: type: boolean nullable: true VMEmailOptions: allOf: - $ref: '#/components/schemas/Pbx.VMEmailOptionsType' nullable: true VMEnabled: type: boolean nullable: true VMPIN: type: string nullable: true VMPlayCallerID: type: boolean nullable: true VMPlayMsgDateTime: allOf: - $ref: '#/components/schemas/Pbx.VMPlayMsgDateTimeType' nullable: true WebMeetingApproveParticipants: type: boolean nullable: true WebMeetingFriendlyName: type: string nullable: true Pbx.CallControlResultResponse: title: CallControlResultResponse type: object properties: FinalStatus: type: string Reason: type: string ReasonText: type: string Result: allOf: - $ref: '#/components/schemas/Pbx.CallParticipant' nullable: true x-ms-navigationProperty: true VttId: type: string nullable: true Pbx.RegenerateOptions: title: RegenerateOptions type: object properties: ConfigurationLink: type: boolean DeskphonePassword: type: boolean RpsKey: type: boolean SendWelcomeEmail: type: boolean SipAuth: type: boolean VoicemailPIN: type: boolean WebclientPassword: type: boolean Pbx.PhoneRegistrar: title: PhoneRegistrar type: object properties: Capabilities: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true FirmwareAvailable: type: string nullable: true FirmwareVersion: type: string nullable: true InterfaceLink: type: string nullable: true IpAddress: type: string nullable: true MAC: type: string nullable: true Model: type: string nullable: true UserAgent: type: string nullable: true Vendor: type: string nullable: true Pbx.UserDeleteError: title: UserDeleteError type: object properties: Error: type: string nullable: true ExtensionNumber: type: string nullable: true Pbx.IActionResult: title: IActionResult type: object Pbx.MultiEditUserData: title: MultiEditUserData type: object properties: AllowLanOnly: type: boolean nullable: true AllowOwnRecordings: type: boolean nullable: true Blfs: maxLength: 10240 type: string nullable: true BossSecretaryRequiresFullEdit: type: boolean nullable: true CallScreening: type: boolean nullable: true CanMoveForwardingExceptions: type: boolean nullable: true DatevEnabled: type: boolean nullable: true DisplayNumbers: type: string nullable: true EmergencyAdditionalInfo: type: string nullable: true EmergencyLocationId: type: string nullable: true Enabled: type: boolean nullable: true EnableHotdesking: type: boolean nullable: true ForwardingExceptions: type: array items: $ref: '#/components/schemas/Pbx.ExtensionRule' x-ms-navigationProperty: true ForwardingProfiles: type: array items: $ref: '#/components/schemas/Pbx.ForwardingProfile' x-ms-navigationProperty: true GoogleCalendarEnabled: type: boolean nullable: true GoogleContactsEnabled: type: boolean nullable: true GoogleSignInEnabled: type: boolean nullable: true Greetings: type: array items: $ref: '#/components/schemas/Pbx.Greeting' x-ms-navigationProperty: true Groups: type: array items: $ref: '#/components/schemas/Pbx.UserGroup' x-ms-navigationProperty: true HideInPhonebook: type: boolean nullable: true Internal: type: boolean nullable: true Mobile: type: string nullable: true MS365CalendarEnabled: type: boolean nullable: true MS365ContactsEnabled: type: boolean nullable: true MS365SignInEnabled: type: boolean nullable: true MS365TeamsEnabled: type: boolean nullable: true MyPhoneAllowDeleteRecordings: type: boolean nullable: true MyPhoneHideForwardings: type: boolean nullable: true MyPhoneShowRecordings: type: boolean nullable: true Number: type: string nullable: true PbxDeliversAudio: type: boolean nullable: true PinProtected: type: boolean nullable: true PinProtectTimeout: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true PromptSet: type: string nullable: true RecordCalls: type: boolean nullable: true RecordEmailNotify: type: boolean nullable: true RecordExternalCallsOnly: type: boolean nullable: true SendEmailMissedCalls: type: boolean nullable: true SRTPMode: allOf: - $ref: '#/components/schemas/Pbx.SRTPModeType' nullable: true TranscriptionMode: allOf: - $ref: '#/components/schemas/Pbx.TranscriptionType' nullable: true VMDisablePinAuth: type: boolean nullable: true VMEmailOptions: allOf: - $ref: '#/components/schemas/Pbx.VMEmailOptionsType' nullable: true VMEnabled: type: boolean nullable: true VMPlayCallerID: type: boolean nullable: true VMPlayMsgDateTime: allOf: - $ref: '#/components/schemas/Pbx.VMPlayMsgDateTimeType' nullable: true Pbx.GreetingFile: title: GreetingFile type: object properties: DisplayName: type: string nullable: true Filename: type: string Pbx.InstallFirmware: title: InstallFirmware type: object properties: Model: type: string nullable: true UserAgent: type: string nullable: true Pbx.PhoneTemplate: title: PhoneTemplate type: object properties: AddAllowed: type: boolean nullable: true AllowedNetConfigs: type: array items: type: string AllowSSLProvisioning: type: boolean nullable: true BacklightTimeouts: type: array items: type: string Codecs: type: array items: type: string Content: type: string nullable: true DateFormats: type: array items: type: string DefaultQueueRingTone: type: string nullable: true HotdeskingAllowed: type: boolean nullable: true Id: type: string IsCustom: type: boolean nullable: true Languages: type: array items: type: string MaxQueueCustomRingtones: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Models: type: array items: $ref: '#/components/schemas/Pbx.PhoneModel' PowerLedSettings: type: array items: type: string QueueRingTones: type: array items: type: string RingTones: type: array items: type: string RpsEnabled: type: boolean nullable: true ScreenSaverTimeouts: type: array items: type: string TemplateType: allOf: - $ref: '#/components/schemas/Pbx.TemplateType' nullable: true TimeFormats: type: array items: type: string TimeZones: type: array items: type: string URL: type: string nullable: true XferTypeEnabled: type: boolean nullable: true Pbx.TrunkTemplate: title: TrunkTemplate type: object properties: AddAllowed: type: boolean nullable: true Content: type: string nullable: true Countries: type: array items: type: string DefaultProxyPort: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true DefaultRegistrarPort: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Description: type: string nullable: true Editors: type: array items: $ref: '#/components/schemas/Pbx.TrunkEditorType' Id: type: string MessagingTemplate: allOf: - $ref: '#/components/schemas/Pbx.TrunkMessagingTemplate' nullable: true Name: type: string Tags: type: array items: type: string TemplateType: $ref: '#/components/schemas/Pbx.TemplateType' Url: type: string nullable: true Pbx.Recording: title: Recording type: object properties: ArchivedUrl: type: string nullable: true CallType: allOf: - $ref: '#/components/schemas/Pbx.RecordingCallType' nullable: true CanBeTranscribed: type: boolean nullable: true EndTime: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time nullable: true FromCallerNumber: type: string nullable: true FromCrmContact: type: string nullable: true FromDidNumber: type: string nullable: true FromDisplayName: type: string nullable: true FromDn: type: string nullable: true FromDnType: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true FromIdParticipant: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Id: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 IsArchived: type: boolean nullable: true IsTranscribed: type: boolean nullable: true RecordingUrl: type: string nullable: true RefParticipantId: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true SentimentScore: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true StartTime: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time nullable: true Summary: type: string nullable: true ToCallerNumber: type: string nullable: true ToCrmContact: type: string nullable: true ToDidNumber: type: string nullable: true ToDisplayName: type: string nullable: true ToDn: type: string nullable: true ToDnType: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true ToIdParticipant: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Transcription: type: string nullable: true TranscriptionResult: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Pbx.RecordingRepositorySettings: title: RecordingRepositorySettings type: object properties: AutoDeleteRecordingDays: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true AutoDeleteRecordingEnabled: type: boolean nullable: true IsRecordingArchiveEnabled: type: boolean nullable: true RecordingDiskSpace: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true RecordingPath: type: string nullable: true RecordingsQuota: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true RecordingUsedSpace: type: number format: int64 nullable: true Pbx.SystemDirectory: title: SystemDirectory type: object properties: Dirs: type: array items: type: string Path: type: string nullable: true Pbx.DirectoryParameters: title: DirectoryParameters type: object properties: Filesystem: $ref: '#/components/schemas/Pbx.FileSystemType' Json: type: string nullable: true Path: type: string nullable: true Pbx.Group: allOf: - $ref: '#/components/schemas/Pbx.ClickToCall' - title: Group type: object properties: AllowCallService: type: boolean nullable: true AnswerAfter: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true BreakRoute: allOf: - $ref: '#/components/schemas/Pbx.Route' nullable: true BreakTime: allOf: - $ref: '#/components/schemas/Pbx.Schedule' nullable: true CallHandlingMode: type: array items: $ref: '#/components/schemas/Pbx.CallHandlingFlags' CurrentGroupHours: allOf: - $ref: '#/components/schemas/Pbx.GroupHoursMode' nullable: true CustomOperator: allOf: - $ref: '#/components/schemas/Pbx.Destination' nullable: true CustomPrompt: type: string nullable: true DisableCustomPrompt: type: boolean nullable: true GloballyVisible: type: boolean nullable: true HasMembers: type: boolean nullable: true HolidaysRoute: allOf: - $ref: '#/components/schemas/Pbx.Route' nullable: true Hours: allOf: - $ref: '#/components/schemas/Pbx.Schedule' nullable: true IsDefault: type: boolean nullable: true Language: type: string nullable: true LastLoginTime: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time nullable: true Members: type: array items: $ref: '#/components/schemas/Pbx.UserGroup' x-ms-navigationProperty: true Name: type: string nullable: true OfficeHolidays: type: array items: $ref: '#/components/schemas/Pbx.Holiday' x-ms-navigationProperty: true OfficeRoute: allOf: - $ref: '#/components/schemas/Pbx.Route' nullable: true OutOfOfficeRoute: allOf: - $ref: '#/components/schemas/Pbx.Route' nullable: true OverrideExpiresAt: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time nullable: true OverrideHolidays: type: boolean nullable: true PromptSet: type: string nullable: true Props: allOf: - $ref: '#/components/schemas/Pbx.GroupProps' nullable: true Rights: type: array items: $ref: '#/components/schemas/Pbx.Rights' x-ms-navigationProperty: true TimeZoneId: type: string nullable: true Pbx.Restrictions: title: Restrictions type: object properties: Dects: allOf: - $ref: '#/components/schemas/Pbx.EntityRestrictions' nullable: true LiveChats: allOf: - $ref: '#/components/schemas/Pbx.EntityRestrictions' nullable: true MaxPrompts: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Sbcs: allOf: - $ref: '#/components/schemas/Pbx.EntityRestrictions' nullable: true System: allOf: - $ref: '#/components/schemas/Pbx.EntityRestrictions' nullable: true Trunks: allOf: - $ref: '#/components/schemas/Pbx.EntityRestrictions' nullable: true Users: allOf: - $ref: '#/components/schemas/Pbx.EntityRestrictions' nullable: true Pbx.OutboundRule: title: OutboundRule type: object properties: DNRanges: type: array items: $ref: '#/components/schemas/Pbx.DNRange' EmergencyRule: type: boolean nullable: true GroupIds: type: array items: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 GroupNames: type: array items: type: string Id: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 Name: type: string nullable: true NumberLengthRanges: type: string nullable: true Prefix: type: string nullable: true Priority: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Routes: type: array items: $ref: '#/components/schemas/Pbx.OutboundRoute' Pbx.XOutboundRulePurge: title: XOutboundRulePurge type: object properties: Ids: type: array items: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 Pbx.Parameter: title: Parameter type: object properties: Description: type: string nullable: true Id: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 Name: type: string nullable: true Value: maxLength: 131072 type: string nullable: true Pbx.DNProperty: title: DNProperty type: object properties: Description: type: string nullable: true Id: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Name: type: string Value: maxLength: 131072 type: string nullable: true Pbx.Peer: title: Peer type: object properties: Hidden: type: boolean nullable: true Id: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 MemberOf: type: array items: $ref: '#/components/schemas/Pbx.PeerGroup' x-ms-navigationProperty: true Name: type: string nullable: true Number: type: string nullable: true Tags: type: array items: $ref: '#/components/schemas/Pbx.UserTag' Type: allOf: - $ref: '#/components/schemas/Pbx.PeerType' nullable: true Pbx.RetreivePeersRequest: title: RetreivePeersRequest type: object properties: DnNumbers: type: array items: type: string IsReportPeers: type: boolean Pbx.Trunk: allOf: - $ref: '#/components/schemas/Pbx.DN' - title: Trunk type: object properties: AuthID: type: string nullable: true AuthPassword: allOf: - $ref: '#/components/schemas/Pbx.ConcealedPassword' nullable: true AutoHolidayMode: allOf: - $ref: '#/components/schemas/Pbx.HolidayMode' nullable: true Certificate: type: string nullable: true CertificateExpirationDate: type: string nullable: true CertificateName: type: string nullable: true ConfigurationIssue: type: string nullable: true DidNumbers: type: array items: type: string Direction: allOf: - $ref: '#/components/schemas/Pbx.DirectionType' nullable: true DisableVideo: type: boolean nullable: true DiversionHeader: type: boolean nullable: true E164CountryCode: type: string nullable: true E164ProcessIncomingNumber: type: boolean nullable: true EmergencyGeoLocations: type: array items: $ref: '#/components/schemas/Pbx.EmergencyGeoTrunkLocation' x-ms-navigationProperty: true EnableInboundCalls: type: boolean nullable: true EnableOutboundCalls: type: boolean nullable: true ExternalNumber: type: string nullable: true Gateway: allOf: - $ref: '#/components/schemas/Pbx.Gateway' nullable: true InCIDFormatting: type: array items: $ref: '#/components/schemas/Pbx.CIDFormatting' IPRestriction: allOf: - $ref: '#/components/schemas/Pbx.TypeOfIPRestriction' nullable: true IsOnline: type: boolean nullable: true Messaging: allOf: - $ref: '#/components/schemas/Pbx.TrunkMessaging' nullable: true OutboundCallerID: type: string nullable: true OutCIDFormatting: type: array items: $ref: '#/components/schemas/Pbx.CIDFormatting' PublicInfoGroups: type: array items: type: string PublicIPinSIP: type: string nullable: true PublishInfo: type: boolean nullable: true ReceiveExtensions: type: array items: $ref: '#/components/schemas/Pbx.Peer' x-ms-navigationProperty: true ReceiveInfo: type: boolean nullable: true RemoteMyPhoneUriHost: type: string nullable: true RemotePBXPreffix: type: string nullable: true RoutingRules: type: array items: $ref: '#/components/schemas/Pbx.InboundRule' x-ms-navigationProperty: true SecondaryRegistrar: type: string nullable: true SeparateAuthId: type: string nullable: true SimultaneousCalls: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Tags: type: array items: $ref: '#/components/schemas/Pbx.UserTag' TransportRestriction: allOf: - $ref: '#/components/schemas/Pbx.TypeOfTransportRestriction' nullable: true TrunkRegTimes: type: array items: $ref: '#/components/schemas/Pbx.Variable' TunnelEnabled: type: boolean nullable: true TunnelRemoteAddr: type: string nullable: true TunnelRemotePort: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true UseSeparateAuthId: type: boolean nullable: true Pbx.TrunkReport: title: TrunkReport type: object properties: Code: allOf: - $ref: '#/components/schemas/Pbx.AnalysisCode' nullable: true Level: allOf: - $ref: '#/components/schemas/Pbx.InfoLevel' nullable: true Params: type: array items: type: string Template: type: string Pbx.TrunkTestResult: title: TrunkTestResult type: object properties: Log: type: array items: $ref: '#/components/schemas/Pbx.LogEntry' Reports: type: array items: $ref: '#/components/schemas/Pbx.TrunkReport' Pbx.SetRouteRequest: title: SetRouteRequest type: object properties: Id: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 Routes: type: array items: $ref: '#/components/schemas/Pbx.SetRoute' Pbx.GetProviderPhones: title: GetProviderPhones type: object properties: AccountSid: type: string ApiKey: type: string NextPageToken: type: string nullable: true PhonesPageSize: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 Type: $ref: '#/components/schemas/Pbx.TrunkType' Pbx.ProviderPhones: title: ProviderPhones type: object properties: NextPageToken: type: string nullable: true Phones: type: array items: $ref: '#/components/schemas/Pbx.ProviderPhone' Pbx.CreateTrunk: title: CreateTrunk type: object properties: AccountSid: type: string nullable: true ApiKey: type: string nullable: true DefaultRule: allOf: - $ref: '#/components/schemas/Pbx.InboundRule' nullable: true x-ms-navigationProperty: true Groups: type: array items: $ref: '#/components/schemas/Pbx.UserGroup' x-ms-navigationProperty: true Name: type: string nullable: true PhoneNumbers: type: array items: $ref: '#/components/schemas/Pbx.ProviderPhone' Type: allOf: - $ref: '#/components/schemas/Pbx.TrunkType' nullable: true Pbx.InboundRule: title: InboundRule type: object properties: AlterDestinationDuringHolidays: type: boolean nullable: true AlterDestinationDuringOutOfOfficeHours: type: boolean nullable: true CallType: allOf: - $ref: '#/components/schemas/Pbx.RuleCallTypeType' nullable: true Condition: allOf: - $ref: '#/components/schemas/Pbx.RuleConditionType' nullable: true CustomData: type: string nullable: true Data: type: string nullable: true HolidaysDestination: allOf: - $ref: '#/components/schemas/Pbx.Destination' nullable: true Hours: allOf: - $ref: '#/components/schemas/Pbx.Schedule' nullable: true Id: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 OfficeHoursDestination: allOf: - $ref: '#/components/schemas/Pbx.Destination' nullable: true OutOfOfficeHoursDestination: allOf: - $ref: '#/components/schemas/Pbx.Destination' nullable: true RuleName: type: string nullable: true TrunkDN: allOf: - $ref: '#/components/schemas/Pbx.Peer' nullable: true x-ms-navigationProperty: true Pbx.Country: title: Country type: object properties: Continent: type: string nullable: true CountryCode: type: string nullable: true CountryCodes: type: array items: type: string DownloadUrl: type: string nullable: true ErpCode: type: string nullable: true ExitCode: type: string nullable: true Name: type: string ParentErpCode: type: string nullable: true StunServer: type: string nullable: true VoicemailNo: type: string nullable: true WebMeetingZone: type: string nullable: true Pbx.Fxs: title: Fxs type: object properties: Brand: type: string nullable: true Codecs: type: array items: type: string FxsLineCount: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true FxsLines: type: array items: $ref: '#/components/schemas/Pbx.DeviceLine' Group: type: string nullable: true Language: type: string nullable: true MacAddress: type: string Model: type: string nullable: true ModelName: type: string nullable: true Name: type: string nullable: true Password: type: string nullable: true Provisioning: allOf: - $ref: '#/components/schemas/Pbx.FxsProvisioning' nullable: true Registered: allOf: - $ref: '#/components/schemas/Pbx.RegistrarFxs' nullable: true x-ms-navigationProperty: true Secret: type: string nullable: true Template: allOf: - $ref: '#/components/schemas/Pbx.FxsTemplate' nullable: true x-ms-navigationProperty: true TimeZone: type: string nullable: true Variables: type: array items: $ref: '#/components/schemas/Pbx.Variable' Pbx.LicenseStatus: title: LicenseStatus type: object properties: Activated: type: boolean nullable: true ActiveModules: type: array items: type: string AdminEMail: type: string nullable: true CompanyName: type: string nullable: true ContactName: type: string nullable: true CountryCode: type: string nullable: true CountryName: type: string nullable: true EMail: type: string nullable: true ExpirationDate: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time nullable: true LicenseActive: type: boolean nullable: true LicenseKey: type: string MaintenanceExpiresAt: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time nullable: true MaxSimCalls: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true ProductCode: type: string nullable: true ResellerName: type: string nullable: true SimMeetingParticipants: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Support: type: boolean nullable: true Telephone: type: string nullable: true Version: type: string nullable: true Pbx.ResellerInfo: title: ResellerInfo type: object properties: Id: type: string nullable: true Name: type: string nullable: true Pbx.XLicenseParams: title: XLicenseParams type: object properties: CompanyName: type: string nullable: true ContactName: type: string nullable: true Country: type: string nullable: true Email: type: string nullable: true Phone: type: string nullable: true Pbx.PromptSet: title: PromptSet type: object properties: CultureCode: type: string nullable: true Description: type: string nullable: true Folder: type: string nullable: true Id: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 LanguageCode: type: string nullable: true Prompts: type: array items: $ref: '#/components/schemas/Pbx.Prompt' x-ms-navigationProperty: true PromptSetName: type: string nullable: true PromptSetType: allOf: - $ref: '#/components/schemas/Pbx.PromptSetType' nullable: true UseAlternateNumberPronunciation: type: boolean nullable: true Version: type: string nullable: true Pbx.CustomPrompt: title: CustomPrompt type: object properties: CanBeDeleted: type: boolean DisplayName: type: string FileLink: type: string Filename: type: string PromptType: $ref: '#/components/schemas/Pbx.PromptType' Pbx.Property: title: Property type: object properties: Description: type: string nullable: true Name: type: string Value: maxLength: 131072 type: string Pbx.FxsTemplate: title: FxsTemplate type: object properties: AllowedNetConfigs: type: array items: type: string AllowSSLProvisioning: type: boolean nullable: true Brand: type: string Content: type: string nullable: true DeviceType: $ref: '#/components/schemas/Pbx.DeviceType' Id: type: string IsCustom: type: boolean Languages: type: array items: type: string Models: type: array items: $ref: '#/components/schemas/Pbx.FxsModel' NumberOfExtensions: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 RpsEnabled: type: boolean nullable: true TemplateType: $ref: '#/components/schemas/Pbx.TemplateType' TimeZones: type: array items: type: string URL: type: string Variables: type: array items: $ref: '#/components/schemas/Pbx.FxsVariable' Pbx.Weblink: title: Weblink type: object properties: Advanced: allOf: - $ref: '#/components/schemas/Pbx.LiveChatAdvancedSettings' nullable: true CallsEnabled: type: boolean nullable: true ChatBox: allOf: - $ref: '#/components/schemas/Pbx.LiveChatBox' nullable: true ChatEnabled: type: boolean nullable: true DefaultRecord: type: boolean nullable: true DN: allOf: - $ref: '#/components/schemas/Pbx.Peer' nullable: true x-ms-navigationProperty: true EnableReCaptcha: type: boolean nullable: true General: allOf: - $ref: '#/components/schemas/Pbx.GeneralLiveChatSettings' nullable: true Group: type: string nullable: true Hidden: type: boolean nullable: true Id: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Link: type: string MeetingEnabled: type: boolean nullable: true Name: type: string nullable: true Styling: allOf: - $ref: '#/components/schemas/Pbx.LiveChatStyling' nullable: true Translations: allOf: - $ref: '#/components/schemas/Pbx.WebsiteLinksTranslations' nullable: true Website: type: array items: type: string Pbx.ChatLinkNameValidation: title: ChatLinkNameValidation type: object properties: FriendlyName: type: string Pair: type: string Pbx.UpdateSettings: title: UpdateSettings type: object properties: AutoUpdateEnabled: type: boolean nullable: true Schedule: allOf: - $ref: '#/components/schemas/Pbx.BackupSchedule' nullable: true Pbx.UpdateList: title: UpdateList type: object properties: Entries: type: array items: $ref: '#/components/schemas/Pbx.UpdateItem' IsMaintananceExpired: type: boolean nullable: true Key: pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$' type: string format: uuid nullable: true LastSuccessfulUpdate: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time nullable: true Pbx.InstallUpdates: title: InstallUpdates type: object properties: Entries: type: array items: pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$' type: string format: uuid Key: pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$' type: string format: uuid Pbx.UpdatesStats: title: UpdatesStats type: object properties: PerPage: type: array items: $ref: '#/components/schemas/Pbx.CategoryUpdate' TcxUpdate: type: array items: $ref: '#/components/schemas/Pbx.CategoryUpdate' Pbx.Parking: allOf: - $ref: '#/components/schemas/Pbx.DN' - title: Parking type: object Pbx.Backups: title: Backups type: object properties: CreationTime: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time nullable: true DownloadLink: type: string FileName: type: string Size: type: number format: int64 nullable: true Pbx.CreateBackup: title: CreateBackup type: object properties: Contents: allOf: - $ref: '#/components/schemas/Pbx.BackupContents' nullable: true Name: type: string Pbx.BackupExtras: title: BackupExtras type: object properties: Footprint: type: number format: int64 nullable: true IsEncrypted: type: boolean nullable: true Version: type: string Pbx.BackupSettings: title: BackupSettings type: object properties: Contents: allOf: - $ref: '#/components/schemas/Pbx.BackupContents' nullable: true Rotation: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Schedule: allOf: - $ref: '#/components/schemas/Pbx.BackupSchedule' nullable: true ScheduleEnabled: type: boolean nullable: true Pbx.BackupRepositorySettings: title: BackupRepositorySettings type: object properties: Location: allOf: - $ref: '#/components/schemas/Pbx.LocationSettings' nullable: true Pbx.BackupFailoverSettings: title: BackupFailoverSettings type: object properties: Condition: allOf: - $ref: '#/components/schemas/Pbx.FailoverCondition' nullable: true Enabled: type: boolean nullable: true Interval: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Mode: allOf: - $ref: '#/components/schemas/Pbx.FailoverMode' nullable: true PostStartScript: type: string nullable: true PreStartScript: type: string nullable: true RemoteServer: type: string nullable: true TestSIPServer: type: boolean nullable: true TestTunnel: type: boolean nullable: true TestWebServer: type: boolean nullable: true Pbx.FailoverScriptFile: title: FailoverScriptFile type: object properties: Filename: type: string Pbx.RestoreSettings: title: RestoreSettings type: object properties: EncryptBackup: type: boolean nullable: true EncryptBackupPassword: allOf: - $ref: '#/components/schemas/Pbx.ConcealedPassword' nullable: true Schedule: allOf: - $ref: '#/components/schemas/Pbx.BackupSchedule' nullable: true ScheduleEnabled: type: boolean nullable: true Pbx.Sbc: title: Sbc type: object properties: AudioPort: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Connection: allOf: - $ref: '#/components/schemas/Pbx.XSBCConnection' nullable: true DisplayName: type: string Group: type: string nullable: true HasConnection: type: boolean nullable: true LocalIPv4: type: string nullable: true LogLevel: allOf: - $ref: '#/components/schemas/Pbx.SbcLogLevel' nullable: true LogSize: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Name: maxLength: 12 type: string PassiveServer: type: string nullable: true PassiveServerIsEnabled: type: boolean nullable: true Password: type: string PhoneMAC: type: string nullable: true PhoneUserId: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true ProvisionLink: type: string nullable: true PublicIP: type: string nullable: true Security: allOf: - $ref: '#/components/schemas/Pbx.Security' nullable: true Version: type: string nullable: true Pbx.RegistrarFxs: title: RegistrarFxs type: object properties: InterfaceLink: type: string MacAddress: type: string Pbx.CallFlowApp: allOf: - $ref: '#/components/schemas/Pbx.DN' - title: CallFlowApp type: object properties: CompilationLastSuccess: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time nullable: true CompilationResult: type: string nullable: true CompilationSucceeded: type: boolean nullable: true InvalidScript: type: boolean nullable: true IsRegistered: type: boolean nullable: true Name: type: string nullable: true RejectedCode: type: string nullable: true RoutingType: allOf: - $ref: '#/components/schemas/Pbx.CfaRoutingType' nullable: true ScriptCode: type: string nullable: true Trunk: allOf: - $ref: '#/components/schemas/Pbx.Trunk' nullable: true x-ms-navigationProperty: true Pbx.ServicePrincipal: allOf: - $ref: '#/components/schemas/Pbx.DN' - title: ServicePrincipal type: object properties: CallControlEnabled: type: boolean nullable: true IsSystem: type: boolean nullable: true LastUsed: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time nullable: true MyPhoneEnabled: type: boolean nullable: true Peers: type: array items: $ref: '#/components/schemas/Pbx.Peer' x-ms-navigationProperty: true XAPIEnabled: type: boolean nullable: true Pbx.CrmTemplate: title: CrmTemplate type: object properties: Authentication: allOf: - $ref: '#/components/schemas/Pbx.CrmAuthentication' nullable: true Name: type: string Parameters: type: array items: $ref: '#/components/schemas/Pbx.CrmParameter' Pbx.NetworkSettings: title: NetworkSettings type: object properties: AllowSourceAsOutbound: type: boolean nullable: true DirectSIPAllowExternal: type: boolean nullable: true DirectSIPLocalDomain: type: string nullable: true FirewallKeepAlive: type: boolean nullable: true FirewallKeepAliveInterval: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Id: type: string IpV6BindingEnabled: type: boolean nullable: true PbxPublicFQDN: type: string nullable: true PublicInterface: type: string nullable: true PublicStaticIP: type: string nullable: true SipPort: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true StunDisabled: type: boolean nullable: true StunPrimaryHost: type: string nullable: true StunPrimaryPort: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true StunQuery: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true StunSecondaryHost: type: string nullable: true StunSecondaryPort: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true StunThirdHost: type: string nullable: true StunThirdPort: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true TunnelPort: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Pbx.CDRSettings: title: CDRSettings type: object properties: Enabled: type: boolean nullable: true EnabledFields: type: array items: $ref: '#/components/schemas/Pbx.CDRSettingsField' LogSize: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true LogType: allOf: - $ref: '#/components/schemas/Pbx.TypeOfCDRLog' nullable: true PossibleFields: type: array items: type: string RemoveCommaDelimiters: type: boolean nullable: true SocketIpAddress: type: string nullable: true SocketPort: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Pbx.CallCostSettings: title: CallCostSettings type: object properties: CountryName: type: string nullable: true Id: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 Invalid: type: boolean nullable: true Prefix: type: string nullable: true Rate: oneOf: - type: number format: float nullable: true - type: string nullable: true - $ref: '#/components/schemas/ReferenceNumeric' ReadOnly: type: boolean nullable: true Pbx.PhoneLogo: title: PhoneLogo type: object properties: DisplayName: type: string nullable: true Filename: type: string Pbx.ActiveCall: title: ActiveCall type: object properties: Callee: type: string nullable: true Caller: type: string nullable: true EstablishedAt: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time nullable: true Id: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 LastChangeStatus: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time nullable: true ServerNow: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time nullable: true Status: type: string nullable: true Pbx.EventLog: title: EventLog type: object properties: EventId: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Group: type: string nullable: true GroupName: type: string nullable: true Id: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 Message: type: string nullable: true Params: type: array items: type: string Source: type: string nullable: true TimeGenerated: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time nullable: true Type: allOf: - $ref: '#/components/schemas/Pbx.EventLogType' nullable: true Pbx.ServiceInfo: title: ServiceInfo type: object properties: DisplayName: type: string HandleCount: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true MemoryUsed: type: number format: int64 nullable: true Name: type: string RestartEnabled: type: boolean nullable: true SampleTime: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time nullable: true StartStopEnabled: type: boolean nullable: true Status: allOf: - $ref: '#/components/schemas/Pbx.ServiceStatus' nullable: true ThreadCount: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true TotalProcessorTime: type: number format: int64 nullable: true Pbx.GarbageCollect: title: GarbageCollect type: object properties: Blocking: type: boolean nullable: true Compacting: type: boolean nullable: true Generation: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Mode: allOf: - $ref: '#/components/schemas/Pbx.GCCollectionMode' nullable: true Pbx.XServiceManageOptions: title: XServiceManageOptions type: object properties: ServiceNames: type: array items: type: string Pbx.FirewallState: title: FirewallState type: object properties: Html: type: string nullable: true Id: type: string Running: type: boolean nullable: true Stopping: type: boolean nullable: true Pbx.Microsoft365Integration: title: Microsoft365Integration type: object properties: AdUsers: allOf: - $ref: '#/components/schemas/Pbx.ADUsersSyncConfiguration' nullable: true ApplicationId: type: string Id: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 SharedMailboxesSync: allOf: - $ref: '#/components/schemas/Pbx.UsersSyncConfiguration' nullable: true TenantId: type: string Pbx.ExternalAccount: title: ExternalAccount type: object properties: Email: type: string Id: type: string Name: type: string Pbx.ExternalGroup: title: ExternalGroup type: object properties: Description: type: string DisplayName: type: string Id: type: string Pbx.Microsoft365SubscriptionTestResult: title: Microsoft365SubscriptionTestResult type: object properties: ExceptionMessage: type: string nullable: true Fqdn: type: string nullable: true IsSubscriptionAvailable: type: boolean nullable: true Pbx.Microsoft365Status: title: Microsoft365Status type: object properties: ApplicationId: type: string nullable: true ExceptionMessage: type: string nullable: true ProvisionUrl: type: string nullable: true Pbx.ExternalAccountsPage: title: ExternalAccountsPage type: object properties: NextPageToken: type: string nullable: true Users: type: array items: $ref: '#/components/schemas/Pbx.ExternalAccount' Pbx.UsersRequestOptions: title: UsersRequestOptions type: object properties: Count: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 NextPageToken: maxLength: 10240 type: string nullable: true Search: type: string nullable: true TypeOfUser: $ref: '#/components/schemas/Pbx.TypeOfUser' Pbx.ExternalGroupsPage: title: ExternalGroupsPage type: object properties: Groups: type: array items: $ref: '#/components/schemas/Pbx.ExternalGroup' NextPageToken: type: string nullable: true Pbx.GroupsRequestOptions: title: GroupsRequestOptions type: object properties: Count: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 NextPageToken: maxLength: 10240 type: string nullable: true Search: type: string nullable: true Pbx.Microsoft365TeamsIntegration: title: Microsoft365TeamsIntegration type: object properties: AreaCode: type: string nullable: true DialPlanCode: type: string nullable: true Enabled: type: boolean nullable: true Id: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 IsDynamicIP: type: boolean nullable: true IsNativeFQDN: type: boolean nullable: true SbcCertificate: allOf: - $ref: '#/components/schemas/Pbx.ConcealedDataFile' nullable: true SbcCertificateExpirationDate: type: string nullable: true SbcFQDN: type: string nullable: true SbcPrivateKey: allOf: - $ref: '#/components/schemas/Pbx.ConcealedDataFile' nullable: true SecureSipEnabled: type: boolean nullable: true SipDomain: type: string nullable: true TlsPortForNativeFQDN: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true TlsPortForNonNativeFQDN: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Pbx.VoicemailSettings: title: VoicemailSettings type: object properties: AutoDeleteDays: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true AutoDeleteEnabled: type: boolean nullable: true CallRecordingStereo: type: boolean nullable: true Extension: type: string nullable: true Id: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 MinDuration: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true OperatorEnabled: type: boolean nullable: true Quota: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true RemoteStorageEnabled: type: boolean nullable: true SendEmailQuotaEnabled: type: boolean nullable: true SendEmailQuotaPercentage: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true TranscribeEngine: allOf: - $ref: '#/components/schemas/Pbx.TranscribeEngine' nullable: true TranscribeLanguage: type: string nullable: true TranscribeModelOpenAI: allOf: - $ref: '#/components/schemas/Pbx.OpenAIModel' nullable: true TranscribeRegion: type: string nullable: true TranscribeSecretKey: allOf: - $ref: '#/components/schemas/Pbx.ConcealedPassword' nullable: true UsedSpace: type: number format: int64 nullable: true Pbx.LanguageItem: title: LanguageItem type: object properties: Code: type: string nullable: true Name: type: string nullable: true Pbx.OnBoardUICommand: title: OnBoardUICommand type: object properties: ErrorMessage: type: string McuId: type: string Operation: type: string RequestExpiration: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time State: type: string Pbx.OnBoardConverterSession: title: OnBoardConverterSession type: object properties: Attempts: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 CallId: type: string Descr: type: string ErrorMessage: type: string Eta: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time Id: type: string Progress: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 Pbx.OnBoardConverterDataDetail: title: OnBoardConverterDataDetail type: object properties: Active: type: boolean Cloud: type: boolean Enabled: type: boolean Guid: type: string Host: type: string Ip: type: string Port: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 Version: type: string Pbx.OnBoardConverterRow: title: OnBoardConverterRow type: object properties: Active: type: boolean Cloud: type: boolean Enabled: type: boolean Guid: type: string Host: type: string InstallScript: type: string Ip: type: string Port: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 Secret: type: string ServerOS: $ref: '#/components/schemas/Pbx.OnBoardMcuServerOS' ServerStatus: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 TsActivated: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time TsCreated: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time Version: type: string Pbx.OnBoardConverterData: title: OnBoardConverterData type: object properties: Available: type: boolean ClockSkew: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 Converter: $ref: '#/components/schemas/Pbx.OnBoardConverterDataDetail' Cpu: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 Delay: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 DiskSpacePerc: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 Instances: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 MemoryPerc: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 Sessions: type: array items: $ref: '#/components/schemas/Pbx.OnBoardConverterSession' TranscriptionQueue: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Ts: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time Pbx.ConferenceSettings: title: ConferenceSettings type: object properties: AutoCallParticipants: type: boolean nullable: true DtmfMode: allOf: - $ref: '#/components/schemas/Pbx.DtmfMode' nullable: true EnableLocalMCU: type: boolean nullable: true EnablePin: type: boolean nullable: true Extension: type: string nullable: true ExternalNumbers: type: string nullable: true Id: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 LogoPath: type: string nullable: true MusicOnHold: type: string nullable: true PinNumber: type: string nullable: true Zone: type: string nullable: true Pbx.MCURequestStatus: title: MCURequestStatus type: object properties: ErrorMessage: type: string nullable: true McuId: type: string nullable: true Operation: allOf: - $ref: '#/components/schemas/Pbx.McuOperation' nullable: true RequestExpiration: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time nullable: true State: allOf: - $ref: '#/components/schemas/Pbx.McuReqState' nullable: true Pbx.OnBoardMcuRow: title: OnBoardMcuRow type: object properties: Active: type: boolean BandCap: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 CityName: type: string Cloud: type: boolean Country: type: string CountryName: type: string Enabled: type: boolean Guid: type: string Host: type: string InstallScript: type: string Ip: type: string Latitude: oneOf: - type: number format: float nullable: true - type: string nullable: true - $ref: '#/components/schemas/ReferenceNumeric' Longitude: oneOf: - type: number format: float nullable: true - type: string nullable: true - $ref: '#/components/schemas/ReferenceNumeric' ManualGeo: type: boolean PartsCap: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 Port: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 Secret: type: string ServerOS: $ref: '#/components/schemas/Pbx.OnBoardMcuServerOS' ServerStatus: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 TsActivated: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time TsCreated: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time Version: type: string Zone: type: string Pbx.OnBoardMcuData: title: OnBoardMcuData type: object properties: Attempts: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 AttendeeCount: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 ClockSkew: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 Connected: type: boolean Cpu: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 Delay: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 Fqdn: type: string FreeDiskSpace: type: integer format: int64 Mcu: $ref: '#/components/schemas/Pbx.OnBoardMcuDataDetail' MeetingCount: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 Memory: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 NetIn: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 NetOut: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 RestartTime: type: string StartTime: type: string Ts: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time UpdateInterval: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 Pbx.OnBoardMeeting: title: OnBoardMeeting type: object properties: McuFqdn: type: string Meeting: $ref: '#/components/schemas/Pbx.MeetingObj' MeetingId: type: string Parts: type: array items: $ref: '#/components/schemas/Pbx.KeyValuePair_2OfString_OnBoardConnectedParticipant' Profile: type: string Recorded: type: boolean Sessionid: type: string Start: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time Pbx.NotificationSettings: title: NotificationSettings type: object properties: AutoRestartFailedServices: type: boolean nullable: true CanEditEmailAddresses: type: boolean nullable: true EmailAddresses: type: string nullable: true NotifyCodes: type: array items: $ref: '#/components/schemas/Pbx.NotifyCodes' NotifyExtensionAdded: type: boolean nullable: true NotifyServiceStopped: type: boolean nullable: true NotifySuccessScheduledBackups: type: boolean nullable: true NotifySystemOwners: type: boolean nullable: true NotifyUpdatesAvailable: type: boolean nullable: true Setpoints: type: array items: $ref: '#/components/schemas/Pbx.Setpoint' Pbx.MailSettings: title: MailSettings type: object properties: CanEditMailServerType: type: boolean nullable: true MailAddress: type: string nullable: true MailPassword: allOf: - $ref: '#/components/schemas/Pbx.ConcealedPassword' nullable: true MailServer: type: string nullable: true MailServerType: allOf: - $ref: '#/components/schemas/Pbx.MailServerType' nullable: true MailSslEnabled: type: boolean nullable: true MailUser: type: string nullable: true Pbx.TestResult: title: TestResult type: object properties: Error: type: string nullable: true Parameters: type: array items: type: string Success: type: boolean nullable: true Pbx.EmailTemplate: title: EmailTemplate type: object properties: Body: maxLength: 102400 type: string From: type: string nullable: true IsConference: type: boolean nullable: true IsDefault: type: boolean nullable: true Lang: type: string nullable: true Name: type: string nullable: true Subject: type: string nullable: true TemplatePath: type: string Pbx.HotelServices: title: HotelServices type: object properties: Enabled: type: boolean nullable: true HotelGroups: type: array items: type: string IntegrationType: allOf: - $ref: '#/components/schemas/Pbx.PmsIntegrationType' nullable: true IpAddress: type: string nullable: true NoAnswerDestination: allOf: - $ref: '#/components/schemas/Pbx.Destination' nullable: true NoAnswerTimeout: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Port: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Pbx.Firmware: title: Firmware type: object properties: Filename: type: string nullable: true Id: type: string Model: type: string nullable: true Vendor: type: string nullable: true Version: type: string nullable: true Pbx.FirmwareState: title: FirmwareState type: object properties: Count: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true FileNames: type: array items: type: string Id: type: string nullable: true TotalSize: type: number format: int64 nullable: true Pbx.AISettings: title: AISettings type: object properties: APIKey: allOf: - $ref: '#/components/schemas/Pbx.ConcealedPassword' nullable: true CompanyDescription: type: string nullable: true CompanyName: type: string nullable: true CompletionModel: type: string nullable: true RealtimeModel: type: string nullable: true Pbx.AIVoice: title: AIVoice type: object properties: Description: type: string Gender: type: string Id: type: string Pbx.AIAgentTemplate: title: AIAgentTemplate type: object properties: Description: type: string FirstMessage: type: string Id: type: string Name: type: string Preview: type: boolean Pbx.AIModel: title: AIModel type: object properties: Id: type: string Name: type: string Preview: type: boolean Pbx.AIResources: title: AIResources type: object properties: Chips: type: array items: $ref: '#/components/schemas/Pbx.AIModel' Models: type: array items: $ref: '#/components/schemas/Pbx.AIModel' RealtimeModels: type: array items: $ref: '#/components/schemas/Pbx.AIModel' Templates: type: array items: $ref: '#/components/schemas/Pbx.AIAgentTemplate' Voices: type: array items: $ref: '#/components/schemas/Pbx.AIVoice' Pbx.VectorStore: title: VectorStore type: object properties: Bytes: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true CreatedAt: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time nullable: true Description: type: string nullable: true Expiration: allOf: - $ref: '#/components/schemas/Pbx.VectorStoreExpiration' nullable: true FilesCompleted: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true FilesTotal: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Id: type: string nullable: true Name: type: string nullable: true Status: type: string nullable: true Pbx.VectorStores: title: VectorStores type: object properties: FirstId: type: string nullable: true HasMore: type: boolean nullable: true Items: type: array items: $ref: '#/components/schemas/Pbx.VectorStore' LastId: type: string nullable: true Pbx.VectorStoreFiles: title: VectorStoreFiles type: object properties: FirstId: type: string nullable: true HasMore: type: boolean nullable: true Items: type: array items: $ref: '#/components/schemas/Pbx.VectorStoreFile' LastId: type: string nullable: true Pbx.VectorStoreFile: title: VectorStoreFile type: object properties: CreatedAt: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time nullable: true Id: type: string nullable: true Name: type: string nullable: true Size: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Status: type: string nullable: true VectorStoreId: type: string nullable: true Pbx.AddVectorStoreFiles: title: AddVectorStoreFiles type: object properties: FileIds: type: array items: type: string VectorId: type: string Pbx.SystemStatus: title: SystemStatus type: object properties: Activated: type: boolean nullable: true AutoUpdateEnabled: type: boolean nullable: true AvailableLocalIps: type: string nullable: true BackupScheduled: type: boolean nullable: true CallsActive: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true ChatUsedSpace: type: number format: int64 nullable: true CurrentLocalIp: type: string nullable: true DBMaintenanceInProgress: type: boolean nullable: true DiskUsage: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true ExpirationDate: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time nullable: true ExtensionsRegistered: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true ExtensionsTotal: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true FQDN: type: string nullable: true FreeDiskSpace: type: number format: int64 nullable: true HasNotRunningServices: type: boolean nullable: true HasUnregisteredSystemExtensions: type: boolean nullable: true Id: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 Ip: type: string nullable: true IpV4: type: string nullable: true IpV6: type: string nullable: true IsAuditLogEnabled: type: boolean nullable: true IsChatLogEnabled: type: boolean nullable: true IsRecordingArchiveEnabled: type: boolean nullable: true LastBackupDateTime: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time nullable: true LastCheckForUpdates: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time nullable: true LastSuccessfulUpdate: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time nullable: true LicenseActive: type: boolean nullable: true LicenseKey: type: string nullable: true LocalIpValid: type: boolean nullable: true LogUsedSpace: type: number format: int64 nullable: true MaintenanceExpiresAt: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time nullable: true MaxSimCalls: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true MaxUserExtensions: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true OS: allOf: - $ref: '#/components/schemas/Pbx.XOperatingSystemType' nullable: true OutboundRules: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true ProductCode: type: string nullable: true RecordingQuota: type: number format: int64 nullable: true RecordingQuotaReached: type: boolean nullable: true RecordingStopped: type: boolean nullable: true RecordingUsedSpace: type: number format: int64 nullable: true RemoteConfigurationRequired: type: boolean nullable: true RemoteStorageEnabled: type: boolean nullable: true RemoteStorageStatus: allOf: - $ref: '#/components/schemas/Pbx.RemoteStorageStatus' nullable: true ResellerName: type: string nullable: true Support: type: boolean nullable: true TotalDiskSpace: type: number format: int64 nullable: true TrunksRegistered: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true TrunksTotal: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true UserExtensions: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Version: type: string nullable: true VoicemailQuotaReached: type: boolean nullable: true VoicemailStopped: type: boolean nullable: true Pbx.SystemTelemetry: title: SystemTelemetry type: object properties: CpuUsage: oneOf: - type: number format: double nullable: true - type: string nullable: true - $ref: '#/components/schemas/ReferenceNumeric' FreeDiskSpace: type: number format: int64 nullable: true FreePhysicalMemory: type: number format: int64 nullable: true FreeVirtualMemory: type: number format: int64 nullable: true TickCount: type: number format: int64 nullable: true Time: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time nullable: true TotalDiskSpace: type: number format: int64 nullable: true TotalPhysicalMemory: type: number format: int64 nullable: true TotalVirtualMemory: type: number format: int64 nullable: true Pbx.ProcessTelemetry: title: ProcessTelemetry type: object properties: HandleCount: type: number format: int64 nullable: true PrivateMemory: type: number format: int64 nullable: true ProcessCount: type: number format: int64 nullable: true Service: allOf: - $ref: '#/components/schemas/Pbx.PhoneSystemService' nullable: true ThreadCount: type: number format: int64 nullable: true Time: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time nullable: true Pbx.NetworkTelemetry: title: NetworkTelemetry type: object properties: Id: type: string KbpsReceived: oneOf: - type: number format: double nullable: true - type: string nullable: true - $ref: '#/components/schemas/ReferenceNumeric' KbpsSent: oneOf: - type: number format: double nullable: true - type: string nullable: true - $ref: '#/components/schemas/ReferenceNumeric' Time: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time nullable: true Pbx.MyPhoneRequestStats: title: MyPhoneRequestStats type: object properties: AvgDuration: oneOf: - type: number format: double nullable: true - type: string nullable: true - $ref: '#/components/schemas/ReferenceNumeric' Count: type: number format: int64 nullable: true MaxDuration: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true RequestId: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true SumDuration: type: number format: int64 nullable: true Pbx.SystemExtensionStatus: title: SystemExtensionStatus type: object properties: IsRegistered: type: boolean nullable: true Name: type: string nullable: true Number: type: string nullable: true Type: type: string nullable: true Pbx.CreateTicket: title: CreateTicket type: object properties: CanCreateTicket: type: boolean nullable: true CreateTicketStatus: allOf: - $ref: '#/components/schemas/Pbx.CreateTicketStatus' nullable: true FixUrl: type: string nullable: true Pbx.SystemDatabaseInformation: title: SystemDatabaseInformation type: object properties: CallsUsedSpace: type: number format: int64 nullable: true ChatFilesCount: type: number format: int64 nullable: true ChatsUsedSpace: type: number format: int64 nullable: true EventLogUsedSpace: type: number format: int64 nullable: true Id: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Pbx.VersionUpdateType: title: VersionUpdateType type: object properties: Type: allOf: - $ref: '#/components/schemas/Pbx.UpdateType' nullable: true Pbx.SystemHealthStatus: title: SystemHealthStatus type: object properties: CustomTemplatesCount: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Firewall: type: boolean nullable: true Id: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Phones: type: boolean nullable: true Trunks: type: boolean nullable: true UnsupportedFirmwaresCount: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Pbx.RequestHelp: title: RequestHelp type: object properties: GrantPeriodDays: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true IssueDescription: maxLength: 2048 type: string Name: type: string PhoneNumber: type: string nullable: true ReplyEmail: type: string Pbx.Playlist: title: Playlist type: object properties: AutoGain: type: boolean nullable: true Files: type: array items: type: string MaxVolumePercent: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Name: type: string PromptName: type: string nullable: true RepositoryPath: type: string nullable: true Shuffle: type: boolean nullable: true Pbx.FaxServerSettings: title: FaxServerSettings type: object properties: AuthId: type: string nullable: true AuthPassword: allOf: - $ref: '#/components/schemas/Pbx.ConcealedPassword' nullable: true AutoCleanup: type: boolean nullable: true Email: type: string nullable: true FaxServerId: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true G711ToT38Fallback: type: boolean nullable: true MaxAge: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Number: type: string RemoteStorageEnabled: type: boolean nullable: true Pbx.Fax: allOf: - $ref: '#/components/schemas/Pbx.DN' - title: Fax type: object properties: AuthID: type: string nullable: true AuthPassword: type: string nullable: true FaxServer: type: boolean nullable: true OutboundCallerId: type: string nullable: true Pbx.CrmIntegration: title: CrmIntegration type: object properties: Country: type: string nullable: true EnabledForDidCalls: type: boolean nullable: true EnabledForExternalCalls: type: boolean nullable: true Id: type: string Name: type: string PhonebookPriorityOptions: allOf: - $ref: '#/components/schemas/Pbx.PhonebookPriorityOptions' nullable: true PhonebookSynchronization: type: boolean nullable: true PossibleValues: type: array items: $ref: '#/components/schemas/Pbx.CrmSelectableValue' x-ms-navigationProperty: true VariableChoices: type: array items: $ref: '#/components/schemas/Pbx.CrmChoice' Pbx.CrmTestResult: title: CrmTestResult type: object properties: IsError: type: boolean nullable: true Log: type: string nullable: true Message: type: string nullable: true SearchResult: type: array items: $ref: '#/components/schemas/Pbx.CrmContact' Pbx.OauthStateParam: title: OauthStateParam type: object properties: PKCECodeVerifier: type: string nullable: true RedirectUri: type: string Variable: type: string Pbx.OauthState: title: OauthState type: object properties: CodeChallenge: type: string nullable: true State: type: string nullable: true Pbx.CrmChoice: title: CrmChoice type: object properties: Key: type: string Value: type: string nullable: true Pbx.CrmTemplateSource: title: CrmTemplateSource type: object properties: Value: type: string nullable: true Pbx.DidNumber: title: DidNumber type: object properties: Number: type: string RoutingRule: allOf: - $ref: '#/components/schemas/Pbx.InboundRule' nullable: true x-ms-navigationProperty: true TemplateFileName: type: string nullable: true TrunkId: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 Pbx.ActivityLogEvent: title: ActivityLogEvent type: object properties: Index: type: integer format: int64 Message: type: string nullable: true TimeStamp: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time nullable: true Pbx.ActivityLogsFilter: title: ActivityLogsFilter type: object properties: Extensions: type: array items: $ref: '#/components/schemas/Pbx.ExtensionFilter' Pbx.RefreshToken: title: RefreshToken type: object properties: Created: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time CreatedByIp: type: string CreatedByUserAgent: type: string DisplayName: type: string nullable: true Expires: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time Id: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 LoginType: $ref: '#/components/schemas/Pbx.LoginType' ReasonRevoked: allOf: - $ref: '#/components/schemas/Pbx.RevokeReason' nullable: true Revoked: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time nullable: true RevokedByIp: type: string nullable: true SlidingExpiration: type: boolean Token: type: string Used: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time UsedByIp: type: string UsedByUserAgent: type: string Username: type: string Pbx.Holiday: title: Holiday type: object properties: Day: type: integer format: uint8 DayEnd: type: integer format: uint8 Group: type: string nullable: true HolidayPrompt: type: string nullable: true Id: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 IsRecurrent: type: boolean nullable: true Month: type: integer format: uint8 MonthEnd: type: integer format: uint8 Name: type: string TimeOfEndDate: pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' type: string format: duration TimeOfStartDate: pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' type: string format: duration Year: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 YearEnd: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 Pbx.RemoteArchivingSettings: title: RemoteArchivingSettings type: object properties: Backups: allOf: - $ref: '#/components/schemas/Pbx.ArchiveSubsystem' nullable: true Chats: allOf: - $ref: '#/components/schemas/Pbx.ArchiveSubsystem' nullable: true Faxes: allOf: - $ref: '#/components/schemas/Pbx.ArchiveSubsystem' nullable: true Id: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 Location: allOf: - $ref: '#/components/schemas/Pbx.LocationSettings' nullable: true Recordings: allOf: - $ref: '#/components/schemas/Pbx.ArchiveSubsystem' nullable: true Voicemails: allOf: - $ref: '#/components/schemas/Pbx.ArchiveSubsystem' nullable: true Pbx.EmergencyGeoLocation: title: EmergencyGeoLocation type: object properties: FriendlyName: type: string Id: type: string Pbx.EmergencyGeoTrunkLocation: title: EmergencyGeoTrunkLocation type: object properties: Id: type: string Location: $ref: '#/components/schemas/Pbx.EmergencyGeoLocation' ProviderUri: type: string TrunkDn: type: string nullable: true Pbx.DataConnectorSettings: title: DataConnectorSettings type: object properties: DataTypesToOffload: allOf: - $ref: '#/components/schemas/Pbx.DataTypesToOffload' nullable: true IsBigQueryEnabled: type: boolean nullable: true OffloadDestination: allOf: - $ref: '#/components/schemas/Pbx.OffloadDestination' nullable: true PurgeAfterSync: type: boolean nullable: true RemoteMySqlConfig: allOf: - $ref: '#/components/schemas/Pbx.RemoteMySqlConfig' nullable: true RemotePostgreConfig: allOf: - $ref: '#/components/schemas/Pbx.RemotePostgreConfig' nullable: true RemoteSqlServerConfig: allOf: - $ref: '#/components/schemas/Pbx.RemoteSqlServerConfig' nullable: true Schedule: allOf: - $ref: '#/components/schemas/Pbx.BackupSchedule' nullable: true Pbx.AmazonIntegrationSettings: title: AmazonIntegrationSettings type: object properties: S3Config: allOf: - $ref: '#/components/schemas/Pbx.S3Config' nullable: true ServiceAccountCredentials: allOf: - $ref: '#/components/schemas/Pbx.AmazonCredentials' nullable: true Pbx.SyslogSettings: title: SyslogSettings type: object properties: CategoryConfig: allOf: - $ref: '#/components/schemas/Pbx.SyslogCategoryConfig' nullable: true CustomRelayConfig: allOf: - $ref: '#/components/schemas/Pbx.SyslogCustomRelayConfig' nullable: true DatadogConfig: allOf: - $ref: '#/components/schemas/Pbx.SyslogDatadogConfig' nullable: true ElasticConfig: allOf: - $ref: '#/components/schemas/Pbx.SyslogElkConfig' nullable: true IntegrationType: allOf: - $ref: '#/components/schemas/Pbx.SyslogIntegrationType' nullable: true IsEnabled: type: boolean nullable: true SplunkConfig: allOf: - $ref: '#/components/schemas/Pbx.SyslogSplunkConfig' nullable: true Pbx.CallHistoryView: title: CallHistoryView type: object properties: CallAnswered: type: boolean nullable: true CallTime: pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' type: string format: duration DstCallerNumber: type: string nullable: true DstDisplayName: type: string nullable: true DstDn: type: string nullable: true DstDnType: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 DstExtendedDisplayName: type: string nullable: true DstExternal: type: boolean DstId: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 DstInternal: type: boolean DstParticipantId: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 DstRecId: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true SegmentActionId: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 SegmentEndTime: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time SegmentId: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 SegmentStartTime: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time SegmentType: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 SrcCallerNumber: type: string nullable: true SrcDisplayName: type: string nullable: true SrcDn: type: string nullable: true SrcDnType: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 SrcExtendedDisplayName: type: string nullable: true SrcExternal: type: boolean SrcId: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 SrcInternal: type: boolean SrcParticipantId: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 SrcRecId: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Pbx.ChatHistoryView: title: ChatHistoryView type: object properties: ChatName: type: string nullable: true ConversationId: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 FromName: type: string nullable: true FromNo: type: string nullable: true IsExternal: type: boolean Message: type: string nullable: true ParticipantEmail: type: string nullable: true ParticipantIp: type: string nullable: true ParticipantPhone: type: string nullable: true ParticipantsGroupsArray: type: array items: type: string ProviderName: type: string nullable: true ProviderType: allOf: - $ref: '#/components/schemas/Pbx.ChatType' nullable: true QueueNumber: type: string nullable: true Source: type: string nullable: true TimeSent: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time Pbx.ChatMessagesHistoryView: title: ChatMessagesHistoryView type: object properties: ConversationId: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 IsExternal: type: boolean Message: type: string nullable: true MessageId: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 ParticipantsGroupsArray: type: array items: type: string QueueNumber: type: string nullable: true Recipients: type: string nullable: true SenderParticipantEmail: type: string nullable: true SenderParticipantIp: type: string nullable: true SenderParticipantName: type: string nullable: true SenderParticipantNo: type: string nullable: true SenderParticipantPbx: type: string nullable: true SenderParticipantPhone: type: string nullable: true TimeSent: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time Pbx.LastCdrAndChatMessageTimestamp: title: LastCdrAndChatMessageTimestamp type: object properties: LastCdrStartedAt: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time LastChatMessageTimeSent: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time nullable: true Pbx.RingGroupStatistics: title: RingGroupStatistics type: object properties: RingGroupAnsweredCount: type: number format: int64 nullable: true RingGroupDisplayName: type: string nullable: true RingGroupDn: type: string RingGroupReceivedCount: type: number format: int64 nullable: true RingGroupSentimentScore: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Pbx.ExtensionsStatisticsByRingGroups: title: ExtensionsStatisticsByRingGroups type: object properties: ExtensionAnsweredCount: type: number format: int64 nullable: true ExtensionDisplayName: type: string nullable: true ExtensionDn: type: string RingGroupDisplayName: type: string nullable: true RingGroupDn: type: string RingGroupReceivedCount: type: number format: int64 nullable: true RingGroupUnansweredCount: type: number format: int64 nullable: true SentimentScore: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true SortOrder: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Pbx.CallLogData: title: CallLogData type: object properties: ActionDnCallerId: type: string nullable: true ActionDnDisplayName: type: string nullable: true actionDnDn: type: string nullable: true ActionDnType: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true ActionType: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Answered: type: boolean nullable: true CallCost: type: number format: decimal nullable: true CallHistoryId: type: string nullable: true CallId: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 CallType: type: string nullable: true CdrId: type: string DestinationCallerId: type: string nullable: true DestinationDisplayName: type: string nullable: true DestinationDn: type: string nullable: true DestinationType: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Direction: type: string nullable: true DstRecId: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Indent: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true MainCallHistoryId: type: string nullable: true QualityReport: type: boolean nullable: true Reason: type: string nullable: true RecordingUrl: type: string nullable: true RingingDuration: pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' type: string format: duration nullable: true SegmentId: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true SentimentScore: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true SourceCallerId: type: string nullable: true SourceDisplayName: type: string nullable: true SourceDn: type: string nullable: true SourceType: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true SrcRecId: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true StartTime: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time nullable: true Status: type: string nullable: true SubrowDescNumber: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Summary: type: string nullable: true TalkingDuration: pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' type: string format: duration nullable: true Transcription: type: string nullable: true Pbx.QualityReport: title: QualityReport type: object properties: MOS: oneOf: - type: number format: float nullable: true - type: string nullable: true - $ref: '#/components/schemas/ReferenceNumeric' OverallScore: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Party1: allOf: - $ref: '#/components/schemas/Pbx.QualityParty' nullable: true Party2: allOf: - $ref: '#/components/schemas/Pbx.QualityParty' nullable: true Reason: type: string nullable: true Summary: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Transcoding: type: boolean nullable: true Pbx.ExtensionStatistics: title: ExtensionStatistics type: object properties: DisplayName: type: string nullable: true Dn: type: string InboundAnsweredCount: type: number format: int64 nullable: true InboundAnsweredTalkingDur: pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' type: string format: duration nullable: true InboundUnansweredCount: type: number format: int64 nullable: true OutboundAnsweredCount: type: number format: int64 nullable: true OutboundAnsweredTalkingDur: pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' type: string format: duration nullable: true OutboundUnansweredCount: type: number format: int64 nullable: true Pbx.ReportExtensionStatisticsByGroup: title: ReportExtensionStatisticsByGroup type: object properties: DisplayName: type: string nullable: true Dn: type: string InboundAnsweredCount: type: number format: int64 nullable: true InboundAnsweredTalkingDur: pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' type: string format: duration nullable: true InboundUnansweredCount: type: number format: int64 nullable: true OutboundAnsweredCount: type: number format: int64 nullable: true OutboundAnsweredTalkingDur: pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' type: string format: duration nullable: true OutboundUnansweredCount: type: number format: int64 nullable: true SentimentScore: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Pbx.CallCostByExtensionGroup: title: CallCostByExtensionGroup type: object properties: BillingCost: type: number format: decimal nullable: true CallType: type: string nullable: true DstDn: type: string nullable: true DstDnClass: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true GroupName: type: string nullable: true IsAnswered: type: boolean nullable: true RingingDur: pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' type: string format: duration nullable: true SegId: type: string SrcDisplayName: type: string nullable: true SrcDn: type: string nullable: true StartTime: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time nullable: true TalkingDur: pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' type: string format: duration nullable: true Pbx.QueuePerformanceOverview: title: QueuePerformanceOverview type: object properties: ExtensionAnsweredCount: type: number format: int64 nullable: true ExtensionDisplayName: type: string nullable: true ExtensionDn: type: string ExtensionDroppedCount: type: number format: int64 nullable: true QueueAnsweredCount: type: number format: int64 nullable: true QueueDisplayName: type: string QueueDn: type: string nullable: true QueueReceivedCount: type: number format: int64 nullable: true SortOrder: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true TalkTime: pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' type: string format: duration nullable: true Pbx.QueuePerformanceTotals: title: QueuePerformanceTotals type: object properties: ExtensionAnsweredCount: type: number format: int64 nullable: true ExtensionDroppedCount: type: number format: int64 nullable: true QueueDisplayName: type: string nullable: true QueueDn: type: string QueueReceivedCount: type: number format: int64 nullable: true Pbx.TeamQueueGeneralStatistics: title: TeamQueueGeneralStatistics type: object properties: AgentsInQueueCount: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true AnsweredCount: type: number format: int64 nullable: true AvgTalkTime: pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' type: string format: duration nullable: true Dn: type: string nullable: true QueueDnNumber: type: string ReceivedCount: type: number format: int64 nullable: true TotalTalkTime: pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' type: string format: duration nullable: true Pbx.DetailedQueueStatistics: title: DetailedQueueStatistics type: object properties: AnsweredCount: type: number format: int64 nullable: true AvgRingTime: pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' type: string format: duration nullable: true AvgTalkTime: pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' type: string format: duration nullable: true CallbacksCount: type: number format: int64 nullable: true CallsCount: type: number format: int64 nullable: true QueueDn: type: string nullable: true QueueDnNumber: type: string RingTime: pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' type: string format: duration nullable: true TalkTime: pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' type: string format: duration nullable: true Pbx.AbandonedQueueCalls: title: AbandonedQueueCalls type: object properties: CallerId: type: string nullable: true CallHistoryId: type: string nullable: true CallTime: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time nullable: true CallTimeForCsv: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time nullable: true ExtensionDisplayName: type: string nullable: true ExtensionDn: type: string nullable: true IsLoggedIn: type: boolean nullable: true PollingAttempts: type: number format: int64 nullable: true QueueDisplayName: type: string nullable: true QueueDn: type: string WaitTime: pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' type: string format: duration nullable: true Pbx.QueueAnsweredCallsByWaitTime: title: QueueAnsweredCallsByWaitTime type: object properties: AnsweredTime: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time CallTime: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time Destination: type: string Dn: type: string DnNumber: type: string nullable: true RingTime: pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' type: string format: duration nullable: true SentimentScore: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Source: type: string Pbx.QueueCallbacks: title: QueueCallbacks type: object properties: CallbacksCount: type: number format: int64 nullable: true Dn: type: string nullable: true FailCallbacksCount: type: number format: int64 nullable: true QueueDnNumber: type: string ReceivedCount: type: number format: int64 nullable: true Pbx.AgentsInQueueStatistics: title: AgentsInQueueStatistics type: object properties: AnsweredCount: type: number format: int64 nullable: true AnsweredPercent: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true AnsweredPerHourCount: type: number format: int64 nullable: true AvgRingTime: pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' type: string format: duration nullable: true AvgTalkTime: pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' type: string format: duration nullable: true Dn: type: string DnDisplayName: type: string nullable: true LoggedInTime: pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' type: string format: duration nullable: true LostCount: type: number format: int64 nullable: true Queue: type: string nullable: true QueueDisplayName: type: string nullable: true RingTime: pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' type: string format: duration nullable: true TalkTime: pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' type: string format: duration nullable: true Pbx.QueueFailedCallbacks: title: QueueFailedCallbacks type: object properties: CallbackNo: type: string CallTime: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time Dn: type: string QueueDnNumber: type: string nullable: true RingTime: pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' type: string format: duration nullable: true Pbx.StatisticSla: title: StatisticSla type: object properties: BadSlaCallsCount: type: number format: int64 nullable: true Dn: type: string nullable: true QueueDnNumber: type: string ReceivedCount: type: number format: int64 nullable: true Pbx.BreachesSla: title: BreachesSla type: object properties: CallerId: type: string CallTime: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time Queue: type: string QueueDnNumber: type: string nullable: true WaitingTime: pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' type: string format: duration nullable: true Pbx.QueueChatPerformance: title: QueueChatPerformance type: object properties: AbandonedCount: type: number format: int64 nullable: true AnsweredCount: type: number format: int64 nullable: true IncomingCount: type: number format: int64 nullable: true QuantityAgents: type: number format: int64 nullable: true Queue: type: string QueueDisplayName: type: string nullable: true Pbx.QueueAgentsChatStatistics: title: QueueAgentsChatStatistics type: object properties: AnsweredCount: type: number format: int64 nullable: true DealtWithCount: type: number format: int64 nullable: true Dn: type: string DnDisplayName: type: string nullable: true Queue: type: string QueueDisplayName: type: string nullable: true SortOrder: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Pbx.QueueAgentsChatStatisticsTotals: title: QueueAgentsChatStatisticsTotals type: object properties: AnsweredCount: type: number format: int64 nullable: true DealtWithCount: type: number format: int64 nullable: true Queue: type: string QueueDisplayName: type: string nullable: true Pbx.AbandonedChatsStatistics: title: AbandonedChatsStatistics type: object properties: ChatId: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 DateOfRequest: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time ParticipantEmail: type: string ParticipantMessage: type: string ParticipantName: type: string nullable: true ParticipantNumber: type: string QueueDisplayName: type: string nullable: true QueueNo: type: string ReasonForAbandoned: type: string nullable: true ReasonForDealtWith: type: string nullable: true Source: type: string Pbx.AgentLoginHistory: title: AgentLoginHistory type: object properties: Agent: type: string AgentNo: type: string Day: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time nullable: true LoggedInDayInterval: pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' type: string format: duration nullable: true loggedInDt: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time nullable: true LoggedInInterval: pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' type: string format: duration nullable: true LoggedInTotalInterval: pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' type: string format: duration nullable: true LoggedOutDt: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time nullable: true QueueNo: type: string TalkingDayInterval: pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' type: string format: duration nullable: true TalkingInterval: pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' type: string format: duration nullable: true TalkingTotalInterval: pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' type: string format: duration nullable: true Pbx.UserActivity: title: UserActivity type: object properties: AnsweredCount: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 DateTimeInterval: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time UnansweredCount: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 Pbx.CallDistribution: title: CallDistribution type: object properties: DateTimeInterval: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time IncomingCount: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 OutgoingCount: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 Pbx.OutboundCall: title: OutboundCall type: object properties: Answered: type: boolean CallCost: type: number format: decimal nullable: true CallDuration: pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' type: string format: duration nullable: true CallHistoryId: type: string nullable: true CdrId: type: string DestinationCalleeId: type: string nullable: true DestinationDisplayName: type: string nullable: true DestinationDn: type: string nullable: true QualityReport: type: boolean nullable: true RecordingId: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true RecordingUrl: type: string nullable: true RingingDuration: pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' type: string format: duration nullable: true RuleName: type: string nullable: true SentimentScore: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true SourceCallerId: type: string nullable: true SourceDisplayName: type: string nullable: true SourceDn: type: string nullable: true StartTime: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time Status: type: string nullable: true Summary: type: string nullable: true TalkingDuration: pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' type: string format: duration nullable: true Transcription: type: string nullable: true TrunkName: type: string nullable: true TrunkNumber: type: string nullable: true Pbx.InboundCall: title: InboundCall type: object properties: CallDuration: pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' type: string format: duration nullable: true CallHistoryId: type: string nullable: true CdrId: type: string DestinationCallerId: type: string nullable: true DestinationDisplayName: type: string nullable: true DestinationDn: type: string nullable: true Did: type: string nullable: true QualityReport: type: boolean nullable: true RecordingId: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true RecordingUrl: type: string nullable: true RingingDuration: pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' type: string format: duration nullable: true RuleName: type: string nullable: true SentimentScore: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true SourceCallerId: type: string nullable: true SourceDisplayName: type: string nullable: true SourceDn: type: string nullable: true StartTime: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time Status: type: string nullable: true Summary: type: string nullable: true TalkingDuration: pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' type: string format: duration nullable: true Transcription: type: string nullable: true TrunkName: type: string nullable: true TrunkNumber: type: string nullable: true Pbx.AuditLog: title: AuditLog type: object properties: Action: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Id: type: integer format: int64 Ip: type: string nullable: true NewData: type: string nullable: true ObjectName: type: string nullable: true ObjectType: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true PrevData: type: string nullable: true Source: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Timestamp: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time nullable: true UserName: type: string nullable: true Pbx.InboundRuleReport: title: InboundRuleReport type: object properties: DID: type: string nullable: true Id: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 InOfficeRouting: allOf: - $ref: '#/components/schemas/Pbx.Destination' nullable: true OutOfficeRouting: allOf: - $ref: '#/components/schemas/Pbx.Destination' nullable: true RuleName: type: string nullable: true Trunk: type: string nullable: true Pbx.TimeReportData: title: TimeReportData type: object properties: XValue: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time YValue1: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true YValue2: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Pbx.ScheduledReport: title: ScheduledReport type: object properties: DN: type: string EmailAddresses: type: string FilterDescription: maxLength: 2048 type: string Id: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 Name: type: string ReportLink: type: string ReportParams: type: string ReportType: $ref: '#/components/schemas/Pbx.ScheduledReportType' ScheduleType: $ref: '#/components/schemas/Pbx.ReportScheduleType' Pbx.PurgeSettings: title: PurgeSettings type: object properties: All: type: boolean Start: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time nullable: true Stop: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time nullable: true Pbx.UserGroup: title: UserGroup type: object properties: CanDelete: type: boolean nullable: true GroupId: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true GroupRights: allOf: - $ref: '#/components/schemas/Pbx.Rights' nullable: true x-ms-navigationProperty: true Id: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true MemberName: type: string nullable: true Name: type: string nullable: true Number: type: string nullable: true Rights: allOf: - $ref: '#/components/schemas/Pbx.Rights' nullable: true x-ms-navigationProperty: true Tags: type: array items: $ref: '#/components/schemas/Pbx.UserTag' TranscriptionMode: allOf: - $ref: '#/components/schemas/Pbx.TranscriptionType' nullable: true Type: allOf: - $ref: '#/components/schemas/Pbx.PeerType' nullable: true Pbx.Codec: title: Codec type: object properties: Id: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 Name: type: string nullable: true RfcName: type: string nullable: true Pbx.VoipProvider: title: VoipProvider type: object properties: Countries: type: array items: type: string Id: type: string Name: type: string Type: $ref: '#/components/schemas/Pbx.TemplateType' Pbx.Defs: title: Defs type: object properties: Codecs: type: array items: $ref: '#/components/schemas/Pbx.Codec' x-ms-navigationProperty: true GatewayParameters: type: array items: $ref: '#/components/schemas/Pbx.GatewayParameter' x-ms-navigationProperty: true GatewayParameterValues: type: array items: $ref: '#/components/schemas/Pbx.GatewayParameterValue' x-ms-navigationProperty: true Id: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 TimeZones: type: array items: $ref: '#/components/schemas/Pbx.TimeZone' x-ms-navigationProperty: true Pbx.TimeZone: title: TimeZone type: object properties: IanaName: type: string Id: type: string Name: type: string WindowsName: type: string Pbx.Gateway: title: Gateway type: object properties: Codecs: type: array items: type: string DeliverAudio: type: boolean nullable: true DestNumberInRemotePartyIDCalled: type: boolean nullable: true DestNumberInRequestLineURI: type: boolean nullable: true DestNumberInTo: type: boolean nullable: true Host: type: string nullable: true Id: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true InboundParams: type: array items: $ref: '#/components/schemas/Pbx.GatewayParameterBinding' Internal: type: boolean nullable: true IPInRegistrationContact: allOf: - $ref: '#/components/schemas/Pbx.IPInRegistrationContactType' nullable: true Lines: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true MatchingStrategy: allOf: - $ref: '#/components/schemas/Pbx.MatchingStrategyType' nullable: true Name: type: string nullable: true OutboundCallerID: type: string nullable: true OutboundParams: type: array items: $ref: '#/components/schemas/Pbx.GatewayParameterBinding' Port: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true ProxyHost: type: string nullable: true ProxyPort: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true RequireRegistrationFor: allOf: - $ref: '#/components/schemas/Pbx.RequireRegistrationForType' nullable: true SourceIdentification: type: array items: $ref: '#/components/schemas/Pbx.GatewayParameterBinding' SpecifiedIPForRegistrationContact: type: string nullable: true SRTPMode: allOf: - $ref: '#/components/schemas/Pbx.SRTPModeType' nullable: true SupportReinvite: type: boolean nullable: true SupportReplaces: type: boolean nullable: true TemplateFilename: type: string nullable: true TimeBetweenReg: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Type: $ref: '#/components/schemas/Pbx.GatewayType' UseIPInContact: type: boolean nullable: true VariableChoices: type: array items: $ref: '#/components/schemas/Pbx.Choice' Pbx.PhoneSettings: title: PhoneSettings type: object properties: AllowCustomQueueRingtones: type: boolean nullable: true Backlight: type: string nullable: true Codecs: type: array items: type: string CustomLogo: type: string nullable: true CustomQueueRingtones: type: array items: $ref: '#/components/schemas/Pbx.CustomQueueRingtone' DateFormat: type: string nullable: true Firmware: type: string nullable: true FirmwareLang: type: string nullable: true IsLogoCustomizable: type: boolean nullable: true IsSBC: type: boolean nullable: true LlDpInfo: allOf: - $ref: '#/components/schemas/Pbx.PhoneLldpInfo' nullable: true LocalRTPPortEnd: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true LocalRTPPortStart: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true LocalSipPort: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true LogoDescription: type: string nullable: true LogoFileExtensionAllowed: type: array items: type: string PhoneLanguage: type: string nullable: true PowerLed: type: string nullable: true ProvisionExtendedData: type: string nullable: true ProvisionType: allOf: - $ref: '#/components/schemas/Pbx.ProvType' nullable: true QueueRingTone: type: string nullable: true RemoteSpmHost: type: string nullable: true RemoteSpmPort: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true RingTone: type: string nullable: true SbcName: type: string nullable: true ScreenSaver: type: string nullable: true Secret: type: string nullable: true Srtp: type: string nullable: true TimeFormat: type: string nullable: true TimeZone: type: string nullable: true VlanInfos: type: array items: $ref: '#/components/schemas/Pbx.PhoneDeviceVlanInfo' XferType: allOf: - $ref: '#/components/schemas/Pbx.XferTypeEnum' nullable: true Pbx.DeviceInfo: title: DeviceInfo type: object properties: Assigned: type: boolean nullable: true AssignedUser: type: string nullable: true DetectedAt: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time nullable: true FirmwareVersion: type: string nullable: true Id: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 InterfaceLink: type: string nullable: true MAC: type: string nullable: true Model: type: string nullable: true NetworkAddress: type: string nullable: true NetworkPath: type: string nullable: true Parameters: type: string nullable: true SbcName: type: string nullable: true TemplateName: type: string nullable: true UserAgent: type: string nullable: true Vendor: type: string nullable: true ViaSBC: type: boolean nullable: true Pbx.SipDevice: title: SipDevice type: object properties: DN: allOf: - $ref: '#/components/schemas/Pbx.Peer' nullable: true x-ms-navigationProperty: true Id: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 PhoneWebPassword: type: string nullable: true ProvLink: type: string nullable: true Registrar: allOf: - $ref: '#/components/schemas/Pbx.PhoneRegistrar' nullable: true Pbx.GatewayParameter: title: GatewayParameter type: object properties: CanHaveDID: type: boolean nullable: true Description: type: string nullable: true Id: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 InboundPossibleValues: type: array items: type: string Name: type: string nullable: true OutboundPossibleValues: type: array items: type: string SourceIDPossibleValues: type: array items: type: string Pbx.GatewayParameterValue: title: GatewayParameterValue type: object properties: Description: type: string nullable: true Id: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 Name: type: string nullable: true Pbx.Greeting: title: Greeting type: object properties: DisplayName: type: string nullable: true Filename: type: string nullable: true Type: $ref: '#/components/schemas/Pbx.ProfileType' Pbx.NetworkInterface: title: NetworkInterface type: object properties: Id: type: string Pbx.SystemParameters: title: SystemParameters type: object properties: Custom1Name: type: string nullable: true Custom2Name: type: string nullable: true EmRuleCreationAllowed: type: boolean nullable: true ENL: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true ENLRange: allOf: - $ref: '#/components/schemas/Pbx.ENL' nullable: true FirstExternalPort: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true FQDN: type: string nullable: true GlobalACPRMSET: type: string nullable: true GlobalLanguage: type: string nullable: true HttpPort: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true HttpsPort: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true IpV6: type: string nullable: true Is3CXFQDN: type: boolean nullable: true IsChatLogEnabled: type: boolean nullable: true IsHosted: type: boolean nullable: true IsHosted3CX: type: boolean nullable: true IsMulticompanyMode: type: boolean nullable: true IsRemoteBackup: type: boolean nullable: true IsStaticIp: type: boolean nullable: true IsTranscriptionEnabled: type: boolean nullable: true License: allOf: - $ref: '#/components/schemas/Pbx.License' nullable: true MaxDIDPerTrunk: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true PbxExternalHost: type: string nullable: true ProcessorCount: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true RemoteStorageStatus: allOf: - $ref: '#/components/schemas/Pbx.RemoteStorageStatus' nullable: true RpsEnabled: type: boolean nullable: true SipPort: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true SipsPort: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true StaticIp: type: string nullable: true StunIp: type: string nullable: true TunnnelPort: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Version: type: string nullable: true WebrtcLastPort: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Pbx.License: title: License type: object properties: CountryCode: type: string nullable: true IsMaintainceExpired: type: boolean nullable: true MaxSimCalls: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true ProductCode: type: string nullable: true Pbx.SendEmail: title: SendEmail type: object properties: DateTime: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time nullable: true Destination: type: string Template: type: string Variables: type: array items: $ref: '#/components/schemas/Pbx.EmailVariable' Pbx.GoogleSettings: title: GoogleSettings type: object properties: ClientId: type: string nullable: true ClientSecret: allOf: - $ref: '#/components/schemas/Pbx.ConcealedPassword' nullable: true Id: type: string IsExtensionSignInEnabled: type: boolean nullable: true ProjectId: type: string nullable: true ProvisionUrl: type: string nullable: true ReCaptchaEnabled: type: boolean nullable: true UserSync: allOf: - $ref: '#/components/schemas/Pbx.GoogleUserSync' nullable: true Pbx.ConsoleRestrictions: title: ConsoleRestrictions type: object properties: AccessRestricted: type: boolean nullable: true Id: type: string IpWhitelist: type: array items: type: string MyIpAddress: type: string nullable: true Pbx.MusicOnHoldSettings: title: MusicOnHoldSettings type: object properties: Id: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 MusicOnHold: type: string nullable: true MusicOnHold1: type: string nullable: true MusicOnHold2: type: string nullable: true MusicOnHold3: type: string nullable: true MusicOnHold4: type: string nullable: true MusicOnHold5: type: string nullable: true MusicOnHold6: type: string nullable: true MusicOnHold7: type: string nullable: true MusicOnHold8: type: string nullable: true MusicOnHold9: type: string nullable: true MusicOnHoldRandomize: type: boolean nullable: true MusicOnHoldRandomizePerCall: type: boolean nullable: true Pbx.CodecsSettings: title: CodecsSettings type: object properties: ExternalCodecList: type: array items: type: string LocalCodecList: type: array items: type: string Pbx.GeneralSettingsForApps: title: GeneralSettingsForApps type: object properties: AllowBlockCalls: type: boolean nullable: true AllowChangePassword: type: boolean nullable: true AutoSchedulerSettings: allOf: - $ref: '#/components/schemas/Pbx.AutoSchedulerSettings' nullable: true AvatarStyle: allOf: - $ref: '#/components/schemas/Pbx.AvatarStyle' nullable: true BrandLogoImage: maxLength: 136533 type: string nullable: true BrandMainImage: maxLength: 2796202 type: string nullable: true BrandUrl: type: string nullable: true EnableChat: type: boolean nullable: true HideAbandonedQueueCalls: type: boolean nullable: true HideCRMContacts: type: boolean nullable: true HideInteractionHistory: type: boolean nullable: true HideSystemExtensions: type: boolean nullable: true NameOfCustomAvailableStatus: type: string nullable: true NameOfCustomOutOfOfficeStatus: type: string nullable: true Pbx.GeneralSettingsForPbx: title: GeneralSettingsForPbx type: object properties: AllowFwdToExternal: type: boolean nullable: true BusyMonitor: type: boolean nullable: true BusyMonitorTimeout: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true DisableOutboundCallsOutOfficeHours: type: boolean nullable: true EnableVMenuOutboundCalls: type: boolean nullable: true HDAutoLogoutEnabled: type: boolean nullable: true HDAutoLogoutTime: pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' type: string format: duration nullable: true LimitCallPickup: type: boolean nullable: true OperatorExtension: type: string nullable: true PlayBusy: type: boolean nullable: true ScheduledReportGenerationTime: pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' type: string format: duration nullable: true Pbx.CallParkingSettings: title: CallParkingSettings type: object properties: AutoPickupEnabled: type: boolean nullable: true AutoPickupForwardDN: type: string nullable: true AutoPickupForwardExternalNumber: type: string nullable: true AutoPickupForwardType: allOf: - $ref: '#/components/schemas/Pbx.TypeOfAutoPickupForward' nullable: true AutoPickupTimeout: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true MaximumParkedCalls: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true MusicOnHold: type: string nullable: true Pbx.DialCodeSettings: title: DialCodeSettings type: object properties: DialCodeBillingCode: type: string nullable: true DialCodeHideCallerID: type: string nullable: true DialCodeHotdesking: type: string nullable: true DialCodeHotelAccess: type: string nullable: true DialCodeIntercom: type: string nullable: true DialCodeLoggedInQueue: type: string nullable: true DialCodeLoggedOutQueue: type: string nullable: true DialCodeOutOffice: type: string nullable: true DialCodePark: type: string nullable: true DialCodePickup: type: string nullable: true DialCodeProfileStatus: type: string nullable: true DialCodeUnpark: type: string nullable: true DialCodeVMail: type: string nullable: true Pbx.E164Settings: title: E164Settings type: object properties: AreaCode: type: string nullable: true CountryCode: type: string nullable: true CountryName: type: string nullable: true Enabled: type: boolean nullable: true InternationalCode: type: string nullable: true NationalCode: type: string nullable: true Prefix: type: string nullable: true RemoveAreaCode: type: boolean nullable: true RemoveCountryCode: type: boolean nullable: true Pbx.CountryCodes: title: CountryCodes type: object properties: CountryCodes: type: array items: type: string Pbx.SecureSipSettings: title: SecureSipSettings type: object properties: Certificate: allOf: - $ref: '#/components/schemas/Pbx.ConcealedDataFile' nullable: true PrivateKey: allOf: - $ref: '#/components/schemas/Pbx.ConcealedDataFile' nullable: true Pbx.PhonesSettings: title: PhonesSettings type: object properties: AllowMultiQueueRingtones: type: boolean nullable: true AutoCleanupFirmware: type: boolean nullable: true AutoUpdatePhonesOnAdd: type: boolean nullable: true CustomDNDProfile: type: string nullable: true FanvilUpdateInterval: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true GrandstreamUpdateInterval: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true PhoneAllowMultiFirmwares: type: boolean nullable: true SnomUpdateInterval: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true UseProvisioningSecret: type: boolean nullable: true UseRpcForLocalPhones: type: boolean nullable: true YealinkUpdateInterval: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Pbx.OfficeHours: title: OfficeHours type: object properties: BreakTime: allOf: - $ref: '#/components/schemas/Pbx.Schedule' nullable: true Hours: allOf: - $ref: '#/components/schemas/Pbx.Schedule' nullable: true OfficeHolidays: type: array items: $ref: '#/components/schemas/Pbx.Holiday' x-ms-navigationProperty: true SystemLanguage: type: string nullable: true TimeZoneId: type: string nullable: true Pbx.PhoneBookSettings: title: PhoneBookSettings type: object properties: PhoneBookAddQueueName: allOf: - $ref: '#/components/schemas/Pbx.TypeOfPhoneBookAddQueueName' nullable: true PhoneBookDisplay: allOf: - $ref: '#/components/schemas/Pbx.TypeOfPhoneBookDisplay' nullable: true ResolvingLength: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true ResolvingType: allOf: - $ref: '#/components/schemas/Pbx.TypeOfPhoneBookResolving' nullable: true Pbx.EmergencyNotificationsSettings: title: EmergencyNotificationsSettings type: object properties: ChatRecipients: allOf: - $ref: '#/components/schemas/Pbx.ChatRecipientsType' nullable: true EmergencyDNPrompt: allOf: - $ref: '#/components/schemas/Pbx.Peer' nullable: true x-ms-navigationProperty: true EmergencyPlayPrompt: type: string nullable: true SpecifiedList: type: string nullable: true Pbx.CallTypesSettings: title: CallTypesSettings type: object properties: International: allOf: - $ref: '#/components/schemas/Pbx.CallTypeInfo' nullable: true Local: allOf: - $ref: '#/components/schemas/Pbx.CallTypeInfo' nullable: true Mobile: allOf: - $ref: '#/components/schemas/Pbx.CallTypeInfo' nullable: true National: allOf: - $ref: '#/components/schemas/Pbx.CallTypeInfo' nullable: true Pbx.LoggingSettings: title: LoggingSettings type: object properties: KeepLogs: type: boolean nullable: true KeepLogsDays: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true LoggingLevel: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Pbx.ChatLogSettings: title: ChatLogSettings type: object properties: AutoClearMonths: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true AutoCloseDays: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true RemoteStorageEnabled: type: boolean nullable: true Pbx.AntiHackingSettings: title: AntiHackingSettings type: object properties: HackAuthRequests: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true HackBarrierAmber: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true HackBarrierGreen: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true HackBarrierRed: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true HackBlacklistDuration: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true HackChallengeRequests: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true MaxRequestPerPeriod: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true SecurityDefenseProgram: type: boolean nullable: true ThrottlePeriodLength: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Pbx.Rights: title: Rights type: object properties: AllowIVR: type: boolean nullable: true AllowParking: type: boolean nullable: true AllowToChangePresence: type: boolean nullable: true AllowToManageCompanyBook: type: boolean nullable: true AssignClearOperations: type: boolean nullable: true CanBargeIn: type: boolean nullable: true CanIntercom: type: boolean nullable: true CanSeeGroupCalls: type: boolean nullable: true CanSeeGroupMembers: type: boolean nullable: true CanSeeGroupRecordings: type: boolean nullable: true Invalid: type: boolean nullable: true PerformOperations: type: boolean nullable: true RoleName: type: string ShowMyCalls: type: boolean nullable: true ShowMyPresence: type: boolean nullable: true ShowMyPresenceOutside: type: boolean nullable: true Pbx.ConcealedPassword: title: ConcealedPassword type: object properties: Concealed: type: boolean nullable: true Value: type: string nullable: true Pbx.TrunkMessaging: title: TrunkMessaging type: object properties: Enabled: type: boolean nullable: true NumberLength: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true NumberLengthEnabled: type: boolean nullable: true Provider: type: string nullable: true Webhook: type: string nullable: true Pbx.GatewayParameterBinding: title: GatewayParameterBinding type: object properties: Custom: type: string nullable: true ParamId: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 ValueId: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 Pbx.Choice: title: Choice type: object properties: Key: type: string Value: type: string Pbx.CIDFormatting: title: CIDFormatting type: object properties: ReplacePattern: type: string nullable: true SourcePattern: type: string nullable: true Pbx.Schedule: title: Schedule type: object properties: IgnoreHolidays: type: boolean nullable: true Periods: type: array items: $ref: '#/components/schemas/Pbx.Period' Type: $ref: '#/components/schemas/Pbx.RuleHoursType' Pbx.Period: title: Period type: object properties: DayOfWeek: allOf: - $ref: '#/components/schemas/Pbx.DayOfWeek' nullable: true Start: pattern: '^([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?$' type: string format: time nullable: true Stop: pattern: '^([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?$' type: string format: time nullable: true Pbx.Destination: title: Destination type: object properties: External: type: string nullable: true Name: type: string nullable: true Number: type: string nullable: true Tags: type: array items: $ref: '#/components/schemas/Pbx.UserTag' To: allOf: - $ref: '#/components/schemas/Pbx.DestinationType' nullable: true Type: allOf: - $ref: '#/components/schemas/Pbx.PeerType' nullable: true Pbx.PeerGroup: title: PeerGroup type: object properties: GroupID: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 IsPrimary: type: boolean nullable: true Name: type: string nullable: true Number: type: string nullable: true RoleName: type: string nullable: true Pbx.Variable: title: Variable type: object properties: Name: type: string Value: type: string Pbx.GroupProps: title: GroupProps type: object properties: DectMaxCount: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true DepartmentContactsMaxCount: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Fqdn: type: string nullable: true LiveChatMaxCount: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true OutboundRulesMaxCount: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true PersonalContactsMaxCount: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true PromptsMaxCount: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true ResellerId: type: string nullable: true ResellerName: type: string nullable: true SbcMaxCount: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true StartupLicense: allOf: - $ref: '#/components/schemas/Pbx.StartupLicense' nullable: true StartupOwnerEmail: type: string nullable: true SubcriptionExpireDate: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time nullable: true Subscription: type: string nullable: true SubscriptionType: type: string nullable: true SystemNumberFrom: type: string nullable: true SystemNumberTo: type: string nullable: true TrunkNumberFrom: type: string nullable: true TrunkNumberTo: type: string nullable: true TrunksMaxCount: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true UserNumberFrom: type: string nullable: true UserNumberTo: type: string nullable: true Pbx.Route: title: Route type: object properties: IsPromptEnabled: type: boolean nullable: true Prompt: type: string nullable: true Route: allOf: - $ref: '#/components/schemas/Pbx.Destination' nullable: true Pbx.QueueAgent: title: QueueAgent type: object properties: Id: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Name: type: string nullable: true Number: type: string SkillGroup: type: string nullable: true Tags: type: array items: $ref: '#/components/schemas/Pbx.UserTag' Pbx.QueueManager: title: QueueManager type: object properties: Id: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Name: type: string nullable: true Number: type: string Tags: type: array items: $ref: '#/components/schemas/Pbx.UserTag' Pbx.ResetQueueStatisticsSchedule: title: ResetQueueStatisticsSchedule type: object properties: Day: allOf: - $ref: '#/components/schemas/Pbx.DayOfWeek' nullable: true Frequency: allOf: - $ref: '#/components/schemas/Pbx.ResetQueueStatisticsFrequency' nullable: true Time: pattern: '^([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?$' type: string format: time nullable: true Pbx.RingGroupMember: title: RingGroupMember type: object properties: Id: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 Name: type: string nullable: true Number: type: string nullable: true Tags: type: array items: $ref: '#/components/schemas/Pbx.UserTag' Pbx.ForwardingProfile: title: ForwardingProfile type: object properties: AcceptMultipleCalls: type: boolean nullable: true AvailableRoute: allOf: - $ref: '#/components/schemas/Pbx.AvailableRouting' nullable: true AwayRoute: allOf: - $ref: '#/components/schemas/Pbx.AwayRouting' nullable: true BlockPushCalls: type: boolean nullable: true CustomMessage: type: string nullable: true CustomName: type: string nullable: true DisableRingGroupCalls: type: boolean nullable: true Id: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 Name: type: string nullable: true NoAnswerTimeout: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true OfficeHoursAutoQueueLogOut: type: boolean nullable: true RingMyMobile: type: boolean nullable: true Pbx.AvailableRouting: title: AvailableRouting type: object properties: BusyAllCalls: type: boolean nullable: true BusyExternal: allOf: - $ref: '#/components/schemas/Pbx.Destination' nullable: true BusyInternal: allOf: - $ref: '#/components/schemas/Pbx.Destination' nullable: true NoAnswerAllCalls: type: boolean nullable: true NoAnswerExternal: allOf: - $ref: '#/components/schemas/Pbx.Destination' nullable: true NoAnswerInternal: allOf: - $ref: '#/components/schemas/Pbx.Destination' nullable: true NotRegisteredAllCalls: type: boolean nullable: true NotRegisteredExternal: allOf: - $ref: '#/components/schemas/Pbx.Destination' nullable: true NotRegisteredInternal: allOf: - $ref: '#/components/schemas/Pbx.Destination' nullable: true Pbx.AwayRouting: title: AwayRouting type: object properties: AllHoursExternal: type: boolean nullable: true AllHoursInternal: type: boolean nullable: true External: allOf: - $ref: '#/components/schemas/Pbx.Destination' nullable: true Internal: allOf: - $ref: '#/components/schemas/Pbx.Destination' nullable: true Pbx.ExtensionRule: title: ExtensionRule type: object properties: CallType: allOf: - $ref: '#/components/schemas/Pbx.RuleCallTypeType' nullable: true Condition: allOf: - $ref: '#/components/schemas/Pbx.RuleConditionType' nullable: true Data: type: string nullable: true Destination: allOf: - $ref: '#/components/schemas/Pbx.Destination' nullable: true Enabled: type: boolean nullable: true Hours: allOf: - $ref: '#/components/schemas/Pbx.Schedule' nullable: true Id: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 Pbx.Phone: title: Phone type: object properties: Id: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 Interface: type: string nullable: true MacAddress: type: string nullable: true Name: type: string nullable: true ProvisioningLinkExt: type: string nullable: true ProvisioningLinkLocal: type: string nullable: true Settings: allOf: - $ref: '#/components/schemas/Pbx.PhoneSettings' nullable: true TemplateName: type: string nullable: true Pbx.PhoneLldpInfo: title: PhoneLldpInfo type: object properties: Configurable: type: boolean nullable: true Value: type: boolean nullable: true Pbx.PhoneDeviceVlanInfo: title: PhoneDeviceVlanInfo type: object properties: Configurable: type: boolean nullable: true Enabled: type: boolean nullable: true Priority: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true PriorityConfigurable: type: boolean nullable: true PriorityMax: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true PriorityMin: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Type: allOf: - $ref: '#/components/schemas/Pbx.PhoneDeviceVlanType' nullable: true VlanId: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true VlanIdMax: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true VlanIdMin: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Pbx.CustomQueueRingtone: title: CustomQueueRingtone type: object properties: Queue: type: string nullable: true Ringtone: type: string nullable: true Pbx.AgentSettings: title: AgentSettings type: object properties: AbusiveCallerAction: allOf: - $ref: '#/components/schemas/Pbx.AgentRoutingAction' nullable: true AgentType: type: string nullable: true AllowedExtensions: type: string nullable: true CallerDoesNotRespondAction: allOf: - $ref: '#/components/schemas/Pbx.AgentRoutingAction' nullable: true CallPrioritySettings: allOf: - $ref: '#/components/schemas/Pbx.CallPrioritySettings' nullable: true CheckStatusBeforeTransfer: type: boolean nullable: true ConfidentialModeEnabled: type: boolean nullable: true EnableNameMatching: type: boolean nullable: true EnableSpamProtection: type: boolean nullable: true FirstMessage: type: string nullable: true Knowledgebase: type: array items: type: string Language: type: string nullable: true MaxCallDuration: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true PhoneBookMatching: type: boolean nullable: true PhonebookOverride: allOf: - $ref: '#/components/schemas/Pbx.Peer' nullable: true x-ms-navigationProperty: true RoutingDirectory: type: array items: $ref: '#/components/schemas/Pbx.AgentRoutingDirectory' SpamAction: allOf: - $ref: '#/components/schemas/Pbx.AgentRoutingAction' nullable: true SpamInstructions: type: string nullable: true SwitchLanguage: type: boolean nullable: true SystemPrompt: type: string nullable: true TokenBudget: allOf: - $ref: '#/components/schemas/Pbx.CallTokenBudget' nullable: true Voice: type: string nullable: true Pbx.AgentRoutingDirectory: title: AgentRoutingDirectory type: object properties: Description: type: string Name: type: string nullable: true Number: type: string nullable: true Tags: type: array items: $ref: '#/components/schemas/Pbx.UserTag' Type: allOf: - $ref: '#/components/schemas/Pbx.PeerType' nullable: true Pbx.AgentRoutingAction: title: AgentRoutingAction type: object properties: Action: type: string Name: type: string nullable: true Number: type: string nullable: true Tags: type: array items: $ref: '#/components/schemas/Pbx.UserTag' Type: allOf: - $ref: '#/components/schemas/Pbx.PeerType' nullable: true Pbx.CallPrioritySettings: title: CallPrioritySettings type: object properties: IsEnabled: type: boolean nullable: true PriorityHigh: allOf: - $ref: '#/components/schemas/Pbx.CallPriority' nullable: true PriorityLow: allOf: - $ref: '#/components/schemas/Pbx.CallPriority' nullable: true PriorityMedium: allOf: - $ref: '#/components/schemas/Pbx.CallPriority' nullable: true Pbx.CallPriority: title: CallPriority type: object properties: Action: type: string nullable: true Instructions: type: string nullable: true Pbx.CallTokenBudget: title: CallTokenBudget type: object properties: Enabled: type: boolean nullable: true MaxInputTokens: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true MinInputTokens: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true NormalSpeechTpm: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Tolerance: oneOf: - type: number format: float nullable: true - type: string nullable: true - $ref: '#/components/schemas/ReferenceNumeric' Pbx.ReceptionistForward: title: ReceptionistForward type: object properties: CustomData: type: string nullable: true ForwardDN: type: string nullable: true ForwardType: $ref: '#/components/schemas/Pbx.IVRForwardType' Id: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 Input: type: string nullable: true PeerType: allOf: - $ref: '#/components/schemas/Pbx.PeerType' nullable: true Pbx.CallParticipant: title: CallParticipant type: object properties: CallId: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 DeviceId: type: string DirectControl: type: boolean DN: type: string Id: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 LegId: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 PartyCallerId: type: string PartyCallerName: type: string PartyDn: type: string PartyDnType: type: string Status: type: string Pbx.PhoneModel: title: PhoneModel type: object properties: AddAllowed: type: boolean nullable: true CanBeSBC: type: boolean nullable: true Name: type: string nullable: true URL: type: string nullable: true UserAgent: type: string nullable: true Pbx.TrunkMessagingTemplate: title: TrunkMessagingTemplate type: object properties: MessagingVariables: type: array items: $ref: '#/components/schemas/Pbx.TrunkVariable' Optional: type: boolean nullable: true Outbound: type: boolean nullable: true Provider: type: string nullable: true Type: type: string nullable: true Pbx.TrunkVariable: title: TrunkVariable type: object properties: DefaultValue: type: string nullable: true MaxLength: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true MinLength: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Name: type: string nullable: true Option: type: string nullable: true OptionType: allOf: - $ref: '#/components/schemas/Pbx.TrunkVariableType' nullable: true Pattern: type: string nullable: true Prompt: type: string nullable: true Required: type: boolean nullable: true Title: type: string nullable: true Validation: type: string nullable: true Pbx.EntityRestrictions: title: EntityRestrictions type: object properties: Allowed: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Unlimited: type: boolean nullable: true Used: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Pbx.OutboundRoute: title: OutboundRoute type: object properties: Append: type: string nullable: true CallerID: type: string nullable: true Prepend: type: string nullable: true StripDigits: type: number format: uint8 nullable: true TrunkId: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true TrunkName: type: string nullable: true Pbx.DNRange: title: DNRange type: object properties: From: type: string nullable: true To: type: string nullable: true Pbx.LogEntry: title: LogEntry type: object properties: Text: type: string TimeStamp: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time Pbx.SetRoute: title: SetRoute type: object properties: DID: type: string DisplayName: type: string nullable: true TrunkId: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 Pbx.ProviderPhone: title: ProviderPhone type: object properties: FriendlyName: type: string nullable: true IsInTrunk: type: boolean nullable: true IsMessagingEnabled: type: boolean nullable: true PhoneNumber: type: string nullable: true Sid: type: string Pbx.FxsProvisioning: title: FxsProvisioning type: object properties: LocalAudioPortEnd: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true LocalAudioPortStart: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true LocalInterface: type: string nullable: true LocalSipPort: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Method: allOf: - $ref: '#/components/schemas/Pbx.ProvType' nullable: true ProvLink: type: string nullable: true RemoteFQDN: type: string nullable: true RemotePort: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true SbcName: type: string nullable: true Pbx.DeviceLine: title: DeviceLine type: object properties: Key: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 Name: type: string nullable: true Number: type: string Pbx.FxsModel: title: FxsModel type: object properties: CanBeSBC: type: boolean nullable: true DisplayName: type: string UserAgent: type: string Pbx.FxsVariable: title: FxsVariable type: object properties: Choices: type: array items: $ref: '#/components/schemas/Pbx.FxsVariableChoice' Name: type: string Title: type: string ValidationType: type: string nullable: true Pbx.FxsVariableChoice: title: FxsVariableChoice type: object properties: DisplayName: type: string Name: type: string Pbx.Prompt: title: Prompt type: object properties: Filename: type: string nullable: true Id: type: string Transcription: type: string nullable: true Pbx.WebsiteLinksTranslations: title: WebsiteLinksTranslations type: object properties: AuthenticationMessage: type: string nullable: true EndingMessage: type: string nullable: true FirstResponseMessage: type: string nullable: true GdprMessage: type: string nullable: true GreetingMessage: type: string nullable: true GreetingOfflineMessage: type: string nullable: true InviteMessage: type: string nullable: true OfflineEmailMessage: type: string nullable: true OfflineFinishMessage: type: string nullable: true OfflineFormInvalidEmail: type: string nullable: true OfflineFormInvalidName: type: string nullable: true OfflineFormMaximumCharactersReached: type: string nullable: true OfflineNameMessage: type: string nullable: true StartChatButtonText: type: string nullable: true UnavailableMessage: type: string nullable: true WindowTitle: type: string nullable: true Pbx.LiveChatStyling: title: LiveChatStyling type: object properties: Animation: allOf: - $ref: '#/components/schemas/Pbx.AnimationStyle' nullable: true Minimized: type: boolean nullable: true Style: maxLength: 2048 type: string nullable: true UseRubik: type: boolean nullable: true Pbx.GeneralLiveChatSettings: title: GeneralLiveChatSettings type: object properties: AllowSoundNotifications: type: boolean nullable: true Authentication: allOf: - $ref: '#/components/schemas/Pbx.Authentication' nullable: true DisableOfflineMessages: type: boolean nullable: true EnableGA: type: boolean nullable: true EnableOnMobile: type: boolean nullable: true GdprEnabled: type: boolean nullable: true Greeting: allOf: - $ref: '#/components/schemas/Pbx.LiveChatGreeting' nullable: true Pbx.LiveChatAdvancedSettings: title: LiveChatAdvancedSettings type: object properties: CallTitle: type: string nullable: true CommunicationOptions: allOf: - $ref: '#/components/schemas/Pbx.LiveChatCommunication' nullable: true EnableDirectCall: type: boolean nullable: true IgnoreQueueOwnership: type: boolean nullable: true Pbx.LiveChatBox: title: LiveChatBox type: object properties: ButtonIconType: allOf: - $ref: '#/components/schemas/Pbx.ButtonIconType' nullable: true ButtonIconUrl: type: string nullable: true ChatDelay: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Height: type: string nullable: true LiveChatLanguage: allOf: - $ref: '#/components/schemas/Pbx.LiveChatLanguage' nullable: true LiveMessageUserinfoFormat: allOf: - $ref: '#/components/schemas/Pbx.LiveMessageUserinfoFormat' nullable: true MessageDateformat: allOf: - $ref: '#/components/schemas/Pbx.LiveChatMessageDateformat' nullable: true MinimizedStyle: allOf: - $ref: '#/components/schemas/Pbx.LiveChatMinimizedStyle' nullable: true OperatorIcon: maxLength: 136533 type: string nullable: true OperatorName: type: string nullable: true ShowOperatorActualName: type: boolean nullable: true WindowIcon: maxLength: 136533 type: string nullable: true Pbx.BackupSchedule: title: BackupSchedule type: object properties: Day: allOf: - $ref: '#/components/schemas/Pbx.DayOfWeek' nullable: true RepeatHours: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true RepeatMinutes: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true ScheduleType: allOf: - $ref: '#/components/schemas/Pbx.ScheduleType' nullable: true Time: pattern: '^([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?$' type: string format: time nullable: true Pbx.UpdateItem: title: UpdateItem type: object properties: Category: type: string Description: type: string DescriptionLink: type: string Guid: pattern: '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$' type: string format: uuid nullable: true Ignore: type: boolean nullable: true Image: type: string LocalVersion: type: string Name: type: string OutOfDate: type: boolean nullable: true ServerVersion: type: string UpdateType: allOf: - $ref: '#/components/schemas/Pbx.UpdateType' nullable: true Pbx.CategoryUpdate: title: CategoryUpdate type: object properties: Category: type: string nullable: true Count: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 Pbx.BackupContents: title: BackupContents type: object properties: CallHistory: type: boolean nullable: true DisableBackupCompression: type: boolean nullable: true EncryptBackup: type: boolean nullable: true EncryptBackupPassword: allOf: - $ref: '#/components/schemas/Pbx.ConcealedPassword' nullable: true FQDN: type: boolean nullable: true License: type: boolean nullable: true PhoneProvisioning: type: boolean nullable: true Prompts: type: boolean nullable: true Recordings: type: boolean nullable: true VoiceMails: type: boolean nullable: true Pbx.LocationSettings: title: LocationSettings type: object properties: FileSystemType: allOf: - $ref: '#/components/schemas/Pbx.FileSystemType' nullable: true FtpPassword: allOf: - $ref: '#/components/schemas/Pbx.ConcealedPassword' nullable: true FtpPath: type: string nullable: true FtpUser: type: string nullable: true FtpValidateCertificate: type: boolean nullable: true GbJson: allOf: - $ref: '#/components/schemas/Pbx.ConcealedDataFile' nullable: true GbPath: type: string nullable: true LocalPath: type: string nullable: true NsDomain: type: string nullable: true NsPassword: allOf: - $ref: '#/components/schemas/Pbx.ConcealedPassword' nullable: true NsPath: type: string nullable: true NsUser: type: string nullable: true S3Path: type: string nullable: true SftpPassword: allOf: - $ref: '#/components/schemas/Pbx.ConcealedPassword' nullable: true SftpPath: type: string nullable: true SftpPrivateKey: allOf: - $ref: '#/components/schemas/Pbx.ConcealedDataFile' nullable: true SftpUser: type: string nullable: true SharePointPath: type: string nullable: true Pbx.ConcealedDataFile: title: ConcealedDataFile type: object properties: Concealed: type: boolean nullable: true Contents: type: string nullable: true Name: type: string nullable: true Pbx.XSBCConnection: title: XSBCConnection type: object properties: Calls: type: number format: int64 nullable: true Cpu: type: string nullable: true Disk: type: string nullable: true ElapsedTime: pattern: '^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$' type: string format: duration nullable: true Latency: type: number format: int64 nullable: true Memory: type: string nullable: true RegisteredPhones: type: number format: int64 nullable: true UdpActive: type: boolean nullable: true Up: type: boolean nullable: true Pbx.CrmParameter: title: CrmParameter type: object properties: Default: type: string nullable: true Editor: allOf: - $ref: '#/components/schemas/Pbx.EditorType' nullable: true ListValues: type: array items: type: string ListValuesText: type: string nullable: true Name: type: string nullable: true Parent: type: string nullable: true RequestUrl: type: string nullable: true RequestUrlParameters: type: string nullable: true ResponseScenario: type: string nullable: true Title: type: string nullable: true Type: allOf: - $ref: '#/components/schemas/Pbx.ParameterType' nullable: true Validation: type: string nullable: true Pbx.CrmAuthentication: title: CrmAuthentication type: object properties: Type: allOf: - $ref: '#/components/schemas/Pbx.AuthenticationType' nullable: true Values: type: array items: type: string Pbx.CDRSettingsField: title: CDRSettingsField type: object properties: Length: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Name: type: string nullable: true Pbx.ADUsersSyncConfiguration: title: ADUsersSyncConfiguration type: object properties: EnableSSO: type: boolean nullable: true IsEnabled: type: boolean nullable: true IsSyncDepartments: type: boolean nullable: true IsSyncDetails: type: boolean nullable: true IsSyncOfficePhone: type: boolean nullable: true IsSyncPhoto: type: boolean nullable: true SelectedGroups: type: array items: type: string SelectedUsers: type: array items: type: string SetTeamsPresence: type: boolean nullable: true StartingExtensionNumber: type: string StatusSyncConfiguration: allOf: - $ref: '#/components/schemas/Pbx.StatusSyncConfiguration' nullable: true SyncEvents: type: boolean nullable: true SyncGuestUsers: type: boolean nullable: true SyncPersonalContacts: type: boolean nullable: true SyncType: allOf: - $ref: '#/components/schemas/Pbx.IntegrationSyncType' nullable: true Pbx.StatusSyncConfiguration: title: StatusSyncConfiguration type: object properties: M365ToPbxBindings: type: array items: $ref: '#/components/schemas/Pbx.M365ToPbxBinding' PBXToM365Bindings: type: array items: $ref: '#/components/schemas/Pbx.PbxToM365Binding' PBXToM365Busy: type: boolean nullable: true Pbx.PbxToM365Binding: title: PbxToM365Binding type: object properties: From: allOf: - $ref: '#/components/schemas/Pbx.SynchronizedPbxProfile' nullable: true To: allOf: - $ref: '#/components/schemas/Pbx.SynchronizedM365Profile' nullable: true Pbx.M365ToPbxBinding: title: M365ToPbxBinding type: object properties: From: allOf: - $ref: '#/components/schemas/Pbx.SynchronizedM365Profile' nullable: true To: allOf: - $ref: '#/components/schemas/Pbx.SynchronizedPbxProfile' nullable: true Pbx.UsersSyncConfiguration: title: UsersSyncConfiguration type: object properties: IsEnabled: type: boolean nullable: true SelectedUsers: type: array items: type: string SyncType: allOf: - $ref: '#/components/schemas/Pbx.IntegrationSyncType' nullable: true Pbx.OnBoardMcuDataDetail: title: OnBoardMcuDataDetail type: object properties: Active: type: boolean Cloud: type: boolean Enabled: type: boolean Guid: type: string Host: type: string Ip: type: string Port: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 Version: type: string Pbx.MeetingObj: title: MeetingObj type: object properties: documentlist: type: string nullable: true friendlyname: type: string nullable: true logo: type: string meetingid: type: string meetingprofile: type: string nullable: true openlink: type: string organizer: $ref: '#/components/schemas/Pbx.ParticipantDetails' params: $ref: '#/components/schemas/Pbx.MeetingParams' participants: type: array items: $ref: '#/components/schemas/Pbx.ParticipantDetails' theme: type: string Pbx.ParticipantDetails: title: ParticipantDetails type: object properties: email: type: string key: type: string moderator: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true name: type: string pbx_extension: type: string nullable: true Pbx.MeetingParams: title: MeetingParams type: object properties: bitrate_data: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 bitrate_video: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 canchangemedia: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true clicktocall: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true forcemoderator: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true hideparticipants: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true mcu: type: string meetingduration: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 meetingtitle: type: string moderateparticipants: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true needorganizer: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true note: type: string org_properties: type: string nullable: true part_properties: type: string nullable: true privaterooms: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true quickmeeting: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 Pbx.KeyValuePair_2OfString_OnBoardConnectedParticipant: title: KeyValuePair_2OfString_OnBoardConnectedParticipant type: object Pbx.Setpoint: title: Setpoint type: object properties: Enabled: type: boolean Type: $ref: '#/components/schemas/Pbx.SetpointType' Value: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Pbx.VectorStoreExpiration: title: VectorStoreExpiration type: object properties: Anchor: type: string nullable: true Days: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true ExpiresAt: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time nullable: true LastActiveAt: pattern: '^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$' type: string format: date-time nullable: true Pbx.CrmSelectableValue: title: CrmSelectableValue type: object properties: Id: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 Name: type: string nullable: true Pbx.CrmContact: title: CrmContact type: object properties: CompanyName: type: string nullable: true ContactRawData: type: string nullable: true ContactType: allOf: - $ref: '#/components/schemas/Pbx.ContactType' nullable: true ContactUrl: type: string nullable: true Department: type: string nullable: true Email: type: string nullable: true FaxBusiness: type: string nullable: true FirstName: type: string nullable: true LastName: type: string nullable: true Pager: type: string nullable: true PhoneBusiness: type: string nullable: true PhoneBusiness2: type: string nullable: true PhoneHome: type: string nullable: true PhoneMobile: type: string nullable: true PhoneMobile2: type: string nullable: true PhoneOther: type: string nullable: true PhotoUrl: type: string nullable: true Title: type: string nullable: true Pbx.ExtensionFilter: title: ExtensionFilter type: object properties: CallIds: type: array items: type: string Number: type: string nullable: true Pbx.ArchiveSubsystem: title: ArchiveSubsystem type: object properties: Archiving: type: boolean nullable: true Enabled: type: boolean nullable: true Folder: type: string nullable: true ScheduleDays: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Pbx.RemotePostgreConfig: title: RemotePostgreConfig type: object properties: AuthenticateMode: allOf: - $ref: '#/components/schemas/Pbx.AuthenticateMode' nullable: true CACertificate: allOf: - $ref: '#/components/schemas/Pbx.ConcealedDataFile' nullable: true ClientCertificate: allOf: - $ref: '#/components/schemas/Pbx.ConcealedDataFile' nullable: true ClientPrivateKey: allOf: - $ref: '#/components/schemas/Pbx.ConcealedDataFile' nullable: true Database: type: string nullable: true Host: type: string nullable: true Password: allOf: - $ref: '#/components/schemas/Pbx.ConcealedPassword' nullable: true Port: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true ServerTrustMode: allOf: - $ref: '#/components/schemas/Pbx.ServerTrustMode' nullable: true Username: type: string nullable: true Pbx.RemoteMySqlConfig: title: RemoteMySqlConfig type: object properties: Database: type: string nullable: true Host: type: string nullable: true Password: allOf: - $ref: '#/components/schemas/Pbx.ConcealedPassword' nullable: true Port: type: number format: int64 nullable: true UserId: type: string nullable: true Pbx.RemoteSqlServerConfig: title: RemoteSqlServerConfig type: object properties: Database: type: string nullable: true Host: type: string nullable: true Password: allOf: - $ref: '#/components/schemas/Pbx.ConcealedPassword' nullable: true Port: type: number format: int64 nullable: true UserId: type: string nullable: true Pbx.DataTypesToOffload: title: DataTypesToOffload type: object properties: AudioMetrics: type: boolean nullable: true CallHistory: type: boolean nullable: true Recordings: type: boolean nullable: true SystemMetrics: type: boolean nullable: true Pbx.S3Config: title: S3Config type: object properties: ApplyBucket: type: boolean nullable: true BucketName: type: string nullable: true Region: type: string nullable: true Pbx.AmazonCredentials: title: AmazonCredentials type: object properties: AccessKey: type: string nullable: true SecretKey: allOf: - $ref: '#/components/schemas/Pbx.ConcealedPassword' nullable: true Pbx.SyslogCustomRelayConfig: title: SyslogCustomRelayConfig type: object properties: ClientCertificate: allOf: - $ref: '#/components/schemas/Pbx.ConcealedDataFile' nullable: true ClientPrivateKey: allOf: - $ref: '#/components/schemas/Pbx.ConcealedDataFile' nullable: true Host: type: string nullable: true Port: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Protocol: allOf: - $ref: '#/components/schemas/Pbx.SyslogProtocol' nullable: true Pbx.SyslogDatadogConfig: title: SyslogDatadogConfig type: object properties: ApiKey: type: string nullable: true Url: type: string nullable: true Pbx.SyslogSplunkConfig: title: SyslogSplunkConfig type: object properties: Token: type: string nullable: true Url: type: string nullable: true Pbx.SyslogElkConfig: title: SyslogElkConfig type: object properties: ApiKey: type: string nullable: true IndexName: type: string nullable: true Url: type: string nullable: true Pbx.SyslogCategoryConfig: title: SyslogCategoryConfig type: object properties: IsAuditLogsEnabled: type: boolean nullable: true IsEventLogsEnabled: type: boolean nullable: true IsSystemAlertsEnabled: type: boolean nullable: true Pbx.QualityParty: title: QualityParty type: object properties: AddressStr: type: string nullable: true Burst: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Codec: type: string nullable: true Duration: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true GlobalPort: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Inbound: type: boolean nullable: true LocalPort: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true Location: type: string nullable: true MOSFromPBX: oneOf: - type: number format: float nullable: true - type: string nullable: true - $ref: '#/components/schemas/ReferenceNumeric' MOSToPBX: oneOf: - type: number format: float nullable: true - type: string nullable: true - $ref: '#/components/schemas/ReferenceNumeric' Number: type: string nullable: true RTT: oneOf: - type: number format: float nullable: true - type: string nullable: true - $ref: '#/components/schemas/ReferenceNumeric' RxJitter: oneOf: - type: number format: float nullable: true - type: string nullable: true - $ref: '#/components/schemas/ReferenceNumeric' RxLost: oneOf: - type: number format: float nullable: true - type: string nullable: true - $ref: '#/components/schemas/ReferenceNumeric' RxPackets: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true TunAddressStr: type: string nullable: true TxBursts: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true TxJitter: oneOf: - type: number format: float nullable: true - type: string nullable: true - $ref: '#/components/schemas/ReferenceNumeric' TxLost: oneOf: - type: number format: float nullable: true - type: string nullable: true - $ref: '#/components/schemas/ReferenceNumeric' TxPackets: maximum: 2147483647 minimum: -2147483648 type: number format: int32 nullable: true UserAgent: type: string nullable: true Pbx.ENL: title: ENL type: object properties: From: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 To: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 Pbx.EmailVariable: title: EmailVariable type: object properties: Name: type: string Value: type: string Pbx.GoogleUserSync: title: GoogleUserSync type: object properties: IsEnabled: type: boolean nullable: true IsSyncDepartments: type: boolean nullable: true IsSyncPersonalContacts: type: boolean nullable: true IsSyncPhoto: type: boolean nullable: true SelectedUsers: type: array items: type: string StartingExtensionNumber: type: string nullable: true SyncType: allOf: - $ref: '#/components/schemas/Pbx.IntegrationSyncType' nullable: true UseCalendarEventsAsPresence: type: boolean nullable: true Pbx.AutoSchedulerSettings: title: AutoSchedulerSettings type: object properties: Enabled: type: boolean nullable: true ProfileAvailable: type: string nullable: true ProfileAway: type: string nullable: true ProfileDND: type: string nullable: true Pbx.CallTypeInfo: title: CallTypeInfo type: object properties: DigitsLength: type: string nullable: true Prefix: type: string nullable: true Pbx.ContactSource: title: ContactSource enum: - 3CX - CRM - Google - M365 type: string Pbx.RemoteAccessStatus: title: RemoteAccessStatus enum: - None - Requested - Active type: string Pbx.PeerType: title: PeerType enum: - None - Extension - Queue - RingGroup - IVR - Fax - Conference - SpecialMenu - Parking - ExternalLine - Group - RoutePoint type: string Pbx.UserTag: title: UserTag enum: - MS - Teams - Google - WakeUp - FaxServer - Principal - WeakID - WeakPass - WM - AI type: string Pbx.TranscriptionType: title: TranscriptionType enum: - Nothing - Voicemail - Recordings - Both - Inherit type: string x-ms-enum-flags: isFlags: true Pbx.CfaRoutingType: title: CfaRoutingType enum: - DialCode - Forward - Trunk type: string Pbx.DirectionType: title: DirectionType enum: - None - Inbound - Outbound - Both type: string Pbx.SRTPModeType: title: SRTPModeType enum: - SRTPDisabled - SRTPEnabled - SRTPEnforced type: string Pbx.MatchingStrategyType: title: MatchingStrategyType enum: - MatchAnyFields - MatchAllFields type: string Pbx.RequireRegistrationForType: title: RequireRegistrationForType enum: - Nothing - IncomingCalls - OutgoingCalls - InOutCalls type: string Pbx.GatewayType: title: GatewayType enum: - Unknown - Analog - Provider - BridgeMaster - BridgeSlave - BridgeSlaveOverTunnel - BRI - T1 - E1 type: string Pbx.IPInRegistrationContactType: title: IPInRegistrationContactType enum: - External - Internal - Both - Specified type: string Pbx.RuleCallTypeType: title: RuleCallTypeType enum: - AllCalls - InternalCallsOnly - ExternalCallsOnly type: string Pbx.RuleHoursType: title: RuleHoursType enum: - AllHours - OfficeHours - OutOfOfficeHours - SpecificHours - SpecificHoursExcludingHolidays - OutOfSpecificHours - OutOfSpecificHoursIncludingHolidays - Never - BreakTime type: string Pbx.DayOfWeek: title: DayOfWeek enum: - Sunday - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday type: string Pbx.RuleConditionType: title: RuleConditionType enum: - NoAnswer - PhoneBusy - PhoneNotRegistered - ForwardAll - BasedOnCallerID - BasedOnDID type: string Pbx.DestinationType: title: DestinationType enum: - None - VoiceMail - Extension - Queue - RingGroup - IVR - External - Fax - Boomerang - Deflect - VoiceMailOfDestination - Callback - RoutePoint - ProceedWithNoExceptions type: string Pbx.TypeOfIPRestriction: title: TypeOfIPRestriction enum: - Any - IPV4 - IPV6 type: string Pbx.TypeOfTransportRestriction: title: TypeOfTransportRestriction enum: - Any - UDP - TCP - TLS type: string Pbx.HolidayMode: title: HolidayMode enum: - Disabled - PlayAndDrop - PlayAndContinue type: string Pbx.Authentication: title: Authentication enum: - Both - Name - Email - None type: string Pbx.CallHandlingFlags: title: CallHandlingFlags enum: - WelcomeMessageForIncomingCalls - HoldCall type: string x-ms-enum-flags: isFlags: true Pbx.GroupHoursMode: title: GroupHoursMode enum: - Default - ForceOpened - ForceClosed - ForceBreak - ForceCustomOperator - ForceHoliday - HasForcedMask type: string x-ms-enum-flags: isFlags: true Pbx.StartupLicense: title: StartupLicense enum: - Free - Pro type: string Pbx.PollingStrategyType: title: PollingStrategyType enum: - Hunt - RingAll - HuntRandomStart - NextAgent - LongestWaiting - LeastTalkTime - FewestAnswered - HuntBy3s - First3Available - SkillBasedRouting_RingAll - SkillBasedRouting_HuntRandomStart - SkillBasedRouting_RoundRobin - SkillBasedRouting_FewestAnswered type: string Pbx.TypeOfChatOwnershipType: title: TypeOfChatOwnershipType enum: - TakeManually - AutoAssign type: string Pbx.QueueRecording: title: QueueRecording enum: - Disabled - AllowToOptOut - AskToOptIn type: string Pbx.QueueNotifyCode: title: QueueNotifyCode enum: - Callback - CallbackFail - SLATimeBreached - CallLost type: string Pbx.ResetQueueStatisticsFrequency: title: ResetQueueStatisticsFrequency enum: - Disabled - Daily - Weekly - Monthly type: string Pbx.VMEmailOptionsType: title: VMEmailOptionsType enum: - None - Notification - Attachment - AttachmentAndDelete - VmailToMembers - EmailToExtrasOnly type: string Pbx.StrategyType: title: StrategyType enum: - Hunt - RingAll - Paging type: string Pbx.VMPlayMsgDateTimeType: title: VMPlayMsgDateTimeType enum: - None - Play12Hr - Play24Hr type: string Pbx.ProfileType: title: ProfileType enum: - Default - Available - Away - OutOfOffice - Available2 - OutOfOffice2 type: string Pbx.QueueStatusType: title: QueueStatusType enum: - LoggedOut - LoggedIn type: string Pbx.OfficeHoursBits: title: OfficeHoursBits enum: - GlobalSchedule - AutoSwitchProfiles - AutoQueueLogOut - BlockOutboundCalls type: string x-ms-enum-flags: isFlags: true Pbx.ProvType: title: ProvType enum: - LocalLan - RemoteExt - RemoteExtSipProxyMgr - SBC type: string Pbx.XferTypeEnum: title: XferTypeEnum enum: - BXfer - AttXfer type: string Pbx.PhoneDeviceVlanType: title: PhoneDeviceVlanType enum: - Wan - Pc type: string Pbx.IVRType: title: IVRType enum: - Default - CodeBased - ScriptBased - Wakeup type: string Pbx.IVRForwardType: title: IVRForwardType enum: - EndCall - Extension - RingGroup - Queue - IVR - VoiceMail - CallByName - RepeatPrompt - CustomInput type: string Pbx.BlockType: title: BlockType enum: - Block - Allow type: string Pbx.AddedBy: title: AddedBy enum: - Manual - Mcu - Webmeeting - AutoBlacklist - Whitelist type: string Pbx.TemplateType: title: TemplateType enum: - Preferred - Supported - Dedicated - ThirdParty - Deleted - Unknown type: string Pbx.TrunkEditorType: title: TrunkEditorType enum: - Messaging - Voip type: string Pbx.TrunkVariableType: title: TrunkVariableType enum: - Text - Password type: string Pbx.RecordingCallType: title: RecordingCallType enum: - Local - InboundExternal - OutboundExternal type: string Pbx.FileSystemType: title: FileSystemType enum: - Local - Ftp - GoogleDrive - NetworkShare - Logs - Sftp - GoogleBucket - SharePoint - AmazonS3 type: string Pbx.InfoLevel: title: InfoLevel enum: - Critical - Error - Warning - Info type: string Pbx.AnalysisCode: title: AnalysisCode enum: - TrunkIsDisabled - RegistrarIsNotSet - SIPCallFailed - CallMonitoringFailed - ErrNoAuthID - OutboundCallFailed - SecureSIPCertificateInvalid - SecureSIPPrivateKeyInvalid - SecureSIPCertificateDateInvalid - InboundCallFailed - RouteSkipped - RouteFailed - RTPMismatchDetected - CodecMismatch - ResponseCodeFail - ResponseTextFail - ErrNoAuthPwd - ErrNoAuth3way - ErrNoTransport - ErrNoReply - TransportMismatch - TransportError - RegistrationFailed - RegistrationIsBlocked - ForwardingFailed - ForwardingFailedEndCall - WarnOutboundDuration - NumberFormatsMismatch - TrunkIsInboundOnly - TrunkIsOutboundOnly - NotSupportedRinstance - NotSupportedRFC2833 - ProxyFqdnHasNoNAPTRorSRV - ProxyZeroPortIP - RegistrarFqdnHasNoNAPTRorSRV - RegistrarZeroPortIP - AltProxyFqdnHasNoNAPTRorSRV - AltProxyZeroPortIP - ForwardingEndsCall - MainTrunkNumber - ProxyFQDNIsNotResolved - RegistrarFQDNIsNotResolved - AltProxyFQDNIsNotResolved - NotSupportedSessionTimers - OutboundDialed - NumberFormatsMatch - OutboundCallerReady - LocalCodec - RemoteCodec - DestinationMediaIP - SourceMediaIP - OutboundRuleFound - OutboundCallSuccessful - SIPMessageResponse - IPMode - ServerAddress - TransportType - TargetDomain - RegisteredOK - RegistrationIsNotRequired - ProxyIsIpAddress - ProxyIsFQDN - ProxyResolvesToNAPTR - ProxyResolvesToSRV - ProxyResolvesToHOST - ProxyResolvesToAAAA - RegistrarIsIPaddress - RegistrarIsFQDN - RegistrarIsFQDNnoResolve - RegistrarResolvesToNAPTR - RegistrarResolvesToSRV - RegistrarResolvesToHOST - RegistrarResolvesToAAAA - InboundCallSource - InboundCallTransport - InboundSIPMessage - ExtraHeader - SupportedPrivacy - SupportedRinstance - SupportedRFC2833 - SupportedVideo - SupportedPRACK - SupportedFax - SupportedRtcp - SupportedCryptos - SupportedSessionTimers - AltProxyIsIPAddress - AltProxyIsFQDN - AltProxyResolvesToNAPTR - AltProxyResolvesToSRV - AltProxyResolvesToHOST - AltProxyResolvesToAAAA - ForwardingInfo type: string Pbx.TrunkType: title: TrunkType enum: - Voxtelesys - Twilio type: string Pbx.DeviceType: title: DeviceType enum: - Fxs - Dect type: string Pbx.PromptSetType: title: PromptSetType enum: - System - Custom type: string Pbx.PromptType: title: PromptType enum: - File - DepFile - Playlist type: string Pbx.AnimationStyle: title: AnimationStyle enum: - SlideUp - SlideFromSide - FadeIn - NoAnimation type: string Pbx.LiveChatGreeting: title: LiveChatGreeting enum: - Disabled - OnlyOnDesktop - OnlyOnMobile - DesktopAndMobile type: string Pbx.LiveChatCommunication: title: LiveChatCommunication enum: - ChatOnly - PhoneAndChat - PhoneOnly - VideoPhoneAndChat type: string Pbx.LiveChatMinimizedStyle: title: LiveChatMinimizedStyle enum: - BubbleLeft - BubbleRight - BottomLeft - BottomRight type: string Pbx.LiveChatLanguage: title: LiveChatLanguage enum: - browser - en - es - de - fr - it - pl - ru - pt - zh type: string Pbx.LiveMessageUserinfoFormat: title: LiveMessageUserinfoFormat enum: - Avatar - Name - Both - None type: string Pbx.LiveChatMessageDateformat: title: LiveChatMessageDateformat enum: - Date - Time - Both type: string Pbx.ButtonIconType: title: ButtonIconType enum: - Url - Default - Bubble - DoubleBubble type: string Pbx.ScheduleType: title: ScheduleType enum: - Daily - Weekly - Monthly - Hourly - Minutely - Immediate type: string Pbx.UpdateType: title: UpdateType enum: - Release - Beta - MajorRelease - Alpha - Hotfix type: string Pbx.FailoverMode: title: FailoverMode enum: - Active - Passive type: string Pbx.FailoverCondition: title: FailoverCondition enum: - AllService - AnyService type: string Pbx.SbcLogLevel: title: SbcLogLevel enum: - None - Low - Medium - Verbose type: string Pbx.Security: title: Security enum: - TCP - TLS type: string Pbx.ParameterType: title: ParameterType enum: - String - Integer - Double - Boolean - DateTime - Password - OAuth - List type: string Pbx.EditorType: title: EditorType enum: - String - Sql type: string Pbx.AuthenticationType: title: AuthenticationType enum: - No - Basic - Scenario type: string Pbx.TypeOfCDRLog: title: TypeOfCDRLog enum: - SingleFileForAllCalls - SingleFileForEachCall - PassiveSocket - ActiveSocket type: string Pbx.EventLogType: title: EventLogType enum: - Error - Warning - Info type: string Pbx.ServiceStatus: title: ServiceStatus enum: - Stopped - StartPending - StopPending - Running - ContinuePending - PausePending - Paused type: string Pbx.GCCollectionMode: title: GCCollectionMode enum: - Default - Forced - Optimized - Aggressive type: string Pbx.IntegrationSyncType: title: IntegrationSyncType enum: - SyncAllUsers - SyncAllUsersExceptSelected - SyncSelected - SyncSelectedGroups type: string Pbx.SynchronizedPbxProfile: title: SynchronizedPbxProfile enum: - Available - OutOfOffice - Away type: string Pbx.SynchronizedM365Profile: title: SynchronizedM365Profile enum: - Available - Busy - Away - AvailableIdle - BusyIdle - DoNotDisturb - BeRightBack - InMeeting - InCall type: string Pbx.TypeOfUser: title: TypeOfUser enum: - Users - SharedMailboxes - LicensedUsers type: string Pbx.TranscribeEngine: title: TranscribeEngine enum: - None - Google - OpenAI - Whisper - Engine3CX - Engine3CXLocal type: string Pbx.OpenAIModel: title: OpenAIModel enum: - Default - Custom - GPT_4o - GPT_4o_mini type: string Pbx.OnBoardMcuServerOS: title: OnBoardMcuServerOS enum: - Debian10 - Debian11 - Debian12 type: string Pbx.DtmfMode: title: DtmfMode enum: - None - SipInfo - Rfc2833 - SipAndRfc type: string x-ms-enum-flags: isFlags: true Pbx.McuOperation: title: McuOperation enum: - Create - Delete type: string Pbx.McuReqState: title: McuReqState enum: - Pending - Success - Failure type: string Pbx.NotifyCodes: title: NotifyCodes enum: - StorageLimit - EmergencyNumberDialed - TrunkStatusChanged - ExtensionRegChanged - LicenseLimit - TrunkFailover - IPBlocked - RequestAntiHacked - NetworkError - TrunkError - STUNError - CallDenied - NumberBlocked - NumberUnblocked type: string Pbx.SetpointType: title: SetpointType enum: - VoicemailQuota - RecordingQuota - CpuUsage - InboundNetworkUsage - OutboundNetworkUsage - PhysicalMemoryUsage - VirtualMemoryUsage - DiskUsage - TimeShift type: string Pbx.MailServerType: title: MailServerType enum: - Tcx - MS365 - Custom - GoogleWorkspace type: string Pbx.PmsIntegrationType: title: PmsIntegrationType enum: - tcxpms - fidelio type: string Pbx.XOperatingSystemType: title: XOperatingSystemType enum: - Other - Linux - Windows type: string Pbx.RemoteStorageStatus: title: RemoteStorageStatus enum: - NotConfigured - PartiallyConfigured - Configured type: string Pbx.PhoneSystemService: title: PhoneSystemService enum: - Database - Configuration - AudioProvider - SIPService - SystemService - IVR - CallFlow - QueueMananger - Tunnel - ManagementConsole - MediaServer - HotelModule - EventNotiificationManager - Nginx - Gateway - AiBridge type: string Pbx.CreateTicketStatus: title: CreateTicketStatus enum: - OK - KeyNotFound - KeyNotAssignedToUser - KeyAssignedToPartner - KeyIsNotCommercial - KeyHasNoSupportTickets type: string Pbx.PhonebookPriorityOptions: title: PhonebookPriorityOptions enum: - NotQueryIfInPhonebookFound - AlwaysQuery type: string Pbx.ContactType: title: ContactType enum: - Company - Personal type: string Pbx.RevokeReason: title: RevokeReason enum: - TooMany - SetPassword - InvalidatePassword - Logout - Manual type: string Pbx.LoginType: title: LoginType enum: - Local - Guest type: string Pbx.OffloadDestination: title: OffloadDestination enum: - None - Postgre - BigQuery - MySql - SqlServer type: string Pbx.ServerTrustMode: title: ServerTrustMode enum: - Prefer - Require - VerifyFull type: string Pbx.AuthenticateMode: title: AuthenticateMode enum: - Password - CertificateFile type: string Pbx.SyslogIntegrationType: title: SyslogIntegrationType enum: - Custom - Splunk - Elastic - Datadog type: string Pbx.SyslogProtocol: title: SyslogProtocol enum: - Udp - Tcp - Tls type: string Pbx.ChatType: title: ChatType enum: - SMS - LiveChat - Facebook - Internal - RCS type: string Pbx.ScheduledReportType: title: ScheduledReportType enum: - None - CallLogs - ChatLogs - AuditLogs - InboundRules - QueueAbandonedCalls - QueueAnsweredCallsByWaitingTime - QueueCallbacks - QueueFailedCallbacks - QueuePerformanceOverview - QueueDetailedStatistics - QueueTeamGeneralStatistics - SlaStatistics - SlaBreaches - AgentInQueueStatistics - AgentLoginHistory - ExtensionsStatisticsByRingGroups - ExtensionStatistics - CallCostByExtensionDept - QueueChatPerformance - QueueAgentsChat - AbandonedChats - RingGroups - InboundCalls - OutBoundCalls - UserActivity - CallDistribution type: string Pbx.ReportScheduleType: title: ReportScheduleType enum: - Daily - Weekly - Monthly - Hourly - NotScheduled type: string Pbx.AvatarStyle: title: AvatarStyle enum: - Square - Circle type: string Pbx.TypeOfAutoPickupForward: title: TypeOfAutoPickupForward enum: - TransferBack - DN - ExtensionVoiceMail - ExternalNumber - RoutePoint type: string Pbx.TypeOfPhoneBookResolving: title: TypeOfPhoneBookResolving enum: - NotResolve - MatchExact - MatchLength type: string Pbx.TypeOfPhoneBookDisplay: title: TypeOfPhoneBookDisplay enum: - FirstNameLastName - LastNameFirstName type: string Pbx.TypeOfPhoneBookAddQueueName: title: TypeOfPhoneBookAddQueueName enum: - NotAdd - Append - Prepend type: string Pbx.ChatRecipientsType: title: ChatRecipientsType enum: - None - MyGroupManagers - MyGroupAllMembers - AllGroupsManagers type: string Pbx.CallFlowScriptCollectionResponse: title: Collection of CallFlowScript type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.CallFlowScript' Pbx.ReceptionistCollectionResponse: title: Collection of Receptionist type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.Receptionist' Pbx.BlackListNumberCollectionResponse: title: Collection of BlackListNumber type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.BlackListNumber' Pbx.BlocklistAddrCollectionResponse: title: Collection of BlocklistAddr type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.BlocklistAddr' Pbx.RingGroupCollectionResponse: title: Collection of RingGroup type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.RingGroup' Pbx.ContactCollectionResponse: title: Collection of Contact type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.Contact' Pbx.QueueCollectionResponse: title: Collection of Queue type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.Queue' Pbx.UserCollectionResponse: title: Collection of User type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.User' Pbx.PhoneTemplateCollectionResponse: title: Collection of PhoneTemplate type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.PhoneTemplate' Pbx.TrunkTemplateCollectionResponse: title: Collection of TrunkTemplate type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.TrunkTemplate' Pbx.RecordingCollectionResponse: title: Collection of Recording type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.Recording' Pbx.GroupCollectionResponse: title: Collection of Group type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.Group' Pbx.OutboundRuleCollectionResponse: title: Collection of OutboundRule type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.OutboundRule' Pbx.ParameterCollectionResponse: title: Collection of Parameter type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.Parameter' Pbx.DNPropertyCollectionResponse: title: Collection of DNProperty type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.DNProperty' Pbx.PeerCollectionResponse: title: Collection of Peer type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.Peer' Pbx.TrunkCollectionResponse: title: Collection of Trunk type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.Trunk' Pbx.InboundRuleCollectionResponse: title: Collection of InboundRule type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.InboundRule' Pbx.CountryCollectionResponse: title: Collection of Country type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.Country' Pbx.FxsCollectionResponse: title: Collection of Fxs type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.Fxs' Pbx.PromptSetCollectionResponse: title: Collection of PromptSet type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.PromptSet' Pbx.CustomPromptCollectionResponse: title: Collection of CustomPrompt type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.CustomPrompt' Pbx.PropertyCollectionResponse: title: Collection of Property type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.Property' Pbx.FxsTemplateCollectionResponse: title: Collection of FxsTemplate type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.FxsTemplate' Pbx.WeblinkCollectionResponse: title: Collection of Weblink type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.Weblink' Pbx.ParkingCollectionResponse: title: Collection of Parking type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.Parking' Pbx.BackupsCollectionResponse: title: Collection of Backups type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.Backups' Pbx.SbcCollectionResponse: title: Collection of Sbc type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.Sbc' Pbx.RegistrarFxsCollectionResponse: title: Collection of RegistrarFxs type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.RegistrarFxs' Pbx.CallFlowAppCollectionResponse: title: Collection of CallFlowApp type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.CallFlowApp' Pbx.ServicePrincipalCollectionResponse: title: Collection of ServicePrincipal type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.ServicePrincipal' Pbx.CrmTemplateCollectionResponse: title: Collection of CrmTemplate type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.CrmTemplate' Pbx.CallCostSettingsCollectionResponse: title: Collection of CallCostSettings type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.CallCostSettings' Pbx.PhoneLogoCollectionResponse: title: Collection of PhoneLogo type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.PhoneLogo' Pbx.ActiveCallCollectionResponse: title: Collection of ActiveCall type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.ActiveCall' Pbx.EventLogCollectionResponse: title: Collection of EventLog type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.EventLog' Pbx.ServiceInfoCollectionResponse: title: Collection of ServiceInfo type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.ServiceInfo' Pbx.EmailTemplateCollectionResponse: title: Collection of EmailTemplate type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.EmailTemplate' Pbx.FirmwareCollectionResponse: title: Collection of Firmware type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.Firmware' Pbx.PlaylistCollectionResponse: title: Collection of Playlist type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.Playlist' Pbx.FaxCollectionResponse: title: Collection of Fax type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.Fax' Pbx.DidNumberCollectionResponse: title: Collection of DidNumber type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.DidNumber' Pbx.ActivityLogEventCollectionResponse: title: Collection of ActivityLogEvent type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.ActivityLogEvent' Pbx.RefreshTokenCollectionResponse: title: Collection of RefreshToken type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.RefreshToken' Pbx.HolidayCollectionResponse: title: Collection of Holiday type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.Holiday' Pbx.EmergencyGeoLocationCollectionResponse: title: Collection of EmergencyGeoLocation type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.EmergencyGeoLocation' Pbx.CallHistoryViewCollectionResponse: title: Collection of CallHistoryView type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.CallHistoryView' Pbx.ChatHistoryViewCollectionResponse: title: Collection of ChatHistoryView type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.ChatHistoryView' Pbx.ChatMessagesHistoryViewCollectionResponse: title: Collection of ChatMessagesHistoryView type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.ChatMessagesHistoryView' Pbx.LastCdrAndChatMessageTimestampCollectionResponse: title: Collection of LastCdrAndChatMessageTimestamp type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.LastCdrAndChatMessageTimestamp' Pbx.RingGroupStatisticsCollectionResponse: title: Collection of RingGroupStatistics type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.RingGroupStatistics' Pbx.ExtensionsStatisticsByRingGroupsCollectionResponse: title: Collection of ExtensionsStatisticsByRingGroups type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.ExtensionsStatisticsByRingGroups' Pbx.CallLogDataCollectionResponse: title: Collection of CallLogData type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.CallLogData' Pbx.ExtensionStatisticsCollectionResponse: title: Collection of ExtensionStatistics type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.ExtensionStatistics' Pbx.ReportExtensionStatisticsByGroupCollectionResponse: title: Collection of ReportExtensionStatisticsByGroup type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.ReportExtensionStatisticsByGroup' Pbx.CallCostByExtensionGroupCollectionResponse: title: Collection of CallCostByExtensionGroup type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.CallCostByExtensionGroup' Pbx.QueuePerformanceOverviewCollectionResponse: title: Collection of QueuePerformanceOverview type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.QueuePerformanceOverview' Pbx.QueuePerformanceTotalsCollectionResponse: title: Collection of QueuePerformanceTotals type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.QueuePerformanceTotals' Pbx.TeamQueueGeneralStatisticsCollectionResponse: title: Collection of TeamQueueGeneralStatistics type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.TeamQueueGeneralStatistics' Pbx.DetailedQueueStatisticsCollectionResponse: title: Collection of DetailedQueueStatistics type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.DetailedQueueStatistics' Pbx.AbandonedQueueCallsCollectionResponse: title: Collection of AbandonedQueueCalls type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.AbandonedQueueCalls' Pbx.QueueAnsweredCallsByWaitTimeCollectionResponse: title: Collection of QueueAnsweredCallsByWaitTime type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.QueueAnsweredCallsByWaitTime' Pbx.QueueCallbacksCollectionResponse: title: Collection of QueueCallbacks type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.QueueCallbacks' Pbx.AgentsInQueueStatisticsCollectionResponse: title: Collection of AgentsInQueueStatistics type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.AgentsInQueueStatistics' Pbx.QueueFailedCallbacksCollectionResponse: title: Collection of QueueFailedCallbacks type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.QueueFailedCallbacks' Pbx.StatisticSlaCollectionResponse: title: Collection of StatisticSla type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.StatisticSla' Pbx.BreachesSlaCollectionResponse: title: Collection of BreachesSla type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.BreachesSla' Pbx.QueueChatPerformanceCollectionResponse: title: Collection of QueueChatPerformance type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.QueueChatPerformance' Pbx.QueueAgentsChatStatisticsCollectionResponse: title: Collection of QueueAgentsChatStatistics type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.QueueAgentsChatStatistics' Pbx.QueueAgentsChatStatisticsTotalsCollectionResponse: title: Collection of QueueAgentsChatStatisticsTotals type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.QueueAgentsChatStatisticsTotals' Pbx.AbandonedChatsStatisticsCollectionResponse: title: Collection of AbandonedChatsStatistics type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.AbandonedChatsStatistics' Pbx.AgentLoginHistoryCollectionResponse: title: Collection of AgentLoginHistory type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.AgentLoginHistory' Pbx.UserActivityCollectionResponse: title: Collection of UserActivity type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.UserActivity' Pbx.CallDistributionCollectionResponse: title: Collection of CallDistribution type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.CallDistribution' Pbx.OutboundCallCollectionResponse: title: Collection of OutboundCall type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.OutboundCall' Pbx.InboundCallCollectionResponse: title: Collection of InboundCall type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.InboundCall' Pbx.AuditLogCollectionResponse: title: Collection of AuditLog type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.AuditLog' Pbx.InboundRuleReportCollectionResponse: title: Collection of InboundRuleReport type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.InboundRuleReport' Pbx.TimeReportDataCollectionResponse: title: Collection of TimeReportData type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.TimeReportData' Pbx.ScheduledReportCollectionResponse: title: Collection of ScheduledReport type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.ScheduledReport' Pbx.DeviceInfoCollectionResponse: title: Collection of DeviceInfo type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.DeviceInfo' Pbx.SipDeviceCollectionResponse: title: Collection of SipDevice type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.SipDevice' Pbx.NetworkInterfaceCollectionResponse: title: Collection of NetworkInterface type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.NetworkInterface' Pbx.UserGroupCollectionResponse: title: Collection of UserGroup type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.UserGroup' Pbx.ReceptionistForwardCollectionResponse: title: Collection of ReceptionistForward type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.ReceptionistForward' Pbx.RingGroupMemberCollectionResponse: title: Collection of RingGroupMember type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.RingGroupMember' Pbx.QueueAgentCollectionResponse: title: Collection of QueueAgent type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.QueueAgent' Pbx.QueueManagerCollectionResponse: title: Collection of QueueManager type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.QueueManager' Pbx.GreetingCollectionResponse: title: Collection of Greeting type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.Greeting' Pbx.ForwardingProfileCollectionResponse: title: Collection of ForwardingProfile type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.ForwardingProfile' Pbx.ExtensionRuleCollectionResponse: title: Collection of ExtensionRule type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.ExtensionRule' Pbx.PhoneCollectionResponse: title: Collection of Phone type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.Phone' Pbx.RightsCollectionResponse: title: Collection of Rights type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.Rights' Pbx.PeerGroupCollectionResponse: title: Collection of PeerGroup type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.PeerGroup' Pbx.EmergencyGeoTrunkLocationCollectionResponse: title: Collection of EmergencyGeoTrunkLocation type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.EmergencyGeoTrunkLocation' Pbx.PromptCollectionResponse: title: Collection of Prompt type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.Prompt' Pbx.CrmSelectableValueCollectionResponse: title: Collection of CrmSelectableValue type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.CrmSelectableValue' Pbx.CodecCollectionResponse: title: Collection of Codec type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.Codec' Pbx.GatewayParameterCollectionResponse: title: Collection of GatewayParameter type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.GatewayParameter' Pbx.TimeZoneCollectionResponse: title: Collection of TimeZone type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.TimeZone' Pbx.GatewayParameterValueCollectionResponse: title: Collection of GatewayParameterValue type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.GatewayParameterValue' Pbx.PhoneModelCollectionResponse: title: Collection of Pbx.PhoneModel type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.PhoneModel' Pbx.OutboundRouteCollectionResponse: title: Collection of Pbx.OutboundRoute type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.OutboundRoute' Pbx.DNRangeCollectionResponse: title: Collection of Pbx.DNRange type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.DNRange' Pbx.CIDFormattingCollectionResponse: title: Collection of Pbx.CIDFormatting type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.CIDFormatting' Pbx.VariableCollectionResponse: title: Collection of Pbx.Variable type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.Variable' Pbx.TrunkReportCollectionResponse: title: Collection of Pbx.TrunkReport type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.TrunkReport' Pbx.LogEntryCollectionResponse: title: Collection of Pbx.LogEntry type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.LogEntry' Pbx.SetRouteCollectionResponse: title: Collection of Pbx.SetRoute type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.SetRoute' Pbx.ProviderPhoneCollectionResponse: title: Collection of Pbx.ProviderPhone type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.ProviderPhone' Pbx.DeviceLineCollectionResponse: title: Collection of Pbx.DeviceLine type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.DeviceLine' Pbx.FxsModelCollectionResponse: title: Collection of Pbx.FxsModel type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.FxsModel' Pbx.FxsVariableCollectionResponse: title: Collection of Pbx.FxsVariable type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.FxsVariable' Pbx.UpdateItemCollectionResponse: title: Collection of Pbx.UpdateItem type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.UpdateItem' Pbx.CategoryUpdateCollectionResponse: title: Collection of Pbx.CategoryUpdate type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.CategoryUpdate' Pbx.CrmParameterCollectionResponse: title: Collection of Pbx.CrmParameter type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.CrmParameter' Pbx.CDRSettingsFieldCollectionResponse: title: Collection of Pbx.CDRSettingsField type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.CDRSettingsField' Pbx.ExternalAccountCollectionResponse: title: Collection of Pbx.ExternalAccount type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.ExternalAccount' Pbx.ExternalGroupCollectionResponse: title: Collection of Pbx.ExternalGroup type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.ExternalGroup' Pbx.OnBoardConverterSessionCollectionResponse: title: Collection of Pbx.OnBoardConverterSession type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.OnBoardConverterSession' Pbx.KeyValuePair_2OfString_OnBoardConnectedParticipantCollectionResponse: title: Collection of Pbx.KeyValuePair_2OfString_OnBoardConnectedParticipant type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.KeyValuePair_2OfString_OnBoardConnectedParticipant' Pbx.SetpointCollectionResponse: title: Collection of Pbx.Setpoint type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.Setpoint' Pbx.AIModelCollectionResponse: title: Collection of Pbx.AIModel type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.AIModel' Pbx.AIAgentTemplateCollectionResponse: title: Collection of Pbx.AIAgentTemplate type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.AIAgentTemplate' Pbx.AIVoiceCollectionResponse: title: Collection of Pbx.AIVoice type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.AIVoice' Pbx.VectorStoreCollectionResponse: title: Collection of Pbx.VectorStore type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.VectorStore' Pbx.VectorStoreFileCollectionResponse: title: Collection of Pbx.VectorStoreFile type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.VectorStoreFile' Pbx.CrmChoiceCollectionResponse: title: Collection of Pbx.CrmChoice type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.CrmChoice' Pbx.CrmContactCollectionResponse: title: Collection of Pbx.CrmContact type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.CrmContact' Pbx.ExtensionFilterCollectionResponse: title: Collection of Pbx.ExtensionFilter type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.ExtensionFilter' Pbx.GatewayParameterBindingCollectionResponse: title: Collection of Pbx.GatewayParameterBinding type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.GatewayParameterBinding' Pbx.ChoiceCollectionResponse: title: Collection of Pbx.Choice type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.Choice' Pbx.PhoneDeviceVlanInfoCollectionResponse: title: Collection of Pbx.PhoneDeviceVlanInfo type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.PhoneDeviceVlanInfo' Pbx.CustomQueueRingtoneCollectionResponse: title: Collection of Pbx.CustomQueueRingtone type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.CustomQueueRingtone' Pbx.EmailVariableCollectionResponse: title: Collection of Pbx.EmailVariable type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.EmailVariable' Pbx.PeriodCollectionResponse: title: Collection of Pbx.Period type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.Period' Pbx.AgentRoutingDirectoryCollectionResponse: title: Collection of Pbx.AgentRoutingDirectory type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.AgentRoutingDirectory' Pbx.TrunkVariableCollectionResponse: title: Collection of Pbx.TrunkVariable type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.TrunkVariable' Pbx.FxsVariableChoiceCollectionResponse: title: Collection of Pbx.FxsVariableChoice type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.FxsVariableChoice' Pbx.PbxToM365BindingCollectionResponse: title: Collection of Pbx.PbxToM365Binding type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.PbxToM365Binding' Pbx.M365ToPbxBindingCollectionResponse: title: Collection of Pbx.M365ToPbxBinding type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.M365ToPbxBinding' Pbx.ParticipantDetailsCollectionResponse: title: Collection of Pbx.ParticipantDetails type: object allOf: - $ref: '#/components/schemas/BaseCollectionPaginationCountResponse' - type: object properties: value: type: array items: $ref: '#/components/schemas/Pbx.ParticipantDetails' Pbx.Warnings: enum: - WARNINGS.CONTACTS_SPECIFY_NAME_SURNAME_COMPANY - WARNINGS.CONTACTS_SPECIFY_PHONE_NUMBER - WARNINGS.CONTACTS_SPECIFY_NAME_SURNAME - WARNINGS.STRING_TOO_LONG - WARNINGS.LENGTH_NOT_MORE_50_CHARS - WARNINGS.LENGTH_NOT_MORE_255_CHARS - WARNINGS.INVALID_HEX_CHARACTER - WARNINGS.NO_MORE_NUMBERS_AVAILABLE - WARNINGS.ERP_SERVER_ERROR - WARNINGS.LICENSE_NOT_FOUND - WARNINGS.LIMIT_REACHED - WARNINGS.INVALID - WARNINGS.XAPI.CAPTCHA_ERROR - WARNINGS.XAPI.INVALID_PIN_NUMBER - WARNINGS.XAPI.NOT_SUPPORTED - WARNINGS.XAPI.USER_ROLE_DOWNGRADE - WARNINGS.GROUP_CANNOT_BE_DELETED - WARNINGS.CANNOT_BE_DELETED - WARNINGS.GROUP_WITH_MEMBERS_CANNOT_BE_DELETED - WARNINGS.XAPI.OTHER_USER_ROLE_DOWNGRADE - WARNINGS.XAPI.INVALID_LICENSE_TYPE - WARNINGS.INVALID_PASSWORD - WARNINGS.XAPI.NOT_FOUND - WARNINGS.XAPI.FILE_NOT_FOUND - WARNINGS.XAPI.FILE_NOT_ACCESSIBLE - WARNINGS.XAPI.REQUIRED - WARNINGS.XAPI.CAN_NOT_BE_EMPTY_STRING - WARNINGS.XAPI.DUPLICATE - WARNINGS.XAPI.MAC_USED_BY - WARNINGS.XAPI.ALREADY_IN_USE - WARNINGS.MAC_ADDRESS_ALREADY_IN_USE - WARNINGS.XAPI.PLAYLIST_IN_USE - WARNINGS.XAPI.OUT_OF_THE_RANGE - WARNINGS.XAPI.TOO_MANY_PHONES - WARNINGS.XAPI.TOO_MANY_TRUNKS - WARNINGS.XAPI.TOO_MANY_SBC - WARNINGS.XAPI.TOO_MANY_PROMPTS - WARNINGS.XAPI.TOO_MANY_ITEMS_IN_LIST - WARNINGS.XAPI.AWS_STORAGE_UNDER_USAGE - WARNINGS.XAPI.OUTBOUND_RULES_LIMIT_REACHED - WARNINGS.XAPI.FORBIDDEN_CHANGE - WARNINGS.FAX_SERVER_CANNOT_BE_DELETED - WARNINGS.OPERATOR_CANNOT_BE_DELETED - WARNINGS.USER_EXTENSION_CANNOT_BE_DELETED - WARNINGS.XAPI.NUMBER_IGNORED - WARNINGS.XAPI.INVALID_TIMEZONE - WARNINGS.XAPI.INVALID_PATH - WARNINGS.XAPI.PATH_SHOULD_NOT_CONTAIN_SPACES - WARNINGS.XAPI.INVALID_CREDENTIALS - WARNINGS.XAPI.CANNOT_CONNECT_FTP - WARNINGS.XAPI.CANNOT_CONNECT_SMB - WARNINGS.XAPI.CANNOT_CONNECT_SFTP - WARNINGS.XAPI.CANNOT_CONNECT_GOOGLE_BUCKET - WARNINGS.XAPI.CANNOT_CONNECT_AMAZON_S3_BUCKET - WARNINGS.XAPI.PLAYLIST_NO_SOURCE - WARNINGS.XAPI.NO_USERS_IN_TEAMS - WARNINGS.XAPI.FILE_FORMAT_IS_INCORRECT - WARNINGS.XAPI.INVALID_FILE_NAME - WARNINGS.CSV_INVALID_FILE_FORMAT - WARNINGS.CSV_LINE_CORRUPTED - WARNINGS.WRONG_CSV_FILE_REQUIRED_COLUMNS_NOT_FOUND - WARNINGS.CSV_IMPORT_LIMIT_REACHED - WARNINGS.WRONG_CSV_FILE_REQUIRED_HEADER_NOT_FOUND - WARNINGS.XAPI.FILE_IS_TOO_LARGE - WARNINGS.XAPI.SBC_CERT_FQDN_MISMATCH - WARNINGS.XAPI.SBC_CERT_EXPIRED - WARNINGS.XAPI.SBC_KEY_CERT_MISMATCH - WARNINGS.XAPI.CERTIFICATE_EXPIRED - WARNINGS.XAPI.NON_EXISTENT_EXT_NUMBER - WARNINGS.XAPI.MCM_MODE_REQUIRED - WARNINGS.INTERNATIONALPREFIX_IS_MISSING - WARNINGS.XAPI.CHAT_LOG_IS_DISABLED - WARNINGS.WAKEUP_IVR_EXISTS - WARNINGS.RING_GROUP_ENABLE_PAGING - WARNINGS.XAPI.CREATE_1_SIP_TRUCK_EMERGENCY - WARNINGS.INVALID_IP_MASK - WARNINGS.TOO_MANY_BACKUPS - WARNINGS.BACKUP_LOCATION_CONFIG_ERROR - WARNINGS.BACKUP_NOT_FOUND_OR_INVALID - WARNINGS.INVALID_CALL_FLOW_FILE - WARNINGS.ALREADY_EXPIRED - WARNINGS.EXTRACTING_OUTSIDE_THE_DESTINATION_DIRECTORY - WARNINGS.WIRESHARK_NOT_FOUND - WARNINGS.CANNOT_DELETE_TRUNKS_BINDED_ERMERGENCY_NUMBER - WARNINGS.BLACKLIST_NUMBER_LIMIT_EXCEEDED - WARNINGS.DOUBLE_QUOTES_NOT_ALLOWED - WARNINGS.MCU_REQUEST_ALREADY_IN_PROGRESS - WARNINGS.MCU_LIMIT_REACHED - WARNINGS.MCU_WEBMEETING_BRIDGE_NOT_FOUND - WARNINGS.MCU_REQUEST_NOT_FOUND - WARNINGS.MCU_REQUEST_TIMEOUT - WARNINGS.CONVERTER_REQUEST_ALREADY_IN_PROGRESS - WARNINGS.CONVERTER_LIMIT_REACHED - WARNINGS.CONVERTER_WEBMEETING_BRIDGE_NOT_FOUND - WARNINGS.CONVERTER_REQUEST_NOT_FOUND - WARNINGS.CONVERTER_REQUEST_TIMEOUT - WARNINGS.XAPI.OPENAI_KEY_IS_MISSING - WARNINGS.LENGTH_NOT_MORE_2048_CHARS - WARNINGS.INVALID_SECURITY_CODE - WARNINGS.SUPPORTED_MEDIA_FORMAT_WAV - WARNINGS.NO_SECRET_DEFINED - WARNINGS.UNABLE_REACH_UPDATES_SERVER - WARNINGS.ERROR_DOWNLOADING_FROM_UPDATES_SERVER - WARNINGS.CAPTURE_LOCALHOST_NOT_ALLOWED - WARNINGS.CAPTURE_ONGOING type: string x-enum-varnames: - ContactsSpecifyNameSurnameCompany - ContactsSpecifyPhoneNumber - ContactsSpecifyNameSurname - StringTooLong - LengthNotMore50Chars - LengthNotMore255Chars - InvalidHexCharacter - NoMoreNumbersAvailable - ErpServerError - LicenseNotFound - LimitReached - Invalid - XapiCaptchaError - XapiInvalidPinNumber - XapiNotSupported - XapiUserRoleDowngrade - GroupCannotBeDeleted - CannotBeDeleted - GroupWithMembersCannotBeDeleted - XapiOtherUserRoleDowngrade - XapiInvalidLicenseType - InvalidPassword - XapiNotFound - XapiFileNotFound - XapiFileNotAccessible - XapiRequired - XapiCanNotBeEmptyString - XapiDuplicate - XapiMacUsedBy - XapiAlreadyInUse - MacAddressAlreadyInUse - XapiPlaylistInUse - XapiOutOfTheRange - XapiTooManyPhones - XapiTooManyTrunks - XapiTooManySbc - XapiTooManyPrompts - XapiTooManyItemsInList - XapiAwsStorageUnderUsage - XapiOutboundRulesLimitReached - XapiForbiddenChange - FaxServerCannotBeDeleted - OperatorCannotBeDeleted - UserExtensionCannotBeDeleted - XapiNumberIgnored - XapiInvalidTimezone - XapiInvalidPath - XapiPathShouldNotContainSpaces - XapiInvalidCredentials - XapiCannotConnectFtp - XapiCannotConnectSmb - XapiCannotConnectSftp - XapiCannotConnectGoogleBucket - XapiCannotConnectAmazonS3Bucket - XapiPlaylistNoSource - XapiNoUsersInTeams - XapiFileFormatIsIncorrect - XapiInvalidFileName - CsvInvalidFileFormat - CsvLineCorrupted - WrongCsvFileRequiredColumnsNotFound - CsvImportLimitReached - WrongCsvFileRequiredHeaderNotFound - XapiFileIsTooLarge - XapiSbcCertFqdnMismatch - XapiSbcCertExpired - XapiSbcKeyCertMismatch - XapiCertificateExpired - XapiNonExistentExtNumber - XapiMcmModeRequired - InternationalprefixIsMissing - XapiChatLogIsDisabled - WakeupIvrExists - RingGroupEnablePaging - XapiCreate1SipTruckEmergency - InvalidIpMask - TooManyBackups - BackupLocationConfigError - BackupNotFoundOrInvalid - InvalidCallFlowFile - AlreadyExpired - ExtractingOutsideTheDestinationDirectory - WiresharkNotFound - CannotDeleteTrunksBindedErmergencyNumber - BlacklistNumberLimitExceeded - DoubleQuotesNotAllowed - McuRequestAlreadyInProgress - McuLimitReached - McuWebmeetingBridgeNotFound - McuRequestNotFound - McuRequestTimeout - ConverterRequestAlreadyInProgress - ConverterLimitReached - ConverterWebmeetingBridgeNotFound - ConverterRequestNotFound - ConverterRequestTimeout - XapiOpenaiKeyIsMissing - LengthNotMore2048Chars - InvalidSecurityCode - SupportedMediaFormatWav - NoSecretDefined - UnableReachUpdatesServer - ErrorDownloadingFromUpdatesServer - CaptureLocalhostNotAllowed - CaptureOngoing responses: error: description: error content: application/json: schema: $ref: '#/components/schemas/Pbx.ODataErrors.ODataError' ODataCountResponse: description: The count of the resource content: text/plain: schema: $ref: '#/components/schemas/ODataCountResponse' Pbx.CallFlowScriptCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.CallFlowScriptCollectionResponse' Pbx.ReceptionistCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.ReceptionistCollectionResponse' Pbx.BlackListNumberCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.BlackListNumberCollectionResponse' Pbx.BlocklistAddrCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.BlocklistAddrCollectionResponse' Pbx.RingGroupCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.RingGroupCollectionResponse' Pbx.ContactCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.ContactCollectionResponse' Pbx.QueueCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.QueueCollectionResponse' Pbx.UserCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.UserCollectionResponse' Pbx.PhoneTemplateCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.PhoneTemplateCollectionResponse' Pbx.TrunkTemplateCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.TrunkTemplateCollectionResponse' Pbx.RecordingCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.RecordingCollectionResponse' Pbx.GroupCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.GroupCollectionResponse' Pbx.OutboundRuleCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.OutboundRuleCollectionResponse' Pbx.ParameterCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.ParameterCollectionResponse' Pbx.DNPropertyCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.DNPropertyCollectionResponse' Pbx.PeerCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.PeerCollectionResponse' Pbx.TrunkCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.TrunkCollectionResponse' Pbx.InboundRuleCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.InboundRuleCollectionResponse' Pbx.CountryCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.CountryCollectionResponse' Pbx.FxsCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.FxsCollectionResponse' Pbx.PromptSetCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.PromptSetCollectionResponse' Pbx.CustomPromptCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.CustomPromptCollectionResponse' Pbx.PropertyCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.PropertyCollectionResponse' Pbx.FxsTemplateCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.FxsTemplateCollectionResponse' Pbx.WeblinkCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.WeblinkCollectionResponse' Pbx.ParkingCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.ParkingCollectionResponse' Pbx.BackupsCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.BackupsCollectionResponse' Pbx.SbcCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.SbcCollectionResponse' Pbx.RegistrarFxsCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.RegistrarFxsCollectionResponse' Pbx.CallFlowAppCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.CallFlowAppCollectionResponse' Pbx.ServicePrincipalCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.ServicePrincipalCollectionResponse' Pbx.CrmTemplateCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.CrmTemplateCollectionResponse' Pbx.CallCostSettingsCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.CallCostSettingsCollectionResponse' Pbx.PhoneLogoCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.PhoneLogoCollectionResponse' Pbx.ActiveCallCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.ActiveCallCollectionResponse' Pbx.EventLogCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.EventLogCollectionResponse' Pbx.ServiceInfoCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.ServiceInfoCollectionResponse' Pbx.EmailTemplateCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.EmailTemplateCollectionResponse' Pbx.FirmwareCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.FirmwareCollectionResponse' Pbx.PlaylistCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.PlaylistCollectionResponse' Pbx.FaxCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.FaxCollectionResponse' Pbx.DidNumberCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.DidNumberCollectionResponse' Pbx.ActivityLogEventCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.ActivityLogEventCollectionResponse' Pbx.RefreshTokenCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.RefreshTokenCollectionResponse' Pbx.HolidayCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.HolidayCollectionResponse' Pbx.EmergencyGeoLocationCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.EmergencyGeoLocationCollectionResponse' Pbx.CallHistoryViewCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.CallHistoryViewCollectionResponse' Pbx.ChatHistoryViewCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.ChatHistoryViewCollectionResponse' Pbx.ChatMessagesHistoryViewCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.ChatMessagesHistoryViewCollectionResponse' Pbx.LastCdrAndChatMessageTimestampCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.LastCdrAndChatMessageTimestampCollectionResponse' Pbx.RingGroupStatisticsCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.RingGroupStatisticsCollectionResponse' Pbx.ExtensionsStatisticsByRingGroupsCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.ExtensionsStatisticsByRingGroupsCollectionResponse' Pbx.CallLogDataCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.CallLogDataCollectionResponse' Pbx.ExtensionStatisticsCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.ExtensionStatisticsCollectionResponse' Pbx.ReportExtensionStatisticsByGroupCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.ReportExtensionStatisticsByGroupCollectionResponse' Pbx.CallCostByExtensionGroupCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.CallCostByExtensionGroupCollectionResponse' Pbx.QueuePerformanceOverviewCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.QueuePerformanceOverviewCollectionResponse' Pbx.QueuePerformanceTotalsCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.QueuePerformanceTotalsCollectionResponse' Pbx.TeamQueueGeneralStatisticsCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.TeamQueueGeneralStatisticsCollectionResponse' Pbx.DetailedQueueStatisticsCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.DetailedQueueStatisticsCollectionResponse' Pbx.AbandonedQueueCallsCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.AbandonedQueueCallsCollectionResponse' Pbx.QueueAnsweredCallsByWaitTimeCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.QueueAnsweredCallsByWaitTimeCollectionResponse' Pbx.QueueCallbacksCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.QueueCallbacksCollectionResponse' Pbx.AgentsInQueueStatisticsCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.AgentsInQueueStatisticsCollectionResponse' Pbx.QueueFailedCallbacksCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.QueueFailedCallbacksCollectionResponse' Pbx.StatisticSlaCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.StatisticSlaCollectionResponse' Pbx.BreachesSlaCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.BreachesSlaCollectionResponse' Pbx.QueueChatPerformanceCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.QueueChatPerformanceCollectionResponse' Pbx.QueueAgentsChatStatisticsCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.QueueAgentsChatStatisticsCollectionResponse' Pbx.QueueAgentsChatStatisticsTotalsCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.QueueAgentsChatStatisticsTotalsCollectionResponse' Pbx.AbandonedChatsStatisticsCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.AbandonedChatsStatisticsCollectionResponse' Pbx.AgentLoginHistoryCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.AgentLoginHistoryCollectionResponse' Pbx.UserActivityCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.UserActivityCollectionResponse' Pbx.CallDistributionCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.CallDistributionCollectionResponse' Pbx.OutboundCallCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.OutboundCallCollectionResponse' Pbx.InboundCallCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.InboundCallCollectionResponse' Pbx.AuditLogCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.AuditLogCollectionResponse' Pbx.InboundRuleReportCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.InboundRuleReportCollectionResponse' Pbx.TimeReportDataCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.TimeReportDataCollectionResponse' Pbx.ScheduledReportCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.ScheduledReportCollectionResponse' Pbx.DeviceInfoCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.DeviceInfoCollectionResponse' Pbx.SipDeviceCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.SipDeviceCollectionResponse' Pbx.NetworkInterfaceCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.NetworkInterfaceCollectionResponse' Pbx.UserGroupCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.UserGroupCollectionResponse' Pbx.ReceptionistForwardCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.ReceptionistForwardCollectionResponse' Pbx.RingGroupMemberCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.RingGroupMemberCollectionResponse' Pbx.QueueAgentCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.QueueAgentCollectionResponse' Pbx.QueueManagerCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.QueueManagerCollectionResponse' Pbx.GreetingCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.GreetingCollectionResponse' Pbx.ForwardingProfileCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.ForwardingProfileCollectionResponse' Pbx.ExtensionRuleCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.ExtensionRuleCollectionResponse' Pbx.PhoneCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.PhoneCollectionResponse' Pbx.RightsCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.RightsCollectionResponse' Pbx.PeerGroupCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.PeerGroupCollectionResponse' Pbx.EmergencyGeoTrunkLocationCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.EmergencyGeoTrunkLocationCollectionResponse' Pbx.PromptCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.PromptCollectionResponse' Pbx.CrmSelectableValueCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.CrmSelectableValueCollectionResponse' Pbx.CodecCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.CodecCollectionResponse' Pbx.GatewayParameterCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.GatewayParameterCollectionResponse' Pbx.TimeZoneCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.TimeZoneCollectionResponse' Pbx.GatewayParameterValueCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.GatewayParameterValueCollectionResponse' Pbx.PhoneModelCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.PhoneModelCollectionResponse' Pbx.OutboundRouteCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.OutboundRouteCollectionResponse' Pbx.DNRangeCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.DNRangeCollectionResponse' Pbx.CIDFormattingCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.CIDFormattingCollectionResponse' Pbx.VariableCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.VariableCollectionResponse' Pbx.TrunkReportCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.TrunkReportCollectionResponse' Pbx.LogEntryCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.LogEntryCollectionResponse' Pbx.SetRouteCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.SetRouteCollectionResponse' Pbx.ProviderPhoneCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.ProviderPhoneCollectionResponse' Pbx.DeviceLineCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.DeviceLineCollectionResponse' Pbx.FxsModelCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.FxsModelCollectionResponse' Pbx.FxsVariableCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.FxsVariableCollectionResponse' Pbx.UpdateItemCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.UpdateItemCollectionResponse' Pbx.CategoryUpdateCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.CategoryUpdateCollectionResponse' Pbx.CrmParameterCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.CrmParameterCollectionResponse' Pbx.CDRSettingsFieldCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.CDRSettingsFieldCollectionResponse' Pbx.ExternalAccountCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.ExternalAccountCollectionResponse' Pbx.ExternalGroupCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.ExternalGroupCollectionResponse' Pbx.OnBoardConverterSessionCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.OnBoardConverterSessionCollectionResponse' Pbx.KeyValuePair_2OfString_OnBoardConnectedParticipantCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.KeyValuePair_2OfString_OnBoardConnectedParticipantCollectionResponse' Pbx.SetpointCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.SetpointCollectionResponse' Pbx.AIModelCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.AIModelCollectionResponse' Pbx.AIAgentTemplateCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.AIAgentTemplateCollectionResponse' Pbx.AIVoiceCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.AIVoiceCollectionResponse' Pbx.VectorStoreCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.VectorStoreCollectionResponse' Pbx.VectorStoreFileCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.VectorStoreFileCollectionResponse' Pbx.CrmChoiceCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.CrmChoiceCollectionResponse' Pbx.CrmContactCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.CrmContactCollectionResponse' Pbx.ExtensionFilterCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.ExtensionFilterCollectionResponse' Pbx.GatewayParameterBindingCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.GatewayParameterBindingCollectionResponse' Pbx.ChoiceCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.ChoiceCollectionResponse' Pbx.PhoneDeviceVlanInfoCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.PhoneDeviceVlanInfoCollectionResponse' Pbx.CustomQueueRingtoneCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.CustomQueueRingtoneCollectionResponse' Pbx.EmailVariableCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.EmailVariableCollectionResponse' Pbx.PeriodCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.PeriodCollectionResponse' Pbx.AgentRoutingDirectoryCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.AgentRoutingDirectoryCollectionResponse' Pbx.TrunkVariableCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.TrunkVariableCollectionResponse' Pbx.FxsVariableChoiceCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.FxsVariableChoiceCollectionResponse' Pbx.PbxToM365BindingCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.PbxToM365BindingCollectionResponse' Pbx.M365ToPbxBindingCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.M365ToPbxBindingCollectionResponse' Pbx.ParticipantDetailsCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/Pbx.ParticipantDetailsCollectionResponse' StringCollectionResponse: description: Retrieved collection content: application/json: schema: $ref: '#/components/schemas/StringCollectionResponse' GenerateProvLinkResponse: description: Success content: application/json: schema: type: object properties: value: type: string GetPhoneSecretResponse: description: Success content: application/json: schema: type: object properties: value: type: string HasDuplicatedEmailResponse: description: Success content: application/json: schema: type: object properties: value: type: boolean default: false GetRestrictionsResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.Restrictions' GetMyGroupPartnerInfoResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/Pbx.ResellerInfo' parameters: top: name: $top in: query description: Show only the first n items explode: false schema: minimum: 0 type: integer format: int64 example: 50 skip: name: $skip in: query description: Skip the first n items explode: false schema: minimum: 0 type: integer format: int64 count: name: $count in: query description: Include count of items explode: false schema: type: boolean filter: name: $filter in: query description: Filter items by property values explode: false schema: type: string search: name: $search in: query description: Search items by search phrases explode: false schema: type: string examples: Pbx.CallFlowScript: value: Id: string (identifier) Help: string Versions: - string Description: string Pbx.DN: value: Number: string TranscriptionMode: Nothing Id: 0 Groups: - '@odata.type': Pbx.UserGroup Pbx.Receptionist: value: Number: string TranscriptionMode: Nothing Id: 0 Groups: - '@odata.type': Pbx.UserGroup ForwardSmsTo: string Name: string IsRegistered: true IVRType: Default Timeout: 0 TimeoutForwardDN: string TimeoutForwardPeerType: None TimeoutForwardType: EndCall InvalidKeyForwardDN: string PromptFilename: string PromptSet: string UseMSExchange: true OutOfOfficeRoute: '@odata.type': Pbx.Route BreakRoute: '@odata.type': Pbx.Route HolidaysRoute: '@odata.type': Pbx.Route TransferEnable: true Forwards: - '@odata.type': Pbx.ReceptionistForward Pbx.FirstAvailableNumber: value: Number: string Pbx.BlackListNumber: value: Id: string (identifier) CallerId: string Description: string Pbx.BlocklistAddr: value: BlockType: Block Description: string ExpiresAt: '0001-01-01T00:00:00.0000000+00:00' IPAddrMask: string AddedBy: Manual Id: 0 Pbx.ClickToCall: value: Number: string TranscriptionMode: Nothing Id: 0 Groups: - '@odata.type': Pbx.UserGroup CallUsRequirement: Both CallUsEnablePhone: true CallUsEnableChat: true CallUsEnableVideo: true ClickToCallId: string Pbx.RingGroup: value: Number: string TranscriptionMode: Nothing Id: 0 Groups: - '@odata.type': Pbx.UserGroup CallUsRequirement: Both CallUsEnablePhone: true CallUsEnableChat: true CallUsEnableVideo: true ClickToCallId: string Name: string IsRegistered: true RingStrategy: Hunt RingTime: 0 ForwardNoAnswer: '@odata.type': Pbx.Destination MulticastAddress: string MulticastPort: 0 MulticastCodec: string MulticastPacketTime: 0 OutOfOfficeRoute: '@odata.type': Pbx.Route BreakRoute: '@odata.type': Pbx.Route HolidaysRoute: '@odata.type': Pbx.Route GreetingFile: string VMEmailOptions: None VMEmailList: string Members: - '@odata.type': Pbx.RingGroupMember Pbx.Contact: value: FirstName: string LastName: string PhoneNumber: string CompanyName: string Tag: string Mobile2: string Email: string Home: string Business: string Other: string Business2: string Title: string BusinessFax: string Department: string Pager: string ContactType: 3CX Id: 0 Pbx.ContactsDirSearchSettings: value: ExchangeServerUrl: string ExchangeUser: string ExchangePassword: '@odata.type': Pbx.ConcealedPassword ExchangeCalendarProfileSwitching: true ExchangeEmailAddresses: - string ExchangeFolders: - string Pbx.Queue: value: Number: string TranscriptionMode: Nothing Id: 0 Groups: - '@odata.type': Pbx.UserGroup CallUsRequirement: Both CallUsEnablePhone: true CallUsEnableChat: true CallUsEnableVideo: true ClickToCallId: string Name: string IsRegistered: true PollingStrategy: Hunt RingTimeout: 0 MasterTimeout: 0 SLATime: 0 AnnounceQueuePosition: true AnnouncementInterval: 0 WrapUpTime: 0 MaxCallersInQueue: 0 PriorityQueue: true EnableIntro: true IntroFile: string OnHoldFile: string GreetingFile: string PlayFullPrompt: true ForwardNoAnswer: '@odata.type': Pbx.Destination PromptSet: string TypeOfChatOwnershipType: TakeManually Recording: Disabled CallbackEnableTime: 0 CallbackPrefix: string NotifyCodes: - Callback ResetStatisticsScheduleEnabled: true ResetQueueStatisticsSchedule: '@odata.type': Pbx.ResetQueueStatisticsSchedule AgentAvailabilityMode: true OutOfOfficeRoute: '@odata.type': Pbx.Route BreakRoute: '@odata.type': Pbx.Route HolidaysRoute: '@odata.type': Pbx.Route VMEmailOptions: None VMEmailList: string Agents: - '@odata.type': Pbx.QueueAgent Managers: - '@odata.type': Pbx.QueueManager Pbx.User: value: Number: string TranscriptionMode: Nothing Id: 0 Groups: - '@odata.type': Pbx.UserGroup CallUsRequirement: Both CallUsEnablePhone: true CallUsEnableChat: true CallUsEnableVideo: true ClickToCallId: string AIAgent: true Enable2FA: true Require2FA: true MyPhoneShowRecordings: true MyPhoneAllowDeleteRecordings: true MyPhoneHideForwardings: true MyPhonePush: true RecordCalls: true AllowOwnRecordings: true RecordExternalCallsOnly: true RecordEmailNotify: true PrimaryGroupId: 0 FirstName: string LastName: string DisplayName: string EmailAddress: string Mobile: string WebMeetingFriendlyName: string WebMeetingApproveParticipants: true SendEmailMissedCalls: true VMEnabled: true VMEmailOptions: None VMPIN: string VMDisablePinAuth: true VMPlayCallerID: true VMPlayMsgDateTime: None ContactImage: string IsRegistered: true CurrentProfileName: string QueueStatus: LoggedOut AuthID: string DeskphonePassword: string AuthPassword: string AccessPassword: string OutboundCallerID: string Blfs: string OfficeHoursProps: - GlobalSchedule Hours: '@odata.type': Pbx.Schedule BreakTime: '@odata.type': Pbx.Schedule Language: string Internal: true Enabled: true PromptSet: string HideInPhonebook: true Tags: - MS PinProtected: true PinProtectTimeout: 0 CallScreening: true AllowLanOnly: true BlockTunnel: true SIPID: string MS365SignInEnabled: true MS365ContactsEnabled: true MS365CalendarEnabled: true MS365TeamsEnabled: true GoogleSignInEnabled: true GoogleContactsEnabled: true GoogleCalendarEnabled: true EnableHotdesking: true HotdeskingAssignment: string SRTPMode: SRTPDisabled PbxDeliversAudio: true EmergencyLocationId: string EmergencyAdditionalInfo: string DatevEnabled: true AgentSettings: '@odata.type': Pbx.AgentSettings Greetings: - '@odata.type': Pbx.Greeting ForwardingProfiles: - '@odata.type': Pbx.ForwardingProfile ForwardingExceptions: - '@odata.type': Pbx.ExtensionRule Phones: - '@odata.type': Pbx.Phone Pbx.CallControlResultResponse: value: FinalStatus: string Reason: string ReasonText: string VttId: string Result: '@odata.type': Pbx.CallParticipant Pbx.RegenerateOptions: value: RpsKey: true SipAuth: true WebclientPassword: true VoicemailPIN: true DeskphonePassword: true SendWelcomeEmail: true ConfigurationLink: true Pbx.PhoneRegistrar: value: Capabilities: 0 Vendor: string Model: string MAC: string UserAgent: string IpAddress: string InterfaceLink: string FirmwareVersion: string FirmwareAvailable: string Pbx.UserDeleteError: value: ExtensionNumber: string Error: string Pbx.IActionResult: value: { } Pbx.MultiEditUserData: value: DisplayNumbers: string Number: string MyPhoneShowRecordings: true MyPhoneAllowDeleteRecordings: true MyPhoneHideForwardings: true RecordCalls: true AllowOwnRecordings: true RecordExternalCallsOnly: true RecordEmailNotify: true Mobile: string SendEmailMissedCalls: true VMEnabled: true VMEmailOptions: None VMDisablePinAuth: true VMPlayCallerID: true VMPlayMsgDateTime: None CanMoveForwardingExceptions: true BossSecretaryRequiresFullEdit: true Blfs: string Internal: true Enabled: true PromptSet: string HideInPhonebook: true PinProtected: true PinProtectTimeout: 0 CallScreening: true AllowLanOnly: true MS365SignInEnabled: true MS365ContactsEnabled: true MS365CalendarEnabled: true MS365TeamsEnabled: true GoogleSignInEnabled: true GoogleContactsEnabled: true GoogleCalendarEnabled: true EnableHotdesking: true SRTPMode: SRTPDisabled PbxDeliversAudio: true EmergencyLocationId: string EmergencyAdditionalInfo: string TranscriptionMode: Nothing DatevEnabled: true Greetings: - '@odata.type': Pbx.Greeting ForwardingProfiles: - '@odata.type': Pbx.ForwardingProfile ForwardingExceptions: - '@odata.type': Pbx.ExtensionRule Groups: - '@odata.type': Pbx.UserGroup Pbx.GreetingFile: value: Filename: string DisplayName: string Pbx.InstallFirmware: value: Model: string UserAgent: string Pbx.PhoneTemplate: value: Codecs: - string URL: string Models: - '@odata.type': Pbx.PhoneModel XferTypeEnabled: true DateFormats: - string RingTones: - string DefaultQueueRingTone: string QueueRingTones: - string TimeFormats: - string TimeZones: - string Languages: - string AllowedNetConfigs: - string AllowSSLProvisioning: true AddAllowed: true IsCustom: true TemplateType: Preferred RpsEnabled: true HotdeskingAllowed: true PowerLedSettings: - string BacklightTimeouts: - string ScreenSaverTimeouts: - string MaxQueueCustomRingtones: 0 Id: string (identifier) Content: string Pbx.TrunkTemplate: value: Name: string Tags: - string AddAllowed: true TemplateType: Preferred Countries: - string Editors: - Messaging Description: string Url: string MessagingTemplate: '@odata.type': Pbx.TrunkMessagingTemplate DefaultRegistrarPort: 0 DefaultProxyPort: 0 Id: string (identifier) Content: string Pbx.Recording: value: CanBeTranscribed: true Id: 0 RefParticipantId: 0 RecordingUrl: string StartTime: '0001-01-01T00:00:00.0000000+00:00' EndTime: '0001-01-01T00:00:00.0000000+00:00' Transcription: string IsTranscribed: true TranscriptionResult: 0 IsArchived: true ArchivedUrl: string CallType: Local FromIdParticipant: 0 FromDnType: 0 FromDn: string FromCallerNumber: string FromDisplayName: string FromDidNumber: string FromCrmContact: string ToIdParticipant: 0 ToDnType: 0 ToDn: string ToCallerNumber: string ToDisplayName: string ToDidNumber: string ToCrmContact: string Summary: string SentimentScore: 0 Pbx.RecordingRepositorySettings: value: RecordingsQuota: 0 AutoDeleteRecordingEnabled: true AutoDeleteRecordingDays: 0 RecordingPath: string RecordingUsedSpace: 0 RecordingDiskSpace: 0 IsRecordingArchiveEnabled: true Pbx.SystemDirectory: value: Path: string Dirs: - string Pbx.DirectoryParameters: value: Path: string Filesystem: Local Json: string Pbx.Group: value: Number: string TranscriptionMode: Nothing Id: 0 Groups: - '@odata.type': Pbx.UserGroup CallUsRequirement: Both CallUsEnablePhone: true CallUsEnableChat: true CallUsEnableVideo: true ClickToCallId: string Name: string IsDefault: true HasMembers: true Hours: '@odata.type': Pbx.Schedule BreakTime: '@odata.type': Pbx.Schedule AnswerAfter: 0 AllowCallService: true CallHandlingMode: - WelcomeMessageForIncomingCalls CustomOperator: '@odata.type': Pbx.Destination LastLoginTime: '0001-01-01T00:00:00.0000000+00:00' CurrentGroupHours: Default PromptSet: string CustomPrompt: string TimeZoneId: string OverrideExpiresAt: '0001-01-01T00:00:00.0000000+00:00' OverrideHolidays: true Props: '@odata.type': Pbx.GroupProps DisableCustomPrompt: true GloballyVisible: true Language: string OfficeRoute: '@odata.type': Pbx.Route OutOfOfficeRoute: '@odata.type': Pbx.Route BreakRoute: '@odata.type': Pbx.Route HolidaysRoute: '@odata.type': Pbx.Route Members: - '@odata.type': Pbx.UserGroup Rights: - '@odata.type': Pbx.Rights OfficeHolidays: - '@odata.type': Pbx.Holiday Pbx.Restrictions: value: MaxPrompts: 0 Sbcs: '@odata.type': Pbx.EntityRestrictions LiveChats: '@odata.type': Pbx.EntityRestrictions Users: '@odata.type': Pbx.EntityRestrictions System: '@odata.type': Pbx.EntityRestrictions Trunks: '@odata.type': Pbx.EntityRestrictions Dects: '@odata.type': Pbx.EntityRestrictions Pbx.OutboundRule: value: Name: string Prefix: string Priority: 0 NumberLengthRanges: string GroupIds: - 0 Routes: - '@odata.type': Pbx.OutboundRoute DNRanges: - '@odata.type': Pbx.DNRange EmergencyRule: true GroupNames: - string Id: 0 Pbx.XOutboundRulePurge: value: Ids: - 0 Pbx.Parameter: value: Name: string Description: string Value: string Id: 0 Pbx.DNProperty: value: Name: string (identifier) Description: string Value: string Id: 0 Pbx.Peer: value: Type: None Hidden: true Name: string Number: string Tags: - MS Id: 0 MemberOf: - '@odata.type': Pbx.PeerGroup Pbx.RetreivePeersRequest: value: DnNumbers: - string IsReportPeers: true Pbx.Trunk: value: Number: string TranscriptionMode: Nothing Id: 0 Groups: - '@odata.type': Pbx.UserGroup IsOnline: true AuthID: string AuthPassword: '@odata.type': Pbx.ConcealedPassword Direction: None ExternalNumber: string OutboundCallerID: string SimultaneousCalls: 0 ConfigurationIssue: string Messaging: '@odata.type': Pbx.TrunkMessaging DidNumbers: - string Gateway: '@odata.type': Pbx.Gateway InCIDFormatting: - '@odata.type': Pbx.CIDFormatting OutCIDFormatting: - '@odata.type': Pbx.CIDFormatting UseSeparateAuthId: true SeparateAuthId: string SecondaryRegistrar: string PublicIPinSIP: string E164ProcessIncomingNumber: true DiversionHeader: true E164CountryCode: string EnableInboundCalls: true EnableOutboundCalls: true IPRestriction: Any TransportRestriction: Any PublishInfo: true PublicInfoGroups: - string RemoteMyPhoneUriHost: string ReceiveInfo: true RemotePBXPreffix: string TunnelEnabled: true TunnelRemoteAddr: string TunnelRemotePort: 0 Tags: - MS DisableVideo: true CertificateName: string CertificateExpirationDate: string Certificate: string TrunkRegTimes: - '@odata.type': Pbx.Variable AutoHolidayMode: Disabled RoutingRules: - '@odata.type': Pbx.InboundRule ReceiveExtensions: - '@odata.type': Pbx.Peer EmergencyGeoLocations: - '@odata.type': Pbx.EmergencyGeoTrunkLocation Pbx.TrunkReport: value: Level: Critical Code: TrunkIsDisabled Template: string Params: - string Pbx.TrunkTestResult: value: Reports: - '@odata.type': Pbx.TrunkReport Log: - '@odata.type': Pbx.LogEntry Pbx.SetRouteRequest: value: Id: 0 Routes: - '@odata.type': Pbx.SetRoute Pbx.GetProviderPhones: value: Type: Voxtelesys ApiKey: string AccountSid: string NextPageToken: string PhonesPageSize: 0 Pbx.ProviderPhones: value: Phones: - '@odata.type': Pbx.ProviderPhone NextPageToken: string Pbx.CreateTrunk: value: Type: Voxtelesys Name: string PhoneNumbers: - '@odata.type': Pbx.ProviderPhone ApiKey: string AccountSid: string DefaultRule: '@odata.type': Pbx.InboundRule Groups: - '@odata.type': Pbx.UserGroup Pbx.InboundRule: value: CustomData: string Data: string RuleName: string CallType: AllCalls Hours: '@odata.type': Pbx.Schedule Condition: NoAnswer AlterDestinationDuringOutOfOfficeHours: true AlterDestinationDuringHolidays: true OfficeHoursDestination: '@odata.type': Pbx.Destination OutOfOfficeHoursDestination: '@odata.type': Pbx.Destination HolidaysDestination: '@odata.type': Pbx.Destination Id: 0 TrunkDN: '@odata.type': Pbx.Peer Pbx.Country: value: Name: string (identifier) Continent: string VoicemailNo: string ExitCode: string CountryCode: string CountryCodes: - string DownloadUrl: string StunServer: string ErpCode: string ParentErpCode: string WebMeetingZone: string Pbx.Fxs: value: MacAddress: string (identifier) Provisioning: '@odata.type': Pbx.FxsProvisioning FxsLines: - '@odata.type': Pbx.DeviceLine Variables: - '@odata.type': Pbx.Variable Group: string Brand: string Name: string Model: string ModelName: string Language: string Password: string Secret: string Codecs: - string TimeZone: string FxsLineCount: 0 Template: '@odata.type': Pbx.FxsTemplate Registered: '@odata.type': Pbx.RegistrarFxs Pbx.LicenseStatus: value: LicenseKey: string (identifier) ProductCode: string ExpirationDate: '0001-01-01T00:00:00.0000000+00:00' MaintenanceExpiresAt: '0001-01-01T00:00:00.0000000+00:00' Activated: true Version: string LicenseActive: true Support: true ResellerName: string MaxSimCalls: 0 AdminEMail: string EMail: string ContactName: string CompanyName: string ActiveModules: - string CountryName: string CountryCode: string SimMeetingParticipants: 0 Telephone: string Pbx.ResellerInfo: value: Id: string Name: string Pbx.XLicenseParams: value: Email: string CompanyName: string ContactName: string Country: string Phone: string Pbx.PromptSet: value: CultureCode: string Description: string Folder: string LanguageCode: string PromptSetName: string PromptSetType: System UseAlternateNumberPronunciation: true Version: string Id: 0 Prompts: - '@odata.type': Pbx.Prompt Pbx.CustomPrompt: value: Filename: string (identifier) PromptType: File FileLink: string DisplayName: string CanBeDeleted: true Pbx.Property: value: Name: string (identifier) Description: string Value: string Pbx.FxsTemplate: value: DeviceType: Fxs IsCustom: true TemplateType: Preferred AllowedNetConfigs: - string AllowSSLProvisioning: true URL: string NumberOfExtensions: 0 Brand: string Models: - '@odata.type': Pbx.FxsModel TimeZones: - string Languages: - string Variables: - '@odata.type': Pbx.FxsVariable RpsEnabled: true Id: string (identifier) Content: string Pbx.Weblink: value: Id: 0 Group: string Website: - string Name: string Link: string (identifier) EnableReCaptcha: true ChatEnabled: true CallsEnabled: true DefaultRecord: true Translations: '@odata.type': Pbx.WebsiteLinksTranslations Styling: '@odata.type': Pbx.LiveChatStyling General: '@odata.type': Pbx.GeneralLiveChatSettings Advanced: '@odata.type': Pbx.LiveChatAdvancedSettings Hidden: true ChatBox: '@odata.type': Pbx.LiveChatBox MeetingEnabled: true DN: '@odata.type': Pbx.Peer Pbx.ChatLinkNameValidation: value: Pair: string FriendlyName: string Pbx.UpdateSettings: value: AutoUpdateEnabled: true Schedule: '@odata.type': Pbx.BackupSchedule Pbx.UpdateList: value: IsMaintananceExpired: true Key: 00000000-0000-0000-0000-000000000000 Entries: - '@odata.type': Pbx.UpdateItem LastSuccessfulUpdate: '0001-01-01T00:00:00.0000000+00:00' Pbx.InstallUpdates: value: Key: 00000000-0000-0000-0000-000000000000 Entries: - 00000000-0000-0000-0000-000000000000 Pbx.UpdatesStats: value: TcxUpdate: - '@odata.type': Pbx.CategoryUpdate PerPage: - '@odata.type': Pbx.CategoryUpdate Pbx.Parking: value: Number: string TranscriptionMode: Nothing Id: 0 Groups: - '@odata.type': Pbx.UserGroup Pbx.Backups: value: FileName: string (identifier) DownloadLink: string CreationTime: '0001-01-01T00:00:00.0000000+00:00' Size: 0 Pbx.CreateBackup: value: Name: string Contents: '@odata.type': Pbx.BackupContents Pbx.BackupExtras: value: IsEncrypted: true Footprint: 0 Version: string Pbx.BackupSettings: value: ScheduleEnabled: true Schedule: '@odata.type': Pbx.BackupSchedule Contents: '@odata.type': Pbx.BackupContents Rotation: 0 Pbx.BackupRepositorySettings: value: Location: '@odata.type': Pbx.LocationSettings Pbx.BackupFailoverSettings: value: Enabled: true Mode: Active RemoteServer: string TestSIPServer: true TestWebServer: true TestTunnel: true Interval: 0 Condition: AllService PreStartScript: string PostStartScript: string Pbx.FailoverScriptFile: value: Filename: string Pbx.RestoreSettings: value: ScheduleEnabled: true Schedule: '@odata.type': Pbx.BackupSchedule EncryptBackup: true EncryptBackupPassword: '@odata.type': Pbx.ConcealedPassword Pbx.Sbc: value: Name: string (identifier) DisplayName: string Password: string Group: string LogLevel: None LogSize: 0 AudioPort: 0 Security: TCP PassiveServerIsEnabled: true PassiveServer: string Connection: '@odata.type': Pbx.XSBCConnection HasConnection: true LocalIPv4: string PublicIP: string ProvisionLink: string PhoneMAC: string PhoneUserId: 0 Version: string Pbx.RegistrarFxs: value: MacAddress: string (identifier) InterfaceLink: string Pbx.CallFlowApp: value: Number: string TranscriptionMode: Nothing Id: 0 Groups: - '@odata.type': Pbx.UserGroup CompilationSucceeded: true InvalidScript: true CompilationResult: string CompilationLastSuccess: '0001-01-01T00:00:00.0000000+00:00' Name: string IsRegistered: true ScriptCode: string RejectedCode: string RoutingType: DialCode Trunk: '@odata.type': Pbx.Trunk Pbx.ServicePrincipal: value: Number: string TranscriptionMode: Nothing Id: 0 Groups: - '@odata.type': Pbx.UserGroup IsSystem: true XAPIEnabled: true CallControlEnabled: true MyPhoneEnabled: true LastUsed: '0001-01-01T00:00:00.0000000+00:00' Peers: - '@odata.type': Pbx.Peer Pbx.CrmTemplate: value: Name: string (identifier) Parameters: - '@odata.type': Pbx.CrmParameter Authentication: '@odata.type': Pbx.CrmAuthentication Pbx.NetworkSettings: value: Id: string (identifier) PublicInterface: string IpV6BindingEnabled: true StunDisabled: true PublicStaticIP: string StunPrimaryHost: string StunPrimaryPort: 0 StunSecondaryHost: string StunSecondaryPort: 0 StunThirdHost: string StunThirdPort: 0 StunQuery: 0 PbxPublicFQDN: string DirectSIPAllowExternal: true DirectSIPLocalDomain: string SipPort: 0 TunnelPort: 0 AllowSourceAsOutbound: true FirewallKeepAlive: true FirewallKeepAliveInterval: 0 Pbx.CDRSettings: value: Enabled: true LogType: SingleFileForAllCalls LogSize: 0 SocketIpAddress: string SocketPort: 0 RemoveCommaDelimiters: true EnabledFields: - '@odata.type': Pbx.CDRSettingsField PossibleFields: - string Pbx.CallCostSettings: value: Id: 0 CountryName: string Prefix: string Rate: 0 ReadOnly: true Invalid: true Pbx.PhoneLogo: value: Filename: string (identifier) DisplayName: string Pbx.ActiveCall: value: Id: 0 Caller: string Callee: string Status: string LastChangeStatus: '0001-01-01T00:00:00.0000000+00:00' EstablishedAt: '0001-01-01T00:00:00.0000000+00:00' ServerNow: '0001-01-01T00:00:00.0000000+00:00' Pbx.EventLog: value: Id: 0 Type: Error EventId: 0 Message: string Group: string GroupName: string Params: - string Source: string TimeGenerated: '0001-01-01T00:00:00.0000000+00:00' Pbx.ServiceInfo: value: Name: string (identifier) DisplayName: string Status: Stopped MemoryUsed: 0 SampleTime: '0001-01-01T00:00:00.0000000+00:00' TotalProcessorTime: 0 ThreadCount: 0 HandleCount: 0 StartStopEnabled: true RestartEnabled: true Pbx.GarbageCollect: value: Generation: 0 Mode: Default Blocking: true Compacting: true Pbx.XServiceManageOptions: value: ServiceNames: - string Pbx.FirewallState: value: Id: string (identifier) Running: true Stopping: true Html: string Pbx.Microsoft365Integration: value: Id: 0 ApplicationId: string TenantId: string AdUsers: '@odata.type': Pbx.ADUsersSyncConfiguration SharedMailboxesSync: '@odata.type': Pbx.UsersSyncConfiguration Pbx.ExternalAccount: value: Id: string Name: string Email: string Pbx.ExternalGroup: value: Id: string DisplayName: string Description: string Pbx.Microsoft365SubscriptionTestResult: value: Fqdn: string IsSubscriptionAvailable: true ExceptionMessage: string Pbx.Microsoft365Status: value: ProvisionUrl: string ApplicationId: string ExceptionMessage: string Pbx.ExternalAccountsPage: value: NextPageToken: string Users: - '@odata.type': Pbx.ExternalAccount Pbx.UsersRequestOptions: value: NextPageToken: string Count: 0 TypeOfUser: Users Search: string Pbx.ExternalGroupsPage: value: NextPageToken: string Groups: - '@odata.type': Pbx.ExternalGroup Pbx.GroupsRequestOptions: value: NextPageToken: string Count: 0 Search: string Pbx.Microsoft365TeamsIntegration: value: Id: 0 Enabled: true DialPlanCode: string IsDynamicIP: true IsNativeFQDN: true AreaCode: string TlsPortForNativeFQDN: 0 TlsPortForNonNativeFQDN: 0 SbcFQDN: string SbcCertificate: '@odata.type': Pbx.ConcealedDataFile SbcPrivateKey: '@odata.type': Pbx.ConcealedDataFile SbcCertificateExpirationDate: string SipDomain: string SecureSipEnabled: true Pbx.VoicemailSettings: value: Id: 0 UsedSpace: 0 SendEmailQuotaEnabled: true SendEmailQuotaPercentage: 0 Quota: 0 Extension: string MinDuration: 0 AutoDeleteEnabled: true AutoDeleteDays: 0 TranscribeEngine: None TranscribeModelOpenAI: Default TranscribeRegion: string TranscribeSecretKey: '@odata.type': Pbx.ConcealedPassword TranscribeLanguage: string RemoteStorageEnabled: true OperatorEnabled: true CallRecordingStereo: true Pbx.LanguageItem: value: Code: string Name: string Pbx.OnBoardUICommand: value: Operation: string McuId: string State: string ErrorMessage: string RequestExpiration: '0001-01-01T00:00:00.0000000+00:00' Pbx.OnBoardConverterSession: value: Id: string CallId: string ErrorMessage: string Descr: string Progress: 0 Eta: '0001-01-01T00:00:00.0000000+00:00' Attempts: 0 Pbx.OnBoardConverterDataDetail: value: Host: string Ip: string Port: 0 Enabled: true Version: string Cloud: true Active: true Guid: string Pbx.OnBoardConverterRow: value: Host: string Ip: string Port: 0 Enabled: true Active: true Secret: string Cloud: true Version: string TsCreated: '0001-01-01T00:00:00.0000000+00:00' TsActivated: '0001-01-01T00:00:00.0000000+00:00' ServerStatus: 0 Guid: string ServerOS: Debian10 InstallScript: string Pbx.OnBoardConverterData: value: Converter: '@odata.type': Pbx.OnBoardConverterDataDetail Cpu: 0 MemoryPerc: 0 Ts: '0001-01-01T00:00:00.0000000+00:00' ClockSkew: 0 Delay: 0 DiskSpacePerc: 0 Available: true Instances: 0 Sessions: - '@odata.type': Pbx.OnBoardConverterSession TranscriptionQueue: 0 Pbx.ConferenceSettings: value: Id: 0 Extension: string EnablePin: true PinNumber: string ExternalNumbers: string AutoCallParticipants: true Zone: string MusicOnHold: string LogoPath: string EnableLocalMCU: true DtmfMode: None Pbx.MCURequestStatus: value: McuId: string Operation: Create State: Pending ErrorMessage: string RequestExpiration: '0001-01-01T00:00:00.0000000+00:00' Pbx.OnBoardMcuRow: value: Host: string Ip: string Port: 0 Country: string CountryName: string CityName: string Latitude: 0 Longitude: 0 Enabled: true Active: true BandCap: 0 PartsCap: 0 ManualGeo: true Zone: string Secret: string Cloud: true Version: string TsCreated: '0001-01-01T00:00:00.0000000+00:00' TsActivated: '0001-01-01T00:00:00.0000000+00:00' ServerStatus: 0 Guid: string ServerOS: Debian10 InstallScript: string Pbx.OnBoardMcuData: value: Mcu: '@odata.type': Pbx.OnBoardMcuDataDetail Fqdn: string NetOut: 0 NetIn: 0 Cpu: 0 Memory: 0 Ts: '0001-01-01T00:00:00.0000000+00:00' StartTime: string RestartTime: string AttendeeCount: 0 MeetingCount: 0 UpdateInterval: 0 ClockSkew: 0 Delay: 0 FreeDiskSpace: 0 Attempts: 0 Connected: true Pbx.OnBoardMeeting: value: Sessionid: string Start: '0001-01-01T00:00:00.0000000+00:00' McuFqdn: string Recorded: true Profile: string MeetingId: string Meeting: '@odata.type': Pbx.MeetingObj Parts: - '@odata.type': Pbx.KeyValuePair_2OfString_OnBoardConnectedParticipant Pbx.NotificationSettings: value: CanEditEmailAddresses: true EmailAddresses: string NotifyExtensionAdded: true NotifyCodes: - StorageLimit NotifyUpdatesAvailable: true NotifyServiceStopped: true NotifySuccessScheduledBackups: true NotifySystemOwners: true AutoRestartFailedServices: true Setpoints: - '@odata.type': Pbx.Setpoint Pbx.MailSettings: value: CanEditMailServerType: true MailServerType: Tcx MailSslEnabled: true MailServer: string MailAddress: string MailUser: string MailPassword: '@odata.type': Pbx.ConcealedPassword Pbx.TestResult: value: Success: true Error: string Parameters: - string Pbx.EmailTemplate: value: TemplatePath: string (identifier) From: string Subject: string Body: string Lang: string IsDefault: true Name: string IsConference: true Pbx.HotelServices: value: Enabled: true IpAddress: string Port: 0 NoAnswerTimeout: 0 IntegrationType: tcxpms NoAnswerDestination: '@odata.type': Pbx.Destination HotelGroups: - string Pbx.Firmware: value: Id: string (identifier) Filename: string Vendor: string Model: string Version: string Pbx.FirmwareState: value: Id: string Count: 0 TotalSize: 0 FileNames: - string Pbx.AISettings: value: APIKey: '@odata.type': Pbx.ConcealedPassword RealtimeModel: string CompletionModel: string CompanyName: string CompanyDescription: string Pbx.AIVoice: value: Id: string Gender: string Description: string Pbx.AIAgentTemplate: value: Id: string Name: string Description: string FirstMessage: string Preview: true Pbx.AIModel: value: Id: string Name: string Preview: true Pbx.AIResources: value: Chips: - '@odata.type': Pbx.AIModel Models: - '@odata.type': Pbx.AIModel RealtimeModels: - '@odata.type': Pbx.AIModel Templates: - '@odata.type': Pbx.AIAgentTemplate Voices: - '@odata.type': Pbx.AIVoice Pbx.VectorStore: value: Id: string Name: string Description: string CreatedAt: '0001-01-01T00:00:00.0000000+00:00' Bytes: 0 FilesCompleted: 0 FilesTotal: 0 Status: string Expiration: '@odata.type': Pbx.VectorStoreExpiration Pbx.VectorStores: value: Items: - '@odata.type': Pbx.VectorStore FirstId: string LastId: string HasMore: true Pbx.VectorStoreFiles: value: Items: - '@odata.type': Pbx.VectorStoreFile FirstId: string LastId: string HasMore: true Pbx.VectorStoreFile: value: Id: string Name: string VectorStoreId: string CreatedAt: '0001-01-01T00:00:00.0000000+00:00' Size: 0 Status: string Pbx.AddVectorStoreFiles: value: VectorId: string FileIds: - string Pbx.SystemStatus: value: Id: 0 FQDN: string Version: string Activated: true MaxSimCalls: 0 ExtensionsRegistered: 0 Ip: string IpV4: string IpV6: string LocalIpValid: true CurrentLocalIp: string AvailableLocalIps: string ExtensionsTotal: 0 MaxUserExtensions: 0 UserExtensions: 0 HasUnregisteredSystemExtensions: true HasNotRunningServices: true TrunksRegistered: 0 TrunksTotal: 0 CallsActive: 0 DiskUsage: 0 FreeDiskSpace: 0 TotalDiskSpace: 0 MaintenanceExpiresAt: '0001-01-01T00:00:00.0000000+00:00' Support: true LicenseActive: true ExpirationDate: '0001-01-01T00:00:00.0000000+00:00' OutboundRules: 0 BackupScheduled: true LastBackupDateTime: '0001-01-01T00:00:00.0000000+00:00' ResellerName: string LicenseKey: string ProductCode: string IsAuditLogEnabled: true IsChatLogEnabled: true RecordingUsedSpace: 0 RecordingQuota: 0 RecordingStopped: true VoicemailStopped: true VoicemailQuotaReached: true DBMaintenanceInProgress: true RecordingQuotaReached: true IsRecordingArchiveEnabled: true OS: Other AutoUpdateEnabled: true LastCheckForUpdates: '0001-01-01T00:00:00.0000000+00:00' LastSuccessfulUpdate: '0001-01-01T00:00:00.0000000+00:00' RemoteStorageEnabled: true RemoteStorageStatus: NotConfigured RemoteConfigurationRequired: true ChatUsedSpace: 0 LogUsedSpace: 0 Pbx.SystemTelemetry: value: Time: '0001-01-01T00:00:00.0000000+00:00' CpuUsage: 0 TotalVirtualMemory: 0 FreeVirtualMemory: 0 TotalPhysicalMemory: 0 FreePhysicalMemory: 0 TotalDiskSpace: 0 FreeDiskSpace: 0 TickCount: 0 Pbx.ProcessTelemetry: value: Time: '0001-01-01T00:00:00.0000000+00:00' Service: Database PrivateMemory: 0 ProcessCount: 0 ThreadCount: 0 HandleCount: 0 Pbx.NetworkTelemetry: value: Id: string (identifier) Time: '0001-01-01T00:00:00.0000000+00:00' KbpsSent: 0 KbpsReceived: 0 Pbx.MyPhoneRequestStats: value: RequestId: 0 MaxDuration: 0 AvgDuration: 0 Count: 0 SumDuration: 0 Pbx.SystemExtensionStatus: value: Number: string Type: string IsRegistered: true Name: string Pbx.CreateTicket: value: CanCreateTicket: true FixUrl: string CreateTicketStatus: OK Pbx.SystemDatabaseInformation: value: Id: 0 CallsUsedSpace: 0 ChatsUsedSpace: 0 EventLogUsedSpace: 0 ChatFilesCount: 0 Pbx.VersionUpdateType: value: Type: Release Pbx.SystemHealthStatus: value: Id: 0 Firewall: true Trunks: true Phones: true CustomTemplatesCount: 0 UnsupportedFirmwaresCount: 0 Pbx.RequestHelp: value: IssueDescription: string ReplyEmail: string Name: string GrantPeriodDays: 0 PhoneNumber: string Pbx.Playlist: value: Name: string (identifier) RepositoryPath: string PromptName: string Shuffle: true AutoGain: true MaxVolumePercent: 0 Files: - string Pbx.FaxServerSettings: value: Number: string (identifier) FaxServerId: 0 AuthId: string AuthPassword: '@odata.type': Pbx.ConcealedPassword Email: string G711ToT38Fallback: true AutoCleanup: true MaxAge: 0 RemoteStorageEnabled: true Pbx.Fax: value: Number: string TranscriptionMode: Nothing Id: 0 Groups: - '@odata.type': Pbx.UserGroup AuthID: string AuthPassword: string OutboundCallerId: string FaxServer: true Pbx.CrmIntegration: value: Name: string Id: string (identifier) EnabledForDidCalls: true EnabledForExternalCalls: true PhonebookPriorityOptions: NotQueryIfInPhonebookFound PhonebookSynchronization: true Country: string VariableChoices: - '@odata.type': Pbx.CrmChoice PossibleValues: - '@odata.type': Pbx.CrmSelectableValue Pbx.CrmTestResult: value: Log: string IsError: true Message: string SearchResult: - '@odata.type': Pbx.CrmContact Pbx.OauthStateParam: value: Variable: string RedirectUri: string PKCECodeVerifier: string Pbx.OauthState: value: State: string CodeChallenge: string Pbx.CrmChoice: value: Key: string Value: string Pbx.CrmTemplateSource: value: Value: string Pbx.DidNumber: value: Number: string (identifier) TrunkId: 0 TemplateFileName: string RoutingRule: '@odata.type': Pbx.InboundRule Pbx.ActivityLogEvent: value: Index: 0 TimeStamp: '0001-01-01T00:00:00.0000000+00:00' Message: string Pbx.ActivityLogsFilter: value: Extensions: - '@odata.type': Pbx.ExtensionFilter Pbx.RefreshToken: value: Id: 0 Username: string DisplayName: string Token: string Created: '0001-01-01T00:00:00.0000000+00:00' CreatedByUserAgent: string CreatedByIp: string Used: '0001-01-01T00:00:00.0000000+00:00' UsedByUserAgent: string UsedByIp: string Expires: '0001-01-01T00:00:00.0000000+00:00' Revoked: '0001-01-01T00:00:00.0000000+00:00' RevokedByIp: string ReasonRevoked: TooMany SlidingExpiration: true LoginType: Local Pbx.Holiday: value: Group: string Day: 0 DayEnd: 0 HolidayPrompt: string IsRecurrent: true Month: 0 MonthEnd: 0 Name: string TimeOfEndDate: string TimeOfStartDate: string Year: 0 YearEnd: 0 Id: 0 Pbx.RemoteArchivingSettings: value: Id: 0 Location: '@odata.type': Pbx.LocationSettings Backups: '@odata.type': Pbx.ArchiveSubsystem Recordings: '@odata.type': Pbx.ArchiveSubsystem Voicemails: '@odata.type': Pbx.ArchiveSubsystem Faxes: '@odata.type': Pbx.ArchiveSubsystem Chats: '@odata.type': Pbx.ArchiveSubsystem Pbx.EmergencyGeoLocation: value: Id: string (identifier) FriendlyName: string Pbx.EmergencyGeoTrunkLocation: value: Id: string (identifier) ProviderUri: string TrunkDn: string Location: '@odata.type': Pbx.EmergencyGeoLocation Pbx.DataConnectorSettings: value: OffloadDestination: None IsBigQueryEnabled: true RemotePostgreConfig: '@odata.type': Pbx.RemotePostgreConfig RemoteMySqlConfig: '@odata.type': Pbx.RemoteMySqlConfig RemoteSqlServerConfig: '@odata.type': Pbx.RemoteSqlServerConfig Schedule: '@odata.type': Pbx.BackupSchedule PurgeAfterSync: true DataTypesToOffload: '@odata.type': Pbx.DataTypesToOffload Pbx.AmazonIntegrationSettings: value: S3Config: '@odata.type': Pbx.S3Config ServiceAccountCredentials: '@odata.type': Pbx.AmazonCredentials Pbx.SyslogSettings: value: IsEnabled: true IntegrationType: Custom CustomRelayConfig: '@odata.type': Pbx.SyslogCustomRelayConfig DatadogConfig: '@odata.type': Pbx.SyslogDatadogConfig SplunkConfig: '@odata.type': Pbx.SyslogSplunkConfig ElasticConfig: '@odata.type': Pbx.SyslogElkConfig CategoryConfig: '@odata.type': Pbx.SyslogCategoryConfig Pbx.CallHistoryView: value: SegmentId: 0 SegmentStartTime: '0001-01-01T00:00:00.0000000+00:00' SegmentEndTime: '0001-01-01T00:00:00.0000000+00:00' SegmentActionId: 0 SegmentType: 0 SrcId: 0 SrcExtendedDisplayName: string SrcDisplayName: string SrcInternal: true SrcExternal: true SrcDnType: 0 SrcDn: string SrcCallerNumber: string SrcParticipantId: 0 SrcRecId: 0 DstId: 0 DstExtendedDisplayName: string DstDisplayName: string DstInternal: true DstExternal: true DstDnType: 0 DstDn: string DstCallerNumber: string DstParticipantId: 0 DstRecId: 0 CallTime: string CallAnswered: true Pbx.ChatHistoryView: value: ConversationId: 0 IsExternal: true QueueNumber: string FromNo: string FromName: string ProviderName: string ProviderType: SMS ParticipantIp: string ParticipantPhone: string ParticipantEmail: string TimeSent: '0001-01-01T00:00:00.0000000+00:00' Message: string ChatName: string ParticipantsGroupsArray: - string Source: string Pbx.ChatMessagesHistoryView: value: MessageId: 0 ConversationId: 0 IsExternal: true QueueNumber: string SenderParticipantIp: string SenderParticipantName: string SenderParticipantNo: string SenderParticipantPhone: string SenderParticipantEmail: string SenderParticipantPbx: string Message: string TimeSent: '0001-01-01T00:00:00.0000000+00:00' Recipients: string ParticipantsGroupsArray: - string Pbx.LastCdrAndChatMessageTimestamp: value: LastCdrStartedAt: 0001-01-01T00:00:00.0000000+00:00 (identifier) LastChatMessageTimeSent: '0001-01-01T00:00:00.0000000+00:00' Pbx.RingGroupStatistics: value: RingGroupDn: string (identifier) RingGroupDisplayName: string RingGroupReceivedCount: 0 RingGroupAnsweredCount: 0 RingGroupSentimentScore: 0 Pbx.ExtensionsStatisticsByRingGroups: value: RingGroupDn: string (identifier) RingGroupDisplayName: string ExtensionDn: string (identifier) ExtensionDisplayName: string RingGroupReceivedCount: 0 ExtensionAnsweredCount: 0 RingGroupUnansweredCount: 0 SentimentScore: 0 SortOrder: 0 Pbx.CallLogData: value: MainCallHistoryId: string CallHistoryId: string CdrId: string (identifier) CallId: 0 Indent: 0 StartTime: '0001-01-01T00:00:00.0000000+00:00' SourceType: 0 SourceDn: string SourceCallerId: string SourceDisplayName: string DestinationType: 0 DestinationDn: string DestinationCallerId: string DestinationDisplayName: string ActionType: 0 ActionDnType: 0 actionDnDn: string ActionDnCallerId: string ActionDnDisplayName: string RingingDuration: string TalkingDuration: string CallCost: 0 Answered: true Direction: string CallType: string Status: string RecordingUrl: string SubrowDescNumber: 0 Reason: string SrcRecId: 0 DstRecId: 0 SegmentId: 0 QualityReport: true SentimentScore: 0 Summary: string Transcription: string Pbx.QualityReport: value: Summary: 0 OverallScore: 0 MOS: 0 Transcoding: true Party1: '@odata.type': Pbx.QualityParty Party2: '@odata.type': Pbx.QualityParty Reason: string Pbx.ExtensionStatistics: value: Dn: string (identifier) DisplayName: string InboundAnsweredCount: 0 InboundAnsweredTalkingDur: string InboundUnansweredCount: 0 OutboundAnsweredCount: 0 OutboundAnsweredTalkingDur: string OutboundUnansweredCount: 0 Pbx.ReportExtensionStatisticsByGroup: value: Dn: string (identifier) DisplayName: string InboundAnsweredCount: 0 InboundAnsweredTalkingDur: string InboundUnansweredCount: 0 OutboundAnsweredCount: 0 OutboundAnsweredTalkingDur: string OutboundUnansweredCount: 0 SentimentScore: 0 Pbx.CallCostByExtensionGroup: value: SegId: string (identifier) GroupName: string SrcDn: string SrcDisplayName: string StartTime: '0001-01-01T00:00:00.0000000+00:00' DstDn: string DstDnClass: 0 IsAnswered: true TalkingDur: string RingingDur: string BillingCost: 0 CallType: string Pbx.QueuePerformanceOverview: value: QueueDn: string QueueDisplayName: string (identifier) ExtensionDn: string (identifier) ExtensionDisplayName: string QueueReceivedCount: 0 ExtensionAnsweredCount: 0 ExtensionDroppedCount: 0 TalkTime: string QueueAnsweredCount: 0 SortOrder: 0 Pbx.QueuePerformanceTotals: value: QueueDn: string (identifier) QueueDisplayName: string QueueReceivedCount: 0 ExtensionAnsweredCount: 0 ExtensionDroppedCount: 0 Pbx.TeamQueueGeneralStatistics: value: QueueDnNumber: string (identifier) Dn: string AgentsInQueueCount: 0 ReceivedCount: 0 AnsweredCount: 0 TotalTalkTime: string AvgTalkTime: string Pbx.DetailedQueueStatistics: value: QueueDnNumber: string (identifier) QueueDn: string CallsCount: 0 AnsweredCount: 0 RingTime: string AvgRingTime: string TalkTime: string AvgTalkTime: string CallbacksCount: 0 Pbx.AbandonedQueueCalls: value: QueueDn: string (identifier) QueueDisplayName: string CallTime: '0001-01-01T00:00:00.0000000+00:00' CallTimeForCsv: '0001-01-01T00:00:00.0000000+00:00' WaitTime: string CallerId: string ExtensionDn: string ExtensionDisplayName: string CallHistoryId: string PollingAttempts: 0 IsLoggedIn: true Pbx.QueueAnsweredCallsByWaitTime: value: CallTime: 0001-01-01T00:00:00.0000000+00:00 (identifier) Dn: string (identifier) Destination: string (identifier) Source: string (identifier) RingTime: string AnsweredTime: 0001-01-01T00:00:00.0000000+00:00 (identifier) DnNumber: string SentimentScore: 0 Pbx.QueueCallbacks: value: QueueDnNumber: string (identifier) Dn: string ReceivedCount: 0 CallbacksCount: 0 FailCallbacksCount: 0 Pbx.AgentsInQueueStatistics: value: Dn: string (identifier) DnDisplayName: string Queue: string QueueDisplayName: string LoggedInTime: string LostCount: 0 AnsweredCount: 0 AnsweredPercent: 0 AnsweredPerHourCount: 0 RingTime: string AvgRingTime: string TalkTime: string AvgTalkTime: string Pbx.QueueFailedCallbacks: value: CallTime: 0001-01-01T00:00:00.0000000+00:00 (identifier) Dn: string (identifier) CallbackNo: string (identifier) RingTime: string QueueDnNumber: string Pbx.StatisticSla: value: QueueDnNumber: string (identifier) Dn: string ReceivedCount: 0 BadSlaCallsCount: 0 Pbx.BreachesSla: value: CallTime: 0001-01-01T00:00:00.0000000+00:00 (identifier) Queue: string (identifier) CallerId: string (identifier) WaitingTime: string QueueDnNumber: string Pbx.QueueChatPerformance: value: Queue: string (identifier) QueueDisplayName: string QuantityAgents: 0 IncomingCount: 0 AnsweredCount: 0 AbandonedCount: 0 Pbx.QueueAgentsChatStatistics: value: Dn: string (identifier) DnDisplayName: string Queue: string (identifier) QueueDisplayName: string AnsweredCount: 0 DealtWithCount: 0 SortOrder: 0 Pbx.QueueAgentsChatStatisticsTotals: value: Queue: string (identifier) QueueDisplayName: string AnsweredCount: 0 DealtWithCount: 0 Pbx.AbandonedChatsStatistics: value: ChatId: 0 QueueNo: string (identifier) QueueDisplayName: string Source: string (identifier) ParticipantName: string ParticipantNumber: string (identifier) ParticipantEmail: string (identifier) DateOfRequest: 0001-01-01T00:00:00.0000000+00:00 (identifier) ParticipantMessage: string (identifier) ReasonForDealtWith: string ReasonForAbandoned: string Pbx.AgentLoginHistory: value: QueueNo: string (identifier) AgentNo: string (identifier) Agent: string (identifier) Day: '0001-01-01T00:00:00.0000000+00:00' loggedInDt: '0001-01-01T00:00:00.0000000+00:00' LoggedOutDt: '0001-01-01T00:00:00.0000000+00:00' LoggedInInterval: string LoggedInDayInterval: string LoggedInTotalInterval: string TalkingInterval: string TalkingDayInterval: string TalkingTotalInterval: string Pbx.UserActivity: value: DateTimeInterval: 0001-01-01T00:00:00.0000000+00:00 (identifier) AnsweredCount: 0 UnansweredCount: 0 Pbx.CallDistribution: value: DateTimeInterval: 0001-01-01T00:00:00.0000000+00:00 (identifier) OutgoingCount: 0 IncomingCount: 0 Pbx.OutboundCall: value: CdrId: string (identifier) CallHistoryId: string StartTime: '0001-01-01T00:00:00.0000000+00:00' TrunkName: string TrunkNumber: string SourceDisplayName: string SourceDn: string SourceCallerId: string DestinationDisplayName: string DestinationDn: string DestinationCalleeId: string Answered: true RingingDuration: string TalkingDuration: string CallDuration: string CallCost: 0 SentimentScore: 0 RecordingId: 0 RecordingUrl: string Summary: string Transcription: string RuleName: string QualityReport: true Status: string Pbx.InboundCall: value: CdrId: string (identifier) CallHistoryId: string StartTime: '0001-01-01T00:00:00.0000000+00:00' TrunkName: string TrunkNumber: string Did: string SourceDn: string SourceCallerId: string SourceDisplayName: string DestinationDn: string DestinationCallerId: string DestinationDisplayName: string Status: string RingingDuration: string TalkingDuration: string CallDuration: string RecordingId: 0 SentimentScore: 0 RecordingUrl: string Summary: string Transcription: string RuleName: string QualityReport: true Pbx.AuditLog: value: Id: 0 Timestamp: '0001-01-01T00:00:00.0000000+00:00' Source: 0 Ip: string Action: 0 ObjectType: 0 UserName: string ObjectName: string PrevData: string NewData: string Pbx.InboundRuleReport: value: RuleName: string DID: string Trunk: string InOfficeRouting: '@odata.type': Pbx.Destination OutOfficeRouting: '@odata.type': Pbx.Destination Id: 0 Pbx.TimeReportData: value: XValue: 0001-01-01T00:00:00.0000000+00:00 (identifier) YValue1: 0 YValue2: 0 Pbx.ScheduledReport: value: Id: 0 DN: string Name: string ReportType: None ScheduleType: Daily FilterDescription: string ReportLink: string ReportParams: string EmailAddresses: string Pbx.PurgeSettings: value: All: true Start: '0001-01-01T00:00:00.0000000+00:00' Stop: '0001-01-01T00:00:00.0000000+00:00' Pbx.UserGroup: value: GroupId: 0 Number: string MemberName: string Name: string Type: None Tags: - MS CanDelete: true TranscriptionMode: Nothing Id: 0 Rights: '@odata.type': Pbx.Rights GroupRights: '@odata.type': Pbx.Rights Pbx.Codec: value: Name: string RfcName: string Id: 0 Pbx.VoipProvider: value: Id: string (identifier) Name: string Type: Preferred Countries: - string Pbx.Defs: value: Id: 0 Codecs: - '@odata.type': Pbx.Codec GatewayParameters: - '@odata.type': Pbx.GatewayParameter TimeZones: - '@odata.type': Pbx.TimeZone GatewayParameterValues: - '@odata.type': Pbx.GatewayParameterValue Pbx.TimeZone: value: Id: string (identifier) Name: string IanaName: string WindowsName: string Pbx.Gateway: value: Codecs: - string InboundParams: - '@odata.type': Pbx.GatewayParameterBinding OutboundParams: - '@odata.type': Pbx.GatewayParameterBinding SourceIdentification: - '@odata.type': Pbx.GatewayParameterBinding VariableChoices: - '@odata.type': Pbx.Choice DeliverAudio: true DestNumberInRemotePartyIDCalled: true DestNumberInRequestLineURI: true DestNumberInTo: true SRTPMode: SRTPDisabled Host: string ProxyHost: string Internal: true Lines: 0 MatchingStrategy: MatchAnyFields Name: string OutboundCallerID: string Port: 0 ProxyPort: 0 RequireRegistrationFor: Nothing SupportReinvite: true SupportReplaces: true TemplateFilename: string TimeBetweenReg: 0 Type: Unknown UseIPInContact: true IPInRegistrationContact: External SpecifiedIPForRegistrationContact: string Id: 0 Pbx.PhoneSettings: value: Codecs: - string Firmware: string FirmwareLang: string LocalRTPPortEnd: 0 LocalRTPPortStart: 0 LocalSipPort: 0 PhoneLanguage: string TimeZone: string ProvisionType: LocalLan ProvisionExtendedData: string SbcName: string RemoteSpmHost: string RemoteSpmPort: 0 XferType: BXfer RingTone: string QueueRingTone: string DateFormat: string TimeFormat: string PowerLed: string Backlight: string ScreenSaver: string Srtp: string Secret: string IsSBC: true CustomLogo: string LogoFileExtensionAllowed: - string LogoDescription: string IsLogoCustomizable: true LlDpInfo: '@odata.type': Pbx.PhoneLldpInfo VlanInfos: - '@odata.type': Pbx.PhoneDeviceVlanInfo AllowCustomQueueRingtones: true CustomQueueRingtones: - '@odata.type': Pbx.CustomQueueRingtone Pbx.DeviceInfo: value: DetectedAt: '0001-01-01T00:00:00.0000000+00:00' MAC: string Vendor: string ViaSBC: true SbcName: string TemplateName: string Model: string FirmwareVersion: string NetworkAddress: string NetworkPath: string Assigned: true AssignedUser: string InterfaceLink: string Parameters: string UserAgent: string Id: 0 Pbx.SipDevice: value: Id: 0 Registrar: '@odata.type': Pbx.PhoneRegistrar ProvLink: string PhoneWebPassword: string DN: '@odata.type': Pbx.Peer Pbx.GatewayParameter: value: CanHaveDID: true Description: string Name: string InboundPossibleValues: - string OutboundPossibleValues: - string SourceIDPossibleValues: - string Id: 0 Pbx.GatewayParameterValue: value: Description: string Name: string Id: 0 Pbx.Greeting: value: Type: Default Filename: string DisplayName: string Pbx.NetworkInterface: value: Id: string (identifier) Pbx.SystemParameters: value: Version: string PbxExternalHost: string FQDN: string SipPort: 0 ProcessorCount: 0 TunnnelPort: 0 SipsPort: 0 HttpPort: 0 HttpsPort: 0 FirstExternalPort: 0 WebrtcLastPort: 0 ENL: 0 ENLRange: '@odata.type': Pbx.ENL IsMulticompanyMode: true IsHosted: true IsHosted3CX: true RpsEnabled: true Custom1Name: string Custom2Name: string IsStaticIp: true IsChatLogEnabled: true StaticIp: string StunIp: string IpV6: string License: '@odata.type': Pbx.License GlobalLanguage: string MaxDIDPerTrunk: 0 GlobalACPRMSET: string EmRuleCreationAllowed: true Is3CXFQDN: true IsTranscriptionEnabled: true IsRemoteBackup: true RemoteStorageStatus: NotConfigured Pbx.License: value: ProductCode: string CountryCode: string IsMaintainceExpired: true MaxSimCalls: 0 Pbx.SendEmail: value: Destination: string DateTime: '0001-01-01T00:00:00.0000000+00:00' Template: string Variables: - '@odata.type': Pbx.EmailVariable Pbx.GoogleSettings: value: Id: string (identifier) IsExtensionSignInEnabled: true ClientId: string ProjectId: string UserSync: '@odata.type': Pbx.GoogleUserSync ClientSecret: '@odata.type': Pbx.ConcealedPassword ReCaptchaEnabled: true ProvisionUrl: string Pbx.ConsoleRestrictions: value: Id: string (identifier) AccessRestricted: true IpWhitelist: - string MyIpAddress: string Pbx.MusicOnHoldSettings: value: Id: 0 MusicOnHold: string MusicOnHold1: string MusicOnHold2: string MusicOnHold3: string MusicOnHold4: string MusicOnHold5: string MusicOnHold6: string MusicOnHold7: string MusicOnHold8: string MusicOnHold9: string MusicOnHoldRandomize: true MusicOnHoldRandomizePerCall: true Pbx.CodecsSettings: value: LocalCodecList: - string ExternalCodecList: - string Pbx.GeneralSettingsForApps: value: AutoSchedulerSettings: '@odata.type': Pbx.AutoSchedulerSettings NameOfCustomAvailableStatus: string NameOfCustomOutOfOfficeStatus: string BrandLogoImage: string BrandMainImage: string BrandUrl: string EnableChat: true AllowChangePassword: true AllowBlockCalls: true HideCRMContacts: true HideSystemExtensions: true HideInteractionHistory: true HideAbandonedQueueCalls: true AvatarStyle: Square Pbx.GeneralSettingsForPbx: value: OperatorExtension: string AllowFwdToExternal: true PlayBusy: true LimitCallPickup: true EnableVMenuOutboundCalls: true DisableOutboundCallsOutOfficeHours: true BusyMonitor: true BusyMonitorTimeout: 0 ScheduledReportGenerationTime: string HDAutoLogoutEnabled: true HDAutoLogoutTime: string Pbx.CallParkingSettings: value: MaximumParkedCalls: 0 MusicOnHold: string AutoPickupEnabled: true AutoPickupTimeout: 0 AutoPickupForwardType: TransferBack AutoPickupForwardDN: string AutoPickupForwardExternalNumber: string Pbx.DialCodeSettings: value: DialCodePark: string DialCodeUnpark: string DialCodePickup: string DialCodeProfileStatus: string DialCodeVMail: string DialCodeLoggedInQueue: string DialCodeLoggedOutQueue: string DialCodeIntercom: string DialCodeBillingCode: string DialCodeOutOffice: string DialCodeHideCallerID: string DialCodeHotdesking: string DialCodeHotelAccess: string Pbx.E164Settings: value: Enabled: true CountryCode: string CountryName: string RemoveCountryCode: true RemoveAreaCode: true AreaCode: string NationalCode: string InternationalCode: string Prefix: string Pbx.CountryCodes: value: CountryCodes: - string Pbx.SecureSipSettings: value: PrivateKey: '@odata.type': Pbx.ConcealedDataFile Certificate: '@odata.type': Pbx.ConcealedDataFile Pbx.PhonesSettings: value: CustomDNDProfile: string PhoneAllowMultiFirmwares: true AutoUpdatePhonesOnAdd: true AllowMultiQueueRingtones: true UseRpcForLocalPhones: true UseProvisioningSecret: true AutoCleanupFirmware: true FanvilUpdateInterval: 0 YealinkUpdateInterval: 0 SnomUpdateInterval: 0 GrandstreamUpdateInterval: 0 Pbx.OfficeHours: value: Hours: '@odata.type': Pbx.Schedule BreakTime: '@odata.type': Pbx.Schedule TimeZoneId: string SystemLanguage: string OfficeHolidays: - '@odata.type': Pbx.Holiday Pbx.PhoneBookSettings: value: ResolvingType: NotResolve ResolvingLength: 0 PhoneBookDisplay: FirstNameLastName PhoneBookAddQueueName: NotAdd Pbx.EmergencyNotificationsSettings: value: ChatRecipients: None EmergencyPlayPrompt: string SpecifiedList: string EmergencyDNPrompt: '@odata.type': Pbx.Peer Pbx.CallTypesSettings: value: Local: '@odata.type': Pbx.CallTypeInfo National: '@odata.type': Pbx.CallTypeInfo Mobile: '@odata.type': Pbx.CallTypeInfo International: '@odata.type': Pbx.CallTypeInfo Pbx.LoggingSettings: value: LoggingLevel: 0 KeepLogs: true KeepLogsDays: 0 Pbx.ChatLogSettings: value: AutoCloseDays: 0 AutoClearMonths: 0 RemoteStorageEnabled: true Pbx.AntiHackingSettings: value: SecurityDefenseProgram: true HackAuthRequests: 0 HackChallengeRequests: 0 HackBlacklistDuration: 0 HackBarrierGreen: 0 HackBarrierAmber: 0 HackBarrierRed: 0 MaxRequestPerPeriod: 0 ThrottlePeriodLength: 0 Pbx.Rights: value: RoleName: string (identifier) AllowToManageCompanyBook: true AllowToChangePresence: true CanSeeGroupMembers: true CanSeeGroupCalls: true ShowMyPresence: true ShowMyPresenceOutside: true ShowMyCalls: true PerformOperations: true CanBargeIn: true CanIntercom: true AllowParking: true AllowIVR: true AssignClearOperations: true CanSeeGroupRecordings: true Invalid: true Pbx.ConcealedPassword: value: Value: string Concealed: true Pbx.TrunkMessaging: value: Enabled: true Webhook: string Provider: string NumberLengthEnabled: true NumberLength: 0 Pbx.GatewayParameterBinding: value: Custom: string ParamId: 0 ValueId: 0 Pbx.Choice: value: Key: string Value: string Pbx.CIDFormatting: value: SourcePattern: string ReplacePattern: string Pbx.Schedule: value: Type: AllHours IgnoreHolidays: true Periods: - '@odata.type': Pbx.Period Pbx.Period: value: DayOfWeek: Sunday Start: string Stop: string Pbx.Destination: value: External: string To: None Number: string Name: string Type: None Tags: - MS Pbx.PeerGroup: value: GroupID: 0 RoleName: string IsPrimary: true Number: string Name: string Pbx.Variable: value: Name: string Value: string Pbx.GroupProps: value: StartupLicense: Free OutboundRulesMaxCount: 0 LiveChatMaxCount: 0 DectMaxCount: 0 TrunksMaxCount: 0 SbcMaxCount: 0 PersonalContactsMaxCount: 0 DepartmentContactsMaxCount: 0 PromptsMaxCount: 0 SubcriptionExpireDate: '0001-01-01T00:00:00.0000000+00:00' UserNumberFrom: string UserNumberTo: string TrunkNumberFrom: string TrunkNumberTo: string SystemNumberFrom: string SystemNumberTo: string Subscription: string SubscriptionType: string ResellerId: string ResellerName: string Fqdn: string StartupOwnerEmail: string Pbx.Route: value: Route: '@odata.type': Pbx.Destination Prompt: string IsPromptEnabled: true Pbx.QueueAgent: value: Number: string SkillGroup: string Name: string Tags: - MS Id: 0 Pbx.QueueManager: value: Number: string Name: string Tags: - MS Id: 0 Pbx.ResetQueueStatisticsSchedule: value: Frequency: Disabled Day: Sunday Time: string Pbx.RingGroupMember: value: Number: string Name: string Tags: - MS Id: 0 Pbx.ForwardingProfile: value: Name: string CustomName: string CustomMessage: string BlockPushCalls: true RingMyMobile: true AcceptMultipleCalls: true OfficeHoursAutoQueueLogOut: true DisableRingGroupCalls: true NoAnswerTimeout: 0 AvailableRoute: '@odata.type': Pbx.AvailableRouting AwayRoute: '@odata.type': Pbx.AwayRouting Id: 0 Pbx.AvailableRouting: value: NoAnswerAllCalls: true BusyAllCalls: true NotRegisteredAllCalls: true NoAnswerInternal: '@odata.type': Pbx.Destination NoAnswerExternal: '@odata.type': Pbx.Destination BusyInternal: '@odata.type': Pbx.Destination BusyExternal: '@odata.type': Pbx.Destination NotRegisteredInternal: '@odata.type': Pbx.Destination NotRegisteredExternal: '@odata.type': Pbx.Destination Pbx.AwayRouting: value: AllHoursInternal: true AllHoursExternal: true External: '@odata.type': Pbx.Destination Internal: '@odata.type': Pbx.Destination Pbx.ExtensionRule: value: Enabled: true CallType: AllCalls Condition: NoAnswer Data: string Destination: '@odata.type': Pbx.Destination Hours: '@odata.type': Pbx.Schedule Id: 0 Pbx.Phone: value: TemplateName: string Name: string MacAddress: string Interface: string ProvisioningLinkLocal: string ProvisioningLinkExt: string Settings: '@odata.type': Pbx.PhoneSettings Id: 0 Pbx.PhoneLldpInfo: value: Configurable: true Value: true Pbx.PhoneDeviceVlanInfo: value: Configurable: true Type: Wan Enabled: true VlanId: 0 VlanIdMin: 0 VlanIdMax: 0 PriorityConfigurable: true Priority: 0 PriorityMin: 0 PriorityMax: 0 Pbx.CustomQueueRingtone: value: Queue: string Ringtone: string Pbx.AgentSettings: value: MaxCallDuration: 0 FirstMessage: string SystemPrompt: string Voice: string Language: string PhoneBookMatching: true AllowedExtensions: string Knowledgebase: - string RoutingDirectory: - '@odata.type': Pbx.AgentRoutingDirectory AgentType: string EnableSpamProtection: true SpamAction: '@odata.type': Pbx.AgentRoutingAction SpamInstructions: string CallPrioritySettings: '@odata.type': Pbx.CallPrioritySettings EnableNameMatching: true AbusiveCallerAction: '@odata.type': Pbx.AgentRoutingAction CallerDoesNotRespondAction: '@odata.type': Pbx.AgentRoutingAction TokenBudget: '@odata.type': Pbx.CallTokenBudget CheckStatusBeforeTransfer: true ConfidentialModeEnabled: true SwitchLanguage: true PhonebookOverride: '@odata.type': Pbx.Peer Pbx.AgentRoutingDirectory: value: Description: string Number: string Name: string Type: None Tags: - MS Pbx.AgentRoutingAction: value: Action: string Number: string Name: string Type: None Tags: - MS Pbx.CallPrioritySettings: value: IsEnabled: true PriorityLow: '@odata.type': Pbx.CallPriority PriorityMedium: '@odata.type': Pbx.CallPriority PriorityHigh: '@odata.type': Pbx.CallPriority Pbx.CallPriority: value: Instructions: string Action: string Pbx.CallTokenBudget: value: Enabled: true NormalSpeechTpm: 0 Tolerance: 0 MinInputTokens: 0 MaxInputTokens: 0 Pbx.ReceptionistForward: value: ForwardType: EndCall Input: string PeerType: None CustomData: string ForwardDN: string Id: 0 Pbx.CallParticipant: value: Id: 0 Status: string PartyCallerName: string PartyDn: string PartyCallerId: string DeviceId: string PartyDnType: string DirectControl: true CallId: 0 LegId: 0 DN: string Pbx.PhoneModel: value: AddAllowed: true Name: string UserAgent: string URL: string CanBeSBC: true Pbx.TrunkMessagingTemplate: value: Provider: string Type: string Outbound: true Optional: true MessagingVariables: - '@odata.type': Pbx.TrunkVariable Pbx.TrunkVariable: value: Name: string Title: string Prompt: string Option: string OptionType: Text Validation: string DefaultValue: string Required: true MaxLength: 0 MinLength: 0 Pattern: string Pbx.EntityRestrictions: value: Unlimited: true Used: 0 Allowed: 0 Pbx.OutboundRoute: value: Append: string CallerID: string Prepend: string StripDigits: 0 TrunkId: 0 TrunkName: string Pbx.DNRange: value: From: string To: string Pbx.LogEntry: value: TimeStamp: '0001-01-01T00:00:00.0000000+00:00' Text: string Pbx.SetRoute: value: TrunkId: 0 DID: string DisplayName: string Pbx.ProviderPhone: value: Sid: string FriendlyName: string PhoneNumber: string IsInTrunk: true IsMessagingEnabled: true Pbx.FxsProvisioning: value: LocalInterface: string Method: LocalLan LocalSipPort: 0 LocalAudioPortStart: 0 LocalAudioPortEnd: 0 RemoteFQDN: string SbcName: string RemotePort: 0 ProvLink: string Pbx.DeviceLine: value: Key: 0 Number: string Name: string Pbx.FxsModel: value: UserAgent: string DisplayName: string CanBeSBC: true Pbx.FxsVariable: value: Name: string Title: string Choices: - '@odata.type': Pbx.FxsVariableChoice ValidationType: string Pbx.FxsVariableChoice: value: Name: string DisplayName: string Pbx.Prompt: value: Filename: string Transcription: string Id: string (identifier) Pbx.WebsiteLinksTranslations: value: OfflineNameMessage: string OfflineEmailMessage: string OfflineFormInvalidName: string OfflineFormMaximumCharactersReached: string OfflineFormInvalidEmail: string InviteMessage: string AuthenticationMessage: string UnavailableMessage: string OfflineFinishMessage: string EndingMessage: string FirstResponseMessage: string GreetingOfflineMessage: string GreetingMessage: string StartChatButtonText: string WindowTitle: string GdprMessage: string Pbx.LiveChatStyling: value: Animation: SlideUp Style: string Minimized: true UseRubik: true Pbx.GeneralLiveChatSettings: value: Greeting: Disabled Authentication: Both DisableOfflineMessages: true GdprEnabled: true EnableOnMobile: true AllowSoundNotifications: true EnableGA: true Pbx.LiveChatAdvancedSettings: value: IgnoreQueueOwnership: true EnableDirectCall: true CommunicationOptions: ChatOnly CallTitle: string Pbx.LiveChatBox: value: MinimizedStyle: BubbleLeft Height: string LiveChatLanguage: browser LiveMessageUserinfoFormat: Avatar ShowOperatorActualName: true OperatorName: string MessageDateformat: Date ButtonIconType: Url ButtonIconUrl: string ChatDelay: 0 WindowIcon: string OperatorIcon: string Pbx.BackupSchedule: value: ScheduleType: Daily Day: Sunday Time: string RepeatHours: 0 RepeatMinutes: 0 Pbx.UpdateItem: value: Category: string Description: string DescriptionLink: string Guid: 00000000-0000-0000-0000-000000000000 Ignore: true Image: string LocalVersion: string Name: string ServerVersion: string OutOfDate: true UpdateType: Release Pbx.CategoryUpdate: value: Category: string Count: 0 Pbx.BackupContents: value: License: true FQDN: true Prompts: true VoiceMails: true Recordings: true CallHistory: true PhoneProvisioning: true EncryptBackup: true DisableBackupCompression: true EncryptBackupPassword: '@odata.type': Pbx.ConcealedPassword Pbx.LocationSettings: value: FileSystemType: Local LocalPath: string SharePointPath: string FtpPath: string FtpUser: string FtpPassword: '@odata.type': Pbx.ConcealedPassword FtpValidateCertificate: true NsPath: string NsDomain: string NsUser: string NsPassword: '@odata.type': Pbx.ConcealedPassword SftpPath: string SftpUser: string SftpPassword: '@odata.type': Pbx.ConcealedPassword SftpPrivateKey: '@odata.type': Pbx.ConcealedDataFile GbJson: '@odata.type': Pbx.ConcealedDataFile GbPath: string S3Path: string Pbx.ConcealedDataFile: value: Name: string Contents: string Concealed: true Pbx.XSBCConnection: value: Up: true ElapsedTime: string RegisteredPhones: 0 Calls: 0 Latency: 0 UdpActive: true Cpu: string Memory: string Disk: string Pbx.CrmParameter: value: Name: string Type: String Parent: string Editor: String Title: string Validation: string Default: string ListValuesText: string ListValues: - string RequestUrl: string RequestUrlParameters: string ResponseScenario: string Pbx.CrmAuthentication: value: Type: No Values: - string Pbx.CDRSettingsField: value: Name: string Length: 0 Pbx.ADUsersSyncConfiguration: value: SelectedUsers: - string SelectedGroups: - string SyncType: SyncAllUsers IsEnabled: true SyncGuestUsers: true IsSyncDepartments: true SyncPersonalContacts: true SyncEvents: true SetTeamsPresence: true EnableSSO: true IsSyncOfficePhone: true IsSyncPhoto: true IsSyncDetails: true StartingExtensionNumber: string StatusSyncConfiguration: '@odata.type': Pbx.StatusSyncConfiguration Pbx.StatusSyncConfiguration: value: PBXToM365Busy: true PBXToM365Bindings: - '@odata.type': Pbx.PbxToM365Binding M365ToPbxBindings: - '@odata.type': Pbx.M365ToPbxBinding Pbx.PbxToM365Binding: value: From: Available To: Available Pbx.M365ToPbxBinding: value: From: Available To: Available Pbx.UsersSyncConfiguration: value: SelectedUsers: - string SyncType: SyncAllUsers IsEnabled: true Pbx.OnBoardMcuDataDetail: value: Host: string Ip: string Port: 0 Enabled: true Version: string Cloud: true Active: true Guid: string Pbx.MeetingObj: value: organizer: '@odata.type': Pbx.ParticipantDetails participants: - '@odata.type': Pbx.ParticipantDetails meetingid: string openlink: string friendlyname: string logo: string theme: string meetingprofile: string params: '@odata.type': Pbx.MeetingParams documentlist: string Pbx.ParticipantDetails: value: name: string email: string moderator: 0 key: string pbx_extension: string Pbx.MeetingParams: value: quickmeeting: 0 meetingduration: 0 meetingtitle: string note: string org_properties: string part_properties: string needorganizer: 0 forcemoderator: 0 hideparticipants: 0 canchangemedia: 0 mcu: string bitrate_video: 0 bitrate_data: 0 privaterooms: 0 moderateparticipants: 0 clicktocall: 0 Pbx.KeyValuePair_2OfString_OnBoardConnectedParticipant: value: { } Pbx.Setpoint: value: Enabled: true Type: VoicemailQuota Value: 0 Pbx.VectorStoreExpiration: value: Anchor: string Days: 0 ExpiresAt: '0001-01-01T00:00:00.0000000+00:00' LastActiveAt: '0001-01-01T00:00:00.0000000+00:00' Pbx.CrmSelectableValue: value: Id: 0 Name: string Pbx.CrmContact: value: FirstName: string LastName: string Email: string ContactUrl: string CompanyName: string PhotoUrl: string ContactType: Company PhoneBusiness: string PhoneBusiness2: string PhoneHome: string Title: string PhoneMobile: string PhoneMobile2: string PhoneOther: string FaxBusiness: string Department: string Pager: string ContactRawData: string Pbx.ExtensionFilter: value: Number: string CallIds: - string Pbx.ArchiveSubsystem: value: Enabled: true Folder: string ScheduleDays: 0 Archiving: true Pbx.RemotePostgreConfig: value: Host: string Port: 0 Database: string Username: string Password: '@odata.type': Pbx.ConcealedPassword ServerTrustMode: Prefer CACertificate: '@odata.type': Pbx.ConcealedDataFile AuthenticateMode: Password ClientCertificate: '@odata.type': Pbx.ConcealedDataFile ClientPrivateKey: '@odata.type': Pbx.ConcealedDataFile Pbx.RemoteMySqlConfig: value: Host: string Port: 0 Database: string UserId: string Password: '@odata.type': Pbx.ConcealedPassword Pbx.RemoteSqlServerConfig: value: Host: string Port: 0 Database: string UserId: string Password: '@odata.type': Pbx.ConcealedPassword Pbx.DataTypesToOffload: value: CallHistory: true SystemMetrics: true Recordings: true AudioMetrics: true Pbx.S3Config: value: BucketName: string Region: string ApplyBucket: true Pbx.AmazonCredentials: value: AccessKey: string SecretKey: '@odata.type': Pbx.ConcealedPassword Pbx.SyslogCustomRelayConfig: value: Host: string Port: 0 Protocol: Udp ClientCertificate: '@odata.type': Pbx.ConcealedDataFile ClientPrivateKey: '@odata.type': Pbx.ConcealedDataFile Pbx.SyslogDatadogConfig: value: Url: string ApiKey: string Pbx.SyslogSplunkConfig: value: Url: string Token: string Pbx.SyslogElkConfig: value: Url: string ApiKey: string IndexName: string Pbx.SyslogCategoryConfig: value: IsEventLogsEnabled: true IsAuditLogsEnabled: true IsSystemAlertsEnabled: true Pbx.QualityParty: value: Inbound: true Number: string Duration: 0 Codec: string UserAgent: string RTT: 0 AddressStr: string LocalPort: 0 TunAddressStr: string GlobalPort: 0 MOSFromPBX: 0 MOSToPBX: 0 RxPackets: 0 RxLost: 0 RxJitter: 0 TxPackets: 0 TxLost: 0 TxJitter: 0 TxBursts: 0 Burst: 0 Location: string Pbx.ENL: value: From: 0 To: 0 Pbx.EmailVariable: value: Name: string Value: string Pbx.GoogleUserSync: value: IsEnabled: true SelectedUsers: - string SyncType: SyncAllUsers IsSyncDepartments: true IsSyncPersonalContacts: true IsSyncPhoto: true UseCalendarEventsAsPresence: true StartingExtensionNumber: string Pbx.AutoSchedulerSettings: value: Enabled: true ProfileAvailable: string ProfileAway: string ProfileDND: string Pbx.CallTypeInfo: value: Prefix: string DigitsLength: string requestBodies: refPostBody: description: New navigation property ref value content: application/json: schema: $ref: '#/components/schemas/ReferenceCreate' required: true refPutBody: description: New navigation property ref values content: application/json: schema: $ref: '#/components/schemas/ReferenceUpdate' required: true SetMonitorStatusRequestBody: description: Action parameters content: application/json: schema: title: SetMonitorStatusRequestBody type: object properties: days: maximum: 2147483647 minimum: -2147483648 type: integer format: int32 required: true RegenerateRequestBody: description: Action parameters content: application/json: schema: title: RegenerateRequestBody type: object properties: opts: $ref: '#/components/schemas/Pbx.RegenerateOptions' required: true MakeCallUserRecordGreetingRequestBody: description: Action parameters content: application/json: schema: title: MakeCallUserRecordGreetingRequestBody type: object properties: dn: type: string filename: type: string required: true ReplaceMyGroupLicenseKeyRequestBody: description: Action parameters content: application/json: schema: title: ReplaceMyGroupLicenseKeyRequestBody type: object properties: licenseKey: type: string required: true LinkMyGroupPartnerRequestBody: description: Action parameters content: application/json: schema: title: LinkMyGroupPartnerRequestBody type: object properties: resellerId: type: string required: true securitySchemes: Application: type: oauth2 description: Use service principal credentials created via Admin/Integrations/API flows: clientCredentials: tokenUrl: /connect/token scopes: { } security: - Application: [ ]