Skip to content

响应字段字典

按对象查询完整响应字段。各接口页提供请求参数、调用示例和处理步骤。

成功外层固定为code=0、message为空字符串、data为接口对象。下表“必返”指字段是否始终存在;允许null时会在类型中注明,不能将null当作0或空字符串。金额单位和枚举见含义列。

请求错误

字段类型必返含义与约束
codeinteger与 HTTP 状态码相同的错误码。
messagestring本次失败的具体说明,供开发者诊断;可能补充字段名,不能用作程序枚举。
error_codestring稳定的错误标识,用于程序分支。不要解析 message 文本。 可选值:"INVALID_ARGUMENT"、"COLLECTION_ADDRESS_MANAGED"、"INVALID_AUTH_HEADER"、"INVALID_SIGNATURE"、"TIMESTAMP_OUT_OF_RANGE"、"TOKEN_INVALID_OR_EXPIRED"、"TENANT_UNAVAILABLE"、"RESOURCE_NOT_FOUND"、"ROUTE_NOT_FOUND"、"METHOD_NOT_ALLOWED"、"IDEMPOTENCY_CONFLICT"、"BUSINESS_CONFLICT"、"PAYLOAD_TOO_LARGE"、"RATE_LIMITED"、"SERVICE_BUSY"、"SERVICE_UNAVAILABLE"、"REQUEST_TIMEOUT"、"INTERNAL_ERROR"。
trace_idstring平台生成的本次 HTTP 请求追踪编号;与 X-Trace-Id 响应头一致。用于排错,与写入幂等 request_id 不同。

加密回调外层

HTTP POST 的加密请求体。HKDF-SHA256 使用 appSecret 原始 UTF-8 字节为 IKM,appID UTF-8 为 salt,guiji/webhook/v1 为 info,派生32字节AES密钥。AAD为guiji/webhook/v1\n{app_id}\n{event_id}\n{timestamp},末尾无换行。先验证认证标签再处理明文。无额外回调签名头。

字段类型必返含义与约束
versioninteger回调加密格式版本,固定为1。 固定值:1。
algorithmstring固定为AES-256-GCM;不支持其他解密算法。 固定值:"AES-256-GCM"。
app_idstring租户 appID。
event_idstring固定事件 ID;重试及人工新轮次保持不变。
timestampstring本次投递的 Unix 秒级时间戳,参与 AAD。
noncestring随机 12 字节 nonce 的标准 Base64。
ciphertextstring标准 Base64:密文后拼接 16 字节 GCM 认证标签。

到账记录(查询与通知共用)

到账详情 data、到账列表 items[] 和到账通知解密正文共用的 24 字段结构,全部字段必返;confirmations 与 block_hash 允许为 null。查询返回当前版本,历史通知保留对应事件版本;同一 id、revision 的内容一致。不包含投递状态。 同步恢复或核验可能补录较早区块的到账;不要按 block_time 距离当前时间的长短认定无效。已有到账恢复保持原 id、event_id、created_at 和 revision,重复事件不得重复入账。

字段类型必返含义与约束
idstring到账记录 ID,同一链上交易日志在撤销、重新确认后保持不变。
event_idstring本次状态事件 ID;重试不变,撤销或重新确认产生新事件 ID。按 event_id 去重,按 id 与 revision 更新到账状态。
event_typestring到账状态事件类型:deposit.confirmed 为达到确认门槛,deposit.reverted 为因链重组撤销。 可选值:"deposit.confirmed"、"deposit.reverted"。
statusstringconfirmed 表示达到租户确认门槛;低确认模式仍可能回退。reverted 表示先前认可的到账已因链重组撤销。 可选值:"confirmed"、"reverted"。
wallet_idstring收款钱包 ID。
custom_idstring钱包的租户自定义ID,同一租户内唯一,取到账入库时快照。
chainstring所属区块链。 固定值:"TRON"。
networkstring资产所属网络:main(主网)或 nile(测试网络)。 可选值:"main"、"nile"。
assetstring资产名称;测试网对应测试代币。资产身份以network+contract为准。 固定值:"USDT"。
token_standardstring代币协议。 固定值:"TRC20"。
decimalsinteger金额精度,展示金额=amount÷10^decimals。使用整数或十进制定点计算。 固定值:6。
addressstring到账收款地址。
sourcestring链上 Transfer 事件的来源地址。
contractstring此笔Transfer的实际代币合约。结合network识别资产;Nile为测试代币,Main为Tether发行的USDT。
amountstring该条到账记录的 USDT 金额,是否有效由 status 决定;最小单位整数字符串,六位精度,禁止用浮点数处理。
txidstring该条到账对应的交易哈希。
log_indexinteger交易收据内的日志索引;与网络、交易哈希一起标识链上事件。
block_numberstring本次到账状态对应的区块高度;低确认模式下不代表已经固化。
block_timestring链上区块时间;UTC RFC3339,固定6位小数秒,以Z结尾。不是通知发送时间。 时间包含时区。
created_atstring平台确认并保存到账的时间;UTC RFC3339,固定6位小数秒,以Z结尾。确认或同步存在延迟时,可能晚于 block_time。 时间包含时区。
revisioninteger同一到账记录的状态版本,从1递增。接收方只应用大于本地版本的状态;迟到的旧版本仍应答 SUCCESS。
confirmation_typestring首次发现该到账时的平台配置快照,仅平台管理员可设置;租户修改后不影响已发现的到账。 可选值:"solidified"、"block_1"、"block_3"、"block_6"、"block_12"。
confirmationsinteger / null按区块深度确认时的确认数,交易所在区块计 1;按固化结果确认时为 null。
block_hashstring / null当前状态对应的区块哈希;历史固化记录未保存此字段时为null。用于区分相同高度的不同区块。

归集结果明文

解密后的归集结果。event_type 前缀区分任务种类,后缀等于 status。

字段类型必返含义与约束
event_idstring固定事件 ID,必须等于加密外层 event_id。
event_typestring归集结果事件,分别为成功、失败或取消;按同一event_id去重。 可选值:"sweep.succeeded"、"sweep.failed"、"sweep.cancelled"。
networkstring资产所属网络:main(主网)或 nile(测试网络)。 可选值:"main"、"nile"。
task_idstring归集任务 ID。
wallet_idstring关联收款钱包 ID。
amountstring归集金额使用USDT六位精度最小单位。尚未确定金额可为0。
destinationstring任务固定目标地址。
txidstring链上交易哈希,尚未生成交易时为空字符串。
statusstring归集任务终态:succeeded成功、failed失败、cancelled取消;推送失败不影响该状态。 可选值:"succeeded"、"failed"、"cancelled"。
reasonstring失败或取消原因;成功为空字符串。
actual_feestring实际手续费,TRX最小单位,六位精度;未产生费用为0。

回调成功应答

提交本地业务事务后应答 HTTP 200 与 code 精确字符串 SUCCESS;最大64KiB,大小写敏感。

字段类型必返含义与约束
codestring业务提交成功后的应答,必须是大写字符串SUCCESS;重复已处理事件同样返回SUCCESS。 固定值:"SUCCESS"。

开放接口令牌

字段类型必返含义与约束
access_tokenstring当前租户唯一有效的第三方访问令牌,32 个随机字节的规范无填充 Base64URL 编码。
token_typestring令牌类型。 固定值:"Bearer"。
expires_ininteger有效秒数,最多 7200 秒,且不超过租户剩余有效期。
expires_atstring令牌过期时间。 时间包含时区。

账户概览

字段类型必返含义与约束
wallet_countinteger当前租户、当前网络的钱包数。
unsynced_wallet_countintegerbalance_block 为 0、尚未完成首次同步的钱包数。
balance_usdtstring当前租户、网络的钱包 USDT 余额合计;最小单位的整数字符串,六位精度,禁止用浮点数处理。
balance_trxstring当前租户、网络的钱包 TRX 余额合计,SUN;最小单位的整数字符串,六位精度,禁止用浮点数处理。
collected_usdtstring累计成功归集 USDT 金额;最小单位的整数字符串,六位精度,禁止用浮点数处理。
deposit_usdtstring已确认到账 USDT 金额累计;最小单位的整数字符串,六位精度,禁止用浮点数处理。
pending_tasksinteger当前租户、网络的未结束任务数,含归集。
engine同步服务状态[]服务运行状态,仅用于辅助排查同步异常;不代表某笔任务成功,无状态信息时为 []。
networkstring资产所属网络:main(主网)或 nile(测试网络)。 可选值:"main"、"nile"。

同步服务状态

字段类型必返含义与约束
componentstring服务状态项名称。
statusstring服务状态文本,不是固定枚举。
detailstring服务状态说明。
updated_atstring状态最近更新时间。 时间包含时区。

钱包分页

字段类型必返含义与约束
items钱包及余额[]本页钱包,无结果为 []。
totalinteger满足筛选条件的总记录数。
pageinteger当前页码。
page_sizeinteger每页条数。
unavailable_wallet_idsstring[]仅当前页及selected_wallet_ids指定钱包中的不可选ID,与本页钱包状态一致,最多 1100 个。
networkstring资产所属网络:main(主网)或 nile(测试网络)。 可选值:"main"、"nile"。

钱包及余额

字段类型必返含义与约束
idstring钱包 ID。
addressstring平台生成的 TRON Base58Check 收款地址。
custom_idstring租户自定义 ID;同一租户内唯一,1–32 个字符,不允许首尾空白。
chainstring所属链。 固定值:"TRON"。
networkstring资产所属网络:main(主网)或 nile(测试网络)。 可选值:"main"、"nile"。
collection_statusstringidle:暂无任务;collecting:存在任一未结束的归集任务。 可选值:"idle"、"collecting"。
balance_usdtstring / null已同步的 USDT 余额;最小单位的整数字符串,六位精度,禁止用浮点数处理。 首次同步前null,显示待同步,不能当作0。
balance_trxstring / null已同步的 TRX 余额,单位 SUN;最小单位的整数字符串,六位精度,禁止用浮点数处理。 首次同步前null,显示待同步,不能当作0。
balance_blockstring余额同步时的固化区块参考高度。0 表示尚未完成首次同步;不是实际链上余额为零的证明。
destinationstring当前租户统一配置的 USDT 归集地址;未绑定时为空字符串,可为外部地址。
collected_usdtstring累计成功归集 USDT 金额;最小单位的整数字符串,六位精度,禁止用浮点数处理。
last_collected_atstring / null最近一次成功归集时间;从未归集为 null。
created_atstring钱包创建时间。 时间包含时区。

新建钱包身份

字段类型必返含义与约束
idstring钱包 ID。
addressstring平台生成的 TRON Base58Check 收款地址。
custom_idstring租户自定义 ID;同一租户内唯一,1–32 个字符,不允许首尾空白。
chainstring所属链。 固定值:"TRON"。
created_atstring钱包创建时间。 时间包含时区。
networkstring资产所属网络:main(主网)或 nile(测试网络)。 可选值:"main"、"nile"。

选中的钱包

字段类型必返含义与约束
wallet_idsstring[]符合条件且可选择的钱包 ID,升序,最多 1000 个。
totalintegerwallet_ids 的实际长度。
networkstring资产所属网络:main(主网)或 nile(测试网络)。 可选值:"main"、"nile"。

归集分页

字段类型必返含义与约束
items归集任务[]本页归集记录,无结果为 []。
totalinteger满足筛选条件的总记录数。
pageinteger当前页码。
page_sizeinteger每页条数。
networkstring资产所属网络:main(主网)或 nile(测试网络)。 可选值:"main"、"nile"。

归集任务

字段类型必返含义与约束
idstring归集任务 ID。
wallet_idstring收款钱包 ID。
addressstring归集来源钱包地址。
kindstring任务类型。 固定值:"sweep"。
sweep_modestringall 全额归集;fixed 按指定金额归集。 可选值:"all"、"fixed"。
requested_amountstring / nullfixed 模式的请求金额;all 模式为 null;最小单位的整数字符串,六位精度,禁止用浮点数处理。
amountstring任务准备后确定的实际转账金额;准备前为 0;最小单位的整数字符串,六位精度,禁止用浮点数处理。
destinationstring任务保存的归集目标地址;修改账户配置不会改写已签名交易的目标。
statusstring归集任务状态。 可选值:"pending"、"ready"、"signed"、"broadcast"、"unknown"、"succeeded"、"failed"、"cancelled"。
reasonstring失败或取消原因;没有原因时为空字符串。
txidstring已保存交易的哈希,通常为 64 位十六进制;签名前为空字符串。
actual_feestring实际链上手续费,TRX 的最小单位 SUN;尚未确认时可能为 0;最小单位的整数字符串,六位精度,禁止用浮点数处理。
created_atstring任务创建时间。 时间包含时区。
updated_atstring任务最后更新时间。 时间包含时区。
webhook关联通知摘要 / null与本条业务结果关联的通知摘要;未创建通知时为null。通知失败不改变资金结果。
networkstring资产所属网络:main(主网)或 nile(测试网络)。 可选值:"main"、"nile"。
preparation_stagestring准备阶段:queued排队、waiting_bandwidth等待免费带宽、renting租赁中、waiting_energy等待能量到账、ready准备完成;最终成功仍以status为准。 可选值:"queued"、"waiting_bandwidth"、"renting"、"waiting_energy"、"ready"。
energy_rentalCatFee租赁记录 / null归集任务唯一的CatFee租赁记录。没有订单记录时energy_rental整体为null。
fee_sourcestring / null费用来源;历史或尚未准备的任务为null,不推断历史支付方式。 可选值:"resources"、"wallet_trx"、"catfee"、null。
prepared_energystring / null准备能量额度;历史或尚未产生该数据时为null。
estimated_wallet_trx_feestring / null准备时预计钱包TRX费用SUN;历史或尚未产生该数据时为null。
max_wallet_trx_feestring / null准备时钱包能量缺口费用上限SUN;历史或尚未产生该数据时为null。
actual_bandwidth_feestring / null回执实际带宽费用SUN;历史或尚未产生该数据时为null。
fee_warningstring / null链上实际发生非零带宽费时记录异常;不改变真实转账成功状态。

关联通知摘要

字段类型必返含义与约束
idstring固定通知事件 ID。
event_typestring通知事件类型。 可选值:"deposit.confirmed"、"sweep.succeeded"、"sweep.failed"、"sweep.cancelled"、"deposit.reverted"。
statusstringpending 待推送;delivering 推送中;delivered 推送成功;failed 推送异常。 可选值:"pending"、"delivering"、"delivered"、"failed"。
attemptsinteger当前轮已开始的尝试次数,包含结果未知的尝试。
current_roundinteger当前推送轮次;人工重新推送开启下一轮。
next_attemptstring / null下一次计划推送时间;没有计划时为 null。
deadline_atstring本轮 10 分钟截止时间。 时间包含时区。
last_errorstring最近推送错误;没有错误时为空字符串。
created_atstring事件创建时间。 时间包含时区。
delivered_atstring / null推送成功时间;尚未成功为 null。
networkstring资产所属网络:main(主网)或 nile(测试网络)。 可选值:"main"、"nile"。

CatFee租赁记录

归集任务唯一的CatFee租赁记录。没有订单记录时energy_rental整体为null。

字段类型必返含义与约束
order_idstring / nullCatFee订单号;尚未确认创建成功时为null,不能据此再次下单。
quantitystring租赁能量数量,整数单位,不是TRX金额。
estimated_coststring预计平台租赁费用,SUN整数字符串;1000000 SUN=1 TRX。
paid_coststring当前记录的实际租赁扣费,SUN;未确认扣费时为0,结合state判断。
activation_coststring当前记录的地址激活费用,SUN;没有激活费或尚未确认时为0。
statestring租赁状态:prepared已准备、requesting请求中、unknown结果未知、waiting等待交付、confirmed已确认、failed失败、expired已过期。 可选值:"prepared"、"requesting"、"unknown"、"waiting"、"confirmed"、"failed"、"expired"。
expires_atstring / null资源到期时间,RFC3339带时区;尚未取得到期时间时为null。 时间包含时区。

归集批次受理结果

字段类型必返含义与约束
items单项受理成功 / 单项受理失败[]逐钱包结果,顺序与 wallet_ids 一致。全项拒绝时 HTTP 仍为 200。
networkstring资产所属网络:main(主网)或 nile(测试网络)。 可选值:"main"、"nile"。

单项受理成功

字段类型必返含义与约束
wallet_idstring来源钱包 ID。
idstring已创建的任务 ID。
statusstring任务已排队;不代表链上成功。 固定值:"pending"。
networkstring资产所属网络:main(主网)或 nile(测试网络)。 可选值:"main"、"nile"。

单项受理失败

字段类型必返含义与约束
wallet_idstring该项输入钱包 ID。
statusstring该钱包未创建任务。 固定值:"failed"。
reasonstring逐钱包拒绝原因。 可选值:"wallet not found"、"collection destination wallet cannot collect to itself"、"tenant collection address not configured"、"wallet already has an unfinished task"。
networkstring资产所属网络:main(主网)或 nile(测试网络)。 可选值:"main"、"nile"。

到账分页

字段类型必返含义与约束
items到账记录(查询与通知共用)[]本页到账记录,无结果为 []。
totalinteger满足筛选条件的总记录数。
pageinteger当前页码。
page_sizeinteger每页条数。
networkstring资产所属网络:main(主网)或 nile(测试网络)。 可选值:"main"、"nile"。

服务健康

字段类型必返含义与约束
statusstring依赖正常。 固定值:"ok"。
networkstring资产所属网络:main(主网)或 nile(测试网络)。 可选值:"main"、"nile"。

账户地址设置

字段类型必返含义与约束
collection_addressstring当前租户统一配置的 USDT 归集目标;未绑定为空字符串,可以是外部 TRON 地址。

归集地址设置结果

字段类型必返含义与约束
collection_addressstring保存后的 USDT 归集地址。

自动归集配置

字段类型必返含义与约束
enabledboolean自动归集的总开关。
usdt_minimumstring / null自动归集触发下限,最小单位 USDT,规范正整数字符串,最大 2^256−1;关闭时可为 null。

回调配置

字段类型必返含义与约束
urlstring公网 HTTPS 回调地址,只允许默认端口或 443;不含用户凭据或片段。关闭时可为空字符串。
enabledboolean是否开启新通知轮次的正常投递;开启时必须有合法非空 URL。

钱包预览

字段类型必返含义与约束
items钱包及余额[]所选钱包,去重并按请求首次出现顺序返回;任何 ID 不属于当前租户和网络则整个请求失败。
networkstring资产所属网络:main(主网)或 nile(测试网络)。 可选值:"main"、"nile"。

批量预估

字段类型必返含义与约束
networkstring资产所属网络:main(主网)或 nile(测试网络)。 可选值:"main"、"nile"。
destinationstring本次预估使用的租户归集地址。
destination_versionstring本次预估使用的归集配置版本,不是钱包 ID。
sweep_modestring与请求一致。 可选值:"all"、"fixed"。
requested_amountstring / nullall 必须明确为 null;fixed 必须为规范正 int64 字符串,最大 9223372036854775807,表示每个钱包的 USDT 最小单位金额。
estimated_atstring本次预估响应开始生成的时间。 时间包含时区。
items单钱包预估结果[]逐钱包结果,与请求顺序一致。

单钱包预估结果

字段类型必返含义与约束
wallet_idstring本项钱包 ID。
addressstring本项来源地址。
amountstring / null本次预估金额;无法取得金额时为 null;六位精度最小单位的整数字符串。
statusstringestimated 已取得费用预估;failed 本项不能预估。 可选值:"estimated"、"failed"。
reasonstring失败原因;预估成功为空字符串。
estimate资源与费用预估 / null该钱包预估明细;本项预估失败时为null,原因见reason。

资源与费用预估

字段类型必返含义与约束
energy_requiredstring交易总能量需求,单位能量点。 以非负整数字符串传递。
energy_from_originstring合约部署方分担的能量点数。 以非负整数字符串传递。
caller_energy_requiredstring调用钱包需要承担的能量点数。 以非负整数字符串传递。
energy_availablestring钱包当前可用能量点数。 以非负整数字符串传递。
energy_from_resourcesstring实际使用已有资源抵扣的能量点数。 以非负整数字符串传递。
energy_burnedstring当前已有资源抵扣后的能量缺口;仅wallet_trx路径预计燃烧TRX支付,catfee路径通过租赁补足。
energy_feestring预计由钱包燃烧的TRX能量费用,SUN;resources和catfee路径为0。
bandwidth_requiredstring预计交易所需带宽,单位字节。 以非负整数字符串传递。
staked_bandwidth_availablestring链上质押或委托带宽,仅作资源信息返回,不计入归集可用额度。归集只允许免费带宽。
free_bandwidth_availablestring当前可用的免费带宽,单位字节。 以非负整数字符串传递。
bandwidth_from_resourcesstring免费带宽可覆盖整笔交易时为完整交易字节数;不足时为0,等待恢复。
bandwidth_burnedstring当前带宽不足时的交易带宽需求;此时任务等待恢复,不会燃烧TRX。
bandwidth_feestring归集不使用TRX购买带宽,固定为0。
energy_pricestring每能量点价格,SUN。 以非负整数字符串传递。
bandwidth_pricestring每带宽字节价格,SUN。 以非负整数字符串传递。
fee_limitstring交易完整能量准备额度折算的SUN上限,不是预计扣款,也不是带宽费用上限。
estimated_feestring预计钱包链上TRX支出,等于energy_fee,独立于rental_cost。
balance_usdtstring预估时查询的已确认 USDT 余额,最小单位。 以非负整数字符串传递。
balance_trxstring确认余额与当前节点余额中的较小值,排除未确认收入并反映未确认支出,SUN。
bandwidth_sourcestringfree使用免费额度;waiting等待免费带宽恢复或地址激活;不使用质押带宽或TRX。 可选值:"free"、"waiting"。
rental_quantitystring仅catfee路径非零;能量准备额度减已有能量,最低65000。
rental_coststring仅 catfee 路径的预计租赁费用,SUN,由平台支付;其他路径为 "0"。
activation_requiredstring地址是否需要激活。true 时订单同时激活地址,完成后重新核验资源。 可选值:"true"、"false"。
fee_sourcestring费用来源:resources 为自身能量,wallet_trx 为钱包 TRX,catfee 为平台能量租赁。 可选值:"resources"、"wallet_trx"、"catfee"。
prepared_energystring模拟总能量加10%后向上取整的准备额度。
max_wallet_trx_feestring本次准备额度中允许钱包支付的能量缺口费用,SUN;仅wallet_trx路径非零。
free_bandwidth_limitstring账户免费带宽上限;交易字节数超过此值不能等待恢复解决。

通知分页

字段类型必返含义与约束
items通知摘要[]本页记录;无结果为 []。
totalinteger满足条件的总记录数。
pageinteger当前页码。
page_sizeinteger每页条数。
networkstring资产所属网络:main(主网)或 nile(测试网络)。 可选值:"main"、"nile"。

通知摘要

字段类型必返含义与约束
idstring固定通知事件 ID。
event_typestring通知事件类型。 可选值:"deposit.confirmed"、"sweep.succeeded"、"sweep.failed"、"sweep.cancelled"、"deposit.reverted"。
statusstringpending 待推送;delivering 推送中;delivered 推送成功;failed 推送异常。 可选值:"pending"、"delivering"、"delivered"、"failed"。
attemptsinteger当前轮已开始的尝试次数,包含结果未知的尝试。
current_roundinteger当前推送轮次;人工重新推送开启下一轮。
next_attemptstring / null下一次计划推送时间;没有计划时为 null。
deadline_atstring本轮 10 分钟截止时间。 时间包含时区。
last_errorstring最近推送错误;没有错误时为空字符串。
created_atstring事件创建时间。 时间包含时区。
delivered_atstring / null推送成功时间;尚未成功为 null。
networkstring资产所属网络:main(主网)或 nile(测试网络)。 可选值:"main"、"nile"。

通知详情

字段类型必返含义与约束
idstring固定通知事件 ID。
event_typestring通知事件类型。 可选值:"deposit.confirmed"、"sweep.succeeded"、"sweep.failed"、"sweep.cancelled"、"deposit.reverted"。
statusstringpending 待推送;delivering 推送中;delivered 推送成功;failed 推送异常。 可选值:"pending"、"delivering"、"delivered"、"failed"。
attemptsinteger当前轮已开始的尝试次数,包含结果未知的尝试。
current_roundinteger当前推送轮次;人工重新推送开启下一轮。
next_attemptstring / null下一次计划推送时间;没有计划时为 null。
deadline_atstring本轮 10 分钟截止时间。 时间包含时区。
last_errorstring最近推送错误;没有错误时为空字符串。
created_atstring事件创建时间。 时间包含时区。
delivered_atstring / null推送成功时间;尚未成功为 null。
payload到账记录(查询与通知共用) / 归集结果明文原始业务事件正文,未加密对象;通过当前租户鉴权后返回,字段与回调解密结果相同。
networkstring资产所属网络:main(主网)或 nile(测试网络)。 可选值:"main"、"nile"。

轮次分页

字段类型必返含义与约束
items推送轮次[]本页记录;无结果为 []。
totalinteger满足条件的总记录数。
pageinteger当前页码。
page_sizeinteger每页条数。
networkstring资产所属网络:main(主网)或 nile(测试网络)。 可选值:"main"、"nile"。

推送轮次

字段类型必返含义与约束
idstring推送轮次 ID。
event_idstring所属固定事件 ID。
round_nointeger从 1 开始的轮次号。
urlstring本轮固定回调地址;未配置时为空字符串。
started_atstring本轮开始时间。 时间包含时区。
deadline_atstring本轮截止时间,开始后 10 分钟。 时间包含时区。
finished_atstring / null本轮结束时间;未结束为 null。
attemptsinteger本轮已占用的尝试次数,包含结果未知的尝试。
next_attemptstring / null下一次计划投递时间;没有计划时为 null。
statusstringpending 待投递;delivering 投递中;delivered 成功;failed 异常。 可选值:"pending"、"delivering"、"delivered"、"failed"。
last_errorstring当前轮次最近异常,正常时为空字符串。
networkstring资产所属网络:main(主网)或 nile(测试网络)。 可选值:"main"、"nile"。

尝试分页

字段类型必返含义与约束
items单次推送[]本页记录;无结果为 []。
totalinteger满足条件的总记录数。
pageinteger当前页码。
page_sizeinteger每页条数。
networkstring资产所属网络:main(主网)或 nile(测试网络)。 可选值:"main"、"nile"。

单次推送

字段类型必返含义与约束
idstring本次尝试记录 ID。
event_idstring固定事件 ID。
round_idstring所属轮次 ID。
round_nointeger所属轮次号。
attemptinteger该轮内的尝试序号。
statusstringsending 正在发送;succeeded 已成功;failed 已失败;unknown 崩溃后结果未知。 可选值:"sending"、"succeeded"、"failed"、"unknown"。
http_statusinteger / null第三方 HTTP 状态码;未取得响应时为 null。
errorstring本次网络或应答错误;正常时为空字符串。
started_atstring发送前入库的尝试开始时间。 时间包含时区。
finished_atstring / null本次尝试结束时间;尚未结束为 null。
duration_msinteger / null尝试耗时毫秒;尚未结束为 null。
response_bodystring第三方返回正文保存为纯文本;存储前清理非法UTF-8及NUL,最多64 KiB,超限标记response_truncated并视为失败。可能不是JSON;展示时不得执行HTML。
response_truncatedboolean正文超过上限或清理后超限时为 true;截断必定视为失败。
created_atstring尝试记录入库时间。 时间包含时区。
networkstring资产所属网络:main(主网)或 nile(测试网络)。 可选值:"main"、"nile"。