Handset SEARCH

Handset Search
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

200OK
401Unauthorized
406SSL must be used
500Server Error

RESULT BODY

idThe unique handset id. This will be needed when calling other api functions.
nameThe name.
ipaddress The local IP address.
macaddressThe MAC address.
phonenumbers A list of one or more phone numbers associated with this handset.
callerphonenumberThe caller party phone number.
useragentThe handset user-agent. This for example is the sip client name and version.
notesAny user entered notes.
enabledWhether the handset is enabled for recording. True or False.
recordinboundWhether inbound calls are configured to record. True or False.
recordoutboundWhether outbound calls are configured to record. True or False.
recordinternalWhether internal calls are configured to record. True or False.
handsetgroup The name of any associated handset group.
minimumcalllengthsecondsThe minimum length of call to keep. Value in seconds.
overlaytonewhilepausedWhen recording is paused, overlay a set tone. True or False.
whendisabledrecordinternalwithenabledhandsetsWhen 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}]

 

Calculate your CallN Costs in 60 Seconds

  • Accurate details are needed in order to use the right pricing tier information.
  • The calculator will give you the total cost of the plan according to the total months you specify
  • Accurate details are needed in order to use the right pricing tier information.
  • The calculator will give you the total cost of the plan according to the total months you specify
  • After you sign up, this will be used for your Calln domain.
  • A Team member will contact you on this number.
  • A summary of your calculations will be sent to this email address.
  • You may review our terms and conditions and privacy policies by clicking on the links above.