1、开发须知
本接口适用第三方对接自有信息系统。API请求提交均为POST方式;基于JSON数据格式;请求Content-Type为application/json;系统使用UTF-8字符集。
请求的baseURL = https://botopenapi.uincall.com
所有的请求方式为 POST
请求Content-Type为application/json;系统使用UTF-8字符集。
1.1、数据格式约定
所有返回JSON的API,成功访问返回http状态值均为200(此字段是通信标识,非业务成功失败标识,业务是否成功见Err值)。
1.1.1 业务结果成功返回
属性 | 类型 | 说明 |
---|---|---|
code | integer | 请求状态码,此时为0 |
msg | string | 请求状态码描述,此时为空 |
data | object | 结果集 |
data.total_count | int | 数据总条数 |
data.page_count | int | 数据总页数 |
data.cur_page | int | 当前页数 |
data.page_size | int | 每页条数 |
data.list | array | 数据内容 |
单条数据示例:
{
"code": 0,
"data": {},
"msg": ""
}
多条数据示例:
{
"code": 0,
"data": {
"total_count": 10,
"page_count": 1,
"cur_page": 1,
"page_size": 10,
"list": [
{
"id": 1
}
]
},
"msg": ""
}
1.1.2 业务结果错误返回
属性 | 类型 | 说明 |
---|---|---|
code | integer | 请求状态码,此时为0 |
msg | string | 请求状态码描述,此时为空 |
data | object | 结果集 |
示例:
{
"code": 1,
"data": "",
"msg": "Error 1062: Duplicate entry"
}
文档更新时间: 2024-10-25 10:34 作者:admin