Query Channel Quiz Card List

Updated: 2024-04-23 14:08:27

API Description

1、获取频道的答题卡列表
2、接口支持https协议

API URL

http://api.polyv.net/live/v3/channel/interact/question/list-question

Online API Call

Request Method

GET

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended to ensure security. API calls have frequency limits. See details

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. It must not be stored or used directly on the client side. All APIs must be called through the customer's own server to relay requests to the POLYV server for response data.` [See Signature Generation Rules]
channelId	true	String	Channel ID

Example

https://api.polyv.net/live/v3/channel/interact/question/list-question?appId=frlr1zazn3&sign=21914C8E80403BF527F6061DD79DAE47&channelId=1965681&timestamp=1621843841035

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code. 200 indicates success, non-200 indicates failure [See Global Error Description]
status	String	Response status text
message	String	Response description. When code is 400 or 500, provides additional error details
data	Object	On success, returns the quiz card list information [See data field description]

data Field Description

Parameter	Type	Description
templateId	String	Default question bank template ID
list	Array	Query result list [See Question field description]

Question Field Description

Parameter	Type	Description
questionId	String	Quiz card ID
channelId	String	Channel ID
userId	String	User ID
name	String	Quiz card name
type	String	Type: R for single choice, C for multiple choice, S for rating, V for voting
itemType	Integer	Type: 0 for quiz card, 1 for Q&A
answer	String	Answer
option1 - option15	String	Quiz card options
tips1 - tips5	String	Rating type prompt information
status	String	Status: draft, sent, deleted
times	Integer	Number of times the quiz card has been sent
createdTime	Long	Creation time, 13-digit millisecond timestamp
lastModified	Long	Last modification time of the quiz card, 13-digit millisecond timestamp

Java Request Example

For quick integration of basic code, please download the relevant dependency source code. Click here to download the source code. After downloading, add it to your own source code project. The test cases include HttpUtil.java and LiveSignUtil.java, both contained in the downloaded file.

It is strongly recommended to use the Live Java SDK for API integration. The Live Java SDK provides unified encapsulation and optimization for API call logic, exception handling, data signing, and HTTP request thread pools.

private static final Logger log = LoggerFactory.getLogger(LiveInteractionTest.class);

/**
 * 查询频道答题卡列表
 * @throws IOException
 */
@Test
public void testListQuestion() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId=super.appId;
    String appSecret=super.appSecret;
    String timestamp=String.valueOf(System.currentTimeMillis());
    //业务参数
    String channelId = "4760542";
    String url = "http://api.polyv.net/live/v3/channel/interact/question/list-question";

    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);
    requestMap.put("channelId",channelId);
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.get(url,requestMap);
    log.info("测试查询频答题卡列表接口返回值：{}",response);
    //do somethings
}

Response Example

For global error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "message": "",
    "data": {
        "templateId": "gv0jmmcqdh",
        "list": [
            {
                "questionId": "gv0l1fu5ox",
                "channelId": 4760542,
                "userId": "cf7f07e096",
                "name": "API题目",
                "type": "R",
                "option1": "正确",
                "option2": "错误1",
                "option3": null,
                "option4": null,
                "option5": null,
                "createdTime": null,
                "lastModified": 1712461149000,
                "answer": "A",
                "note": null,
                "templateId": "gv0jmmcqdh",
                "status": "send",
                "times": 1,
                "tips1": null,
                "tips2": null,
                "tips3": null,
                "tips4": null,
                "tips5": null,
                "required": null,
                "scoreEnabled": null,
                "option6": null,
                "option7": null,
                "option8": null,
                "option9": null,
                "option10": null,
                "score": null,
                "itemType": 0,
                "option11": null,
                "option12": null,
                "option13": null,
                "option14": null,
                "option15": null
            }
        ]
    }
}

Error Example

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}

Live Streaming Server API