查询分机通话状态
查询单个分机、多个分机或所有分机的通话状态。
请求地址
{base_url}/{api_path}/extension/query_call?token={token}
请求参数
参数 | 是否必选 | 类型 | 描述 |
---|---|---|---|
number | 是 | String | 分机号码。 取值范围:
|
响应参数
参数 | 类型 | 描述 |
---|---|---|
status | String | 请求结果。
|
calllist | Array <ExtesnionInfo> | 分机通话列表。 |
- ExtensionInfo
-
参数 类型 描述 number String 分机号。 numbercalls Array <CallStatus> 分机通话信息。
- CallStatus
-
参数 类型 描述 callid String 每个通话的唯一 ID。 members Array <MemberType> 通话中的不同类型成员的信息列表。
- MemberType
-
参数 类型 描述 ext Object <ExtensionInfo> 分机的信息。 inbound Object <InboundInfo> 外线来电的信息。 outbound Object <OutboundInfo> 外线呼出的信息。 - ExtensionInfo
-
参数 类型 描述 number Integer 分机号码。 channelid String 通话中,每个成员的通话通道 ID。 memberstatus String 该成员的通话状态。 - ALERT:该成员作为主叫,发起呼叫后,处于回铃状态。
- RING:该成员作为被叫,处于响铃状态。
- ANSWERED:该成员作为主叫,发起呼叫后,电话被接听。
- ANSWER:该成员作为被叫,接听来电。
- HOLD:该成员的通话被保持住。
- BYE:该成员主动挂断通话。
callpath Integer 通话建立使用的路径。 注: 通过 IVR、队列、响铃组、广播组或会议室与分机建立通话时,才会携带 callpath。例如:分机 1000 呼叫 IVR (6500),通过 IVR 转拨分机 2000,callpath 即为 6500。
- InboundInfo
-
参数 类型 描述 from Integer 主叫号码。 to Integer 被叫号码。 trunkname String 通过哪条中继呼入。 channelid String 通话中,每个成员的通话通道 ID。 memberstatus String 该成员的通话状态。 - ALERT:该成员作为主叫,发起呼叫后,处于回铃状态。
- RING:该成员作为被叫,处于响铃状态。
- ANSWERED:该成员作为主叫,发起呼叫后,电话被接听。
- ANSWER:该成员作为被叫,接听来电。
- HOLD:该成员的通话被保持住。
- BYE:该成员主动挂断通话。
callpath Integer 通话建立使用的路径。 注: 通过中继、IVR、队列或响铃组与外线号码建立通话时,才会携带 callpath。例如:外线 2203303 呼叫 IVR (6500),通过 IVR 转拨分机 2000,callpath 即为 6500。
- OutboundInfo
-
参数 类型 描述 from Integer 主叫号码。 to Integer 被叫号码。 trunkname String 通过哪条中继呼出。 channelid String 通话中,每个成员的通话通道 ID。 memberstatus String 该成员的通话状态。 - ALERT:该成员作为主叫,发起呼叫后,处于回铃状态。
- RING:该成员作为被叫,处于响铃状态。
- ANSWERED:该成员作为主叫,发起呼叫后,电话被接听。
- ANSWER:该成员作为被叫,接听来电。
- HOLD:该成员的通话被保持住。
- BYE:该成员主动挂断通话。
callpath Integer 通话建立使用的路径。注: 通过 IVR、队列或响铃组与外线号码建立通话时,才会携带 callpath。例如:使用 IVR (6500)拨打外线号码 5503302,callpath 为 6500。
示例
响应示例
POST /api/v2.0.0/extension/query_call?token=4dfa215a2a835361425878c43e25dc8d HTTP/1.1
Content-Type:application/json; charset=utf-8
Host: 192.168.5.150
{
"number": "1000"
}
响应示例
HTTP/1.1 200 OK
Server: Boa/0.94.14rc21
Accept-Ranges: bytes
Connection: close
Content-Type: application/json
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE
{
"status": "Success",
"calllist": [
{
"number": "1084",
"numbercalls": [
{
"callid": "1593507412.76",
"members": [
{
"inbound": {
"from": "31622",
"to": "1084",
"trunkname": "sps-3.183",
"channelid": "PJSIP/trunk-sps-3.183-endpoint-00000034",
"callpath": "1000"
}
},
{
"ext": {
"number": "1084",
"channelid": "PJSIP/1084-00000035"
}
}
]
}
]
}
]
}