Overview

​

Basic usage

​

Calling conventions

1. Request method: POST
2. Request format: application/json, encoded in UTF-8
3. Base URL: https://{server-domain-or-IP}/meeting/{endpoint-path}
4. Request headers

5. Signing algorithm

• Step 1: Build the string to sign by joining the app ID, nonce, timestamp, and the JSON string of the request body with &

// Assume appid=1 nonce=2 timestamp=3 and the request body is {}
appid=1&nonce=2&timestamp=3&{}

With the appid  header → appid=1&nonce=2&timestamp=3&{}
With the app_id header → app_id=1&nonce=2&timestamp=3&{}

• Step 2: Compute HMAC-SHA256 over the string. The key is the appkey secret key.

HMACSHA256(key, stringToSign)

• Step 3: Convert the binary result to lowercase hexadecimal to get the signature

6. Response format: JSON

// On success, `data` contains the data
{
	"code": 0,
	"data": 123
}

// On error, `msg` is the error description ("认证失败" means "Authentication failed")
{
	"code": 10041,
	"msg": "认证失败"
}

// For list data, `_meta` contains the pagination info
{
	"code": 0,
	"data": [
		{"id": 123}
	],
	"_meta": {
		"totalCount": 5,
		"pageCount": 1,
		"currentPage": 1,
		"perPage": 20
	}
}