Authorization and Co-hosting Token

Updated: 2022-09-02 18:08:07

API Description

1、获取授权和连麦的token
2、接口支持https协议

API URL

http://api.polyv.net/live/v3/channel/common/get-chat-token

Online API Call

Request Method

POST

API Constraints

The API supports both HTTP and HTTPS. HTTPS is recommended to ensure API security. API calls are subject to rate 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 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 never be saved 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 and obtain response data.` See Signature Generation Rules
channelId	true	String	Channel ID
userId	true	String	Viewer user ID
role	true	String	Role teacher: Instructor admin: Administrator guest: Guest assistant: Teaching Assistant viewer: Viewer
origin	false	String	Viewing source, customizable web: Web browser client: Client application app: Mobile application

Example

http://api.polyv.net/live/v3/channel/common/get-chat-token

Form Parameters:

role=viewer&appId=frlr1zazn3&origin=web&sign=F9DCE80BFC6DE3293D5EE432C1B8CD55&userId=1b448be323&channelId=2094979&timestamp=1621844705410

Response Parameter Description

Parameter	Type	Description
code	Integer	Response status code, 200 for success, non-200 for failure See Global Error Description
status	String	Response status text
message	String	Response description, provides error details when code is 400 or 500
data	Object	Empty on failure, channel information on success See data field description

data Field Description

Parameter	Type	Description
token	String	Token required for connection API, valid for 6 hours
mediaChannelKey	String	Key required for co-hosting
roomId	String	Room ID
childRoomEnabled	String	Whether sub-room is enabled Y: Enabled N: Disabled
chatApiDomain	String	Chat room API address
chatDomain	String	Chat room socket address

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 download file.

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

private static final Logger log = LoggerFactory.getLogger(ChannelOperateTest.class);
/**
 * 查询授权和连麦的token
 * @throws IOException
 * @throws NoSuchAlgorithmException
 */
@Test
public void testGetChatToken() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId = super.appId;
    String appSecret = super.appSecret;
    String userId = super.userId;
    String timestamp = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "http://api.polyv.net/live/v3/channel/common/get-chat-token";
    String channelId = "2094979";
    String role = "viewer";
    String origin = "web";
    
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp", timestamp);
    requestMap.put("channelId", channelId);
    requestMap.put("userId", userId);
    requestMap.put("role", role);
    requestMap.put("origin", origin);
    requestMap.put("sign", LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.info("测试查询授权和连麦的token，返回值：{}", response);
    //do somethings
    
}

Response Example

For system-wide global error descriptions, see Global Error Description

Success Example

{
    "code":200,
    "status":"success",
    "message":"",
    "data":{
        "chatApiDomain":"apichat.polyv.net",
        "childRoomEnabled":"N",
        "mediaChannelKey":"e235543623u0jd193b575afed369cce5e52hj1oe8000413e9020c21adf91ab136dfd1b7aeeeddfa6c883e9437b81085c5b28c7707caa44fe41826c5bae97baa242a5a8bb7b4d4d706d29f667a7a812fe94fca054210c603cb1f727e02307c1f2a9d5d7bfafc077de33ff9a232761ef004c496dfa536c5e2fb0fb033a04066188bd148aaf1e9d2efe20c2f1ab31464b6d0afb54393fcfb269a065eb5625c289a2e752030ec4631d842021540b3b0466b0c0a19b590ab087aadb19bf621c657b7f003123572e5590fb43175ef120969b2ac125ae2db7d3a6f0c1fa87ec05c7cbb0f20016ed3a3354a6ce50c73c9fecbfe17a98a0bada2f1e6970515cd373a8e12aaa0bd7fc29bfebeb771939156c90c89fbd2da3647ecf050a738e306f4f2a13e9564ba24cbbd26e720d8dab76aa3ee901c10a1754e3dc9ac5173dc75898ea79e9fc851de045dc27f7bde1c58c7591cd186e72dd3d15052ff85925e6fe680599fc8e602b",
        "chatDomain":"chat.polyv.net",
        "roomId":"2094979",
        "token":"7f6d83hojaw2f2bb3b46f875946a75"
    }
}

Error Example

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