文档帮助平台
首页服务端API参考 统计分析 查询企业通话记录列表
查询企业通话记录列表
更新时间：2025-05-30 07:51:29

查询企业通话记录列表

请求方法

GET

请求地址

/metrics/calls

请求参数

参数 参数类型 参数类型 是否必须 描述
from Query Long 是 会议开始时间的查询起始时间戳，UNIX时间戳（毫秒）
to Query Long 是 会议开始时间的查询截止时间戳，UNIX时间戳（毫秒）
peerType Query Integer 是 通话类型，1：meeting；2：p2p
type Query Integer 否 会议类型，1：VMR；2：预约会议；3：即时会议，该参数适用于通话类型为meeting
callerType Query String 否 主叫方类型，user：用户账号；device：硬件设备账号，该参数适用于通话类型为p2p
calleeType Query String 否 被叫方类型，user：用户账号；device：硬件设备账号，该参数适用于通话类型为p2p
limit Query Long 否 返回的数量限制，默认10，最大100
offset Query Long 否 跳过的记录数，默认为0

HTTP状态码

返回值 描述
200 操作成功，详见响应参数
400 客户端传参异常
401 鉴权失败
500 服务端异常

响应参数

参数 数据类型 描述
offset Long 偏移量
limit Long 返回最大数量
total Long 总数据量
data Call[] 通话记录对象数组，当通话类型为meeting时，仅Call对象的meeting属性有返回值；当通话类型为p2p时，仅Call对象的p2p属性有返回值

Call对象定义

参数 数据类型 描述
conference Conference 视频会议通话记录信息
p2p P2P P2P通话记录信息

Conference对象定义

参数 数据类型 描述
id String 会议记录id
type Integer 会议类型，1：VMR；2：预约会议；3：即时会议
number String 会议号码
subject String 会议主题
startTimeStamp Long 预约开始时间戳，UNIX时间戳（毫秒）
endTimeStamp Long 预约结束时间戳，UNIX时间戳（毫秒）
realStopTimeStamp Long 实际停止时间戳，UNIX时间戳（毫秒）
isRecurrence Boolean 是否是周期会议
organizerName String 组织者名称
maxParticipantNum Integer 最大并发数
isRTMP Boolean 是否RTMP
enableRecording Boolean 是否开启录制
duration Long 通话时长
rtmpDuration Long 直播总时长，单位毫秒
rtmpStartTimeStamp Long 直播开始时间戳，-1表示未开始
rtmpWatchCount Integer 直播总观看人次

P2P对象定义

参数 数据类型 描述
id String 通话记录id
startTimeStamp Long 开始时间戳，UNIX时间戳（毫秒）
endTimeStamp Long 结束时间戳，UNIX时间戳（毫秒）
duration Integer 通话时长
answerTimeStamp Long 接通时间戳，UNIX时间戳（毫秒）
calleeDisplayName String 被叫方名称
calleeNumber String 被叫方账号
calleeType String 被叫方设备类型，user：用户账号；device：硬件设备账号
calleeUserAgent String 被叫方设备型号
callerDisplayName String 主叫方名称
callerNumber String 主叫方账号
callerType String 主叫方设备类型，user：用户账号；device：硬件设备账号
callerUserAgent String 主叫方设备型号
displayInfo String 显示信息

请求消息示例

GET /open/api/v2/metrics/calls?from=1583723997045&to=1583823997045&peerType=1    HTTP/1.1
Host: api.yealink.com
Content-Type: application/json

响应消息示例

HTTP/1.1 200 
Content-Type: application/json;charset=UTF-8

{
	"offset": 0,
	"limit": 10,
	"total": 1,
	"data": [{
		"conference": {
			"id": "A_8100000007323990497",
			"number": "237559*55704",
			"type": 3,
			"subject": "zd's video meeting",
			"organizerName": "zd",
			"isRTMP": false,
			"enableRecording": false,
			"isRecurrence": false,
			"startTimeStamp": 1583827208448,
			"endTimeStamp": 1583827250400,
			"realStopTimeStamp": 1583827250870,
			"duration": 41,
			"maxParticipantNum": 1,
			"rtmpDuration": 0,
			"rtmpStartTimeStamp": 0,
			"rtmpWatchCount": 0,
			"recurrence": false,
			"rtmp": false
		},
		"p2p": null
	}]
}

CURL命令示例

curl -XGET -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1GSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjo1NCwiZXgiOjE1ODMxMTc3MzMxNzMsInQiOiJvIiwiY2kiOiIxZGU3MzA4YzZlYzM0YmZlODY5OWY0ZmQ0ZjZlMWE4MyIsInBpZCI6IjE5MmI4NmM4MzNhMDQ5OGFiNWU5NTgwMGE0YWMxOWU4IiwianRpIjoiMTkwYzljMDgxMzA2NDQ3M2IxZTI0MDY4YzE1OWFmOWEifQ.UPbzEA5i4To9SAWXor-KU835cBaRp3Ws_aZI6MHIrcqy8l2BSXz_XdgiGU5D3Cv0QwF7Bt9oWScNOspk4AbWVRTtYMhQfsVuemwBHD7BVth3UiBJDyScl-kcoQ_2vajUlv-pglcCQtNLfPyzH6Dk1gKzcrMSmYRKtIjqNyuFOmg' -H 'timestamp: 1583742732181' -H 'nonce: 53f0765fadb54fb6b002f3baac2d5ec8' -H 'Content-type: application/json' 'https://api.yealink.com/open/api/v2/metrics/calls?from=1583723997045&to=1583823997045&peerType=1'
本页目录