保利威文档中心

帮助中心

查询学员提问客户回调地址

更新时间:2026-05-12 09:49:17

接口描述

查询当前账号已配置的「学员提问」客户回调 URL;若从未配置或已删除,则 data.callbackUrl 为空字符串。 读取路径带 Redis 缓存(未命中时回源 MySQL 并写入缓存,过期时间 1 天)。 接口支持 HTTPS 协议。

接口URL

https://api.polyv.net/live/v5/chat/redirect/channel/student-question-webhook/get

请求方式

GET

接口约束

1、接口同时支持 HTTP、HTTPS,建议使用 HTTPS。
3、**roomId(query)可选**:不传时,中间件对 roomId 不做归属校验;若传入,则须为该账号下合法频道号,与 post/delete 一致,便于与其它 v5 接口统一传参习惯。

请求参数描述

参数名 必选 类型 说明
appId true String 账号appId【详见获取密钥
timestamp true Long 当前13位毫秒级时间戳,3分钟内有效
sign true String 签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则
roomId false String 可选;传入时须为该账号下合法频道号

示例

请求示例(带可选 roomId):

GET https://api.polyv.net/live/v5/chat/redirect/channel/student-question-webhook/get?roomId=412738

响应体 JSON(已配置):

{
  "code": 200,
  "status": "success",
  "message": "",
  "data": {
    "callbackUrl": "https://your-server.example.com/api/polyv/student-question"
  }
}

响应体 JSON(未配置):

{
  "code": 200,
  "status": "success",
  "message": "",
  "data": {
    "callbackUrl": ""
  }
}

响应参数描述

参数名 类型 说明
code Integer 200 成功;500 多为查询异常
status String success / error
message String 成功时多为空字符串
data Object callbackUrl(string,未配置时为 ""

异常示例

未传 x-auth-user-id

{
  "code": 400,
  "status": "fail",
  "message": "accountId is required"
}

传入的 roomId 与账号不匹配:

{
  "code": 400,
  "status": "fail",
  "message": "roomId非法"
}

服务端异常:

{
  "code": 500,
  "status": "error",
  "message": "unknown error"
}

(具体 message 以实际为准。)

联系客服,在线咨询