查询来电

查询当前外部来电的详细信息,如:主叫、被叫、通话状态、通过的中继等。

Endpoint

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

请求参数

  • 不带参数表示查询所有。
  • 带参数表示查询单个或多个,多个时需用 , 隔开。
名称 是否必需 类型 描述
inboundid Int 外线来电编号。
注: 从 PBX 发送的通话报告中获取 inboundid 的值。

响应参数

名称 类型 描述
inbound Object 来电,由外线呼入的外部通话。
inboundid Int 外线来电编号,通过该参数对来电进行转接、查询、挂断等操作。
from String 主叫号码。
to String 被叫号码。
callee Object 来电的通话方,可能为分机、IVR、去电。
trunk String 呼入时通过的中继名。
status String 通话状态
  • Talking:通话进行中。
  • Progress:呼叫处理中。
  • Wait:呼叫等待。

实际示例

请求示例

POST /api/v1.1.0/inbound/query?token=1e3b3ebb6a974cb42ed31de5413df52d HTTP/1.1
Content-Type:application/json; charset=utf-8
Host: 192.168.5.150
{
    "inboundid": "1495698433.203"
}
响应示例
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"
                }
            ]
        ]
    }