Jingl - voice in the cloud
  • Sign Up
  • Login

Talk to us: 1300 0 JINGL

(54645)
Login
.jingl.com.au
Login
Forgot Password
☰
  • Features
  • Benefits
  • Plans
  • Equipment
  • Screenshots
  • Support
  • Contact Us
  • General
    • General
    • Documents
    • Bandwidth
  • Handsets
    • Supported Handsets
    • Other
  • Fax
    • Overview
  • TAPI Integration
    • Overview
  • API
    • Overview
    • Call Search
    • Call Select
    • Call Update
    • Call Create
    • CallRecording Select
    • CallRecording Delete
    • Handset Search
    • Handset Select
    • Handset Update
    • Handset Status Search
    • Handset Status Select
  • How It Works
    • How It Works
  • Number Portability
    • Number Portability
  • International Call Collection
    • Int. Call Collection

GET /api/handsetstatus

Retrieve the status of a single handset.

Result Code

200 OK
401 Unauthorized
404 Handset not found
406 SSL must be used
500 Server Error

Result Body

extensionnumber The unique extension number of the handset.
state The state of the handset, one of Idle, OnCall, Ringing, Calling, OnHold, Unavailable
calldirection The direction of the current call, if any. One of Unknown, Inbound, Outbound, Internal
calldurationseconds The number of seconds the current call, if any, has been connected
otherpartyphonenumber If connected to another party, then the phone number of that party
app If connected to an application, then the name of the application, eg. VoiceMail
registrationaddress The public IP address and port of the current registration if any

Example request

Example;-
GET
https://www.jingl.com.au/api/handset/101

Result;-
200 (OK)
{"extensionnumber":"101", "registeredaddress":"101.100.99.98:1234", "otherpartyphonenumber":"0412341234", "app":"", "calldurationseconds":21, "state":"OnCall", "calldirection":"Outbound"}

  • About Us Support Contact Us Join Jingl
  • Product Information Benefits Features How It Works Plans and Call Rates
  • Product Documentation Privacy Policy Number Portability Terms & Conditions Financial Hardship Policy
  • Contact Us
    1300 0 JINGL
    (1300 0 54645)
    sales@jingl.com.au
    support@jingl.com.au
Jingl implements a very strict Privacy Policy and Security Policy
Jingl is a product of Jingl IT Pty Ltd with ABN: 23 624 989 939.
All text and design is copyright ©2021 Jingl IT Pty Ltd. All rights reserved.