APIs Related to H5 Application WeChat Applet SDK Authorization

API List

Request method	API	description
GET	/v1.0/osaas/sdk/room/{room_id}/token	API for Obtaining a Room Token.
DELETE	/v1.0/osaas/sdk/room/token/{access_token}	API for Invalidating a Room Token Based on the Access Token.
DELETE	/v1.0/osaas/sdk/room/{room_id}/token	API for Invalidating a Room Token Based on the Unique ID of the Room.

API for Obtaining a Room Token

API Description

You can use this API to obtain a room token based on the unique ID of the room.

API Address

GET /v1.0/osaas/sdk/room/{room_id}/token

Request Parameters

Parameter	Type	Position	Description	Mandatory
room_id	String	URI	Unique ID of a room.	Yes

Response Parameters

Parameter	Type	Description
code	Integer	Response code.Null indicates success.
success	Boolean	Request result. true: success false: failure
msg	String	Exception message.It is null when the request result is success.
t	Long	Response time, which is a 13-digit timestamp.
result	Object	Result object

Parameters in result

Parameter	Type	Description
access_token	String	Access token.
expire_time	Integer	Validity period, in seconds.
refresh_token	String	Refresh token, used for refreshing tokens.

Request Example

GET {url}/v1.0/osaas/sdk/room/12223333******/token

Success Response Example

{
  "success": true,
  "t": 1566053034624,
  "result": {
    "access_token": "********************************",
    "expire_time": 7200,
    "refresh_token": "********************************"
  }
}

Failure Response Example

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

API for Invalidating a Room Token Based on the Access Token

API Description

You can use this API to invalidate a room token based on the access token.

API Address

DELETE /v1.0/osaas/sdk/room/token/{access_token}

Request Parameters

Parameter	Type	Position	Description	Mandatory
access_token	String	URI	Access token.	Yes

Response Parameters

Parameter	Type	Description
code	Integer	Response code.Null indicates success.
success	Boolean	Request result. true: success false: failure
msg	String	Exception message.It is null when the request result is success.
t	Long	Response time, which is a 13-digit timestamp.
result	Boolean	Operation result

Request Example

DELETE {url}/v1.0/osaas/sdk/room/token/********************

Success Response Example

{
  "success": true,
  "result": true,
  "t": 1566053034624
}

Failure Response Example

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

API for Invalidating a Room Token Based on the Unique ID of the Room

API Description

You can use this API to invalidate a room token based on the unique ID of the room.

API Address

DELETE /v1.0/osaas/sdk/room/{room_id}/token

Request Parameters

Parameter	Type	Position	Description	Mandatory
room_id	String	URI	Unique ID of a room.	Yes

Response Parameters

Parameter	Type	Description
code	Integer	Response code.Null indicates success.
success	Boolean	Request result. true: success false: failure
msg	String	Exception message.It is null when the request result is success.
t	Long	Response time, which is a 13-digit timestamp.
result	Boolean	Operation result

Request Example

DELETE {url}/v1.0/osaas/sdk/room/1222333******/token

Success Response Example

{
  "success": true,
  "result": true,
  "t": 1566053034624
}

Failure Response Example

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

Error Code

The following are common business exceptions for this interface. For more exception errors, see Global Error Codes.

error code	explain
500	system error