GET /API/HANDSET
Search for handset(s) within the search criteria.
QUERY STRING PARAMETERS
| afterid optional | After retrieving a previous result set, include only records after the previous maximum id. |
|---|---|
| maxresults optional | The maximum amount of records to return. The default value is 100 with a maximum value of 1,000. |
| enabled optional | Only return records matching this enabled status. Value true or false. |
| name optional | Only return records matching this name. |
| phonenumber optional | Only return records containing this as one of the associated phone numbers. |
RESULT CODE
| 200 | OK |
|---|---|
| 401 | Unauthorized |
| 406 | SSL must be used |
| 500 | Server Error |
RESULT BODY
| id | The unique handset id. This will be needed when calling other api functions. |
|---|---|
| name | The name. |
| ipaddress | The local IP address. |
| macaddress | The MAC address. |
| phonenumbers | A list of one or more phone numbers associated with this handset. |
| callerphonenumber | The caller party phone number. |
| useragent | The handset user-agent. This for example is the sip client name and version. |
| notes | Any user entered notes. |
| enabled | Whether the handset is enabled for recording. True or False. |
| recordinbound | Whether inbound calls are configured to record. True or False. |
| recordoutbound | Whether outbound calls are configured to record. True or False. |
| recordinternal | Whether internal calls are configured to record. True or False. |
| handsetgroup | The name of any associated handset group. |
| minimumcalllengthseconds | The minimum length of call to keep. Value in seconds. |
| overlaytonewhilepaused | When recording is paused, overlay a set tone. True or False. |
| whendisabledrecordinternalwithenabledhandsets | When recording is disabled, enable this if you also don’t want to keep calls associated with another enabled internal handset. True or False. |
EXAMPLE REQUEST
Example;-
GET
https://api.calln.com/api/handset?enabled=true
Result;-
200 (OK)
[{"id":1897,"name":"Switchboard","ipaddress":"10.16.2.1","macaddress":"00E0DB0F193A","phonenumbers":["0393196500"],"useragent":"","notes":"","enabled":true,"recordinbound":true,"recordoutbound":true,"recordinternal":true,"handsetgroup":"","minimumcalllengthseconds":0,"overlaytonewhilepaused":true,"whendisabledrecordinternalwithenabledhandsets":true},{"id":1898,"name":"Kala Vani","ipaddress":"10.16.1.11","macaddress":"0004F24D33DB","phonenumbers":["0393196602"],"useragent":"","notes":"","enabled":true,"recordinbound":true,"recordoutbound":true,"recordinternal":true,"handsetgroup":"Customer Support","minimumcalllengthseconds":0,"overlaytonewhilepaused":true,"whendisabledrecordinternalwithenabledhandsets":true},{"id":1899,"name":"Nils Long","ipaddress":"10.16.1.147","macaddress":"0004F24CA02A","phonenumbers":["0393196604"],"useragent":"","notes":"","enabled":true,"recordinbound":true,"recordoutbound":true,"recordinternal":true,"handsetgroup":"Finance","minimumcalllengthseconds":0,"overlaytonewhilepaused":true,"whendisabledrecordinternalwithenabledhandsets":true},{"id":1900,"name":"Mark Fotheringham","ipaddress":"10.16.1.100","macaddress":"0004F2BEA415","phonenumbers":["0393196605"],"useragent":"","notes":"","enabled":true,"recordinbound":true,"recordoutbound":true,"recordinternal":true,"handsetgroup":"","minimumcalllengthseconds":0,"overlaytonewhilepaused":true,"whendisabledrecordinternalwithenabledhandsets":true}]
USING CURL
curl "https://api.calln.com/api/handset?enabled=true" -H "Authorization: Basic username:password | base64" -X GET
