注:使用openapi接口前,首先需要参照接口鉴权说明完成鉴权
通话服务记录查询
访问路径
POST /openapi/crm/service-record/call/query
请求参数
| 字段名称 | 字段类型 | 是否必填 | 说明 |
|---|---|---|---|
| startTime | String | 是 | 开始时间,格式 yyyy-MM-dd HH:mm:ss |
| endTime | String | 是 | 结束时间,格式 yyyy-MM-dd HH:mm:ss |
| callId | String | 否 | 通话 ID,不传时只按时间查询 |
| limit | Integer | 否 | 返回条数,1~1000,默认 1000 |
请求示例
{
"startTime": "2026-07-01 00:00:00",
"endTime": "2026-07-01 23:59:59",
"callId": "CALL_ID",
"limit": 100
}
在线服务记录查询
访问路径
POST /openapi/crm/service-record/im/query
请求参数
| 字段名称 | 字段类型 | 是否必填 | 说明 |
|---|---|---|---|
| startTime | String | 是 | 开始时间,格式 yyyy-MM-dd HH:mm:ss |
| endTime | String | 是 | 结束时间,格式 yyyy-MM-dd HH:mm:ss |
| sessionId | String | 否 | 会话 ID,不传时只按时间查询 |
| limit | Integer | 否 | 返回条数,1~1000,默认 1000 |
请求示例
{
"startTime": "2026-07-01 00:00:00",
"endTime": "2026-07-01 23:59:59",
"sessionId": "SESSION_ID",
"limit": 100
}
返回结果
返回参数
| 字段名称 | 字段类型 | 说明 |
|---|---|---|
| accountId | String | 账户 ID |
| data | Object | 服务记录表单内容 |
| updateAgent | String | 更新座席工号,可能为空 |
| updateTime | String | 服务记录产生时间 |
| eventUniqueId | String | 事件唯一 ID |
| callId | String | 通话 ID,仅通话记录使用 |
| sessionId | String | 会话 ID,仅在线记录使用 |
| scene | String | callCenter或 im |
| pushType | String | serviceNoteInsert 或 serviceNoteUpdate |
| otherParams | Object | 在线会话自定义参数,可能为空 |
返回示例
{
"success": true,
"message": "200 ok!",
"code": "200",
"data": [
{
"accountId": "1090",
"data": {
"memo": "服务记录备注",
"resolveStatus": "已解决",
"serviceLabel": []
},
"updateAgent": "5235",
"updateTime": "2026-07-01 10:20:30",
"eventUniqueId": "EVENT_UNIQUE_ID",
"callId": "CALL_ID",
"scene": "callCenter",
"pushType": "serviceNoteInsert"
}
]
}
在线记录返回 sessionId,通话记录返回 callId。没有数据时返回:
{
"success": true,
"message": "200 ok!",
"code": "200",
"data": []
}
错误处理
| 场景 | code | message示例 |
|---|---|---|
| 时间格式错误 | 03001023 | 时间格式不正确,应为yyyy-MM-dd HH:mm:ss |
| 开始时间晚于结束时间 | 03001023 | 开始时间不能晚于结束时间 |
| limit 小于 1 | 00000400 | limit不能小于1 |
| limit 大于 1000 | 00000400 | limit不能大于1000 |
| 缺少必填参数 | 00000400 | 开始时间不能为空 |
| 账户认证错误 | 00000400 | APP_ID参数错误 |
注意事项
- 时间格式必须为 yyyy-MM-dd HH:mm:ss。
- 开始时间不能晚于结束时间。
- limit 最大为 1000。
- 查询结果按 updateTime 从早到晚返回。
- data: [] 表示查询成功但没有数据。
- callId、sessionId、updateAgent、otherParams 等字段需要判空。
- 返回正好 1000 条时,可能还有更多数据,建议缩小时间范围继续查询。