Docs Overview/
获取公众号详细资料/

获取公众号详细资料

功能说明

App 管理员可以通过该接口获取公众号的相关资料信息。

接口调用说明

请求 URL 示例

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

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明，更多参数详情请参考 REST API 简介。
参数
说明
xxxxxx
SDKAppID 所在国家/地区对应的专属域名：
中国：console.tim.qq.com
新加坡：adminapisgp.im.qcloud.com
首尔： adminapikr.im.qcloud.com
法兰克福：adminapiger.im.qcloud.com
硅谷：adminapiusa.im.qcloud.com
雅加达：adminapiidn.im.qcloud.com
v4/official_account_open_http_svc/get_official_account_info
请求接口
sdkappid
创建应用时即时通信 IM 控制台分配的 SDKAppID
identifier
必须为 App 管理员账号，更多详情请参见 App 管理员
usersig
App 管理员账号生成的签名，具体操作请参见 生成 UserSig
random
请输入随机的32位无符号整数，取值范围0 - 4294967295
contenttype
请求格式固定值为json

最高调用频率

200次/秒。

请求包示例

{
    "OfficialAccountIdList": [    // 请求的公众号列表，最大一次拉取50个公众号
        {
            "Official_Account": "@TOA#_test_for_penn"
        },
        {
            "Official_Account": "@TOA#_@TOA#dZDP"
        }
    ],
    "ResponseFilter": {		// 过滤字段
        "OfficialAccountBaseInfoFilter": [		// 公众号信息的过滤字段
            "CreateTime",
            "Name",
            "Owner_Account",
            "LastMsgTime",
            "SubscriberNum",
            "Introduction",
            "FaceUrl",
            "Organization",
            "CustomString"
        ]
    }
}

请求包字段说明

字段
类型
属性
说明
OfficialAccountIdList
Array
必填
需要获取的公众号列表 ID
Official_Account
String
必填
需要获取的公众号 ID. 使用创建时接口返回的 OfficialAccountUserID 字段
ResponseFilter
Object
选填
过滤返回的公众号信息字段，不填时默认返回全部字段，包括 OfficialAccountBaseInfoFilter 过滤器，主要可取以下值：
CreateTime 公众号的创建时间
Name 公众号名称
Owner_Account公众号所属的用户
LastMsgTime 公众号内的最后一条消息时间
SubscriberNum 公众号目前的订阅者人数
Introduction 公众号简介
FaceUrl 公众号的头像Url
Organization 公众号的所在组织
CustomString 公众号维度的自定义字段

应答包体示例

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,		// 此处的ErrorCode表示整个请求的返回结果
    "OfficialAccountInfoList": [	// 返回的公众号信息列表
        {
            "ErrorCode": 0,		// 此处的ErrorCode表示获取此公众号的结果，返回0表示获取成功，其他值表示失败
            "ErrorInfo": "",
            "Name": "test_modify_official_account3",
            "Official_Account": "@TOA#_test_for_penn",
            "CreateTime": 1696577604,
            "Owner_Account": "107867",
            "LastMsgTime": 1699501664,
            "SubscriberNum": 780031,
            "Introduction": "test compare introduction",
            "FaceUrl": "http://this.is.face.url1",
            "Organization": "test compare organization",
            "CustomString": "modify_custom_string"
        },
        {
            "ErrorCode": 0,
            "ErrorInfo": "",
            "Name": "测试环境测试公众号",
            "Official_Account": "@TOA#_@TOA#dZDP",
            "CreateTime": 1694514910,
            "Owner_Account": "109635",
            "LastMsgTime": 1698894911,
            "SubscriberNum": 1004,
            "Introduction": "waynezou",
            "FaceUrl": "",
            "Organization": "Tencent",
            "CustomString": ""
        }
    ]
}

应答包字段说明

字段
类型
说明
ActionStatus
String
请求处理的结果：
OK：表示处理成功
FAIL：表示失败
ErrorCode
Integer
错误码：
0：表示成功
非0：表示失败
ErrorInfo
String
错误信息
OfficialAccountInfoList
Array
返回的公众号列表字段，返回的结果是根据过滤器中设置的过滤字段进行过滤后的信息。

错误码说明

除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。 公共错误码（60000到79999）参见 错误码 文档。 本 API 私有错误码如下：
错误码
含义说明
6017
请求参数非法，请修改后重试
10004
服务器内部错误，请重试
20001
请求包非法，请修改后重试
20005
服务器内部错误，请重试
130002
操作权限不足，请根据错误信息检查请求参数。
130004
公众号不存在，或者曾经存在过，但是目前已经被销毁
130007
公众号 ID 错误，请修改后重试
131000
此 AppId 暂未开通公众号服务，请开通后重试

参考