OkayAPI Docs
API Params
| Parameter | Type | Required | Default | Note | Description |
|---|---|---|---|---|---|
| HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
| other_uuid | String | Required | MIN: 32;MAX: 32 | 接收私信的会员uuid | |
| chat_message_type | Enum | Required | text | Range: text/html/image/link/custom | 私信消息类型,text普通文本,html富文本,image图片,link链接,custom自定义。注意,不同私信类型,需要提供的chat_message_data参数不同。 |
| chat_message_data | ArrayJSON Format | Required | 私信消息数据,JSON格式。不同消息类型,参数格式不同。分别是:
|
API Debug
| KEY | REQUIRED | VALUE |
|---|---|---|
| app_key | *Required | |
| other_uuid | *Required | |
| chat_message_type | *Required | |
| chat_message_data | *Required |
API Response
| KEY | Type | Description |
|---|---|---|
| err_code | Int | 操作码,0表示成功,1不能发送给自己,2发送失败,9表示插件未安装 |
| err_msg | String | 错误提示信息,err_code非0时参考此提示信息 |
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 |