接口描述
描述:
会议创建者、主持人、联席主持人可以查询 PSTN 的 ms_open_id。
ms_open_id 是 PSTN 的识别标识,用户拨号进入后,在实时参会列表等 API 及 Webhook 中可以获取。
由于可能出现一个座机号同时拨入的情况,所以同一个座机号可能对应多个 ms_open_id。
仅当 PSTN 接通后,该接口会返回对应的 ms_open_id。
支持查询会议下 PSTN 的历史 ms_open_id 列表。
请求方式:POST
鉴权方式:JWT 鉴权
接口请求域名:
https://api.meeting.qq.com/v1/meetings/{meeting_id}/phone/ms-open-id
输入参数
参数名称 | 必选 | 参数类型 | 参数描述 |
meeting_id | 是 | String | 会议 ID。 |
operator_id | 是 | String | 操作者 ID。 会议创建者、主持人、联席主持人可以调用该接口。 operator_id 必须与 operator_id_type 配合使用。根据 operator_id_type 的值,operator_id 代表不同类型。 |
operator_id_type | 是 | Number | 操作者 ID 的类型: 1:企业内用户 userid |
phone_numbers | 是 | PhoneNumbers 对象数组 | 外呼的电话号码对象数组。 |
PhoneNumbers 对象数组
参数名称 | 必选 | 参数类型 | 参数描述 |
area | 是 | Number | 国家/地区代码。(例如:中国是86)。 |
phone | 是 | String | 电话号码或固定电话总机号。 |
extension_number | 否 | String | 固定电话分机号。 |
输出参数
参数名称 | 必选 | 参数类型 | 参数描述 |
meeting_id | 是 | String | 会议的唯一 ID。 |
ms_open_id_list | 是 | MsOpenIdList 对象数组 | 返回的 ms_open_id 对象数组。 |
MsOpenIdList 对象数组
参数名称 | 必选 | 参数类型 | 参数描述 |
area | 是 | Number | 国家/地区代码。(例如:中国是86)。 |
phone | 是 | String | 电话号码或固定电话总机号。 |
extension_number | 否 | String | 固定电话分机号。 |
ms_open_id | 是 | String | 当场会议的用户临时 ID,可用于会控操作,适用于所有用户。 |
错误码列表
状态码 | 错误码 | 错误描述 |
400 | 9042 | 无权限进行该操作,建议检查操作者身份或资源归属。 |
400 | 190457 | 会议不存在, 请核对 meeting_id。 |
400 | 190004 | 参数非法,请对照接口文档检查您的参数。 |
500 | 190001 | 存在未注册的用户。 |
示例
输入示例
{"operator_id":"songe","operator_id_type":2,"phone_numbers":[{"area":86,"phone":"13888888888",}]}
输出示例
{"meeting_id":"1111111111111","ms_open_id_list":[{"area":86,"phone":"13888888888","ms_open_id":"xxxx"}]}