Query Outbound Calls

Get detailed information like caller, callee, call status, etc. of all calls dialing out via the trunks of the PBX.


POST /api/v1.1.0/outbound/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
outboundid Required Int Query all outbound calls.
Note: Obtain the ouboundid value from CDR.

Response Parameters

Name Type Description
outbound Object Outbound calls: calls to external numbers.
outboundid String The outbound ID. With this parameter, operations like forwarding, query, and hangup can be performed on the outbound call.
from String The caller's number.
to String The callee's number.
trunk String The name of the trunk that passes the outbound call.
status String Call status.
  • Talking: talking on the call .
  • Progress: progressing the call .
  • Wait: call waiting.


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