OkayAPI Docs
API Params
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
topic | String | Required | 主题,自定义主题,发布不同主题时可定义不同的主题名称 | ||
message | String | Required | 需要发送的消息内容 | ||
qos | Int | Optaion | 0 | MIN: 0;MAX: 2 | qos = 0:仅发一次,不管是否能收到 qos = 1:没返回一直发,可能有重复接收 qos = 2:保证必须收到,并且不重复 |
API Debug
KEY | REQUIRED | VALUE |
---|---|---|
app_key | *Required | |
topic | *Required | |
message | *Required | |
qos | Option |
API Response
KEY | Type | Description |
---|---|---|
err_code | Int | 操作码,0发送成功,1发送失败 |
topic | String | 成功发布后的主题名称,客户端进行订阅时需要使用此topic主题。如果需要接入,请联系技术客服获取服务端IP和端口。 |
HTTP Response Code
HTTP Status Code | Description |
---|---|
Http Status = 200 | Success |
Http Status = 400 | 表示客户端参数错误 |
Http Status = 404 | 表示接口服务不存在 |
Http Status = 500 | 表示服务端内部错误 |