tencent cloud

Feedback

Getting Topic Profile

Last updated: 2024-06-11 10:57:33

    Feature Overview

    This API is used to get the topic profile.

    API Calling Description

    Applicable group types

    Group Type ID
    Whether This RESTful API Is Supported
    Private
    No
    Public
    No
    ChatRoom
    No
    AVChatRoom
    No
    Community
    This API applies only to topic-enabled communities.
    These are the preset group types in Chat. For more information, see Group System.
    Note
    To use the topic feature, you need to go to the console, choose Feature Configuration > Group configuration > Group feature configuration > Community, enable the community feature and then enable the topic feature.

    Sample request URL

    https://xxxxxx/v4/million_group_open_http_svc/get_topic?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
    Mumbai: adminapiind.im.qcloud.com
    Silicon Valley: adminapiusa.im.qcloud.com
    Jakarta: adminapiidn.im.qcloud.com
    v4/million_group_open_http_svc/get_topic
    Request API
    sdkappid
    The SDKAppID assigned by the Chat console when the application 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. Fixed value: json.

    Maximum call frequency

    200 calls per second

    Sample request

    Basic format
    Used to get the topic details. The request contains the group ID and the list of all the topics to be pulled.
    {
    "GroupId":"@TGS#_@TGS#cQVLVHIM62CJ", // You need to get the group ID of the topic, which is required.
    "From_Account":"1400187352" // Get the information of the specified user in the topic, which is required
    }
    Specify the form of topic list to be pulled
    {
    "GroupId":"@TGS#_@TGS#cQVLVHIM62CJ", // You need to get the group ID of the topic, which is required.
    "From_Account":"1400187352", // Get the information of the specified user in the topic, which is required
    "TopicIdList":[ // Specify the topic list to be pulled, which is optional
    "@TGS#_@TGS#cQVLVHIM62CJ@TOPIC#_@TOPIC#cRTE3HIM62C5"
    ]
    }
    Use the filter to get the specified information form You can specify the topic field to be pulled in ResponseFilter. If a filter is set, fields not specified in the filter will not be pulled.
    {
    "GroupId":"@TGS#_@TGS#cQVLVHIM62CJ", // You need to get the group ID of the topic, which is required.
    "From_Account":"1400187352", // Get the information of the specified user in the topic, which is required
    "TopicIdList":[ // Specify the topic list to be pulled, which is optional
    "@TGS#_@TGS#cQVLVHIM62CJ@TOPIC#_@TOPIC#cRTE3HIM62C5"
    ],
    "ResponseFilter":[ // Response filter. Specify the topic information to be pulled, which is optional
    "TopicName",// Topic name
    "FaceUrl",// Profile photo URL of the topic
    "Notification",// Topic notice
    "Introduction"// Topic introduction
    ]
    }
    

    Request fields

    Field
    Type
    Required
    Description
    GroupId
    String
    Required
    You need to get the group ID of the topic.
    From_Account
    String
    Required
    Get the information of the specified user in the topic.
    TopicIdList
    Array
    Optional
    You need to get the topic list. If it is left empty, all the topic information of the group will be obtained.
    ResponseFilter
    Array
    Optional
    Response filter. Specify the topic information to be obtained.

    Sample response

    Basic form; specify the form of topic list to be obtained
    {
    "ActionStatus": "OK",
    "ErrorInfo": "ok",// The `ErrorInfo` parameter here is meaningless. You need to check the `ErrorInfo` parameter of each topic.
    "ErrorCode": 0, // The `ErrorCode` parameter here is meaningless. You need to check the `ErrorCode` parameter of each topic.
    "TopicAndSelfInfo": [ // The returned result is a topic information array. Only one topic is listed here for simple demonstration.
    {
    "ErrorCode": 0,
    "ErrorInfo": "ok",// Return result specific to this topic
    "SelfInfo": { // Information of the specified user in the topic
    "ShutUpTime": 0,// Muting period of the user
    "MsgSeq": 0,// Sequence number of the member’s read message
    "MsgFlag": "AcceptAndNotify"
    },
    "TopicInfo": { // Returned topic information
    "TopicName": "TestTopicName", // Topic name
    "GroupID": "@TGS#_@TGS#cQVLVHIM62CJ", // Group ID of the topic
    "FaceUrl": "http://this.is.new.face.url",// URL of the topic profile photo
    "TopicId": "@TGS#_@TGS#cQVLVHIM62CJ@TOPIC#_@TOPIC#cRTE3HIM62C5", // Topic ID
    "NextMsgSeq": 1,
    "Notification": "Notification",// Topic notice
    "Introduction": "Introduction",// Topic introduction
    "CreateTime": 1658839448,// Topic creation time in UTC
    "LastMsgTime": 0,// UTC time when the last message in the topic was sent
    "MuteAllMember": "Off", // Flag indicating whether to mute all in the topic. `On`: Yes; `Off`: No
    "CustomString": "This is a customs string." // Custom string in the topic
    }
    }
    ]
    }
    Use the filter to get the specified topic information form
    {
    "ActionStatus": "OK",
    "ErrorInfo": "ok",// The `ErrorInfo` parameter here is meaningless. You need to check the `ErrorInfo` parameter of each topic.
    "ErrorCode": 0, // The `ErrorCode` parameter here is meaningless. You need to check the `ErrorCode` parameter of each topic.
    "TopicAndSelfInfo": [ // The returned result is a topic information array. Only one topic is listed here for simple demonstration.
    {
    "ErrorCode": 0,
    "ErrorInfo": "ok",// Return result specific to this topic
    "SelfInfo": { // Information of the specified user in the topic
    "ShutUpTime": 0,// Muting period of the user
    "MsgSeq": 0,
    "MsgFlag": "AcceptAndNotify"
    },
    "TopicInfo": { // Returned topic information
    "TopicName": "TestTopicName", // Topic name
    "GroupID": "@TGS#_@TGS#cQVLVHIM62CJ", // Group ID of the topic
    "FaceUrl": "http://this.is.new.face.url",// URL of the topic profile photo
    "TopicId": "@TGS#_@TGS#cQVLVHIM62CJ@TOPIC#_@TOPIC#cRTE3HIM62C5", // Topic ID
    "Notification": "Notification",// Topic notice
    "Introduction": "Introduction"// Topic introduction
    }
    }
    ]
    }

    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
    TopicAndSelfInfo
    Array
    The returned result is a topic information array, which contains the basic topic information and the information of the specified user in the topic.

    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 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.
    10003
    Invalid command word.
    10004
    Invalid parameter. Check the error description and troubleshoot the issue.
    10006
    The operation exceeds the frequency limit. Please reduce the call frequency. This error is usually caused by too much net group increase in a single day or too frequent calls to obtain all groups in the app.
    10007
    Insufficient operation permissions. Check the request parameters based on the error message.
    10008
    The request is invalid, probably because verification of the signing information in the request failed. Please try again or submit a ticket.
    10010
    Invalid request. The group or topic has been deleted.
    11000
    The current group does not support the community topic feature. To use this feature, you need to purchase the Premium edition and enable it in the console.
    110003
    Request failed. The topic has been deleted.

    API Debugging Tool

    Use the RESTful API online debugging tool to debug this API.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support