1.1 接口说明
第三方系统调用此接口查询客户联系历史记录。
1.2 调用形式
1.3 调用方式
POST
1.4 传入参数
非必填参数,调用接口时请传递参数名,参数值可为空
序号 | 名称 | 类型 | 是否必填 | 说明 |
---|---|---|---|---|
1 | page | Int | 是 | 页码(int类型的正整数) |
2 | size | Int | 是 | 每页展示数量(int类型的正整数,最大50) |
3 | start | String | 否 | 开始时间(针对联系计划创建时间) |
4 | end | String | 否 | 结束时间(针对联系计划创建时间) |
5 | kind | Int | 是 | 联系历史类型 0 联系计划 1 工单 2 在线咨询 3 邮件 4 呼入 5 呼出 99 全部 |
6 | customer_id | String | 是 | 客户编号 |
1.5 回应参数
序号 | 名称 | 类型 | 是否必填 | 说明 |
---|---|---|---|---|
1 | errcode | Number | 是 | 状态码:0成功,及其他非0错误码,详见错误码列表 |
2 | errmsg | String | 是 | 状态说明 |
3 | data | Object对象 | 是 | 结果集 |
3.1 | total | Int | 是 | 总个数 |
3.2 | size | Int | 是 | 每页条数 |
3.3 | current | Int | 是 | 当前页码 |
3.4 | pages | Int | 是 | 总页数 |
3.5 | records | Int | 是 | 结果集(有数据则返回结果集;无则为空) |
3.5.1 | kind | Int | 是 | 类型 0 联系计划 1 工单 2 在线咨询 3 邮件 4 呼入 5 呼出 |
3.5.2 | summary | String | 是 | 备注 |
3.5.3 | agent_name | String | 是 | 座席名称 |
3.5.4 | agent_num | String | 是 | 座席工号 |
3.5.5 | created_at | LocalDateTime | 是 | 操作时间(创建时间) |
3.5.6 | status | Boolean | 是 | 联系计划状态: 0 未执行 1 已完成 |
3.5.7 | is_finish | Boolean | 是 | 工单状态: 0 进行中 1 已完成 |
1.6 使用样例
调用:
url:https://ykf.uincall.com/openapi/customer/histories?tenant_id=acf528a2-d0e2-4a7b-8513-74cb399xxxxx&access_token=48220f04b6ca8afe21ebc010f01xxxxx
POST数据:
{
"page":1,
"size":50,
"start": "",
"end": "",
"kind": 0,
"customer_id":"2fdd362033d87e00b5b37c3b0fb52d69"
}
响应:
{
"errcode": 0,
"errmsg": "success",
"data": {
"total": 2,
"size": 50,
"current": 1,
"pages": 1,
"records": [
{
"kind": 0,
"summary": "更新客户联系计划",
"agent_name": "1006",
"agent_num": "1006",
"created_at": "2021-12-28 11:40:52",
"status": false
},
{
"kind": 0,
"summary": "新增客户联系计划",
"agent_name": "1006",
"agent_num": "1006",
"created_at": "2021-12-28 11:25:56",
"status": false
}
]
}
}
文档更新时间: 2024-09-24 14:34 作者:admin