增加出口
您可以从Zendesk Chat实例导出项目的完整列表，然后定期(增量)获取自上次获取以来已创建或更亚博新的项目。
可以导出的项目如下:
- 增量聊天
- 增量代理时间跨度
- 增量转换
- 增量部门事件
根据更新时间戳返回项。例如，如果一个聊天被更新，任何后续请求都将返回该聊天。即使聊天结束了，但后来又进行了更新(比如添加了一个标记)，后续请求仍然会返回已结束的带有更改的聊天。
看到核心API增量导出文档有关Zendesk增量api的一般信息，包括详细的使用亚博说明和示例。
查询字符串参数
| 名字 | 类型 | 强制性的 | 评论 |
|---|---|---|---|
| start_time | 整数 | 没有 | 以微秒为单位的Unix纪元时间。看到开始时间．默认为0 |
| start_id | 字符串 | 没有 | 默认为空字符串 |
| 限制 | 整数 | 没有 | 要返回的结果数。默认值和最大值为1000 |
| 字段 | 字符串 | 没有 | 需要响应属性。看到资源扩张 |
开始时间
增量导出端点(除了agent_timeline) take astart_time参数表示为Unix纪元时间在几秒钟内。例如，如果您想将开始时间设置为2019年1月1日，即格林尼治时间早上7点，则转换器在http://www.epochconverter.com以epoch时间戳的形式给出时间1546326000。
GET / api / v2 /增量/聊天吗?start_time = 1546326000
座席时间轴导出采用aUnix纪元时间在微秒。例子:1546326000000000。看到增量代理时间轴导出．
请注意:start_time值必须是过去五分钟以上，否则出口请求将被拒绝。
资源扩张
对于支持资源扩展的端点，资源响应在默认情况下只有一组有限的属性，通常只有ID。
{“聊天”：［{“id”：“1712.4987.QeUipU4eZOoO3”｝，{“id”：“1712.4987.QELAIbLLINHPV”｝，…］｝
资源展开允许您指定应该返回资源的哪些属性，方法是将属性名传递到字段查询字符串参数。
?字段=聊天(id、评论、评分)
要有选择地展开嵌套属性，请使用
．指定属性名称。?字段=聊天(response_time.max)要充分扩展资源，请通过a
*作为通配符:?字段=聊天(*)
分页和轮询
对于分页(在初始导出期间)和轮询(对新数据的定期请求)，都使用next_pageURL。
的next_pageURL包含start_time和start_id参数匹配end_time和end_id但是建议将此URL作为不透明字符串处理。注意，这与增量导出API在Ze亚博ndesk支持中，它只使用start_time和end_time．
的值返回null，这与其他端点不同next_page当到达结果集的最后一页时，这些端点返回应该用于下一次轮询获取的URL。你应该使用数属性以确定是否有更多项立即可用。
这些端点返回到限制每页条目(默认为1000)。如果数小于限制，更多的项目可用，和next_pageURL可以立即请求。否则，没有其他项目立即可用，并且next_page应该在轮询间隔后请求URL。
速度限制
的速度限制聊天API的应用。
常见响应属性
导出的项表示为JSON对象。格式取决于导出的资源，但都有以下额外的公共属性:
JSON格式
增量导出表示为JSON对象，具有以下属性:
| 名字 | 类型 | 只读 | 强制性的 | 描述 |
|---|---|---|---|---|
| 数 | 整数 | 真正的 | 假 | 为当前请求返回的结果数 |
| end_id | 字符串 | 真正的 | 假 | 这个结果集中最近出现的项的ID;这被用作start_id在next_pageURL |
| end_time | 数量 | 真正的 | 假 | 这个结果集中最近出现的时间(Unix epoch time);这被用作start_time在next_pageURL |
| next_page | 字符串 | 真正的 | 假 | 应该被调用以获得下一组结果的URL |
例子
{“数”：4，“end_id”：“1804.2.QqHwCNX18mZ7Y”，“end_time”：1524710057，“next_page”：“https://www.zopim.com/api/v2/incremental/chats?fields=chats%28%2A%29&start_time=1524710057&start_id=1804.2.QqHwCNX18mZ7Y”｝
增量代理时间轴导出
得到/ api / v2 /增量/ agent_timeline
返回一个agent_timeline对象，该对象由自给定开始时间以来生成的时间跨度对象的按时间顺序排列的列表组成。时间跨度是代理在一定时期内的状态。目前，国家包括状态和engagement_count．engagement_count与业务的数量相关。要了解约定中捕获的信息，请参见约定对象属性．
agent_timeline
| 名字 | 类型 | 只读 | 描述 |
|---|---|---|---|
| agent_id | 整数 | 是的 | 座席ID |
| start_time | 日期 | 是的 | 时间范围开始时的日期和时间(以微秒为单位) |
| 持续时间 | 数量 | 是的 | 时间跨度的持续时间，以秒为单位 |
| 状态 | 字符串 | 是的 | 代理在时间范围内的状态(非离线):“在线”、“离开”或“不可见” |
| engagement_count | 整数 | 是的 | 座席参与的并发聊天(约定)的计数 |
的start_time的用法如开始时间，除了它需要Unix纪元时间在微秒。要获得以微秒为单位的时间戳(不要与毫秒混淆)，请在epoch时间上加6个零，即1546326000000000。
GET / api / v2 /增量/ agent_timeline吗?start_time = 1546326000000000
2018年3月15日，将单位改为微秒。
允许
- 老板
- 管理员
资源扩张
不适用。
参数
| 名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| 字段 | 字符串 | 查询 | 假 | 需要响应属性。看到资源扩张 |
| 限制 | 整数 | 查询 | 假 | 要返回的结果数。默认值和最大值为1000 |
| start_id | 字符串 | 查询 | 假 | 默认为空字符串 |
| start_time | 整数 | 查询 | 假 | 以微秒为单位的Unix纪元时间。看到开始时间．默认为0 |
代码示例
旋度
旋度“https://www.zopim.com/api/v2/incremental/agent_timeline”\- v - u{email_address｝：{密码｝
去
进口（“fmt”“输入输出”“net/http”）函数主要（）{url：=“https://support.亚博zendesk.com/api/v2/incremental/agent_timeline?fields=&limit=&start_id=&start_time=”方法：=“获得”要求的事情，犯错：=http．NewRequest（方法，url，零）如果犯错! =零{fmt．Println（犯错）返回｝要求的事情．头．添加（“内容类型”，“application / json”）客户端：=&http．客户端{｝res，犯错：=客户端．做（要求的事情）如果犯错! =零{fmt．Println（犯错）返回｝推迟res．身体．关闭（）身体，犯错：=io．ReadAll（res．身体）如果犯错! =零{fmt．Println（犯错）返回｝fmt．Println（字符串（身体））｝
Java
进口com．squareup．okhttp．*；OkHttpClient客户端＝新OkHttpClient（）；HttpUrl．构建器urlBuilder＝HttpUrl．解析（“https://support.亚博zendesk.com/api/v2/incremental/agent_timeline”）．newBuilder（）．addQueryParameter（“字段”，”“）．addQueryParameter（“限制”，”“）．addQueryParameter（“start_id”，”“）．addQueryParameter（“start_time”，”“）；请求请求＝新请求．构建器（）．url（urlBuilder．构建（））．方法（“获得”，零）．addHeader（“内容类型”，“application / json”）．构建（）；响应响应＝客户端．newCall（请求）．执行（）；
Nodejs
varaxios＝需要（“axios”）；var配置＝{方法：“得到”，url：“https://support.亚博zendesk.com/api/v2/incremental/agent_timeline”，头：{“内容类型”：“application / json”，｝，参数个数：{“字段”：”，“限制”：”，“start_id”：”，“start_time”：”，｝，｝；axios（配置）．然后（函数（响应）{控制台．日志（JSON．stringify（响应．数据））；｝）．抓（函数（错误）{控制台．日志（错误）；｝）；
Python
进口请求url＝“https://support.亚博zendesk.com/api/v2/incremental/agent_timeline?fields=&limit=&start_id=&start_time=”头＝{“内容类型”：“application / json”，｝响应＝请求．请求（“获得”，url，头＝头）打印（响应．文本）
鲁比（人名）
需要“net/http”uri＝URI（“https://support.亚博zendesk.com/api/v2/incremental/agent_timeline”）uri．查询＝URI．encode_www_form（“字段”：”“，“限制”：”“，“start_id”：”“，“start_time”：”“）请求＝网：：HTTP：：得到．新（uri，“内容类型”：“application / json”）响应＝网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束
示例响应(年代)
200好了
//状态200 OK{“agent_timeline”：［{“agent_id”：1730415，“持续时间”：65.705271，“engagement_count”：0，“start_time”：“2018 - 04 - 29 - t10:26:40.957650z”，“状态”：“走”｝，{“agent_id”：1730415，“持续时间”：0.29361，“engagement_count”：0，“start_time”：“2018 - 04 - 29 - t10:27:46.662921z”，“状态”：“隐形”｝，{“agent_id”：1730415，“持续时间”：9957.130438，“engagement_count”：0，“start_time”：“2018 - 04 - 29 - t10:27:46.956531z”，“状态”：“走”｝，{“agent_id”：980824，“持续时间”：10654.117251，“engagement_count”：0，“start_time”：“2018 - 04 - 29 - t11:02:33.286461z”，“状态”：“在线”｝］，“数”：4，“end_time”：1525010407403712，“next_page”：“https://www.zopim.com/api/v2/incremental/agent_timeline?limit=7&start_time=1525010407403712”｝
增量聊天导出
GET / api / v2 /增量/聊天
返回一个聊天对象，其中列出自开始时间以来更新的聊天记录。每个聊天都有一个活动对象，该对象仅在代理加入聊天对话时创建。座席加入聊天对话时开始，座席离开时结束。看到在Chat中什么是订婚?
聊天
| 名字 | 类型 | 只读 | 描述 |
|---|---|---|---|
| <所有聊天属性> | - | - | 文件中记录的所有属性聊天API |
| 活动 | 数组 | 是的 | 代理约定的数组。看到活动 |
| update_timestamp | 日期 | 是的 | 聊天更新的日期和时间 |
| skills_requested | 数组 | 是的 | 所要求的技能 |
| skills_fulfilled | 布尔 | 是的 | 提供聊天服务的特工是否具备相关技能 |
| abandon_time | 数量 | 是的 | 访问者在离开前等待响应的秒数(仅针对错过/丢失的聊天) |
| 下降了 | 布尔 | 是的 | 聊天是否被中断 |
| 积极主动的 | 布尔 | 是的 | 座席是否主动发起聊天 |
| 删除 | 布尔 | 是的 | 聊天内容是否被删除 |
活动
| 名字 | 类型 | 只读 | 描述 |
|---|---|---|---|
| id | 字符串 | 是的 | 订婚证明 |
| chat_id | 字符串 | 是的 | 聊天ID |
| started_by | 字符串 | 是的 | 是谁开始交战的。可以是“访客”、“代理”或“调任”(当调任到另一个部门时)之一。 |
| agent_id | 整数 | 是的 | 座席ID |
| agent_full_name | 字符串 | 是的 | 代理人的全名 |
| department_id | 整数 | 是的 | 订婚的部门编号 |
| 分配 | 布尔 | 是的 | 是否分配代理 |
| 接受 | 布尔 | 是的 | 代理是否接受分配并加入聊天 |
| 评级 | 字符串 | 是的 | 客户对约定的满意度评级 |
| 评论 | 字符串 | 是的 | 客户对约定作出评论 |
| skills_requested | 数组 | 是的 | 所要求的技能 |
| skills_fulfilled | 布尔 | 是的 | 提供聊天服务的特工是否具备相关技能 |
| 时间戳 | 日期 | 是的 | 订婚开始的日期和时间 |
| 持续时间 | 数量 | 是的 | 交战持续时间(以秒为单位) |
| response_time | 对象 | 是的 | 关于聊天中响应时间的统计数据，avg，马克斯和第一个 |
| 数 | 对象 | 是的 | 访问者和代理的消息数(每个) |
允许
- 老板
- 管理员
资源扩张
此端点支持资源扩展。看到资源扩张．
参数
| 名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| 字段 | 字符串 | 查询 | 假 | 需要响应属性。看到资源扩张 |
| 限制 | 整数 | 查询 | 假 | 要返回的结果数。默认值和最大值为1000 |
| start_id | 字符串 | 查询 | 假 | 默认为空字符串 |
| start_time | 整数 | 查询 | 假 | 以微秒为单位的Unix纪元时间。看到开始时间．默认为0 |
代码示例
旋度
旋度“https://www.zopim.com/api/v2/incremental/chats?fields=chats”(*)\- v - u{email_address｝：{密码｝
去
进口（“fmt”“输入输出”“net/http”）函数主要（）{url：=“https://support.亚博zendesk.com/api/v2/incremental/chats?fields=&limit=&start_id=&start_time=”方法：=“获得”要求的事情，犯错：=http．NewRequest（方法，url，零）如果犯错! =零{fmt．Println（犯错）返回｝要求的事情．头．添加（“内容类型”，“application / json”）客户端：=&http．客户端{｝res，犯错：=客户端．做（要求的事情）如果犯错! =零{fmt．Println（犯错）返回｝推迟res．身体．关闭（）身体，犯错：=io．ReadAll（res．身体）如果犯错! =零{fmt．Println（犯错）返回｝fmt．Println（字符串（身体））｝
Java
进口com．squareup．okhttp．*；OkHttpClient客户端＝新OkHttpClient（）；HttpUrl．构建器urlBuilder＝HttpUrl．解析（“https://support.亚博zendesk.com/api/v2/incremental/chats”）．newBuilder（）．addQueryParameter（“字段”，”“）．addQueryParameter（“限制”，”“）．addQueryParameter（“start_id”，”“）．addQueryParameter（“start_time”，”“）；请求请求＝新请求．构建器（）．url（urlBuilder．构建（））．方法（“获得”，零）．addHeader（“内容类型”，“application / json”）．构建（）；响应响应＝客户端．newCall（请求）．执行（）；
Nodejs
varaxios＝需要（“axios”）；var配置＝{方法：“得到”，url：“https://support.亚博zendesk.com/api/v2/incremental/chats”，头：{“内容类型”：“application / json”，｝，参数个数：{“字段”：”，“限制”：”，“start_id”：”，“start_time”：”，｝，｝；axios（配置）．然后（函数（响应）{控制台．日志（JSON．stringify（响应．数据））；｝）．抓（函数（错误）{控制台．日志（错误）；｝）；
Python
进口请求url＝“https://support.亚博zendesk.com/api/v2/incremental/chats?fields=&limit=&start_id=&start_time=”头＝{“内容类型”：“application / json”，｝响应＝请求．请求（“获得”，url，头＝头）打印（响应．文本）
鲁比（人名）
需要“net/http”uri＝URI（“https://support.亚博zendesk.com/api/v2/incremental/chats”）uri．查询＝URI．encode_www_form（“字段”：”“，“限制”：”“，“start_id”：”“，“start_time”：”“）请求＝网：：HTTP：：得到．新（uri，“内容类型”：“application / json”）响应＝网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束
示例响应(年代)
200好了
//状态200 OK{“聊天”：［{“abandon_time”：29.43400001525879，“agent_ids”：［“383486450414”］，“agent_name”：［“大卫Foo”］，“评论”：零，“转换”：［］，“数”：{“代理”：1，“总”：2，“访客”：1｝，“删除”：假，“department_id”：零，“department_name”：零，“下降”：真正的，“持续时间”：12，“end_timestamp”：“2020 - 12 - 22 - t04:54:59z”，“活动”：［{“接受”：假，“agent_full_name”：“新员工”，“agent_id”：“383486450414”，“agent_name”：“新员工”，“分配”：假，“评论”：零，“数”：{“代理”：1，“总”：2，“访客”：1｝，“department_id”：零，“持续时间”：43.4449999332428，“id”：“2012.9339545.SJs7biGpcbveH.1”，“评级”：零，“response_time”：{“平均”：零，“第一”：零，“马克斯”：零｝，“skills_fulfilled”：假，“skills_requested”：［］，“started_by”：“代理”，“时间戳”：“2020 - 12 - 22 - t04:54:15z”｝］，“历史”：［{“通道”：“# supportchat: 9339545 - 11 - mjg3gvk0uheik”，“department_id”：零，“department_name”：零，“指数”：0，“名称”：“游客25396546”，“源”：“chat.invite”，“时间戳”：“2020 - 12 - 22 - t04:54:15z”，“类型”：“chat.memberjoin”｝，{“通道”：“# supportchat: 9339545 - 11 - mjg3gvk0uheik”，“指数”：1，“名称”：“大卫Foo”，“源”：“chat.invite”，“时间戳”：“2020 - 12 - 22 - t04:54:15z”，“类型”：“chat.memberjoin”｝，{“agent_id”：“383486450414”，“通道”：“# supportchat: 9339545 - 11 - mjg3gvk0uheik”，“指数”：2，“味精”：“黛德”，“名称”：“大卫Foo”，“选项”：”“，“sender_type”：“代理”，“时间戳”：“2020 - 12 - 22 - t04:54:18z”，“类型”：“chat.msg”｝，{“通道”：“# supportchat: 9339545 - 11 - mjg3gvk0uheik”，“指数”：3.，“味精”：“你好”，“msg_id”：“1608612869871”，“名称”：“游客25396546”，“选项”：”“，“sender_type”：“访客”，“时间戳”：“2020 - 12 - 22 - t04:54:30z”，“类型”：“chat.msg”｝，{“通道”：“# supportchat: 9339545 - 11 - mjg3gvk0uheik”，“指数”：4，“名称”：“大卫Foo”，“原因”：“user_leave_chat”，“时间戳”：“2020 - 12 - 22 - t04:54:59z”，“类型”：“chat.memberleave”｝，{“通道”：“# supportchat: 9339545 - 11 - mjg3gvk0uheik”，“指数”：5，“名称”：“游客25396546”，“原因”：“user_leave_chat”，“时间戳”：“2020 - 12 - 22 - t04:54:59z”，“类型”：“chat.memberleave”｝］，“id”：“2012.9339545.SJs7biGpcbveH”，“错过”：假，“主动”：真正的，“评级”：零，“referrer_search_engine”：”“，“referrer_search_terms”：”“，“response_time”：{“平均”：零，“第一”：零，“马克斯”：零｝，“会话”：{“浏览器”：“铬”，“城市”：“悉尼”，“country_code”：“盟”，“country_name”：“澳大利亚”，“end_date”：“2020 - 12 - 22 - t04:54:59z”，“id”：“201222.9339545.7MmWjNbx50y3nMJBz”，“知识产权”：“13.55.49.175”，“平台”：“Mac OS”，“地区”：“新南威尔士”，“start_date”：“2020 - 12 - 22 - t04:50:58z”，“user_agent”：“Mozilla / 5.0(麦金塔电脑;Intel Mac OS X 10_15_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.88 Safari/537.36”｝，“skills_fulfilled”：假，“skills_requested”：［］，“started_by”：“代理”，“标签”：［］，“时间戳”：“2020 - 12 - 22 - t04:54:16z”，“触发”：假，“triggered_response”：零，“类型”：“聊天”，“未读”：假，“update_timestamp”：“2020 - 12 - 22 - t05:05:36z”，“访客”：{“电子邮件”：”“，“id”：“9339545.11 mjg3gvk0uheik”，“名称”：“游客25396546”，“笔记”：”“，“电话”：”“｝，“webpath”：［{“从”：”“，“时间戳”：“2020 - 12 - 22 - t04:50:58z”，“标题”：“亚博Zendesk”，”到“：“https://subdomain.亚博zendesk.com/hc/en-us”｝］，“亚博zendesk_ticket_id”：83｝，{“abandon_time”：零，“agent_ids”：［“383486450414”］，“agent_name”：［“大卫Foo”］，“评论”：零，“转换”：［］，“数”：{“代理”：1，“总”：1，“访客”：0｝，“删除”：假，“department_id”：零，“department_name”：零，“下降”：假，“持续时间”：0，“end_timestamp”：“2020 - 12 - 22 - t05:05:36z”，“活动”：［{“接受”：假，“agent_full_name”：“新员工”，“agent_id”：“383486450414”，“agent_name”：“新员工”，“分配”：假，“评论”：零，“数”：{“代理”：1，“总”：1，“访客”：0｝，“department_id”：零，“持续时间”：40.003000020980835，“id”：“2012.9339545.SJsAIFAY09HB1.1”，“评级”：零，“response_time”：{“平均”：零，“第一”：零，“马克斯”：零｝，“skills_fulfilled”：假，“skills_requested”：［］，“started_by”：“代理”，“时间戳”：“2020 - 12 - 22 - t05:04:55z”｝］，“历史”：［{“通道”：“# supportchat: 9339545 - 11 - mjg3gvk0uheik”，“department_id”：零，“department_name”：零，“指数”：0，“名称”：“游客25396546”，“源”：“chat.invite”，“时间戳”：“2020 - 12 - 22 - t05:04:55z”，“类型”：“chat.memberjoin”｝，{“通道”：“# supportchat: 9339545 - 11 - mjg3gvk0uheik”，“指数”：1，“名称”：“大卫Foo”，“源”：“chat.invite”，“时间戳”：“2020 - 12 - 22 - t05:04:55z”，“类型”：“chat.memberjoin”｝，{“agent_id”：“383486450414”，“通道”：“# supportchat: 9339545 - 11 - mjg3gvk0uheik”，“指数”：2，“味精”：“你好”，“名称”：“大卫Foo”，“选项”：”“，“sender_type”：“代理”，“时间戳”：“2020 - 12 - 22 - t05:04:59z”，“类型”：“chat.msg”｝，{“通道”：“# supportchat: 9339545 - 11 - mjg3gvk0uheik”，“指数”：3.，“名称”：“大卫Foo”，“new_tags”：［“一”］，“标签”：［］，“时间戳”：“2020 - 12 - 22 - t05:05:02z”，“类型”：“chat.tag”｝，{“通道”：“# supportchat: 9339545 - 11 - mjg3gvk0uheik”，“指数”：4，“名称”：“大卫Foo”，“new_tags”：［“goodbye_survey”，“一”］，“标签”：［“一”］，“时间戳”：“2020 - 12 - 22 - t05:05:04z”，“类型”：“chat.tag”｝，{“通道”：“# supportchat: 9339545 - 11 - mjg3gvk0uheik”，“指数”：5，“名称”：“大卫Foo”，“原因”：“user_leave_chat”，“时间戳”：“2020 - 12 - 22 - t05:05:35z”，“类型”：“chat.memberleave”｝，{“通道”：“# supportchat: 9339545 - 11 - mjg3gvk0uheik”，“指数”：6，“名称”：“游客25396546”，“原因”：“user_leave_chat”，“时间戳”：“2020 - 12 - 22 - t05:05:36z”，“类型”：“chat.memberleave”｝］，“id”：“2012.9339545.SJsAIFAY09HB1”，“错过”：假，“主动”：真正的，“评级”：零，“referrer_search_engine”：”“，“referrer_search_terms”：”“，“response_time”：{“平均”：零，“第一”：零，“马克斯”：零｝，“会话”：{“浏览器”：“铬”，“城市”：“悉尼”，“country_code”：“盟”，“country_name”：“澳大利亚”，“end_date”：“2020 - 12 - 22 - t05:05:36z”，“id”：“201222.9339535.7MmWjNbx50y3nMJBz”，“知识产权”：“13.55.49.175”，“平台”：“Mac OS”，“地区”：“新南威尔士”，“start_date”：“2020 - 12 - 22 - t04:50:58z”，“user_agent”：“Mozilla / 5.0(麦金塔电脑;Intel Mac OS X 10_15_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.88 Safari/537.36”｝，“skills_fulfilled”：假，“skills_requested”：［］，“started_by”：“代理”，“标签”：［“一”，“goodbye_survey”］，“时间戳”：“2020 - 12 - 22 - t05:04:56z”，“触发”：假，“triggered_response”：零，“类型”：“聊天”，“未读”：假，“update_timestamp”：“2020 - 12 - 22 - t05:42:05z”，“访客”：{“电子邮件”：”“，“id”：“9339545.11 mjg3gvk0uheik”，“名称”：“乔”，“笔记”：”“，“电话”：”“｝，“webpath”：［{“从”：”“，“时间戳”：“2020 - 12 - 22 - t04:50:58z”，“标题”：“亚博Zendesk”，”到“：“https://subdomain.亚博zendesk.com/hc/en-us”｝］，“亚博zendesk_ticket_id”：84｝］，“数”：2，“end_id”：“2012.9339545.SJsAIFAY09HB1”，“end_time”：1608613496，“next_page”：“https://www.zopim.com/api/v2/incremental/chats?fields=chats%28%2A%29&start_time=1608613496&start_id=2012.9339545.SJsAIFAY09HB1”｝
增量转换输出
GET / api / v2 /增量/转换
返回一个转换对象，该对象列出自开始时间以来已发生或已更新的转换。
转换属性
| 名字 | 类型 | 只读 | 描述 |
|---|---|---|---|
| id | 字符串 | 是的 | 转换的ID |
| 时间戳 | 日期 | 是的 | 转换发生的日期和时间 |
| goal_id | 整数 | 是的 | 转换目标ID |
| goal_name | 字符串 | 是的 | 转换的目标名称 |
| 归因 | 对象 | 是的 | 转换的归因。看到归因 |
归因
| 名字 | 类型 | 只读 | 描述 |
|---|---|---|---|
| agent_id | 整数 | 是的 | 涉及代理人编号 |
| department_id | 整数 | 是的 | 涉及部门ID |
| chat_id | 字符串 | 是的 | 关联聊天ID |
| chat_timestamp | 日期 | 是的 | 关联聊天的开始日期和时间 |
允许
- 老板
- 管理员
资源扩张
此端点支持资源扩展。看到资源扩张．
参数
| 名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| 字段 | 字符串 | 查询 | 假 | 需要响应属性。看到资源扩张 |
| 限制 | 整数 | 查询 | 假 | 要返回的结果数。默认值和最大值为1000 |
| start_id | 字符串 | 查询 | 假 | 默认为空字符串 |
| start_time | 整数 | 查询 | 假 | 以微秒为单位的Unix纪元时间。看到开始时间．默认为0 |
代码示例
旋度
旋度“https://www.zopim.com/api/v2/incremental/conversions?fields=conversions”(*)\- v - u{email_address｝：{密码｝
去
进口（“fmt”“输入输出”“net/http”）函数主要（）{url：=“https://support.亚博zendesk.com/api/v2/incremental/conversions?fields=&limit=&start_id=&start_time=”方法：=“获得”要求的事情，犯错：=http．NewRequest（方法，url，零）如果犯错! =零{fmt．Println（犯错）返回｝要求的事情．头．添加（“内容类型”，“application / json”）客户端：=&http．客户端{｝res，犯错：=客户端．做（要求的事情）如果犯错! =零{fmt．Println（犯错）返回｝推迟res．身体．关闭（）身体，犯错：=io．ReadAll（res．身体）如果犯错! =零{fmt．Println（犯错）返回｝fmt．Println（字符串（身体））｝
Java
进口com．squareup．okhttp．*；OkHttpClient客户端＝新OkHttpClient（）；HttpUrl．构建器urlBuilder＝HttpUrl．解析（“https://support.亚博zendesk.com/api/v2/incremental/conversions”）．newBuilder（）．addQueryParameter（“字段”，”“）．addQueryParameter（“限制”，”“）．addQueryParameter（“start_id”，”“）．addQueryParameter（“start_time”，”“）；请求请求＝新请求．构建器（）．url（urlBuilder．构建（））．方法（“获得”，零）．addHeader（“内容类型”，“application / json”）．构建（）；响应响应＝客户端．newCall（请求）．执行（）；
Nodejs
varaxios＝需要（“axios”）；var配置＝{方法：“得到”，url：“https://support.亚博zendesk.com/api/v2/incremental/conversions”，头：{“内容类型”：“application / json”，｝，参数个数：{“字段”：”，“限制”：”，“start_id”：”，“start_time”：”，｝，｝；axios（配置）．然后（函数（响应）{控制台．日志（JSON．stringify（响应．数据））；｝）．抓（函数（错误）{控制台．日志（错误）；｝）；
Python
进口请求url＝“https://support.亚博zendesk.com/api/v2/incremental/conversions?fields=&limit=&start_id=&start_time=”头＝{“内容类型”：“application / json”，｝响应＝请求．请求（“获得”，url，头＝头）打印（响应．文本）
鲁比（人名）
需要“net/http”uri＝URI（“https://support.亚博zendesk.com/api/v2/incremental/conversions”）uri．查询＝URI．encode_www_form（“字段”：”“，“限制”：”“，“start_id”：”“，“start_time”：”“）请求＝网：：HTTP：：得到．新（uri，“内容类型”：“application / json”）响应＝网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束
示例响应(年代)
200好了
//状态200 OK{“转换”：［{“归因”：{“agent_id”：361271293212，“chat_id”：“1805.2234024.QrLZCCXVnzGJH”，“chat_timestamp”：“2018 - 05 - 07 - t07:57:37z”，“department_id”：零｝，“goal_id”：1863，“goal_name”：“添加到购物车”，“id”：“1805.2234024.v.1863.7BjLCgLGCJp4W90JapicWu”，“时间戳”：“2018 - 05 - 07 - t07:57:39z”｝，{“归因”：{“agent_id”：361271293212，“chat_id”：“1805.2234024.QrLoIcRHWMeul”，“chat_timestamp”：“2018 - 05 - 07 - t08:57:36z”，“department_id”：零｝，“goal_id”：1863，“goal_name”：“添加到购物车”，“id”：“1805.2234024.v.1863.6DPoXaF5JozixQ5RVoK9K3”，“时间戳”：“2018 - 05 - 07 - t08:57:39z”｝，{“归因”：{“agent_id”：零，“chat_id”：零，“chat_timestamp”：零，“department_id”：零｝，“goal_id”：1865，“goal_name”：“下订单”，“id”：“1805.2234024.v.1865.4rUmpcFFfUBCkBqDru9j6V”，“时间戳”：“2018 - 05 - 07 - t10:57:38z”｝］，“数”：3.，“end_id”：“1805.2234024.v.1865.4rUmpcFFfUBCkBqDru9j6V”，“end_time”：1525690658，“next_page”：“https://www.zopim.com/api/v2/incremental/conversions?fields=conversions%28%2A%29&start_time=1525690658&start_id=1805.2234024.v.1865.4rUmpcFFfUBCkBqDru9j6V”｝
增量部门事件导出
得到/ api / v2 /增量/ department_events
返回一个department_events对象，该对象包含按时间顺序排列的事件对象列表，这些事件对象反映了自给定开始时间以来部门属性的变化。目前，可用的属性是queue_sizes．
department_events
| 名字 | 类型 | 只读 | 描述 |
|---|---|---|---|
| id | 字符串 | 是的 | 事件ID |
| department_id | 整数或null | 是的 | 可空的部门ID |
| 时间戳 | 日期 | 是的 | 事件发生的日期和时间，以秒为单位 |
| field_name | 字符串 | 是的 | 定义事件属性的字段名。取值范围:queue_sizes |
| 价值 | 对象 | 是的 | “field_name”属性指定的字段的当前值。 |
| previous_value | 对象 | 是的 | “field_name”属性指定的字段的上一个值。如果该属性为空或不适用，则该属性可能不会出现在响应中。 |
允许
- 老板
- 管理员
资源扩张
不适用。
参数
| 名字 | 类型 | 在 | 要求 | 描述 |
|---|---|---|---|---|
| 字段 | 字符串 | 查询 | 假 | 需要响应属性。看到资源扩张 |
| 限制 | 整数 | 查询 | 假 | 要返回的结果数。默认值和最大值为1000 |
| start_id | 字符串 | 查询 | 假 | 默认为空字符串 |
| start_time | 整数 | 查询 | 假 | 以微秒为单位的Unix纪元时间。看到开始时间．默认为0 |
代码示例
旋度
旋度“https://www.zopim.com/api/v2/incremental/department_events”\- v - u{email_address｝：{密码｝
去
进口（“fmt”“输入输出”“net/http”）函数主要（）{url：=“https://support.亚博zendesk.com/api/v2/incremental/department_events?fields=&limit=&start_id=&start_time=”方法：=“获得”要求的事情，犯错：=http．NewRequest（方法，url，零）如果犯错! =零{fmt．Println（犯错）返回｝要求的事情．头．添加（“内容类型”，“application / json”）客户端：=&http．客户端{｝res，犯错：=客户端．做（要求的事情）如果犯错! =零{fmt．Println（犯错）返回｝推迟res．身体．关闭（）身体，犯错：=io．ReadAll（res．身体）如果犯错! =零{fmt．Println（犯错）返回｝fmt．Println（字符串（身体））｝
Java
进口com．squareup．okhttp．*；OkHttpClient客户端＝新OkHttpClient（）；HttpUrl．构建器urlBuilder＝HttpUrl．解析（“https://support.亚博zendesk.com/api/v2/incremental/department_events”）．newBuilder（）．addQueryParameter（“字段”，”“）．addQueryParameter（“限制”，”“）．addQueryParameter（“start_id”，”“）．addQueryParameter（“start_time”，”“）；请求请求＝新请求．构建器（）．url（urlBuilder．构建（））．方法（“获得”，零）．addHeader（“内容类型”，“application / json”）．构建（）；响应响应＝客户端．newCall（请求）．执行（）；
Nodejs
varaxios＝需要（“axios”）；var配置＝{方法：“得到”，url：“https://support.亚博zendesk.com/api/v2/incremental/department_events”，头：{“内容类型”：“application / json”，｝，参数个数：{“字段”：”，“限制”：”，“start_id”：”，“start_time”：”，｝，｝；axios（配置）．然后（函数（响应）{控制台．日志（JSON．stringify（响应．数据））；｝）．抓（函数（错误）{控制台．日志（错误）；｝）；
Python
进口请求url＝“https://support.亚博zendesk.com/api/v2/incremental/department_events?fields=&limit=&start_id=&start_time=”头＝{“内容类型”：“application / json”，｝响应＝请求．请求（“获得”，url，头＝头）打印（响应．文本）
鲁比（人名）
需要“net/http”uri＝URI（“https://support.亚博zendesk.com/api/v2/incremental/department_events”）uri．查询＝URI．encode_www_form（“字段”：”“，“限制”：”“，“start_id”：”“，“start_time”：”“）请求＝网：：HTTP：：得到．新（uri，“内容类型”：“application / json”）响应＝网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束
示例响应(年代)
200好了
//状态200 OK{“数”：2，“department_events”：［{“department_id”：123，“field_name”：“queue_sizes”，“id”：“R3J4l7Q.department: 123. jnny6n”，“时间戳”：“2017 - 12 - 02 - t00:00:00.312082z”，“价值”：{“分配”：2，“输入”：2｝｝，{“department_id”：456，“field_name”：“queue_sizes”，“id”：“R3J4l7Q.department: 456. ccf4lg”，“时间戳”：“2017 - 12 - 02 - t00:01:00.657078z”，“价值”：{“分配”：2，“输入”：3.｝｝］，“end_id”：“R3J4l7Q.department: 456. ccf4lg”，“end_time”：1536041904，“next_page”：“https://www.zopim.com/api/v2/incremental/department_events?start_time=1512172860.657078&start_id=R3J4l7Q.department: 456. ccf4lg”｝