企业内部开发 服务端API 会议 电话入会(PSTN)管理 获取会议的外呼状态
获取会议的外呼状态
最后更新:2023/04/27
可联系渠道经理采购或代理智慧硬件接口已支持设备 联系渠道经理
获取会议的外呼状态
最后更新:2023/04/27

此接口用于获取外呼电话入会的数据。

  • 无论是从客户端、API 还是 Web 端发起的外呼,在该接口都可以获取到,不针对呼叫人做数据的隔离。
  • 需要分页,分页最大条数100。
  • Webinar 暂不支持外呼。

 

请求方式: POST(HTTPS
请求地址: https://qyapi.weixin.qq.com/cgi-bin/meeting/phone/get_callout_status?access_token=ACCESS_TOKEN

请求包体:

{
	"meetingid": "MEETINGID",
	"cursor": "CURSOR",
	"limit": 10
}

参数说明:

参数必须类型说明
access_tokenstring调用接口凭证。获取方法查看“获取access_token
meetingidstring会议ID
cursorstring分页查询用,将上一个请求返回的next_cursor字段传入。第一次查询时可不传值。
limituint32分页大小,默认20,最大100。

 

权限说明

  • 仅配置在“可调用接口的应用”列表中的自建应用可调用
  • 仅允许获取该应用创建的会议的数据

 

返回结果:

{
	"errcode": 0,
	"errmsg": "ok",
	"phone_numbers": [
		{
			"area": 86,
			"phone": "13333333333",
			"extension_number": "12345678",
			"status": "STATUS",
			"tmp_openid": "TMP_OPENID"
		}
	],
	"next_cursor": "NEXT_CURSOR",
	"has_more": false
}

参数说明

参数类型说明
errcodeint32返回码
errmsgstring对返回码的文本描述内容
phone_numbersobject[]电话号码对象数组。详见PhoneNumber。
next_cursorstring分页用,下一次拉取列表将该字段填入cursor字段
has_morebool是否还有待拉取的列表

PhoneNumber说明

参数类型说明
areauint32国家/地区代码。(例如:中国是86)
phonestring电话号码或固定电话总机号
extension_numberstring固定电话分机号
statusstring外呼状态
tmp_openidstring当场会议的成员临时 ID,可用于会控操作,适用于所有成员。

 

上一篇
批量外呼
下一篇
获取电话入会的成员ID