功能说明
本接口用于根据任务 ID 查询单个定时推送任务的详细信息,包括任务状态、调度时间、推送内容等。
接口调用说明
请求 URL 示例
https://xxxxxx/v4/timpush/get_sched_task?usersig=xxx&identifier=admin&sdkappid=88888888&random=99999999&contenttype=json
请求参数说明
参数 | 说明 |
https | 请求协议为:HTTPS。 请求方式为:POST。 |
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/timpush/get_sched_task | 请求接口。 |
usersig | |
identifier | |
sdkappid | 创建应用时即时通信控制台分配的 SdkAppid。 |
random | 请输入随机的32位无符号整数,取值范围0 - 4294967295。 |
contenttype | 固定值为: json。 |
调用频率限制
每秒5次。
请求包示例
{"Sdkappid": 88888888,"TaskID": 1234567890}
请求包字段说明
字段 | 类型 | 必填 | 说明 |
Sdkappid | Integer | 是 | 应用的 SDKAppID,必须与 URL 中的 sdkappid 一致。 |
TaskID | Integer | 是 | 定时任务 ID,创建任务时返回的 TaskID。 |
应答包体示例
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0,"TaskInfo": {"TaskID": 1234567890,"Sdkappid": 88888888,"CreateAt": "2025-05-20 08:30:00","Type": "All","SchedAt": "2025-06-01 10:00:00","Content": {"From_Account": 12345,"MsgRandom": 123456,"OfflinePushInfo": {"Title": "推送标题","Desc": "推送内容描述"}},"Title": "推送标题","Desc": "推送内容描述","Status": "pending","DispatchSuccess": 0,"DispatchErr": "","PushTaskID": ""}}
应答包字段说明
字段 | 类型 | 说明 |
ActionStatus | String | 请求处理的结果, OK 表示处理成功,FAIL 表示失败。 |
ErrorCode | Integer | 错误码, 0 表示成功,非 0 表示失败。 |
ErrorInfo | String | 错误信息。 |
TaskInfo | Object | 定时任务详细信息,详见下表 TaskInfo 字段说明。 |
TaskInfo 字段说明
字段 | 类型 | 说明 |
TaskID | Integer | 定时任务 ID。 |
Sdkappid | Integer | 应用的 SDKAppID。 |
CreateAt | String | 任务创建时间(UTC),格式 YYYY-MM-DD HH:MM:SS。 |
Type | String | 推送任务类型: All(全员推送)、Tag(按条件推送)、User(按用户推送)。 |
SchedAt | String | 定时调度时间(UTC),格式 YYYY-MM-DD HH:MM:SS。 |
Content | Object | 推送任务内容,结构与创建时传入的 Content 一致。 |
Title | String | 推送标题,从 Content 中的 OfflinePushInfo.Title 提取。 |
Desc | String | 推送描述,从 Content 中的 OfflinePushInfo.Desc 提取。 |
Status | String | 任务状态: pending 待执行,dispatching 调度中,dispatched 已调度。 |
DispatchSuccess | Integer | 调度是否成功: 0 表示未成功或未调度,1 表示调度成功。 |
DispatchErr | String | 调度失败时的错误信息,调度成功或未调度时为空。 |
PushTaskID | String | 调度成功后生成的推送任务 ID,可用于查询推送结果。 |
错误码说明
除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。公共错误码(60000到79999)参见 错误码 文档。
本 API 私有错误码如下:
错误码 | 说明 |
90104 | 请求参数无效,例如 TaskID 无效、sdkappid 不匹配等。 |
90105 | 内部错误。 |