查询通话

查询指定通话或指定类型的通话详情。

请求地址

{base_url}/{api_path}/call/query?token={token}

请求参数

查询指定通话
参数 是否必选 类型 描述
callid 是 String 每个通话的唯一 ID。
查询指定类型的通话信息
参数 是否必选 类型 描述
type 是 String 查询的通话类型。

取值范围：

  • inbound：查询所有呼入类型的通话。
  • outbound：查询所有呼出类型的通话。

响应参数

参数 类型 描述
calls Array <CallInfo> 通话信息列表。
status String 请求结果。
  • Success：请求成功。
  • Failed：请求失败。
CallInfo
参数 类型 描述
members Array <MemberType> 通话中的不同类型成员的信息列表。
callid String 每个通话的唯一 ID。
MemberType
参数 类型 描述
ext Object <ExtensionInfo> 分机的信息。
inbound Object <InboundInfo> 外线来电的信息。
outbound Object <OutboundInfo> 外线呼出的信息。
ExtensionInfo
参数 类型 描述
number String 分机号码。
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。

示例 1

查询指定通话信息。

请求示例

POST /api/v2.0.0/call/query?token=4dfa215a2a835361425878c43e25dc8d HTTP/1.1
Content-Type:application/json; charset=utf-8
Host: 192.168.5.150

{
    "callid": "1571386069.8"
}
响应示例
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

{
    "Calls": [
		{
		"members": [
			{
			"inbound": {
				"from": "500",
				"to": "1023",
				"trunkname": "siptrunk",
				"channelid": "PJSIP/trunk-API-endpoint-00000005",
				"memberstatus": "ANSWERED"
				}
			},
			{
				"ext": {
					"number": "1023",
					"channelid": "PJSIP/1023-00000006",
					"memberstatus": "ANSWER"
				}
			}
			],
			"callid": "1571386069.8"
		}
	],
	"status": "Success"
    }

示例 2

查询指定类型的通话信息

请求示例
POST /api/v2.0.0/call/query?token=4dfa215a2a835361425878c43e25dc8d HTTP/1.1
Content-Type:application/json; charset=utf-8
Host: 192.168.5.150

{
	"type": "inbound"
}
响应示例
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

{
"Calls": [
		{
			"members": [
				{
					"inbound": {
						"from": "3000",
						"to": "4000",
						"trunkname": "siptrunk",
						"channelid": "PJSIP/trunk-siptrunk-endpoint-000000a2",
						"memberstatus": "ANSWERED"
					}
				},
				{
					"ext": {
						"number": "4000",
						"channelid": "PJSIP/4000-000000a3",
						"memberstatus": "ANSWER"
					}
				}
			],
			"callid": "1571639442.264"
		},
		{
			"members": [
				{
					"inbound": {
						"from": "2000",
						"to": "1023",
						"trunkname": "siptrunk",
						"channelid": "PJSIP/trunk-siptrunk-endpoint-00000098",
						"memberstatus": "ANSWERED"
					}
				},
				{
					"ext": {
						"number": "1023",
						"channelid": "PJSIP/1023-00000099",
						"memberstatus": "ANSWER"
					}
				}
			],
			"callid": "1571639198.248"
		}
	],
	"status": "Success"
}