获取业务记录列表

业务记录相关接口

业务记录列表

获取业务记录列表，支持 IM 和呼叫中心（CC）模块。

请求方法: GET

请求路径: /api/v1/bizrecords.json

认证方式: Bearer Token

请求参数

参数	类型	是否必填	说明
`module`	string	是	业务模块：`im` 或 `cc`
`created_start`	datetime	否	创建起始时间（如：2025-01-01 00:00:00）
`created_end`	datetime	否	创建截止时间
`created_order`	string	否	创建时间排序：`asc`-升序，`desc`-降序（默认升序）
`updated_start`	datetime	否	更新起始时间
`updated_end`	datetime	否	更新截止时间
`updated_order`	string	否	更新时间排序：`asc`-升序，`desc`-降序（默认升序）
`page`	int	否	当前页
`per_page`	int	否	每页条数，最大 500，默认 10
`contact_id`	string	否	联系人 ID
`company_id`	string	否	公司 ID

注意：创建时间或更新时间相关参数，传一组即可。

响应参数

参数	类型	说明
`recordId`	string	业务记录 ID
`chatId`	string	IM 服务记录 ID
`entryName`	string	IM 渠道名称
`menuName`	string	IM 最终进线导航菜单名称
`content`	string	业务描述
`contactId`	string	客户联系人 ID
`mobile`	string	客户电话
`authaccount`	string	客户唯一标识
`companyId`	string	客户公司 ID
`agentId`	string	坐席 ID
`agentEmail`	string	坐席邮箱
`createTime`	datetime	业务创建时间
`updateTime`	datetime	业务更新时间
`templateId`	string	业务模板 ID
`callId`	string	CC 逻辑 ID
`crId`	string	CC 电话记录 ID
`custom_fields`	array	业务记录自定义字段数据
`con_custom_fields`	array	联系人自定义字段数据

custom_fields / con_custom_fields 字段说明：

参数	类型	说明
`key`	string	自定义字段标识
`value`	string \| array	自定义字段值

请求示例

响应示例

{
  "requestId": "4462aee2-c93e-4559-bc56-1fff651afedc",
  "status": "0",
  "message": "OK",
  "data": {
    "bizRecords": [
      {
        "recordId": "6790af3ce7a0ff3aeb12e8e2",
        "chatId": "111960",
        "content": "",
        "contactId": "0",
        "companyId": "0",
        "agentId": "176853",
        "createTime": "2025-01-22 16:41:32",
        "updateTime": "",
        "templateId": "12",
        "custom_fields": [
          {
            "key": "servicesummary_default_field",
            "value": "客户报告了一个关于供应商信息的问题..."
          },
          {
            "key": "field_8",
            "value": ["重庆市"]
          }
        ],
        "agentEmail": "332778006@qq.com",
        "entryName": "",
        "menuName": "",
        "con_custom_fields": []
      }
    ]
  }
}

在 Header 添加参数

Authorization

，其值为在 Basic 之后拼接空格，以及经过 Base64 编码的 username:password

示例：

Authorization: Basic *****************

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

示例

{
    "requestId": "65536eb4-ec54-4e5a-8778-49a457649c7d",
    "status": "0",
    "message": "OK",
    "data": {
        "bizRecords": [
            "200",
            {
                "requestId": "65536eb4-ec54-4e5a-8778-49a457649c7d",
                "status": "40401",
                "message": "Bad params: datetime format is invalid"
            },
            ""
        ]
    }
}

业务记录相关接口#

业务记录列表#

请求参数#

响应参数#

请求示例#

响应示例#

请求参数

请求示例代码

返回响应

业务记录相关接口

业务记录列表

请求参数

响应参数

请求示例

响应示例