OkayAPI Docs


API Path: /api/App/Task/Push

API Description: 推送将要执行的任务(即url链接),可以指定执行的时机为现在、多少秒后、或指定具体的时间点。任务url链接须支持80端口访问,支持带参数,指定请求方法。支持高并发批量任务推送,如果需要定时固定的计划任务,可进入小白开放平台计划任务管理面板配置。

1
API Traffic
HTTP/HTTPS
Protocol
GET/POST
Method
UTF-8
Charset
JSON
Response

API Debug   


API Params

ParameterTypeRequiredDefaultNoteDescription
HTTP_APPKEYStringRequiredMIN: 32Common Put Your APPKEY
urlStringRequired待请求的链接,必须是以http://或https://开头,且使用80端口
paramsArrayJSON FormatOptaion[]请求链接时的更多参数,为JSON格式
methodEnumOptaionGETRange: GET/POST通过HTTP执行任务链接时的请求方式
timeIntOptaion0计划任务的执行时间,分为以下三种情况:
  • time=0时(默认情况):任务被推送后会立即执行;
  • 0<time<2,592,000时(一个月),表示延后多少秒执行该任务,如time=10表示10秒后执行该任务;
  • time=UNIX时间戳时,表示在指定的时间点执行该任务。

API Debug

KEYREQUIREDVALUE
app_key *Required
url *Required
params Option
method Option
time Option

API Response

KEYTypeDescription
err_codeInt操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景
err_msgString错误提示信息,err_code非0时参考此提示信息

HTTP Response Code

HTTP Status CodeDescription
Http Status = 200Success
Http Status = 400Illegal-Params
Http Status = 401Illegal-Token
Http Status = 402IP-Banned
Http Status = 404API-NOT-Exsits
Http Status = 406Illegal-APPKEY
Http Status = 407APPKEY-Expired-Out
Http Status = 408APPKEY-Busy
Http Status = 409Illegal-Sign
Http Status = 413API-Traffic-NOT-Enough
Http Status = 415API-LOCKED
Http Status = 500Internal-Server-Error