Query Student Question Customer Callback URL

Updated: 2026-05-12 09:49:17

API Description

Query the currently configured "Student Question" customer callback URL for the current account; if never configured or deleted, data.callbackUrl is an empty string. The read path includes Redis cache (if not found, it falls back to MySQL and writes to cache, with an expiration time of 1 day). The API supports the HTTPS protocol.

API URL

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

Request Method

GET

API Constraints

The API supports both HTTP and HTTPS; HTTPS is recommended.
roomId (query) optional: If not provided, the middleware does not validate the ownership of roomId; if provided, it must be a valid channel ID under the account, consistent with post/delete, to unify parameter conventions with other v5 APIs.

Request Parameter Description

Parameter	Required	Type	Description
appId	true	String	Account appId [See Get Secret Key]
timestamp	true	Long	Current 13-digit millisecond timestamp, valid within 3 minutes
sign	true	String	Signature, a 32-character uppercase MD5 value. `The appSecret key used to generate the signature is critical for communication data security and must never be used directly on the client side. All APIs must be called through the customer's own server to relay to the POLYV server for response data.` [See Signature Generation Rules]
roomId	false	String	Optional; if provided, must be a valid channel ID under the account

Examples

Request example (with optional roomId):

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

Response JSON (configured):

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

Response JSON (not configured):

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

Response Parameter Description

Parameter	Type	Description
code	Integer	200 success; 500 mostly indicates query error
status	String	`success` / `error`
message	String	Usually an empty string on success
data	Object	Contains `callbackUrl` (string, `""` when not configured)

Error Examples

Missing x-auth-user-id:

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

Provided roomId does not match the account:

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

Server error:

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

(The specific message depends on the actual situation.)

Live Streaming Server API