{"info":{"_postman_id":"28e90ca4-c5e0-4f24-b333-a378a80924a9","name":"P-Test API Documentation","description":"

Introduction

What does your API do?

Overview

Before you begin working with the REST API, note the following:

The REST API features is disabled by default.
You must update the default password to use the REST API.
A POST request must send the content type as application/JSON.

Authentication

Authenticate with basic authentication with the administrator credentials:

User Name: Polycom
Password: The phone's admin password

Error Codes

2000 - Success
5000 - Failure

Rate limit

The REST API cannot receive more than 20 KB of data. If more than 20 KB of data is sent, the phone returns an HTTP 413 error.
Parallel processing is not allowed. If one API is being processed and another API is received by the phone, the second request will receive an HTTP 403 error or will be queued for later processing.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Introduction","slug":"introduction"},{"content":"Overview","slug":"overview"},{"content":"Authentication","slug":"authentication"},{"content":"Error Codes","slug":"error-codes"},{"content":"Rate limit","slug":"rate-limit"}],"owner":"13192773","collectionId":"28e90ca4-c5e0-4f24-b333-a378a80924a9","publishedId":"TVYDdKDz","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-10-22T12:17:39.000Z"},"item":[{"name":"Management.NetworkInfo","id":"546b7356-d8bb-4ea6-9ab9-e0f1dd0521d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://10.223.74.40/api/v1/mgmt/network/info","description":"

Provides details about the phone's network information.

Protocol: HTTP/HTTPS

Method:GET

Path: /api/v2/mgmt/network/info

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"28e90ca4-c5e0-4f24-b333-a378a80924a9","id":"28e90ca4-c5e0-4f24-b333-a378a80924a9","name":"P-Test API Documentation","type":"collection"}},"urlObject":{"path":["api","v1","mgmt","network","info"],"host":["https://10.223.74.40"],"query":[],"variable":[]}},"response":[{"id":"4b300f2e-2ed1-4bfe-b76f-95802f4996fb","name":"Management.NetworkInfo","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https:///api/v1/mgmt/network/info"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"9f6eca4c-575d-4ac6-81b3-327d23000c3b","name":"Management.NetworkInfo","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://192.168.68.117/api/v1/mgmt/network/info"},"code":2000,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Poly CCX Telephone HTTPd"},{"key":"Date","value":"Thu, 22 Oct 2020 02:39:41 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1"},{"key":"Content-Security-Policy","value":"default-src 'self'; style-src 'self' 'unsafe-inline'; script-src 'self' 'unsafe-inline'"},{"key":"Cache-Control","value":"no-store"},{"key":"Content-length","value":"880"},{"key":"Content-type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"SNTPAddress\": \"north-america.pool.ntp.org\",\n \"LANSpeed\": \"1000Mbps\",\n \"DHCPServer\": \"192.168.68.1\",\n \"SubnetMask\": \"255.255.255.0\",\n \"ProvServerAddress\": \"192.168.68.114/provision\",\n \"DHCP\": \"enabled\",\n \"VLANDiscoveryMode\": \"Fixed\",\n \"DefaultGateway\": \"192.168.68.1\",\n \"AlternateDNSServer\": \"192.168.68.1\",\n \"IPV4Address\": \"192.168.68.117\",\n \"DHCPBootServerUseOption\": \"Custom+Option66\",\n \"DNSServer\": \"192.168.1.1\",\n \"DHCPBootServerOption\": \"161\",\n \"DNSDomain\": \"\",\n \"DHCPBootServerOptionType\": \"String\",\n \"DHCPOption60Format\": \"ASCII String\",\n \"VLANID\": \"\",\n \"IPV6Address\": \"::\",\n \"LANPortStatus\": \"active\",\n \"LLDP\": \"enabled\",\n \"CDPCompatibility\": \"enabled\",\n \"VLANIDOption\": \"129\",\n \"ProvServerType\": \"HTTP\",\n \"ZTPStatus\": \"disabled\",\n \"UpgradeServer\": \"http://downloads.polycom.com/voice/software/Poly_UC_Software_6_2_22_0185_CCX600_release_sig/\",\n \"ProvServerUser\": \"\"\n },\n \"Status\": \"2000\"\n}"}],"_postman_id":"546b7356-d8bb-4ea6-9ab9-e0f1dd0521d1"},{"name":"Management.DeviceInfo","id":"4966f694-e904-45da-972b-ddab6a0ae18c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://10.223.74.40/api/v1/mgmt/device/info","description":"

Provides details about the phone's information.

Protocol: HTTP/HTTPS
Method: GET
Path: /api/v1/mgmt/device/info

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"28e90ca4-c5e0-4f24-b333-a378a80924a9","id":"28e90ca4-c5e0-4f24-b333-a378a80924a9","name":"P-Test API Documentation","type":"collection"}},"urlObject":{"path":["api","v1","mgmt","device","info"],"host":["https://10.223.74.40"],"query":[],"variable":[]}},"response":[{"id":"0f773fd9-5d9a-4714-aa23-bf88b229324a","name":"Management.DeviceInfo Success","originalRequest":{"method":"GET","header":[],"url":"https:///api/v1/mgmt/device/info"},"code":2000,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Poly CCX Telephone HTTPd"},{"key":"Date","value":"Thu, 22 Oct 2020 03:01:30 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1"},{"key":"Content-Security-Policy","value":"default-src 'self'; style-src 'self' 'unsafe-inline'; script-src 'self' 'unsafe-inline'"},{"key":"Cache-Control","value":"no-store"},{"key":"Content-length","value":"296"},{"key":"Content-type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"ModelNumber\": \"CCX 600\",\n \"IPV4Address\": \"192.168.68.xxx\",\n \"FirmwareRelease\": \"6.2.22.0185\",\n \"DeviceVendor\": \"Poly\",\n \"DeviceType\": \"hardwareEndpoint\",\n \"MACAddress\": \"64167xxxxx5\",\n \"UpTimeSinceLastReboot\": \"0 Day 0:40:23\",\n \"IPV6Address\": \"::\",\n \"AttachedHardware\": {}\n },\n \"Status\": \"2000\"\n}"},{"id":"c85cfa39-93b6-46c9-be02-5a4dbad2ce17","name":"Management.DeviceInfo","originalRequest":{"method":"GET","header":[],"url":"https://https://10.223.74.40/api/v1/mgmt/device/info"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Poly CCX Telephone HTTPd"},{"key":"Date","value":"Thu, 22 Oct 2020 04:19:00 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1"},{"key":"Content-Security-Policy","value":"default-src 'self'; style-src 'self' 'unsafe-inline'; script-src 'self' 'unsafe-inline'"},{"key":"Cache-Control","value":"no-store"},{"key":"Content-length","value":"296"},{"key":"Content-type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"ModelNumber\": \"CCX 600\",\n \"FirmwareRelease\": \"6.2.22.0185\",\n \"DeviceType\": \"hardwareEndpoint\",\n \"DeviceVendor\": \"Poly\",\n \"UpTimeSinceLastReboot\": \"0 Day 0:29:15\",\n \"IPV4Address\": \"192.168.68.117\",\n \"MACAddress\": \"64167fcc35e5\",\n \"IPV6Address\": \"::\",\n \"AttachedHardware\": {}\n },\n \"Status\": \"2000\"\n}"}],"_postman_id":"4966f694-e904-45da-972b-ddab6a0ae18c"},{"name":"Management.SetConfig","id":"fb44509e-b141-4e8c-9f0f-eca3ce3e9055","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"data\":\n {\"feature.callRecording.enabled\":\"0\",\n \"phoneLock.enabled\":\"1\",\n \"voice.CNControl\":\"1\"}\n \n}","options":{"raw":{"language":"json"}}},"url":"https://10.223.74.40/api/v1/mgmt/config/set","description":"

Provides the interface to set the configuration allowing a maximum of 20 parameters and up to 20 KB of content length for given request.

Protocol: HTTP/HTTPS
Method: GET
Path: /api/v1/mgmt/config/set

Provides a running configuration value for given configuration parameters. The maximum is 20 parameters. The maximum content length is 20 KB.

Protocol: HTTP/HTTPS
Method: GET
Path: /api/v1/mgmt/config/get

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"28e90ca4-c5e0-4f24-b333-a378a80924a9","id":"28e90ca4-c5e0-4f24-b333-a378a80924a9","name":"P-Test API Documentation","type":"collection"}},"urlObject":{"path":["api","v1","mgmt","config","get"],"host":["https://10.223.74.40"],"query":[],"variable":[]}},"response":[{"id":"6f82535d-4ee6-4570-b757-95fa13cc2f1b","name":"Management.GetConfig","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"data\":\n {\"feature.callRecording.enabled\",\n \"phoneLock.enabled\"}\n \n}","options":{"raw":{"language":"json"}}},"url":"https://192.168.68.117/api/v1/mgmt/config/set"},"code":4000,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Poly CCX Telephone HTTPd"},{"key":"Date","value":"Thu, 22 Oct 2020 03:37:55 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1"},{"key":"Content-Security-Policy","value":"default-src 'self'; style-src 'self' 'unsafe-inline'; script-src 'self' 'unsafe-inline'"},{"key":"Cache-Control","value":"no-store"},{"key":"Content-length","value":"18"},{"key":"Content-type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Status\": \"4000\"\n}"},{"id":"87f24c16-4ef8-4b2f-8e21-fc3f84c08ec4","name":"Management.GetConfig","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"data\":\n [\"feature.callRecording.enabled\",\n \"phoneLock.enabled\"]\n \n}","options":{"raw":{"language":"json"}}},"url":"https://192.168.68.117/api/v1/mgmt/config/get"},"code":2000,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Poly CCX Telephone HTTPd"},{"key":"Date","value":"Thu, 22 Oct 2020 03:39:44 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1"},{"key":"Content-Security-Policy","value":"default-src 'self'; style-src 'self' 'unsafe-inline'; script-src 'self' 'unsafe-inline'"},{"key":"Cache-Control","value":"no-store"},{"key":"Content-length","value":"152"},{"key":"Content-type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Status\": \"2000\",\n \"data\": {\n \"feature.callRecording.enabled\": {\n \"Value\": \"1\",\n \"Source\": \"local\"\n },\n \"phoneLock.enabled\": {\n \"Value\": \"1\",\n \"Source\": \"local\"\n }\n }\n}"}],"_postman_id":"44cf7fda-71d5-4047-b37a-ba702ee8998f"},{"name":"Management.Uixml","id":"bdccd44d-6568-4572-833a-d7bbaab85f67","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://10.223.74.40/api/v1/mgmt/uixml","description":"

Provides an XML representation of the phone's user interface.

Protocol: HTTP/HTTPS
Method: GET
Path: /api/v1/mgmt/uixml

Details about the phone's CPU and memory usage.

Protocol: HTTP/HTTPS
Method: GET
Path: /api/v1/mgmt/device/stats

This API provides the phone's call logs.

Protocol: HTTP/HTTPS\nMethod: GET\nPath:\n/api/v1/mgmt/callLogs\n/api/v1/mgmt/callLogs/missed\n/api/v1/mgmt/callLogs/received\n/api/v1/mgmt/callLogs/placed