Query Inbound Calls

Get detailed information like caller, callee, call status, etc. of the active inbound calls of the PBX.


POST /api/v1.1.0/inbound/query?token={token}

Request Parameters

  • Sending no parameter means query all information.
  • With parameters in request, developers could query specific information. Separate them with ,.
Name Importance Type Description
inboundid Required Int Query all inbound calls.
Note: Obtain the inboundid value from Inbound Call Report.

Response Parameters

Name Type Description
inbound Object Inbound calls: calls from external numbers through the trunks.
inboundid Int The inbound ID. With this parameter, operations like forwarding, query, and hangup can be performed on this inbound call.
from String The caller's number.
to String The callee's number.
callee Object The called party of an inbound call, could be an extension, IVR, or an outbound ID.
trunk String The name of the trunk that passes the inbound call.
status String Call status.
  • Talking: talking on the call.
  • Progress: progressing the call .
  • Wait: call waiting.


Request Example

POST /api/v1.1.0/inbound/query?token=1e3b3ebb6a974cb42ed31de5413df52d HTTP/1.1
Content-Type:application/json; charset=utf-8
Host: api.yeastarcloud.com
    "inboundid": "1495698433.203"
Response Example
HTTP/1.1 200 OK
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE
    "status": "Success",
    "inbound": [
            "inboundid": "1495698433.203",
            "from": "1000",
            "to": "1002",
            "trunk": "SIP-142",
            "status": "Talking",
            "callee": [
                    "extid": "1002"