tencent cloud

Feedback

Modifying Topic Profile

Last updated: 2024-07-16 11:20:06

    Feature Overview

    This API is used to modify a 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/modify_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
    Silicon Valley: adminapiusa.im.qcloud.com
    Jakarta: adminapiidn.im.qcloud.com
    v4/million_group_open_http_svc/modify_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

    Modify the basic topic information Modify the basic topic information, such as topic name and topic notice.
    {
    "GroupId":"@TGS#_@TGS#cQVLVHIM62CJ",// Group of the topic to be modified, which is required
    "TopicId":"@TGS#_@TGS#cQVLVHIM62CJ@TOPIC#_@TOPIC#cRTE3HIM62C5",// ID of the topic to be modified, which is required
    "TopicName":"TestTopicName",// Topic name, which is optional
    "Notification":"Notification" // Topic notice, which is optional
    }
    ALL IN ONE
    {
    "GroupId":"@TGS#_@TGS#cQVLVHIM62CJ", // Group of the topic to be modified, which is required
    "TopicId":"@TGS#_@TGS#cQVLVHIM62CJ@TOPIC#_@TOPIC#cRTE3HIM62C5", // ID of the topic to be modified, which is required
    "From_Account":"1400187352", // Member modifying the topic
    "TopicName":"TestTopicName",// Topic name, which is optional
    "FaceUrl": "http://this.is.new.face.url", // Topic profile photo, which is optional
    "Notification":"Notification", // Topic notice, which is optional
    "Introduction": "Introduction",// Topic introduction, which is optional
    "MuteAllMember": "On", // Mutes all members, which is optional. `On`: Enable. `Off`: Disable
    "CustomString":"This is a customs string." // Custom string, which is optional
    }
    

    Request fields

    Field
    Type
    Required
    Description
    GroupId
    String
    Required
    Group ID of the topic to be modified
    TopicId
    String
    Required
    ID of the topic to be modified
    TopicName
    String
    Optional
    Topic name, whose maximum length is 30 bytes. This field is UTF-8-encoded, and one Chinese character occupies three bytes.
    From_Account
    uint64
    Optional
    User account that wants to modify the topic
    CustomString
    String
    Optional
    A custom string, which can contain up to 3,000 bytes. encoded in UTF-8.
    FaceUrl
    String
    Optional
    Profile photo URL of the topic, which can contain up to 100 bytes.
    Notification
    String
    No
    Topic notice, whose maximum length is 300 bytes. This field is UTF-8-encoded, and one Chinese character occupies three bytes.
    Introduction
    String
    No
    Topic introduction, whose maximum length is 240 bytes. This field is UTF-8-encoded, and one Chinese character occupies three bytes.
    MuteAllMember
    String
    Optional
    Mutes all members in a topic and allows only the group admin, group owner, and system admin to speak.

    Sample response

    {
    "ActionStatus": "OK",
    "ErrorInfo": "ok",
    "ErrorCode":0
    }

    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

    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 topic has been deleted.
    10015
    The requested group ID is invalid. Check the request parameter based on the error message.
    10016
    The app backend rejected this operation through a third-party callback. Check the returned value of your webhook "Topic Profile Change Webhook".
    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.
    80001
    Failed to pass the security check. Check the request parameters based on the error message.

    API Debugging Tool

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

    Possible Webhooks

    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