[FAQ] REST API

SteffenBaierUK · ‎05-23-2018

Since VVX UC Software 5.8.0 the REST API is publicly available to everybody.

27/02/2018: Added Trio Rest API document

Trio UC Software 5.9.5 REST API Document >here<
Trio UC Software 5.9.2 REST API Document >here<
Trio UC Software 5.9.1 REST API Document >here<
Trio UC Software 5.9.0 REST API Document >here<
Trio UC Software 5.8.0 REST API Document >here<

The attached manual applies to the following Polycom models: 101, 150, 201, 250, 300, 301, 310, 311, 350, 400, 401, 410, 411, 450, 500, 501, 600, 601,1500, Trio 8800, Trio 8500, Trio C60, CCX500, CCX600.

UC Software 6.1.0 REST API Document >here<
UC Software 6.0.0 REST API Document >here<
UC Software 5.9.0 REST API Document >here<

To enable simply logon to the Web Interface and browse to Settings > Applications > REST API

This can also be enabled via configuration:

<test apps.restapi.enabled="1" />

IMPORTANT:

The password must be changed from 456 to anything else or the REST API will not work
The Username is Polycom
If this is used with a Phone in Microsoft Teams mode many features do not work as they are not translated via the underlying UC Software to the Microsoft Teams IP phone application

Power Shell Examples

RESET:

Attached is the PDF explaining all supported parameters and below is an example of how to Reset a Phone using Windows Power Shell

$username = "Polycom"
$password = "789" | ConvertTo-SecureString -AsPlainText -Force
$cred = New-Object System.Management.Automation.PSCredential($username,$password)

add-type @"
        using System.Net;
        using System.Security.Cryptography.X509Certificates;

            public class IDontCarePolicy : ICertificatePolicy {
            public IDontCarePolicy() {}
            public bool CheckValidationResult(
                ServicePoint sPoint, X509Certificate cert,
                WebRequest wRequest, int certProb) {
                return true;
            }
        }
"@
[System.Net.ServicePointManager]::CertificatePolicy = new-object IDontCarePolicy 
[System.Net.ServicePointManager]::SecurityProtocol = [System.Net.SecurityProtocolType]::Tls11


 Invoke-RestMethod -Uri "https://10.252.149.61/api/v1/mgmt/safeRestart" -Credential $cred  -Method Post -ContentType "application/json"  -TimeoutSec 2

The above will use the following hardcoded values:

Username: Polycom
Password: 789
Phone IP: 10.252.149.61

Dial a number:

The below example dials 123

$username = "Polycom"
$password = "789" | ConvertTo-SecureString -AsPlainText -Force
$cred = New-Object System.Management.Automation.PSCredential($username,$password)

add-type @"
        using System.Net;
        using System.Security.Cryptography.X509Certificates;

            public class IDontCarePolicy : ICertificatePolicy {
            public IDontCarePolicy() {}
            public bool CheckValidationResult(
                ServicePoint sPoint, X509Certificate cert,
                WebRequest wRequest, int certProb) {
                return true;
            }
        }
"@
[System.Net.ServicePointManager]::CertificatePolicy = new-object IDontCarePolicy 
[System.Net.ServicePointManager]::SecurityProtocol = [System.Net.SecurityProtocolType]::Tls11

 				$body = @"
{
`"data`":
{
`"Dest`": `"123`", 
`"Line`": `"1`",
`"Type`": `"SIP`"
}
}

"@
 Invoke-RestMethod -Uri "https://10.252.149.61/api/v1/callctrl/dial" -Credential $cred  -body $body -Method Post -ContentType "application/json"  -TimeoutSec 2

LineInfo:

The below prints the Line Info

$username = "Polycom"
$password = "789" | ConvertTo-SecureString -AsPlainText -Force
$cred = New-Object System.Management.Automation.PSCredential($username,$password)

add-type @"
        using System.Net;
        using System.Security.Cryptography.X509Certificates;

            public class IDontCarePolicy : ICertificatePolicy {
            public IDontCarePolicy() {}
            public bool CheckValidationResult(
                ServicePoint sPoint, X509Certificate cert,
                WebRequest wRequest, int certProb) {
                return true;
            }
        }
"@
[System.Net.ServicePointManager]::CertificatePolicy = new-object IDontCarePolicy 
[System.Net.ServicePointManager]::SecurityProtocol = [System.Net.SecurityProtocolType]::Tls11
 Invoke-RestMethod -Uri "https://10.252.149.61/api/v1/mgmt/lineInfo" -Credential $cred  -Method Get -ContentType "application/json"  -TimeoutSec 2

Simulate Touch:

$step1=$args[0]
$username = "Polycom"
$password = "789" | ConvertTo-SecureString -AsPlainText -Force
$cred = New-Object System.Management.Automation.PSCredential($username,$password)

add-type @"
        using System.Net;
        using System.Security.Cryptography.X509Certificates;

            public class IDontCarePolicy : ICertificatePolicy {
            public IDontCarePolicy() {}
            public bool CheckValidationResult(
                ServicePoint sPoint, X509Certificate cert,
                WebRequest wRequest, int certProb) {
                return true;
            }
        }
"@
[System.Net.ServicePointManager]::CertificatePolicy = new-object IDontCarePolicy 
[System.Net.ServicePointManager]::SecurityProtocol = [System.Net.SecurityProtocolType]::Tls11

 				$body = @"
{`"data`": {`"Type`": `"Tap`", `"Positions`": [
{`"X`": `"70`",`"Y`": `"34`"}
]}}

"@
 Invoke-RestMethod -Uri "https://$step1/api/v1/mgmt/simulateTouch" -Credential $cred  -body $body -Method Post -ContentType "application/json"  -TimeoutSec 2

The above example add's the IP address to the PowerShell command aka:

.\REST_API_simulateTouch.ps1 10.252.149.62

It expects a hardcoded Password of:

789

and hardcoded coordinates of the X and Y

70 and 34

Which in this example is the Missed Call Icon on a VVX600

Touch using a Swipe motion from left to right:

$step1=$args[0]
$username = "Polycom"
$password = "789" | ConvertTo-SecureString -AsPlainText -Force
$cred = New-Object System.Management.Automation.PSCredential($username,$password)

add-type @"
        using System.Net;
        using System.Security.Cryptography.X509Certificates;

            public class IDontCarePolicy : ICertificatePolicy {
            public IDontCarePolicy() {}
            public bool CheckValidationResult(
                ServicePoint sPoint, X509Certificate cert,
                WebRequest wRequest, int certProb) {
                return true;
            }
        }
"@
[System.Net.ServicePointManager]::CertificatePolicy = new-object IDontCarePolicy 
[System.Net.ServicePointManager]::SecurityProtocol = [System.Net.SecurityProtocolType]::Tls11

 				$body = @"
{
`"data`": {`"Type`": `"Swipe`", `"Positions`": [
{`"X`": `"68`",`"Y`": `"121`"}
,
{`"X`": `"320`",`"Y`": `"156`"}
],
`"Duration`": `"100`"
}
}

"@
 Invoke-RestMethod -Uri "https://$step1/api/v1/mgmt/simulateTouch" -Credential $cred  -body $body -Method Post -ContentType "application/json"  -TimeoutSec 2

The above original example is now using additional Swipe motion with new coordinates

The above example "swipes" the screen during an active call to the display showing the Line View

Setting Device Parameters:

$step1=$args[0]
$username = "Polycom"
$password = "789" | ConvertTo-SecureString -AsPlainText -Force
$cred = New-Object System.Management.Automation.PSCredential($username,$password)

add-type @"
        using System.Net;
        using System.Security.Cryptography.X509Certificates;

            public class IDontCarePolicy : ICertificatePolicy {
            public IDontCarePolicy() {}
            public bool CheckValidationResult(
                ServicePoint sPoint, X509Certificate cert,
                WebRequest wRequest, int certProb) {
                return true;
            }
        }
"@
[System.Net.ServicePointManager]::CertificatePolicy = new-object IDontCarePolicy 
[System.Net.ServicePointManager]::SecurityProtocol = [System.Net.SecurityProtocolType]::Tls11

 				$body = @"
{
`"data`":
{
`"device.set`": `"1`", 
`"device.prov.serverName.set`": `"1`",
`"device.prov.serverName`": `"10.252.149.102`"
}
}

"@
 Invoke-RestMethod -Uri "https://$step1/api/v1/mgmt/config/set" -Credential $cred  -body $body -Method Post -ContentType "application/json"  -TimeoutSec 8

The above example sets the Provisioning Server to 10.252.149.102

Batch Processing:

Example Power Shell to read a text file (ip.txt) containing a list of IP addresses and executing this to all IP's in the List:

$username = "Polycom"
$password = "789" | ConvertTo-SecureString -AsPlainText -Force
$cred = New-Object System.Management.Automation.PSCredential($username,$password)

add-type @"
        using System.Net;
        using System.Security.Cryptography.X509Certificates;

            public class IDontCarePolicy : ICertificatePolicy {
            public IDontCarePolicy() {}
            public bool CheckValidationResult(
                ServicePoint sPoint, X509Certificate cert,
                WebRequest wRequest, int certProb) {
                return true;
            }
        }
"@
[System.Net.ServicePointManager]::CertificatePolicy = new-object IDontCarePolicy 
[System.Net.ServicePointManager]::SecurityProtocol = [System.Net.SecurityProtocolType]::Tls11

$phoneips = Get-Content "C:\temp\restapi\ip.txt"
foreach($phoneip in $phoneips)
{
$url = "https://" + $phoneip + "/api/v1/mgmt/skype/signOut"
Invoke-RestMethod -Uri $url -Credential $cred  -Method Post -ContentType "application/json"
}

ip.txt:

10.252.149.67
10.252.149.59

The above expects the IP list to be in C:\temp\restapi\ip.txt and has hardcoded values for Username and Password.

It will execute a POST REST Api to sign out the list of IP addresses of phones from Skype for Business

Curl Examples:

EDIT: Windows 10 version 1809 or later comes with CURL via the MS-Dos Command line

REST API command Format for GET:

curl -X GET -H "Content-Type: application/JSON" http://Polycom:789@10.221.72.163/api/v1/mgmt/transferType/get

HTTPS Example:

curl -k -X GET -H "Content-Type: application/JSON" https://Polycom:777@10.252.149.59/api/v1/mgmt/network/stats

the -k disables the certificate check

For POST Method to dial a number:

curl -d "{\"data\": {\"Dest\": 123,\"Line\": 1,\"Type\": \"SIP\"}}" -H "Content-Type: application/json" http://Polycom:789@10.221.72.163/api/v1/callctrl/dial

the -d is being used to send the actual data

Signing Into Skype for Business:

curl -k -d "{\"data\": {\"Address\": \"test.user@poly.com\",\"User\": \"test.user@poly.com\",\"Password\": \"MyPassword\", \"Domain\":\"\" ,\"LockCode\":\"\" }}" -H "Content-Type: application/json" https://Polycom:789@10.252.149.60/api/v1/mgmt/skype/signIn

-k is for HTTPS and -d is the data

In the above, we used Skype for Business online with the Username and Sign In address the same. We did not supply a Domain or a code to unlock the phone.

Sign Out of Skype

curl -X POST -H "Content-Type: application/json" -d "" -k https://Polycom:789@10.252.149.59/api/v1/mgmt/skype/signOut

In the below example, we change the Provisioning Server via Device Parameters

curl -k -d "{\"data\": {\"device.set\": \"1\",\"device.prov.serverName.set\": \"1\",\"device.prov.serverName\": \"10.252.149.102\" }}" -H "Content-Type: application/json" https://Polycom:789@10.252.149.62/api/v1/mgmt/config/set

Restart Example:

curl -X POST -H "Content-Type: application/json" -d "" http://Polycom:777@10.252.149.59/api/v1/mgmt/safeRestart

in this case, we use the -d as the device does not like an empty CURL request and would answer with a "411 Length Required" error

Get Call Details and Hangup Call:

In order to get the call reference via the REST API use the webCallControl/callStatus

curl -k -X GET -H "Content-Type: application/JSON" https://Polycom:789@10.252.149.62/api/v1/webCallControl/callStatus

The above will return this:

{"data": {"CallHandle": "0x2341880", "LineId": "1", "Type": "Outgoing", "Protocol": "Sip", "CallState": "Connected", "RemotePartyName": "123", "DurationInSeconds": "2", "RemotePartyNumber": "123"}, "Status": "2000"}

The CallHandle Value without the 0x is the Call_Reference.

Disconnecting the call:

curl -d "{\"data\": {\"Ref\": 2341880}}" -H "Content-Type: application/JSON" -k https://Polycom:789@10.252.149.62/api/v1/callctrl/endCall

Ends the call:

{"Status": "2000"}

Batch Processing:

Example MS-Dos Batch file to read a text file (ip.txt) containing a list of IP addresses and executing this to all IP's in the List:

@echo off
echo Reading ip.txt
for /F "tokens=1" %%i in (ip.txt) do curl -i -X POST -H "Content-Type: application/json" -d "" -k https://Polycom:789@%%i/api/v1/mgmt/updateConfiguration

ip.txt:

10.252.149.67
10.252.149.59

The above expects the IP list to be in C:\temp\restapi\ip.txt and has hardcoded values for Username and Password.

It will execute a POST REST Api force the phone to update the configuration of its provisioning server based on the list of IP addresses of phones in the IP.txt

Using POSTMAN to send and Receive REST API info:

Sending a GET request

Select GET as the request type
Enter the full address and REST command into the command bar
Click the Authorization tab and enter the required username and password as “Basic Auth”
Optionally, add the command to a “collection” so that it is easily resent at a later time without re-writing the full command.
Press the send button, the response will appear in the box below
Select “JSON” as the display type

Sending a POST request

Select POST as the request type
Enter the full address and REST command into the command bar
Click the Authorization tab and enter the required username
Click the “Body” tab and select the “Raw” radio button
Choose “JSON” as the format if you would like syntax highlighting
Enter the required parameters in JSON format
Optionally, add the command to a “collection” so that it is easily resent at a later time without re-writing the full command.
Press the send button, the response will appear in the box below
Select “JSON” as the display type

Troubleshooting:

Set the Presentation and the overall logging to Debug:

Settings > Logging > Global Settings > Global Log Level Limit > Debug
Settings > Logging > Module Log Level Limits > Rest API > Debug

And check Diagnostics > View & Download Logs > UCS Application

0904183359|rest |0|00|At wappRestApiHandlerC::Handle. Received request is NOT for REST API handler. path=/Diagnostics/log
0904183359|rest |0|00|At wappRestApiHandlerC::Handle. Received request is NOT for REST API handler. path=/images/ajax-loader.gif
0904183405|rest |0|00|At wappRestApiHandlerC::Handle. Authentication failed, sending authDemand
0904183405|rest |0|00|At wappRestApiHandlerC::Handle. Moved REST API to request processing mode.
0904183405|rest |0|00|At wappRestApiHandlerC::Handle. Request's HTTP method POST
0904183405|rest |0|00|At wappRestApiHandlerC::Handle. JSON prepared as per input parameters - {
"data": {
"Type": "Tap", 
"Positions": [
{
"X": "70",
"Y": "34"
}
]
}
}

0904183405|rest |0|00|At wappRestApiHandlerC::Handle. Returning from Handle.
0904183407|rest |0|00|At wappRestApiHandlerC::Handle. Received request is NOT for REST API handler. path=/images/ajax-loader.gif

Finding the Coordinates of the Touch Screen:

Set the Presentation and the overall logging to Debug:

Settings > Logging > Global Settings > Global Log Level Limit > Debug
Settings > Logging > Module Log Level Limits > Presentation > Event 3 or Trio/CCX Event 1

Touch the screen at the desired position:

0904183707|pgui |3|00|CLayoutMgr::onFilteredMouseEvent: mouse event detected at (x,y)=(438,254), state = 1, wheel = 0

In the above example, I touched the more Softkey on a VVX600

----------------
The title Polycom Employee & Community Manager is a community setting and does not reflect my role. I am just a simple volunteer in the community like everybody else. My official "day" Job is 3rd Level support at Poly but I am unable to provide official support via the community.

----------------

Notice: This community forum is not an official Poly support resource, thus responses from Poly employees, partners, and customers alike are best-effort in attempts to share learned knowledge. If you need immediate and/or official assistance please open a service ticket through your proper support channels.
Please also ensure you always check the VoIP , Video Endpoint , Skype for Business , PSTN or RPM FAQ's