REST API

如果您想按需提取数据，Real Time Chat API提供REST端点。如果您希望实时监视或处理指标，请考虑使用流API代替。

REST API使用以下路径:

https://rtm.zopim.com/stream/{资源}

该路径与Chat API的路径不同，如下所示:

https://www.zopim.com/api/v2/{资源}

数据初始化

如果还没有为您的帐户计算数据，或者在很长一段时间不活动之后，REST API将暂时返回不计算响应消息。

             

              
Http /1.1 200 ok内容类型:application / json{“status_code”:200年,"message": "Not Computed!"}
             

获取所有聊天指标

/流/聊天

捕获您帐户的所有聊天活动。

允许

• 老板
• 管理员
• 代理

使用旋度

             

              
旋度https://rtm.zopim.com/stream/chats＼- h"授权:承载{访问令牌}"
             

示例响应

             

              
Http /1.1 200 ok内容类型:application / json{"内容":{“主题”:“聊天”,"数据":{“incoming_chats”:2“assigned_chats”:0,“waiting_time_avg”:12," missed_chats ": {“30”:1、“60”:1}，“active_chats”:7,…}，“类型”:“更新”,“department_id”:null}，“status_code”:200}
             

获取聊天指标

GET /流/聊天/ {metric_key}

为您的帐户返回单个聊天指标。看到聊天指标对于公制键。

允许

• 老板
• 管理员
• 代理

使用旋度

             

              
旋度https://rtm.zopim.com/stream/chats/{metric_key}＼- h"授权:承载{访问令牌}"
             

参数

示例响应

GET /流/聊天/ missed_chats

             

              
Http /1.1 200 ok内容类型:application / json{"内容":{“主题”:“聊天”,"数据":{" missed_chats ": {“30”:1、“60”:2}}，“类型”:“更新”,“department_id”:null}，“status_code”:200}
             

按部门获取聊天指标

• /流/聊天吗?department_id＝{department_id}
• GET /流/聊天/ {metric_key} ?department_id = {department_id}

捕获特定部门的聊天活动。

要列出帐户上的所有部门或按名称获取部门，请使用部门API．

要捕获不属于任何部门的聊天的活动，请使用department_id = 0．

允许

• 老板
• 管理员
• 代理

参数

使用旋度

             

              
旋度https://rtm.zopim.com/stream/chats/{metric_key}department_id ?＝{department_id}＼- h"授权:承载{访问令牌}"
             

示例响应

/流/聊天吗?department_id = 5

             

              
Http /1.1 200 ok内容类型:application / json{"内容":{“主题”:“聊天”,"数据":{“incoming_chats”:0,“waiting_time_avg”:空," missed_chats ": {“30”:0,“60”:0}，…}，“类型”:“更新”,“department_id”:5}，“status_code”:200}
             

获取特定时间窗口的聊天指标

• /流/聊天吗?窗口= {window_size_in_minutes}
• GET /流/聊天/ {metric_key} ?窗口= {window_size_in_minutes}

过滤给定时间窗口的聊天指标。

看到聊天指标对于与时间窗口关联的度量。其他指标不受影响。

可用的时间窗口是30.分钟,60分钟。

允许

• 老板
• 管理员
• 代理

使用旋度

             

              
旋度https://rtm.zopim.com/stream/chats/{metric_key}窗口吗?＝{window_size_in_minutes}＼- h"授权:承载{访问令牌}"
             

参数

示例响应

GET /流/聊天/ missed_chats吗?窗口= 30

             

              
Http /1.1 200 ok内容类型:application / json{"内容":{“主题”:“聊天”,"数据":{" missed_chats ": {“30”:1}}，“类型”:“更新”,“department_id”:null}，“status_code”:200}
             

获取座席状态计数

/流/代理

返回在您的帐户中在线、离开和不可见的代理的数量。

允许

• 老板
• 管理员
• 代理

使用旋度

             

              
旋度https://rtm.zopim.com/stream/agents＼- h"授权:承载{访问令牌}"
             

示例响应

             

              
Http /1.1 200 ok内容类型:application / json{"内容":{“主题”:“代理”,"数据":{“agents_online”:27岁“agents_away”:1、“agents_invisible”:1}，“类型”:“更新”,“department_id”:null}，“status_code”:200}
             

获取座席状态计数

GET /流/代理/ {metric_key}

返回在您的帐户中在线、离开或不可见的代理的数量。使用度量键指定状态(agents_online，agents_away，agents_invisible)。看到代理指标．

允许

• 老板
• 管理员
• 代理

使用旋度

             

              
旋度https://rtm.zopim.com/stream/agents/{metric_key}＼- h"授权:承载{访问令牌}"
             

参数

示例响应

GET /流/代理/ agents_online

             

              
Http /1.1 200 ok内容类型:application / json{"内容":{“主题”:“代理”,"数据":{“agents_online”:27}，“类型”:“更新”,“department_id”:null}，“status_code”:200}
             

按部门获取座席状态计数

• /流/代理吗?department_id＝{department_id}
• GET /流/代理/ {metric_key} ?department_id = {department_id}

按状态返回特定部门的座席数。

要列出帐户上的所有部门或按名称获取部门，请使用部门API．

要统计不属于任何部门的座席，使用department_id = 0．

允许

• 老板
• 管理员
• 代理

参数

使用旋度

             

              
旋度https://rtm.zopim.com/stream/agents/{metric_key}department_id ?＝{department_id}＼- h"授权:承载{访问令牌}"
             

示例响应

/流/代理吗?department_id = 5

             

              
Http /1.1 200 ok内容类型:application / json{"内容":{“主题”:“代理”,"数据":{“agents_online”:26日,“agents_away”:0,“agents_invisible”:1}，“类型”:“更新”,“department_id”:5}，“status_code”:200}