Creating Conversation Group Data

Last updated: 2024-07-16 10:52:14

Feature Overview
Conversation group mark data is independent of recent contacts. You can use RESTful APIs to add, delete, modify, and query conversation group, standard conversation mark, custom conversation mark, and other fields. Conversation group marks support up to 1,000 conversations, and up to 20 conversation groups can be added for each user. This API can be used to update conversation group data. Only the Premium edition supports conversation group data operations.
API Calling Description
Sample request URL
https://xxxxxx/v4/recentcontact/create_contact_group?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
Request parameters
The following table describes the modified parameters when this API is called. For other parameters, see RESTful API Overview.
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/recentcontact/create_contact_group
Request API
sdkappid
SDKAppID assigned by the Chat console when an app is created
identifier
App admin account. For more information, see the App Admin section in Login Authentication.
usersig
Signature generated by the app admin account. For details, see Generating UserSig.
random
A random 32-bit unsigned integer ranging from 0 to 4294967295.
contenttype
Request format, which should always be json.
Maximum call frequency
200 calls per second
Sample request
{
    "From_Account":"user15",
    "GroupContactItem":[
        {
            "GroupName":"test0",
            "ContactItem": [
                {
                    "Type": 1,
                    "To_Account": "user0"
                }
            ]
        }
    ]
}
Request fields
Field
Type
Required
Description
From_Account
String
Yes
UID of the requester
GroupContactItem
Array
Yes
Conversation group to be added. Only one conversation group can be added at a time.
GroupName
String
Yes
Name of the conversation group to be added, which can contain up to 32 bytes
ContactItem
Array
Yes
List of conversations to be added
Type
Integer
Yes
Conversation type. 1: One-to-one conversation; 2: Group conversation
ToGroupId
String
No
Group ID
To_Account
String
No
User ID
Sample response
{
    "GroupResultItem": [
        {
            "GroupItem": {
                "GroupName": "test2",
                "GroupId": 2
            },
            "ResultItem": [
                {
                    "ContactItem": {
                        "Type": 1,
                        "To_Account": "user1"
                    },
                    "ResultCode": 0,
                    "ResultInfo": ""
                }
            ]
        }
    ],
    "ActionStatus": "OK",
    "ErrorCode": 0,
    "ErrorInfo": "",
    "ErrorDisplay": ""
}
Response fields
Field
Type
Description
ActionStatus
String
Request result. OK: Successful; FAIL: Failed
ErrorCode
Integer
Error code. 0: Successful; other values: Failed
ErrorInfo
String
Error information
GroupResultItem
Array
Result of the conversation group adding
GroupItem
Object
Conversation group object
GroupName
String
Conversation group name
GroupId
Integer
Conversation group ID
ResultItem
Array
Operation result
ContactItem
Integer
Conversation object
Type
Integer
Conversation type. 1: One-to-one conversation; 2: Group conversation
ToGroupId
String
Group ID
To_Account
String
User ID
ResultCode
Integer
Error code in the conversation operation result. 0: Successful
ResultInfo
String
Error description in the conversation operation result
﻿
Error Codes
The returned HTTP status code for this API is always 200 unless a network error (such as error 502) occurs. The specific error code and details can be found in the response fields ResultCode, ResultInfo, ErrorCode, and ErrorInfo.
For public error codes (60000 to 79999), please see Error Codes.
The following table describes the error codes specific to this API:
Error Code
Description
50001
The requested UserID has not been imported into the Tencent Cloud Chat backend. Please import.
50002
Incorrect request parameter. Check your request according to the error description.
50003
The request requires app admin permissions.
50004
Internal server error. Please try again.
50005
Network timeout. Try again later.
51006
When you are modifying conversation mark, the number of conversations is empty or exceeds the upper limit of 100.
51007
Failed to replace GroupID with GroupCode because an internal error occurred or the group was disbanded.
51008
The total number of conversations in the conversation group exceeds 1,000.
51009
The conversation group does not exist when a deletion attempt is made.
51010
The number of conversation groups exceeds the upper limit of 20.
51011
The conversation group name contains more than 32 bytes.
51012
Exceeded the maximum number of conversations pinned to the top.
51013
If the requested app is not of the Premium edition, an error will be reported when a standard conversation mark or conversation group is modified.
API Debugging Tool
Use the RESTful API online debugging tool to debug this API.

tencent cloud

Recent Pages

Creating Conversation Group Data

Feature Overview

API Calling Description

Sample request URL

Request parameters

Maximum call frequency

Sample request

Request fields

Sample response

Response fields

Error Codes

API Debugging Tool

Was this page helpful?

Was this page helpful?

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/recentcontact/create_contact_group	Request API
sdkappid	SDKAppID assigned by the Chat console when an app is created
identifier	App admin account. For more information, see the App Admin section in Login Authentication.
usersig	Signature generated by the app admin account. For details, see Generating UserSig.
random	A random 32-bit unsigned integer ranging from 0 to 4294967295.
contenttype	Request format, which should always be `json`.

Field	Type	Required	Description
From_Account	String	Yes	UID of the requester
GroupContactItem	Array	Yes	Conversation group to be added. Only one conversation group can be added at a time.
GroupName	String	Yes	Name of the conversation group to be added, which can contain up to 32 bytes
ContactItem	Array	Yes	List of conversations to be added
Type	Integer	Yes	Conversation type. `1`: One-to-one conversation; `2`: Group conversation
ToGroupId	String	No	Group ID
To_Account	String	No	User ID

Error Code	Description
50001	The requested UserID has not been imported into the Tencent Cloud Chat backend. Please import.
50002	Incorrect request parameter. Check your request according to the error description.
50003	The request requires app admin permissions.
50004	Internal server error. Please try again.
50005	Network timeout. Try again later.
51006	When you are modifying conversation mark, the number of conversations is empty or exceeds the upper limit of 100.
51007	Failed to replace GroupID with GroupCode because an internal error occurred or the group was disbanded.
51008	The total number of conversations in the conversation group exceeds 1,000.
51009	The conversation group does not exist when a deletion attempt is made.
51010	The number of conversation groups exceeds the upper limit of 20.
51011	The conversation group name contains more than 32 bytes.
51012	Exceeded the maximum number of conversations pinned to the top.
51013	If the requested app is not of the Premium edition, an error will be reported when a standard conversation mark or conversation group is modified.

tencent cloud

Sign Up

Log in

Recent Pages

Creating Conversation Group Data

Feature Overview

API Calling Description

Sample request URL

Request parameters

Maximum call frequency

Sample request

Request fields

Sample response

Response fields

Error Codes

API Debugging Tool

Was this page helpful?

Was this page helpful?