Handset GET

Handset GET
GET /api/handset/{id}

Retrieve detailed information for a single handset.

Result Code

200

OK

401

Unauthorized

404

Handset not found

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/1234

Result;-
200 (OK)
{"id":1909,"name":"Paul Johansen","ipaddress":"10.16.1.52","macaddress":"0004F2BEB091","phonenumbers":["0393196614"],"useragent":"Cisco/SPA525G2-7.5.6","notes":"","enabled":true,"recordinbound":true,"recordoutbound":true,"recordinternal":true,"handsetgroup":"Tech","minimumcalllengthseconds":0,"overlaytonewhilepaused":true,"whendisabledrecordinternalwithenabledhandsets":true}

 

Using Curl

curl "https://api.calln.com/api/handset/{id}" -H "Authorization: Basic username:password | base64" -X GET 

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.