Group Type ID | RESTful API Support |
Private | Yes. Same as work groups (Work) in the new version. |
Public | Yes |
ChatRoom | Yes. Same as the meeting group (Meeting) in the new version. |
AVChatRoom | No |
Community | No |
https://xxxxxx/v4/openim_msg_ext_http_svc/group_set_key_values?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
Parameter | Description |
xxxxxx | Domain name corresponding to the country/region where your SDKAppID is located. China: console.tim.qq.com Singapore: adminapisgp.im.qcloud.com Seoul: adminapikr.im.qcloud.com Frankfurt: adminapiger.im.qcloud.com Silicon Valley: adminapiusa.im.qcloud.com Jakarta: adminapiidn.im.qcloud.com |
v4/openim_msg_ext_http_svc/group_get_key_values | Request API |
sdkappid | SDKAppID assigned by the Chat console when an app is created |
identifier | |
usersig | |
random | A random 32-bit unsigned integer ranging from 0 to 4294967295. |
contenttype | Request format. The value is fixed to json . |
MsgSeq
is 158:{"GroupId": "@TGS#1YMVAB3IZ","MsgSeq": 158,"OperateType": 1,"ExtensionList": [{"Key": "key1", "Value": "value1", "Seq": 0},{"Key": "key2", "Value": "value2", "Seq": 0},]}
MsgSeq
is 158:{"GroupId": "@TGS#1YMVAB3IZ","MsgSeq": 158,"OperateType": 2,"ExtensionList": [{"Key": "key1", "Value": "", "Seq": 1}]}
MsgSeq
is 158:{"GroupId": "@TGS#1YMVAB3IZ","MsgSeq": 158,"OperateType": 3}
Field | Type | Required | Description |
GroupId | String | Yes | Group ID |
MsgSeq | Integer | Yes | Seq of the group message to be configured |
OperateType | Integer | Yes | 1 : Setting key-value pairs for a message; 2 : Deleting certain key-value pairs for a message; 3 : Clearing all key-value pairs for a message |
ExtensionList | Array | Yes (when OperateType is 1 or 2 ) | Up to 20 key-value pairs can be set or deleted per request |
ExtensionList
are described as follows:Field | Type | Required | Description |
Key | String | Yes | Key in a key-value pair, which can be up to 100 bytes |
Value | String | Yes | Value in a key-value pair, which can be up to 1,000 bytes |
Seq | Integer | Yes (when the API is not called by an app admin) | Version number of the current key-value pair. Seq is 0 when the API is called by a group member to configure a key-value pair for the first time and is 1 when the configuration is successful. For subsequent key-value pair configuration, the latest Seq of the key-value pair needs to be passed back to the backend, which then checks whether the key-value pair has been modified by others. If the Seq does not match the key-value pair, the configuration fails, and an error code is returned. The backend does not verify the Seq when the API is called by an app admin. |
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0,"ExtensionList": [{"ErrorCode": 0,"Extension": {"Key": "key1","Value": "value1","Seq": 1}},{"ErrorCode": 23001,"Extension": {"Key": "key2","Value": "value1234","Seq": 2}}]}
Field | Type | Description |
ActionStatus | String | Request result. OK : successful; FAIL : failed |
ErrorCode | Integer | Error code. 0 : Successful; other values: Failed |
ErrorInfo | String | Error information |
ExtensionList | Array | Message extension configuration result |
ErrorCode
and ErrorInfo
respectively.
For public error codes (60000 to 79999), see Error Codes.
The following table describes the error codes specific to this API:Error Code | Description |
10002 | Internal server error. Try again. |
10004 | Invalid parameter. Check the error description and troubleshoot the issue. |
10008 | Invalid request: The request is not an Ultimate edition plan request. |
23001 | Seq conflict: The key-value setting has been modified by others. You need to pull the latest Seq to request again. |
23002 | The configured group message does not support message extension. |
23003 | Too many key-value setting attempts (more than 200 attempts per minute per message) |
23004 | The configured group message does not exist. |
Was this page helpful?