OkayAPI Docs
API Params
| Parameter | Type | Required | Default | Note | Description |
|---|---|---|---|---|---|
| HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
| message_key | String | Optaion | MAX: 64 | 评论的唯一标识，例如某篇文章，精准匹配此项 | |
| order | Int | Optaion | 1 | 1按评论时间顺序显示，2按评论时间逆序 | |
| page | Int | Optaion | 1 | MIN: 1 | 第几页 |
| perpage | Int | Optaion | 10 | MIN: 1；MAX: 100 | 分页数量 |
| more_select | ArraySeperated with , | Optaion | 需要返回的更多字段，例如客户端额外添加的自定义字段和小白系统字段。如：more_select=id,uuid |
API Debug
| KEY | REQUIRED | VALUE |
|---|---|---|
| app_key | *Required | |
| message_key | Option | |
| order | Option | |
| page | Option | |
| perpage | Option | |
| more_select | Option |
API Response
| KEY | Type | Description |
|---|---|---|
| err_code | Int | 操作码，0表示成功，正数表示业务失败场景，负数表示系统失败场景 |
| err_msg | String | 错误提示信息，err_code非0时参考此提示信息 |
| total | Int | 顶层评论总数 |
| items | Array | 评论列表 |
| items[].id | Int | 评论ID |
| items[].message_content | String | 内容，支持HTML格式 |
| items[].message_nickname | String | 留言用户名 |
| items[].message_post_time | String | 留言时间 |
| items[].message_pid | Int | 评论的父级ID，为0时表示没有父级 |
| items[].child | Array | 评论的评论，多层嵌套 |
| items[].moreSelect | string/int | 返回的更多的字段 |
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 |