本接口用于获取端对端用户事件列表。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
AppId | string | 是 | APP ID。 | testappid |
ChannelId | string | 是 | 频道 ID。 | testid |
CreatedTs | long | 是 | 事件查询时间区间的开始时间,该时间不得早于频道实际的创建时间,不得早于 30 天之前。使用 UNIX 时间戳表示,单位:秒。 | 1614936817 |
DestroyedTs | long | 否 | 事件查询时间区间的结束时间,该时间不得晚于频道释放时间。使用 UNIX 时间戳表示,单位:秒。参数为空,表示获取当前时间。 | 1614936817 |
UserIdList | string | 是 | 用户 ID 列表,多个用英文逗号(,)分隔。 | testuserid1,testuserid2 |
返回参数
示例
正常返回示例
JSON
格式
{
"Nodes": [
{
"UserId": "testuserid",
"EventDataItems": [
{
"Ts": 1614936817,
"EventList": [
{
"EventName": "开始发布",
"EventType": "USER",
"Ts": 1614936817,
"TsInMs": "1614936817123"
}
]
}
]
}
],
"RequestId": "231470C1-ACFB-4C9F-844F-4CFE1E3804C5"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | ApiParamError | API %s. | Api参数错误 |
403 | BizAppError | A business application permission error occurred. | 业务应用权限错误 |
403 | BizUidError | A business UID error occurred. | 业务主账号错误 |
403 | BizCreatedTsError | A business CreatedTs error occurred. | 参数会议创建时间不准确。 |
500 | ServerInternalError | An internal error occurred. | 服务器内部错误 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-05-09 | OpenAPI 错误码发生变更 | 查看变更详情 |