查询通话

查询正在进行中的通话的详细信息。

请求 URL

GET {base_url}/{api_path}/call/query?access_token={access_token}

请求参数

查询指定通话
表 1.
参数 是否必填 类型 说明
call_id 是 String 通话的唯一 ID。
注： 可在 (30011) 通话状态变更 事件报告中获取通话的唯一 ID。
查询指定通讯类型的通话
表 2.
参数 是否必填 类型 说明
type 是 String 通讯类型。

取值范围：

  • inbound：查询外线呼入的通话。
  • outbound：查询外线呼出的通话。
  • internal：查询内部通话。
查询指定分机的通话
表 3.
参数 是否必填 类型 说明
extension 是 String 分机号码。

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
data Array<Call_Info> 通话详情。
Call_Info
表 4.
参数 类型 说明
call_id String 通话的唯一 ID。
members Array<Members> 通话中不同类型成员的信息列表。
Members
表 5.
参数 类型 说明
extension Object<Extension_Info> 分机的信息。
inbound Object<Inbound_Info> 外线呼入的信息。
outbound Object<Outbound_Info> 外线呼出的信息。
Extension_Info
表 6.
参数 类型 说明
number String 分机号码。
channel_id String 通话中每个成员的通话通道 ID。
member_status String 该成员的通话状态。
  • ALERT：该成员作为主叫，发起呼叫后，处于回铃状态。
  • RING：该成员作为被叫，处于响铃状态。
  • ANSWERED：该成员作为主叫，发起呼叫后，电话被接听。
  • ANSWER：该成员作为被叫，接听来电。
  • HOLD：该成员的通话被保持。
  • BYE：该成员主动挂断通话。
call_path String 通话建立使用的路径。
注： 当通过 IVR、队列、响铃组、广播组或会议室与分机建立通话时，才会返回值。

例如：用户呼叫 IVR (6400)，并通过 IVR 转拨分机 2000，则 call_path 返回 "6400"。
Inbound_Info
表 7.
参数 类型 说明
from String 主叫号码。
to String 被叫号码。
trunk_name String 通过哪条中继呼入。
channel_id String 通话中每个成员的通话通道 ID。
member_status String 该成员的通话状态。
  • ALERT：该成员作为主叫，发起呼叫后，处于回铃状态。
  • RING：该成员作为被叫，处于响铃状态。
  • ANSWERED：该成员作为主叫，发起呼叫后，电话被接听。
  • ANSWER：该成员作为被叫，接听来电。
  • HOLD：该成员的通话被保持。
  • BYE：该成员主动挂断通话。
call_path String 通话建立使用的路径。
注： 当通过 IVR、队列、响铃组、广播组或会议室与分机建立通话时，才会返回值。

例如：用户呼叫 IVR (6400)，并通过 IVR 转拨分机 2000，则 call_path 返回 "6400"。
Outbound_Info
表 8.
参数 类型 说明
from String 主叫号码。
to String 被叫号码。
trunk_name String 通过哪条中继呼出。
channel_id String 通话中每个成员的通话通道 ID。
member_status String 该成员的通话状态。
  • ALERT：该成员作为主叫，发起呼叫后，处于回铃状态。
  • RING：该成员作为被叫，处于响铃状态。
  • ANSWERED：该成员作为主叫，发起呼叫后，电话被接听。
  • ANSWER：该成员作为被叫，接听来电。
  • HOLD：该成员的通话被保持。
  • BYE：该成员主动挂断通话。
call_path String 通话建立使用的路径。
注： 当通过 IVR、队列、响铃组、广播组或会议室与分机建立通话时，才会返回值。

例如：用户呼叫 IVR (6400)，并通过 IVR 转拨分机 2000，则 call_path 返回 "6400"。

示例

请求示例

通过通话的唯一 ID 查询指定通话。

GET /openapi/v1.0/call/query?access_token=bKLJMkg5taCtUEdDy7MmLZfRXqiDEboh&call_id=1650012665.266 HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "data": [
        {
            "call_id": "1650012665.266",
            "members": [
                {
                    "extension": {
                        "number": "2000",
                        "channel_id": "PJSIP/2000-0000008a",
                        "member_status": "ANSWERED",
                        "call_path": ""
                    }
                },
                {
                    "outbound": {
                        "from": "2000",
                        "to": "1003",
                        "trunk_name": "test-peer-trunking",
                        "channel_id": "PJSIP/trunk-test-peer-trunking-endpoint-0000008b",
                        "member_status": "ANSWER",
                        "call_path": ""
                    }
                }
            ]
        }
    ]
}