Update the Room Member Information
Feature Overview
App administrators can update room members information through this API.
API Calling Description
Sample Request URL
https://xxxxxx/v4/room_engine_http_srv/update_room_member_info?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
Request parameters
The table below only lists the parameters modified when calling this API. For more details, please refer to RESTful API Overview.
Parameter | Description |
xxxxxx | The reserved domain for the country/region where the SDKAppID is located: Singapore : adminapisgp.im.qcloud.com |
v4/room_engine_http_srv/update_room_member_info | Request API |
sdkappid | The SDKAppID assigned by the Chat console when an app is created |
identifier | |
usersig | The Signature generated by the App administrator account. For more details, please refer to Generating UserSig. |
random | Enter a random 32-bit unsigned integer ranging from 0 to 4294967295 |
contenttype | The request format fixed value is json |
Maximum Calling Frequency
200 times per second.
Sample Request Packets
Basic Form
{"RoomId":"room-test","MemberInfo":{"Member_Account": "user4","NameCard": "jack","Role": "Admin","CustomInfo": "custom info"}}
Request Packet Field Description
Field | Type | Attribute | Description |
RoomId | String | Mandatory | Room ID |
Member_Account | String | Mandatory | Room member ID |
NameCard | String | Optional | Room member nickname, up to 32 Bytes |
Role | String | Optional | Room member permissions: Admin, Member |
CustomInfo | String | Optional | Room member custom definition fields, up to 60 Bytes |
Sample Response Packets
Basic Form
{"ErrorCode": 0,"ErrorInfo": "","ActionStatus": "OK","RequestId": "Id-8d5f107ce00f420597a2db9fbe7f71ca-O-Seq-102831"}
Response Packet Field Description
Field | Type | Description |
ActionStatus | String | The result of the request process. OK for success, FAIL for failure. |
ErrorCode | Integer | Error code. 0 for success, others for failure. |
ErrorInfo | String | Error message |
RequestId | String | The unique request ID is returned with each request and required to provide this RequestId when locating issues. |
Error Codes
Unless a network error occurs (e.g., 502 error), the HTTP status code for this interface will always be 200. The actual error codes and messages are conveyed through ErrorCode and ErrorInfo in the response body.
For common error codes (60000 to 79999), see Error Code documentation.
The private error codes for this API are as follows:
Error code | Description |
100001 | Internal server error, please retry. |
100002 | Invalid parameter, please check the request for correctness based on the error description. |
100004 | The room does not exist, or it once existed but now has been destroyed. |
100005 | Non-room members |
100006 | Insufficient operational permissions |