tencent cloud

功能说明

App 管理员可以通过该接口获取话题资料。

接口调用说明

适用的群组类型

即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。

说明：

话题功能需要在 控制台 > 功能配置 > 群组配置 > 群功能配置 > 社群 页面，完成开通社群后，再打开开通话题开关，方可使用。

请求 URL 示例

https://xxxxxx/v4/million_group_open_http_svc/get_topic?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明，更多参数详情请参考 REST API 简介。

最高调用频率

200次/秒。

请求包示例

• 基础形式

  用来获取话题的详细信息，请求中包含群组 ID 和所需要拉取的所有话题列表。

  {
    "GroupId":"@TGS#_@TGS#cQVLVHIM62CJ",    // 需要获取话题所在的群组ID （必填）
    "From_Account":"1400187352"    // 获取指定用户在话题中的信息 （必填）
  }
  

• 指定需要拉取的话题列表形式

  {
    "GroupId":"@TGS#_@TGS#cQVLVHIM62CJ",    // 需要获取话题所在的群组ID （必填）
    "From_Account":"1400187352",    // 获取指定用户在话题中的信息 （必填）
    "TopicIdList":[        // 指定需要拉取的话题列表 （选填）
        "@TGS#_@TGS#cQVLVHIM62CJ@TOPIC#_@TOPIC#cRTE3HIM62C5"
    ]
  }
  

• 使用过滤器，获取指定的信息形式
  可以指定拉取的话题信息字段，在 ResponseFilter 中设置。如果设置了过滤器，没有在过滤器中指明的字段将不被拉取。

  {
    "GroupId":"@TGS#_@TGS#cQVLVHIM62CJ",    // 需要获取话题所在的群组ID （必填）
    "From_Account":"1400187352",    // 获取指定用户在话题中的信息 （必填）
    "TopicIdList":[    // 指定需要拉取的话题列表 （选填）
        "@TGS#_@TGS#cQVLVHIM62CJ@TOPIC#_@TOPIC#cRTE3HIM62C5"
    ],
    "ResponseFilter":[    // 返回信息的过滤器，指定需要获取的话题信息 （选填）
        "TopicName",    // 话题的名称  
        "FaceUrl",        // 话题头像 URL
        "Notification",    // 话题公告
        "Introduction"    // 话题简介
    ]
  }
  

请求包字段说明

应答包体示例

• 基础形式、指定获取的话题列表形式

  {
    "ActionStatus": "OK",
    "ErrorInfo": "ok",    // 这里的 ErrorInfo 无意义，需要判断每个话题的 ErrorInfo
    "ErrorCode": 0,    // 这里的 ErrorCode 无意义，需要判断每个话题的 ErrorCode
    "TopicAndSelfInfo": [    // 返回结果为话题信息数组，为简单起见这里仅列出一个话题
        {
            "ErrorCode": 0,
            "ErrorInfo": "ok",    // 针对该话题的返回结果
            "SelfInfo": {     // 指定的用户在此话题中的相关信息
                "ShutUpTime": 0,    //用户的禁言时间
                "MsgSeq": 0,        // 成员已读消息 seq
                "MsgFlag": "AcceptAndNotify"    
            },
            "TopicInfo": {    // 返回的话题信息
                "TopicName": "TestTopicName",    // 话题的名称
                "GroupID": "@TGS#_@TGS#cQVLVHIM62CJ",    // 话题所在的群组ID
                "FaceUrl": "http://this.is.new.face.url",    // 话题头像 URL
                "TopicId": "@TGS#_@TGS#cQVLVHIM62CJ@TOPIC#_@TOPIC#cRTE3HIM62C5",    //话题的ID
                "NextMsgSeq": 1,    
                "Notification": "Notification",    // 话题公告
                "Introduction": "Introduction",    // 话题简介
                "CreateTime": 1658839448,    //话题的创建时间 （UTC 时间）
                "LastMsgTime": 0,    // 话题内最后一条消息的时间（UTC 时间）
                "MuteAllMember": "Off",  // 话题全员禁言标志，On代表为启用全员禁言，Off代表未启用全员禁言
                "CustomString": "This is a customs string."    //话题中的自定义字符串
            }
        }
    ]
  }
  

• 使用过滤器，获取指定的话题信息形式

    {
      "ActionStatus": "OK",
      "ErrorInfo": "ok",    // 这里的 ErrorInfo 无意义，需要判断每个话题的 ErrorInfo
      "ErrorCode": 0,    // 这里的 ErrorCode 无意义，需要判断每个话题的 ErrorCode
      "TopicAndSelfInfo": [    // 返回结果为话题信息数组，为简单起见这里仅列出一个话题
          {
              "ErrorCode": 0,
              "ErrorInfo": "ok",    // 针对该话题的返回结果
              "SelfInfo": {     // 指定的用户在此话题中的相关信息
                  "ShutUpTime": 0,    //用户的禁言时间
                  "MsgSeq": 0,    
                  "MsgFlag": "AcceptAndNotify"
              },
              "TopicInfo": {    // 返回的话题信息
                  "TopicName": "TestTopicName",    // 话题的名称
                  "GroupID": "@TGS#_@TGS#cQVLVHIM62CJ",    // 话题所在的群组ID
                  "FaceUrl": "http://this.is.new.face.url",    // 话题头像 URL
                  "TopicId": "@TGS#_@TGS#cQVLVHIM62CJ@TOPIC#_@TOPIC#cRTE3HIM62C5",    //话题的ID
                  "Notification": "Notification",    // 话题公告
                  "Introduction": "Introduction"    // 话题简介
              }
          }
      ]
  }
  
  

应答包字段说明

错误码说明

除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码（60000到79999）参见 错误码 文档。
本 API 私有错误码如下：

接口调试工具

通过 REST API 在线调试工具 调试本接口。