有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

功能说明

App 管理员可以通过该接口拉取最近30天的运营数据,可拉取的字段见下文 可拉取的运营字段
数据是按天维度(北京时间)统计。

接口调用说明

请求 URL 示例

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

最高调用频率

200次/秒。

请求包示例

查询 SDKAppID 的最近30天的运营数据。
基础形式 默认拉取所有字段
{}
指定拉取字段 用 RequestField 指定需要拉取的字段。
{
"RequestField":[
"ChainIncrease",
"ChainDecrease"
]
}

请求包字段说明

字段
类型
属性
说明
RequestField
Array
选填
该字段用来指定需要拉取的运营数据,不填默认拉取所有字段。详细可参阅下文 可拉取的运营字段

应答包体示例

基础形式
{
"ErrorCode": 0,
"ErrorInfo": "OK",
"Result": [{
"APNSMsgNum": "84",
"ActiveUserNum": "2014",
"AppId": "1104620500",
"C2CAPNSMsgNum": "84",
"C2CDownMsgNum": "11040",
"C2CSendMsgUserNum": "9",
"C2CUpMsgNum": "52209",
"CallBackReq": "73069",
"CallBackRsp": "72902",
"ChainDecrease": "16",
"ChainIncrease": "18",
"Date": "20160607",
"DownMsgNum": "11869",
"GroupAPNSMsgNum": "0",
"GroupAllGroupNum": "41913",
"GroupDestroyGroupNum": "35019",
"GroupDownMsgNum": "829",
"GroupJoinGroupTimes": "121438",
"GroupNewGroupNum": "35904",
"GroupQuitGroupTimes": "108292",
"GroupSendMsgGroupNum": "5189",
"GroupSendMsgUserNum": "12",
"GroupUpMsgNum": "8433",
"LoginTimes": "13708",
"LoginUserNum": "2094",
"MaxOnlineNum": "62",
"RegistUserNumOneDay": "1052",
"RegistUserNumTotal": "53091",
"SendMsgUserNum": "19",
"UpMsgNum": "60642",
}]
}
指定拉取字段
{
"ErrorCode":0,
"ErrorInfo":"OK",
"Result":[{
"ChainDecrease":"8",
"ChainIncrease":"8",
"Date":"20160605"
},
{
"ChainDecrease":"17",
"ChainIncrease":"17",
"Date":"20160604"
}
]
}

应答包字段说明

字段
类型
说明
Result
Array
请求最近30天的运营数据
ErrorCode
Integer
错误码:
0:表示成功
非0:表示失败
ErrorInfo
String
错误信息

错误码说明

除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。 公共错误码(60000到79999)参见 错误码 文档。 本 API 私有错误码如下:
错误码
含义说明
130001
请求包 JSON 解析错误
130009
SQL Open 错误
130010
SQL Ping 错误
130011
SQL 查询错误
130012
SQL 结果解析错误

可拉取的运营字段

字段
说明
AppId
应用 SDKAppID
ActiveUserNum
活跃用户数
RegistUserNumOneDay
新增注册人数
RegistUserNumTotal
累计注册人数
LoginTimes
登录次数
LoginUserNum
登录人数
UpMsgNum
上行消息数
SendMsgUserNum
发消息人数
APNSMsgNum
APNs 推送数
C2CUpMsgNum
上行消息数(C2C)
C2CDownMsgNum
下行消息数(C2C)
C2CSendMsgUserNum
发消息人数(C2C)
C2CAPNSMsgNum
APNs 推送数(C2C)
MaxOnlineNum
最高在线人数
DownMsgNum
下行消息总数(C2C和群)
ChainIncrease
关系链对数增加量
ChainDecrease
关系链对数删除量
GroupUpMsgNum
上行消息数(群)
GroupDownMsgNum
下行消息数(群)
GroupSendMsgUserNum
发消息人数(群)
GroupAPNSMsgNum
APNs 推送数(群)
GroupSendMsgGroupNum
发消息群组数
GroupJoinGroupTimes
入群总数
GroupQuitGroupTimes
退群总数
GroupNewGroupNum
新增群组数
GroupAllGroupNum
累计群组数
GroupDestroyGroupNum
解散群个数
CallBackReq
回调请求数
CallBackRsp
回调应答数
Date
日期

接口调试工具

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