Stop Answer Card

Updated: 2024-04-22 19:18:32

Interface Description

1、停止答题卡
2、接口支持https协议

Interface URL

http://api.polyv.net/live/v4/channel/question/stop

Request Method

POST

Interface Constraints

The interface supports both HTTP and HTTPS. HTTPS is recommended to ensure interface security. Interface calls have frequency limits. See details
If parameters are incorrect, a 400 exception will be returned.

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 for 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 on the client side for direct use. 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	Integer	Channel ID
questionId	true	String	Answer card ID

Example

http://api.polyv.net/live/v4/channel/question/stop?channelId=4760542&questionId=gv0uf9s5v7&timestamp=1712480998000&appId=fso8gzbxlr&sign=72BA87A7BB04EC47C209AAC10D4BC103

Response Description

Parameter	Type	Description
code	Integer	Status code, same as HTTP status code, used to determine the basic response status
status	String	Response result, determined by business logic. Returns success on success, error on failure
success	Boolean	Whether the response was successful
requestId	String	Request ID, a unique UUID generated for each request. Only used for troubleshooting and debugging, not related to business logic
error	Object	Error information when status code is not 200 See Error Field Description
data	Object	Detailed response information See data Field Description

Error Response Description

Parameter	Type	Description
code	Integer	Error code, used to determine the specific error reason
desc	String	Error description, corresponding to error.code

data Response Description

Parameter	Type	Description
answer	String	Correct answer
type	String	Answer card type: R for single choice, C for multiple choice, S for rating, V for voting
itemType	Integer	Type: 0 for answer card, 1 for Q&A
total	Long	Total number of respondents
rightUserCount	Long	Number of correct answers
faultUserCount	Long	Number of incorrect answers
singleResult	List	Number of selections for each option

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. HttpUtil.java and LiveSignUtil.java from the test cases are included in the downloaded file.

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

Response Example

For global system error descriptions, see Global Error Description

Success Example

{
    "code": 200,
    "status": "success",
    "requestId": "b8e410f71a9f4246acc9e597ca27be8b.73.17124809986010047",
    "data": {
        "answer": "A",
        "type": "R",
        "itemType": 0,
        "total": 1,
        "rightUserCount": 1,
        "faultUserCount": 0,
        "singleResult": [
            1,
            0
        ]
    },
    "success": true
}

Error Example

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360831552223589",
    "error": {
        "code": 20001,
        "desc": "application not found."
    },
    "success": false
}

Live Streaming Server API