tencent cloud

Chat

ドキュメントChatサービス側 APIsRESTful APIs Session RelatedSession Grouping TagCreating Conversation Group Data

Creating Conversation Group Data

PDF
フォーカスモード
フォントサイズ
最終更新日: 2026-04-14 11:25:27

Feature Overview

This API supports the creation of conversation group data.
Note:
Conversation Grouping and Conversation Marking are independent from recent contacts. The REST API provides full CRUD support (create, read, update, delete) for resources such as conversation groups, standard conversation markings, and custom conversation markings.
Each user can create up to 20 conversation groups. A session can join multiple groups. The session cap is set at 1000, and exceeding it will return error code: 51008.
Session tags and session custom fields have a combined upper limit of 1000 sessions. Exceeding this limit will return error code: 51008.
Conversation grouping and marking features require enabling Pro Edition、Pro Plus Edition or Enterprise Edition. The number of cloud sessions that can be pulled is limited by the "Number of Conversations to Pull" in the Chat basic package. If the number of grouped or marked sessions exceeds the corresponding limit, complete session retrieval may fail. You can upgrade the Chat package version to increase the cloud session limit.

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
Tokyo: adminapijpn.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": "user_0001",
  "GroupContactItem": [
    {
      "GroupName": "group_0001",
      "ContactItem": [
        {
          "Type": 1,
          "To_Account": "user_0002"
        },
        {
          "Type": 2,
          "ToGroupId": "@TGS#1B2AUI7RZ"
        }
      ]
    }
  ]
}

Request fields

Field
Type
Required
Description
From_Account
String
Yes
Fill in UserID, request to create conversation group for this user.
GroupContactItem
Array
Yes
Conversation group to be added. Only one conversation group can be added at a time.
GroupName
String
Yes
Name of the chat group to be created. The name can be up to 64 bytes in length.
ContactItem
Array
No
Initial conversation list, up to 100 items.
Type
Integer
Yes
Conversation type：
1: One-to-one conversation.
2: Group conversation.
ToGroupId
String
No
Assign value only for Group conversation, fill in the group ID of the conversation party.
To_Account
String
No
Assign value only for One-to-one conversation, fill in the UserID of the conversation party.

Sample response

{
  "GroupResultItem": [
    {
      "GroupItem": {
        "GroupName": "group_0001",
        "GroupId": 1
      },
      "ResultItem": [
        {
          "ContactItem": {
            "Type": 1,
            "To_Account": "user_0002"
          },
          "ResultCode": 0,
          "ResultInfo": ""
        },
        {
          "ContactItem": {
            "Type": 2,
            "ToGroupId": "@TGS#1B2AUI7RZ"
          },
          "ResultCode": 0,
          "ResultInfo": ""
        }
      ]
    }
  ],
  "ActionStatus": "OK",
  "ErrorCode": 0,
  "ErrorInfo": ""
}

Response fields

Field
Type
Description
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
Assign value only for Group conversation, fill in the group ID of the conversation party.
To_Account
String
Assign value only for One-to-one conversation, fill in the UserID of the conversation party.
ResultCode
Integer
The result. 0 means success and other values mean failure. For details on non-zero results, see Error Codes.
ResultInfo
String
Error description of To_Account. This field is empty if the request is successful.
ActionStatus
String
The request result.
OK: successful.
FAIL: failed.
ErrorCode
Integer
Error code in the conversation operation result.
0: successful.
Non-zero: failed.
ErrorInfo
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 to Chat. Please import the UserID first.
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
The number of conversations specified in your request exceeds the allowed limit of 100. Please adjust the ContactItem parameter to specify 100 or fewer conversations.
51007
Failed to replace GroupID with GroupCode because an internal error occurred or the group was disbanded.
51008
The number of grouped conversations has reached the system limit (the default supports up to 1,000 conversations).
51010
The number of conversation groups exceeds the upper limit of 20.
51011
The conversation group name contains more than 64 bytes.
51013
The current version does not support conversation grouping. To use this feature, please upgrade to the Pro edition, Pro edition Plus, or Enterprise edition.

API Debugging Tool

Use the RESTful API online debugging tool to debug this API.
前の記事へ: Deleting a conversation次の記事へ: Updating Conversation Group Data

ヘルプとサポート

この記事はお役に立ちましたか？

フィードバック