tencent cloud

Chat

製品の説明
製品の概要
Basic Concepts
ユースケース
機能概要
アカウントシステム
ユーザープロフィールとリレーションシップチェーン
メッセージ管理
グループシステム
Official Account
Audio/Video Call
使用制限
購入ガイド
課金概要
価格説明
Purchase Instructions
Renewal Guide
支払い延滞説明
Refund Policy
ダウンロードセンター
SDK & Demo ソースコード
更新ログ
シナリオプラン
Live Streaming Setup Guide
AI Chatbot
極めて大規模なエンターテインメントコラボレーションコミュニティ
Discord実装ガイド
ゲーム内IM統合ガイド
WhatsApp Channel-style Official Account Integration Solution
Send Red Packet
Firewall Restrictions
クライアントAPIs
SDK API（Web）
Android
iOS & macOS
Swift
Flutter
SDK API（Electron）
SDK APIs (Unity)
SDK API（React Native）
C APIs
C++
サービス側 APIs
UserSigの生成
RESTful APIs
Webhooks
コンソールガイド
New Console Introduction
アプリケーションの作成とアップグレード
基本設定
機能設定
アカウント管理
グループ管理
Official Channel Management
コールバック設定
監視ダッシュボード
Viewing Guide for Resource Packages
Real-Time Monitor
補助ツールの開発
アクセス管理
Advanced Features
よくあるご質問
uni-app FAQs
 購入に関する質問
SDKに関する質問
アカウント認証に関する質問
ユーザープロファイルとリレーションシップチェーンに関する質問
メッセージに関する質問
グループに関する質問
ライブ配信グループに関する質問
ニックネームプロフィール画像に関連した問題
一般的なリファレンス
Service Level Agreement
セキュリティコンプライアンス認証
IM ポリシー
プライバシーポリシー
データプライバシーとセキュリティ契約
エラーコード
お問い合わせ
ドキュメントChatサービス側 APIsRESTful APIs Session RelatedSession Grouping TagCreating Conversation Group Data

Creating Conversation Group Data

PDF
フォーカスモード
フォントサイズ
最終更新日: 2026-03-26 16:09:04

Feature Overview

Conversation group data is independent of recent contacts. The REST API supports add, delete, modify, and query fields for conversation groups, standard conversation marks, and custom tags. This API supports the creation of conversation group data.
Note:
1. Each user can create up to 20 conversation groups. A session can join multiple groups. The session capacity limit per group is 1000. Exceeding this limit will return error code: 51008.
2. Session tags and session custom fields have a combined upper limit of 1000 sessions. Exceeding this limit will return error code: 51008.
3. Note: The conversation grouping and tagging feature requires enabling Ultimate Edition or Enterprise Edition. The number of cloud-based 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 tagged sessions exceeds the corresponding limit, complete session pulling will be unavailable. You can upgrade the IM 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":"user15",
    "GroupContactItem":[
        {
            "GroupName":"test0",
            "ContactItem": [
                {
                    "Type": 1,
                    "To_Account": "user0"
                }
            ]
        }
    ]
}

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 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
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": "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
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
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 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
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 Pro edition 、Pro Plus edition、Enterprise 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.
前の記事へ: Deleting a conversation次の記事へ: Updating Conversation Group Data

ヘルプとサポート

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

フィードバック