路由设置

您可以使用这个API来获取或修改聊天路由设置。有关更多信息，请参见设置聊天路由在聊天帮助中心。

JSON格式

帐号路由设置有效载荷

帐户级路由设置表示为嵌套的JSON对象。

字段名	类型	只读	描述
routing_mode	字符串	没有	帐号的路由方式。可能的值:"broadcast"， "assigned"或"hybrid"
chat_limit	对象	没有	看到聊天限制属性
skill_routing	对象	没有	看到技能路由属性
重新分配	对象	没有	看到重新分配财产
auto_idle	对象	没有	看到自动怠速特性

聊天限制属性

字段名	类型	只读	描述
启用	布尔	没有	启用聊天限制
限制	整数	没有	每个座席一次可以进行的并发聊天数。取值范围:0 ~ 20之间的整数
limit_type	字符串	没有	聊天限制应用到的范围。当设置为“代理”时，每个代理将有自己的个人聊天限制。可能值:"account"或"agent"
allow_agent_override	布尔	没有	允许每个座席在个人设置下设置自己的聊天限制

技能路由属性

字段名	类型	只读	描述
启用	布尔	没有	开启技能路由
max_wait_time	整数	没有	在将聊天分配给具有匹配技能的座席之前等待的最大时间(以秒为单位)。仅适用于`routing_mode`不就是“播”和`skill_routing.enabled`是真的。取值范围:5 ~ 300之间的整数

重新分配财产

字段名	类型	只读	描述
启用	布尔	没有	使再赋值
超时	整数	没有	在将聊天分配给另一个代理之前没有响应的时间(以秒为单位)。取值范围:10 ~ 120之间的整数

自动怠速特性

字段名	类型	只读	描述
启用	布尔	没有	启用自动空闲
reassignments_before_idle	整数	没有	座席状态改变前重新分配的通话数。取值范围:1 ~ 20之间的整数
new_status	字符串	没有	空闲时的状态。可能值:"away"或"invisible"

例有效载荷:

             
              {“routing_mode”：“广播”，“chat_limit”：{“限制”：3.，“启用”：假，“allow_agent_override”：假，“limit_type”：“账户”｝，“auto_idle”：{“启用”：真正的，“reassignments_before_idle”：3.，“new_status”：“走”｝，“skill_routing”：{“启用”：真正的，“max_wait_time”：30.｝，“重新分配”：{“启用”：假，“超时”：30.｝｝

代理路由设置有效负载

代理级路由设置表示为嵌套的JSON对象。

字段名	类型	只读	描述
技能	数组/对象	没有	座席分配的技能号。看到技能属性
路由	对象	没有	看到路由属性

路由属性

字段名	类型	只读	描述
chat_limit	整数	没有	座席的聊天限制，如果帐户`chat_limit.limit_type`是“代理”还是`chat_limit.allow_agent_override`是真的。取值范围:0 ~ 20之间的整数

例有效载荷:

             
              {“技能”：［1，2，3.]，“路由”：{“chat_limit”：3.｝｝

技能属性

通过代理路由设置，您可以增量地更新代理的技能，以便在添加或删除技能时具有更大的灵活性。

API总是返回技能作为整数形式的技能id数组。例子:

             
              {“技能”：［1，2，3.]，“路由”：{“chat_limit”：3.｝｝

若要用一组新的技能id替换座席现有的所有技能，请提供一个技能请求有效负载中的技能id数组。

例如，下面的有效负载将删除所有现有技能并将技能id设置为1、2和3。

             
              {“技能”：［1，2，3.]｝

要从座席的现有技能中添加或删除技能，您可以提供技能作为一个对象。使用技能id作为键(参见技能API获取如何获取技能id的说明)。如果需要，可以提供true作为值添加将技能ID设置为现有技能，如果需要，也可以设置为空删除技能ID。

下面的示例添加一项技能并删除另一项技能。

现有的技能:

             
              {“技能”：［1，2，3.]｝

下面的有效负载添加带有ID的技能5并移除带有ID的技能3.从现有技能来看:

             
              {“技能”：{“5”：真正的，“3”：零｝｝

更新的技能:

             
              {“技能”：［1，2，5]｝

显示帐户路由设置

GET / api / v2 / routing_settings /帐户

获取帐户的路由设置。

允许

代理

代码示例

旋度

              
               旋度https://www.zopim.com/api/v2/routing_settings/account＼- v - u{email_address｝：{密码｝

去

              
               进口（“fmt”“输入输出”“net/http”）函数主要（）{url: =“https://support.亚博zendesk.com/api/v2/routing_settings/account”方法: =“获得”要求的事情，犯错: =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/routing_settings/account”）．newBuilder（）；请求请求=新请求．构建器（）．url（urlBuilder．构建（））．方法（“获得”，零）．addHeader（“内容类型”，“application / json”）．构建（）；响应响应=客户端．newCall（请求）．执行（）；

Nodejs

              
               varaxios=需要（“axios”）；var配置={方法：“得到”，url：“https://support.亚博zendesk.com/api/v2/routing_settings/account”，头：{“内容类型”：“application / json”，｝，｝；axios（配置）．然后（函数（响应）{控制台．日志（JSON．stringify（响应．数据））；｝）．抓（函数（错误）{控制台．日志（错误）；｝）；

Python

              
               进口请求url=“https://support.亚博zendesk.com/api/v2/routing_settings/account”头={“内容类型”：“application / json”，｝响应=请求．请求（“获得”，url，头=头）打印（响应．文本）

鲁比（人名）

              
               需要“net/http”uri=URI（“https://support.亚博zendesk.com/api/v2/routing_settings/account”）请求=网：：HTTP：：得到．新（uri，“内容类型”：“application / json”）响应=网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束

示例响应(年代)

200好了

              
               //状态200 OK{“数据”：{“auto_idle”：{“启用”：真正的，“new_status”：“走”，“reassignments_before_idle”：3.｝，“chat_limit”：{“allow_agent_override”：假，“启用”：假，“限制”：3.，“limit_type”：“账户”｝，“重新分配”：{“启用”：假，“超时”：30.｝，“routing_mode”：“广播”，“skill_routing”：{“启用”：真正的，“max_wait_time”：30.｝｝｝

更新帐户路由设置

补丁/ api / v2 / routing_settings /帐户

更新帐户的路由设置。您可以只包含您想要修改的字段。不存在的字段将不会被更改。

允许

管理员

代码示例

旋度

              
               旋度https://www.zopim.com/api/v2/routing_settings/account＼- d”{“routing_mode”:“广播”," chat_limit ": {“启用”:真的}，“重新分配”:{“启用”:没错,“超时”:60｝} '＼- v - u{email_address｝：{密码｝＼-x patch -h“application / json内容类型:

去

              
               进口（“fmt”“输入输出”“net/http”）函数主要（）{url: =“https://support.亚博zendesk.com/api/v2/routing_settings/account”方法: =“补丁”要求的事情，犯错: =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/routing_settings/account”）．newBuilder（）；RequestBody身体=RequestBody．创建（MediaType．解析（“application / json”），”“””“”）；请求请求=新请求．构建器（）．url（urlBuilder．构建（））．方法（“补丁”，身体）．addHeader（“内容类型”，“application / json”）．构建（）；响应响应=客户端．newCall（请求）．执行（）；

Nodejs

              
               varaxios=需要（“axios”）；var配置={方法：“补丁”，url：“https://support.亚博zendesk.com/api/v2/routing_settings/account”，头：{“内容类型”：“application / json”，｝，｝；axios（配置）．然后（函数（响应）{控制台．日志（JSON．stringify（响应．数据））；｝）．抓（函数（错误）{控制台．日志（错误）；｝）；

Python

              
               进口请求url=“https://support.亚博zendesk.com/api/v2/routing_settings/account”头={“内容类型”：“application / json”，｝响应=请求．请求（“补丁”，url，头=头）打印（响应．文本）

鲁比（人名）

              
               需要“net/http”uri=URI（“https://support.亚博zendesk.com/api/v2/routing_settings/account”）请求=网：：HTTP：：补丁．新（uri，“内容类型”：“application / json”）响应=网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束

示例响应(年代)

200好了

              
               //状态200 OK{“数据”：{“auto_idle”：{“启用”：真正的，“new_status”：“走”，“reassignments_before_idle”：3.｝，“chat_limit”：{“allow_agent_override”：假，“启用”：真正的，“限制”：3.，“limit_type”：“账户”｝，“重新分配”：{“启用”：真正的，“超时”：60｝，“routing_mode”：“广播”，“skill_routing”：{“启用”：真正的，“max_wait_time”：30.｝｝｝

列出代理的路由设置

GET / api / v2 / routing_settings /代理

获取所有代理的路由设置。

分页

此端点使用基于游标的分页。看到分页列表代理。

允许

代理

参数

名字	类型	在	要求	描述
限制	整数	查询	假	端点将返回的记录数。默认为10。
max_id	整数	查询	假	使用max_id参数通过记录集向后分页
since_id	整数	查询	假	使用since_id参数通过记录集向前分页

代码示例

旋度

              
               旋度https://www.zopim.com/api/v2/routing_settings/agents＼- v - u{email_address｝：{密码｝

去

              
               进口（“fmt”“输入输出”“net/http”）函数主要（）{url: =“https://support.亚博zendesk.com/api/v2/routing_settings/agents?limit=20&max_id=20&since_id=10”方法: =“获得”要求的事情，犯错: =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/routing_settings/agents”）．newBuilder（）．addQueryParameter（“限制”，“20”）．addQueryParameter（“max_id”，“20”）．addQueryParameter（“since_id”，“10”）；请求请求=新请求．构建器（）．url（urlBuilder．构建（））．方法（“获得”，零）．addHeader（“内容类型”，“application / json”）．构建（）；响应响应=客户端．newCall（请求）．执行（）；

Nodejs

              
               varaxios=需要（“axios”）；var配置={方法：“得到”，url：“https://support.亚博zendesk.com/api/v2/routing_settings/agents”，头：{“内容类型”：“application / json”，｝，参数个数：{“限制”：“20”，“max_id”：“20”，“since_id”：“十”，｝，｝；axios（配置）．然后（函数（响应）{控制台．日志（JSON．stringify（响应．数据））；｝）．抓（函数（错误）{控制台．日志（错误）；｝）；

Python

              
               进口请求url=“https://support.亚博zendesk.com/api/v2/routing_settings/agents?limit=20&max_id=20&since_id=10”头={“内容类型”：“application / json”，｝响应=请求．请求（“获得”，url，头=头）打印（响应．文本）

鲁比（人名）

              
               需要“net/http”uri=URI（“https://support.亚博zendesk.com/api/v2/routing_settings/agents”）uri．查询=URI．encode_www_form（“限制”：“20”，“max_id”：“20”，“since_id”：“10”）请求=网：：HTTP：：得到．新（uri，“内容类型”：“application / json”）响应=网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束

示例响应(年代)

200好了

              
               //状态200 OK{“数据”：{“19174”：{“路由”：{“chat_limit”：3.｝，“技能”：［1，2，3.]｝，“19175”：{“路由”：{“chat_limit”：5｝，“技能”：［5，6]｝｝｝

显示座席路由设置

GET / api / v2 / routing_settings /代理/ {agent_id}
GET / api / v2 / routing_settings /代理/我

获取代理的路由设置。经过身份验证的代理可以通过替换{agent_id}与我．

允许

代理

参数

名字	类型	在	要求	描述
agent_id	整数	路径	真正的	座席的ID

代码示例

旋度

              
               旋度https://www.zopim.com/api/v2/routing_settings/agents/{agent_id｝＼- v - u{email_address｝：{密码｝

去

              
               进口（“fmt”“输入输出”“net/http”）函数主要（）{url: =“https://support.亚博zendesk.com/api/v2/routing_settings/agents/1”方法: =“获得”要求的事情，犯错: =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/routing_settings/agents/1”）．newBuilder（）；请求请求=新请求．构建器（）．url（urlBuilder．构建（））．方法（“获得”，零）．addHeader（“内容类型”，“application / json”）．构建（）；响应响应=客户端．newCall（请求）．执行（）；

Nodejs

              
               varaxios=需要（“axios”）；var配置={方法：“得到”，url：“https://support.亚博zendesk.com/api/v2/routing_settings/agents/1”，头：{“内容类型”：“application / json”，｝，｝；axios（配置）．然后（函数（响应）{控制台．日志（JSON．stringify（响应．数据））；｝）．抓（函数（错误）{控制台．日志（错误）；｝）；

Python

              
               进口请求url=“https://support.亚博zendesk.com/api/v2/routing_settings/agents/1”头={“内容类型”：“application / json”，｝响应=请求．请求（“获得”，url，头=头）打印（响应．文本）

鲁比（人名）

              
               需要“net/http”uri=URI（“https://support.亚博zendesk.com/api/v2/routing_settings/agents/1”）请求=网：：HTTP：：得到．新（uri，“内容类型”：“application / json”）响应=网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束

示例响应(年代)

200好了

              
               //状态200 OK{“数据”：{“路由”：{“chat_limit”：3.｝，“技能”：［1，2，3.]｝｝

更新代理路由设置

补丁/ api / v2 / routing_settings /代理/ {agent_id}
补丁/ api / v2 / routing_settings /代理/我

更新代理的路由设置。经过身份验证的代理可以通过替换{agent_id}与我．

允许

管理员
代理(使用/我）

参数

名字	类型	在	要求	描述
agent_id	整数	路径	真正的	座席的ID

代码示例

旋度

              
               旋度https://www.zopim.com/api/v2/routing_settings/agents/{agent_id｝＼- d”{“技能”:[5,6]，“路由”:{“chat_limit”:5｝} '＼- v - u{email_address｝：{密码｝＼-x patch -h“application / json内容类型:

去

              
               进口（“fmt”“输入输出”“net/http”）函数主要（）{url: =“https://support.亚博zendesk.com/api/v2/routing_settings/agents/1”方法: =“补丁”要求的事情，犯错: =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/routing_settings/agents/1”）．newBuilder（）；RequestBody身体=RequestBody．创建（MediaType．解析（“application / json”），”“””“”）；请求请求=新请求．构建器（）．url（urlBuilder．构建（））．方法（“补丁”，身体）．addHeader（“内容类型”，“application / json”）．构建（）；响应响应=客户端．newCall（请求）．执行（）；

Nodejs

              
               varaxios=需要（“axios”）；var配置={方法：“补丁”，url：“https://support.亚博zendesk.com/api/v2/routing_settings/agents/1”，头：{“内容类型”：“application / json”，｝，｝；axios（配置）．然后（函数（响应）{控制台．日志（JSON．stringify（响应．数据））；｝）．抓（函数（错误）{控制台．日志（错误）；｝）；

Python

              
               进口请求url=“https://support.亚博zendesk.com/api/v2/routing_settings/agents/1”头={“内容类型”：“application / json”，｝响应=请求．请求（“补丁”，url，头=头）打印（响应．文本）

鲁比（人名）

              
               需要“net/http”uri=URI（“https://support.亚博zendesk.com/api/v2/routing_settings/agents/1”）请求=网：：HTTP：：补丁．新（uri，“内容类型”：“application / json”）响应=网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束

示例响应(年代)

200好了

              
               //状态200 OK{“数据”：{“路由”：{“chat_limit”：5｝，“技能”：［5，6]｝｝

批量更新多个代理的路由设置

补丁/ api / v2 / routing_settings /代理

批量更新多个代理的路由设置。

有效负载必须是一个对象，代理id作为键，代理设置更新作为值。您可以在设置更新中只包含要修改的字段。不存在的字段将不会被更改。

速率限制

这个API有不同的速率限制。当批量更新代理时，为了限制速率，请求主体中的每5个代理计数为1个请求。请调整一次请求的代理数量，以免受到费率限制。

例子:

一批代理的数量	请求数
2个代理	1
5代理	1
6代理	2
51代理	11

允许

管理员

代码示例

旋度

              
               旋度https://www.zopim.com/api/v2/routing_settings/agents＼- d”{" 19174 ": {技能:[8,9]}，" 19175 ": {“路由”:{“chat_limit”:7｝｝} '＼- v - u{email_address｝：{密码｝＼-x patch -h“application / json内容类型:

去

              
               进口（“fmt”“输入输出”“net/http”）函数主要（）{url: =“https://support.亚博zendesk.com/api/v2/routing_settings/agents”方法: =“补丁”要求的事情，犯错: =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/routing_settings/agents”）．newBuilder（）；RequestBody身体=RequestBody．创建（MediaType．解析（“application / json”），”“””“”）；请求请求=新请求．构建器（）．url（urlBuilder．构建（））．方法（“补丁”，身体）．addHeader（“内容类型”，“application / json”）．构建（）；响应响应=客户端．newCall（请求）．执行（）；

Nodejs

              
               varaxios=需要（“axios”）；var配置={方法：“补丁”，url：“https://support.亚博zendesk.com/api/v2/routing_settings/agents”，头：{“内容类型”：“application / json”，｝，｝；axios（配置）．然后（函数（响应）{控制台．日志（JSON．stringify（响应．数据））；｝）．抓（函数（错误）{控制台．日志（错误）；｝）；

Python

              
               进口请求url=“https://support.亚博zendesk.com/api/v2/routing_settings/agents”头={“内容类型”：“application / json”，｝响应=请求．请求（“补丁”，url，头=头）打印（响应．文本）

鲁比（人名）

              
               需要“net/http”uri=URI（“https://support.亚博zendesk.com/api/v2/routing_settings/agents”）请求=网：：HTTP：：补丁．新（uri，“内容类型”：“application / json”）响应=网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束

示例响应(年代)

200好了

              
               //状态200 OK{“数据”：{“19174”：{“路由”：{“chat_limit”：3.｝，“技能”：［8，9]｝，“19175”：{“路由”：{“chat_limit”：7｝，“技能”：［5，6]｝｝｝