OkayAPI Docs
API Params
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
message_content | String | Required | 留言内容,支持HTML格式 | ||
message_nickname | String | Optaion | MAX: 32 | 留言用户名 | |
message_key | String | Optaion | MAX: 64 | 评论的唯一标识,例如某篇文章 | |
message_pid | Int | Optaion | 0 | MIN: 0 | 嵌套评论时的父级评论ID,没有时为0,目前最多支持三层嵌套 |
more_data | ArrayJSON Format | Optaion | 额外需要添加的数据,即客户端自定义添加的额外字段,需要JSON编码后传递。格式:data={"字段名1":"字段值1","字段名2":"字段值2"...},系统保留表字段(id, uuid, add_time, update_time, ext_data)将会被忽略。JSON在线解析及格式化验证 |
API Debug
KEY | REQUIRED | VALUE |
---|---|---|
app_key | *Required | |
message_content | *Required | |
message_nickname | Option | |
message_key | Option | |
message_pid | Option | |
more_data | Option |
API Response
KEY | Type | Description |
---|---|---|
err_code | Int | 操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景 |
err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
id | Int | 新发布的评论ID |
HTTP Response Code
HTTP Status Code | Description |
---|---|
Http Status = 200 | Success |
Http Status = 400 | Illegal-Params |
Http Status = 401 | Illegal-Token |
Http Status = 402 | IP-Banned |
Http Status = 404 | API-NOT-Exsits |
Http Status = 406 | Illegal-APPKEY |
Http Status = 407 | APPKEY-Expired-Out |
Http Status = 408 | APPKEY-Busy |
Http Status = 409 | Illegal-Sign |
Http Status = 413 | API-Traffic-NOT-Enough |
Http Status = 415 | API-LOCKED |
Http Status = 500 | Internal-Server-Error |