1.1 接口说明
第三方系统调用此接口查询客户联系计划信息。
1.2 调用形式
1.3 调用方式
POST
1.4 传入参数
非必填参数,调用接口时请传递参数名,参数值可为空
序号 | 名称 | 类型 | 是否必填 | 说明 |
---|---|---|---|---|
1 | page | Int | 是 | 页码(int类型的正整数) |
2 | size | Int | 是 | 每页展示数量(int类型的正整数,最大50) |
3 | customer_id | String | 是 | 客户编号 |
4 | status | Boolean | 否 | 状态 0 进行中 1 已完成 |
5 | agent_num | String | 否 | 创建计划座席工号 |
6 | summary | String | 否 | 计划内容 |
7 | start | String | 否 | 开始日期范围(针对联系计划创建时间) |
8 | end | 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 | id | String | 是 | 联系计划编号 |
3.5.2 | summary | String | 是 | 计划内容 |
3.5.3 | creator | String | 是 | 创建人 |
3.5.4 | assigner | String | 是 | 执行人 |
3.5.5 | agent_id | String | 是 | 创建座席编号 |
3.5.6 | assign_id | String | 是 | 执行座席编号 |
3.5.7 | status | String | 是 | 状态 |
3.5.8 | start_at | String | 是 | 计划开始时间 |
3.5.9 | created_at | String | 是 | 创建时间 |
1.6 使用样例
调用:
url:https://ykf.uincall.com/openapi/customer/plans?tenant_id=acf528a2-d0e2-4a7b-8513-74cb399xxxxx&access_token=12dc1a0e50628c37ec58ef1e4f7xxxxx
POST数据:
{
"page":1,
"size":50,
"customer_id":"8312245ca88974204f625208856af2c5",
"status":0,
"agent_num":"8019",
"summary": "敢死队风格",
"start":"",
"end":""
}
响应:
{
"errcode": 0,
"errmsg": "success",
"data": {
"total": 1,
"size": 50,
"current": 1,
"pages": 1,
"records": [
{
"id": "6db51fb45d81cac44e803697e19c24b3",
"summary": "敢死队风格",
"creator": "侯叶婷8019",
"assigner": "侯叶婷8019",
"agent_id": "a672fa8f5ac3e1d537d0d06ace0b5452",
"assign_id": "a672fa8f5ac3e1d537d0d06ace0b5452",
"status": false,
"start_at": "2021-12-30 00:00:00",
"created_at": "2021-12-31 19:23:20"
}
]
}
}
文档更新时间: 2024-09-24 14:34 作者:admin