1. Home
  2. Develop Docs
  3. API 开发文档

API 开发文档

通过 API 获取对话,联系人等数据。

准备工作

点击左下角 「设置」,选择 API,获取 Access Token,同时启用 Access Token

通用

  • 调用以下 APIs 时都需要使用 Access Token, Token 重置后将导致上次的 Token 失效。请求头:
Authorization: Bearer YOUR_ACCESS_TOKEN
  • 所有请求/响应时间字段均采用毫秒级的 UTCISO 8601 格式,示例:2024-01-01T00:00:00.000Z

接口列表

1. 对话数据查询

注意: 仅支持查询最近 6 个月的数据

1.1 对话数据模型

字段名类型说明
ent_idinteger企业 ID
client_infoobject联系人信息
agent_namestring客服真实姓名
agent_idinteger客服 ID
agent_nick_namestring客服昵称
agent_work_numstring客服工号
agent_emailstring客服邮箱
agent_group_namestring客服分组名称
conv_idinteger对话 ID
track_idstring对话访问标识
conv_tagsarray(string)对话标签
conv_start_timestring对话创建时间
conv_end_timestring对话结束时间
summarystring对话小结
summary_timestring对话小结时间
evaluationinteger评价类型 0-差评 1-中评 2-好评
evaluation_contentstring评价内容
source_typestring访问来源
source_urlstring来源 URL
sourcestring对话渠道
sub_sourcestring子渠道名称
visit_page_titlestring着陆页标题
visit_page_urlstring着陆页 URL
conv_titlestring对话页标题
conv_urlstring对话页 URL
search_enginestring搜索引擎
visitor_osstring操作系统
visitor_browserstring浏览器
visitor_locationstring地区
browser_languagestring浏览器语言
utm_sourcestringutm_source
utm_mediumstringutm_medium
utm_termstringutm_term
utm_contentstringutm_content
utm_campaignstringutm_campaign
messagesarray(object)对话消息列表

client_info 对象字段:

字段名类型说明
contact_idstring联系人 ID
track_idsarray(string)访问标识列表
tagsarray(string)联系人标签
system_fieldsobject系统字段,只包含启用显示的字段
custom_fieldsobject自定义字段,只包含启用显示的字段

messages 对象字段:

字段名类型说明
agent_namestring消息对应的接待客服真实姓名
agent_tokenstring消息对应的接待客服 token
fromstring消息来源
timestampstring消息时间
contentstring消息内容
typestring消息类型

1.2 根据对话 ID 查询对话详情

接口地址:

GET https://api-gateway.mixdesk.com/mixdesk/hikari/open/api/v1/conversation/{conversation_id}

请求参数:

参数名参数类型类型必填描述
conversation_idPathinteger对话 ID

响应参数

字段名类型说明
codeinteger状态码
msgstring提示信息
successboolean是否成功
data对话数据模型对话数据模型

1.3 根据结束时间查询对话列表

接口地址:

GET https://api-gateway.mixdesk.com/mixdesk/hikari/open/api/v1/conversations

请求参数:

参数名参数类型类型必填描述
end_time_startquerystring对话结束时间起始值
end_time_endquerystring对话结束时间结束值
pagequeryinteger页码,从 1 开始,默认值:1
page_sizequeryinteger每页数量,取值范围:1-50,默认值:20

响应参数

字段名类型说明
codeinteger状态码
msgstring提示信息
successboolean是否成功
dataobject对话列表数据

data 对象字段:

字段名类型说明
totalinteger筛选的对话总数
dataarray(对话数据模型)对话数据列表

2. 联系人数据查询

注意:联系人字段仅在系统中启用显示时才会返回

2.1 联系人数据模型

字段名类型说明
contact_idstring联系人 ID
track_idsarray(string)访问标识列表
system_fieldsobject系统字段
custom_fieldsobject自定义字段

2.2 根据创建时间查询联系人列表

接口地址:

GET https://api-gateway.mixdesk.com/mixdesk/hikari/open/api/v1/contacts`

请求参数:

参数名参数类型类型必填描述
create_time_startquerystring联系人创建时间起始值
create_time_endquerystring联系人创建时间结束值
pagequeryinteger页码,从 1 开始,默认值:1
page_sizequeryinteger每页数量,取值范围:1-50,默认值:20

响应参数:

字段名类型说明
codeinteger状态码
msgstring提示信息
successboolean是否成功
dataobject联系人列表数据

data 对象字段:

字段名类型说明
totalinteger筛选的联系人总数
dataarray(联系人数据模型)联系人数据列表

状态码

Code说明
1请求成功
10000认证失败,请检查 Access Token
10010企业版本限制
10012Access Token 未启用
11000请求参数错误
20000服务器内部错误
Updated on 2025年6月26日
Was this article helpful?

Related Articles