修改公众号资料

最近更新时间:2024-07-09 18:05:52

我的收藏

功能说明

App 管理员可以通过该接口修改公众号的相关信息,如公众号的名称、头像、简介等。

接口调用说明

请求 URL 示例

https://xxxxxx/v4/official_account_open_http_svc/modify_official_account_base_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/modify_official_account_base_info
请求接口
sdkappid
创建应用时即时通信 IM 控制台分配的 SDKAppID
identifier
必须为 App 管理员账号,更多详情请参见 App 管理员
usersig
App 管理员账号生成的签名,具体操作请参见 生成 UserSig
random
请输入随机的32位无符号整数,取值范围0 - 4294967295
contenttype
请求格式固定值为json

最高调用频率

200次/秒。

请求包示例

{
"Official_Account": "@TOA#_@TOA#dOEF",
"CustomString": "modify_custom_string",
"FaceUrl": "http://this.is.face.url",
"Introduction": "This is modify test Introduction",
"Name": "test_modify_official_account",
"Organization": "modify_organization",
"MaxSubscriberNum":1000
}

请求包字段说明

字段
类型
属性
说明
Official_Account
String
必填
需要修改的公众号ID. 使用创建时接口返回的OfficialAccountUserID字段
Name
String
选填
公众号的名称,最长150字节,使用 UTF-8 编码,1个汉字占3个字节
Introduction
String
选填
公众号简介,最长400字节,使用 UTF-8 编码,1个汉字占3个字节
FaceUrl
String
选填
公众号头像,最长500字节
Organization
String
选填
公众号所属的团体组织,最长500字节,使用 UTF-8 编码,1个汉字占3个字节
CustomString
String
选填
公众号的自定义字段,最长3000字节,应用层可以使用此字段来实现特殊场景的需求
MaxSubscriberNum
Integer
选填
一个公众号支持的最大可订阅人数。缺省时的默认值为100000


应答包体示例

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

应答包字段说明

字段
类型
说明
ActionStatus
String
请求处理的结果:
OK:表示处理成功
FAIL:表示失败
ErrorCode
Integer
错误码:
0:表示成功
非0:表示失败
ErrorInfo
String
错误信息

错误码说明

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

参考

可能触发的回调