查询员工与客户的记录

开发中

POST

/open-api/chatmsg/document/query-chat

最后修改时间：2024-11-07 07:54:03

该接口用于通过应用获取企业的会话记录。

消息类型

类型	说明
0	暂不支持的消息类型
1	文本
2	图片
3	表情
4	链接
5	小程序
6	语音
7	视频
8	文件
9	名片
10	转发消息
11	视频号
12	日程
13	红包
14	地理位置
15	快速会议
16	待办
17	投票
18	在线文档
19	图文消息
20	图文混合消息
21	音频存档
22	音视频通话
23	微盘文件
24	同意会话存档
25	拒绝会话存档
26	群接龙
27	markdown

提示

音视频通话分为微信互通通话和普通通话两种类型。

微信互通：1 次音视频通话只会产生 1 条记录。

普通通话：1 次音视频通话会产生多条记录，由参与人数决定。

请求参数

Query 参数

access_token

string

可选

应用调用 API 的凭证

示例值:

Header 参数

Authorization

string

可选

默认值:

Bearer {{auth_token}}

Body 参数application/json

userOpenid

string

会话存档员工明文userid

必需

pageNo

integer

页码

必需

>= 1

pageSize

integer

每页条数

必需

<= 100

groupOpenid

string

会话存档微信群明文id

可选

与 customerOpenid 互斥

customerOpenid

string

会话存档客户明文customerid

可选

与 groupOpenid 互斥

startTime

integer

搜索条件-开始时间

可选

endTime

integer

搜索条件-结束时间

可选

keyword

string

搜索聊天内容关键字

可选

msgType

string

聊天类型

可选

详见”消息类型“

tenantId

integer

租户id

可选

seq

integer

会话原文seq值

必需

示例

{
    "userOpenid": "string",
    "pageNo": 1,
    "pageSize": 100,
    "groupOpenid": "string",
    "customerOpenid": "string",
    "startTime": 0,
    "endTime": 0,
    "keyword": "string",
    "msgType": "string",
    "tenantId": 0,
    "seq": 0
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST '/open-api/chatmsg/document/query-chat?access_token={{access_token}}' \
--header 'Authorization: Bearer {{auth_token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "userOpenid": "string",
    "pageNo": 1,
    "pageSize": 100,
    "groupOpenid": "string",
    "customerOpenid": "string",
    "startTime": 0,
    "endTime": 0,
    "keyword": "string",
    "msgType": "string",
    "tenantId": 0,
    "seq": 0
}'

返回响应

🟢200成功

application/json

Body

code

integer

状态码

必需

0 表示成功，非 0 表示失败

msg

string

状态码描述

必需

示例

{
    "code": 0,
    "msg": "string"
}

创建日程

创建应用通知

查询员工与客户的记录

消息类型#

请求参数

示例代码

返回响应

消息类型