您可以使用API来获取或设置代理信息。

如果您在Zendesk支持中创建了Zen亚博desk聊天帐户,则访问聊天帐户和代理api仅限于GET请求。您仍然可以正常使用其他聊天api。

JSON格式

代理被表示为具有以下属性的JSON对象:

名字 类型 只读 强制性的 描述
create_date 字符串 真正的 代理的创建日期
部门 数组 真正的 各部门为代理
display_name 字符串 要为代理显示的名称
电子邮件 字符串 座席的电子邮件地址
启用 整数 描述代理是否已启用
enabled_departments 数组 真正的 座席启用的部门
first_name 字符串 代理人的名字
id 整数 真正的 座席的ID
last_name 字符串 代理人的姓
role_id 整数 代理的角色ID
角色 对象 真正的 特殊角色权限。请参阅下面的值(已弃用)
技能 数组 真正的 代理的技能

角色属性有以下值:

价值 用户
老板 帐户所有者
管理员 具有管理员权限的代理

注意:创建时需要输入以下字段:

名字 类型 只读 描述
密码 字符串 是的 这是代理的密码。这只在创建过程中需要。

例子

             
{“create_date”“2014 - 09 - 30 - t08:25:09z”“部门”“display_name”“约翰”“电子邮件”(电子邮件保护)“启用”1“enabled_departments”“first_name”“约翰。”“id”5“last_name”“母鹿”“role_id”3.“角色”{“管理员”“所有者”}}

代理列表

  • GET / api / v2 /代理

列出您帐户的所有代理。

分页

此端点使用基于游标的分页。这些记录按记录id顺序排序。端点取max_idsince_id查询参数,它们充当跟踪记录集中的记录id的单独游标。的max_id游标在记录集中向后移动,记录id变小。的since_id光标向前移动,记录id变大。

  • 使用max_id参数对记录集进行向后分页。示例:“获取前200条记录,以并包括。max_id记录。”

    “https://www.zopim.com/api/v2/agents?max_id=10&limit=200”

  • 使用since_id参数以通过记录集向前分页。示例:“获取接下来的200条记录,从开始并包括。since_id记录。”

    “https://www.zopim.com/api/v2/agents?since_id=10&limit=200”

可以通过计算下一页来检索下一页since_id将当前集合中最后一条记录的ID添加1,并将其指定为since_id在下一个请求中。类似地,可以通过发出一个请求来检索前一个页面max_id它比当前记录集的第一个元素小1。

此外,下一页和上一页路径将在响应中作为标题可用。

如果任何分页参数(since_idmax_id限制),则结果的默认数量为10,但您可以使用限制参数。如果没有分页参数存在,则返回整个记录集。

亚博Zendesk Chat建议尽可能使用分页。非分页查询将在API的后续版本中弃用。

允许

  • 代理

参数

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

代码示例

旋度
              
旋度“https://www.zopim.com/api/v2/agents?since_id=5&limit=2”- v - u{email_address}{密码}
              
进口“fmt”“输入输出”“net/http”函数主要{url:=“https://support.亚博zendesk.com/api/v2/agents?limit=20&max_id=20&since_id=10”方法:=“获得”要求的事情犯错:=httpNewRequest方法url如果犯错! ={fmtPrintln犯错返回}要求的事情添加“内容类型”“application / json”客户端:=http客户端{}res犯错:=客户端要求的事情如果犯错! ={fmtPrintln犯错返回}推迟res身体关闭身体犯错:=ioReadAllres身体如果犯错! ={fmtPrintln犯错返回}fmtPrintln字符串身体}
Java
              
进口comsquareupokhttpOkHttpClient客户端=OkHttpClientHttpUrl构建器urlBuilder=HttpUrl解析“https://support.亚博zendesk.com/api/v2/agents”newBuilderaddQueryParameter“限制”“20”addQueryParameter“max_id”“20”addQueryParameter“since_id”“10”请求请求=请求构建器urlurlBuilder构建方法“获得”addHeader“内容类型”“application / json”构建响应响应=客户端newCall请求执行
Nodejs
              
varaxios=需要“axios”var配置={方法“得到”url“https://support.亚博zendesk.com/api/v2/agents”{“内容类型”“application / json”}参数个数{“限制”“20”“max_id”“20”“since_id”“十”}}axios配置然后函数响应{控制台日志JSONstringify响应数据}函数错误{控制台日志错误}
Python
              
进口请求url=“https://support.亚博zendesk.com/api/v2/agents?limit=20&max_id=20&since_id=10”={“内容类型”“application / json”}响应=请求请求“获得”url=打印响应文本
鲁比(人名)
              
需要“net/http”uri=URI“https://support.亚博zendesk.com/api/v2/agents”uri查询=URIencode_www_form“限制”“20”“max_id”“20”“since_id”“10”请求=HTTP得到uri“内容类型”“application / json”响应=HTTP开始uri主机名uri港口use_ssl真正的|http|http请求请求结束

示例响应(年代)

200好了
              
//状态200 OK{“create_date”“2014 - 09 - 30 - t08:25:09z”“部门”“display_name”“约翰”“电子邮件”(电子邮件保护)“启用”1“first_name”“约翰。”“id”5“last_name”“母鹿”“role_id”3.“角色”{“管理员”“所有者”}}

按ID显示代理人

  • GET / api / v2 /代理/ {agent_id}

通过代理人的ID获取代理人。

允许

  • 管理员

参数

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

代码示例

旋度
              
旋度https://www.zopim.com/api/v2/agents/{agent_id}- v - u{email_address}{密码}
              
进口“fmt”“输入输出”“net/http”函数主要{url:=“https://support.亚博zendesk.com/api/v2/agents/1”方法:=“获得”要求的事情犯错:=httpNewRequest方法url如果犯错! ={fmtPrintln犯错返回}要求的事情添加“内容类型”“application / json”客户端:=http客户端{}res犯错:=客户端要求的事情如果犯错! ={fmtPrintln犯错返回}推迟res身体关闭身体犯错:=ioReadAllres身体如果犯错! ={fmtPrintln犯错返回}fmtPrintln字符串身体}
Java
              
进口comsquareupokhttpOkHttpClient客户端=OkHttpClientHttpUrl构建器urlBuilder=HttpUrl解析“https://support.亚博zendesk.com/api/v2/agents/1”newBuilder请求请求=请求构建器urlurlBuilder构建方法“获得”addHeader“内容类型”“application / json”构建响应响应=客户端newCall请求执行
Nodejs
              
varaxios=需要“axios”var配置={方法“得到”url“https://support.亚博zendesk.com/api/v2/agents/1”{“内容类型”“application / json”}}axios配置然后函数响应{控制台日志JSONstringify响应数据}函数错误{控制台日志错误}
Python
              
进口请求url=“https://support.亚博zendesk.com/api/v2/agents/1”={“内容类型”“application / json”}响应=请求请求“获得”url=打印响应文本
鲁比(人名)
              
需要“net/http”uri=URI“https://support.亚博zendesk.com/api/v2/agents/1”请求=HTTP得到uri“内容类型”“application / json”响应=HTTP开始uri主机名uri港口use_ssl真正的|http|http请求请求结束

示例响应(年代)

200好了
              
//状态200 OK{“create_date”“2014 - 09 - 30 - t08:25:09z”“部门”“display_name”“约翰”“电子邮件”(电子邮件保护)“启用”1“enabled_departments”“first_name”“约翰。”“id”5“last_name”“母鹿”“role_id”3.“角色”{“管理员”“所有者”}}

通过邮件展示代理

  • GET / api / v2 /代理/电子邮件/ {email}

使用座席的电子邮件地址获取座席。

允许

  • 管理员

参数

名字 类型 要求 描述
电子邮件 字符串 路径 真正的 代理的邮箱

代码示例

旋度
              
旋度“https://www.zopim.com/api/v2/agents/email/ {email_id}”- v - u{email_address}{密码}
              
进口“fmt”“输入输出”“net/http”函数主要{url:=“https://support.亚博zendesk.com/api/v2/agents/email/(电子邮件保护)方法:=“获得”要求的事情犯错:=httpNewRequest方法url如果犯错! ={fmtPrintln犯错返回}要求的事情添加“内容类型”“application / json”客户端:=http客户端{}res犯错:=客户端要求的事情如果犯错! ={fmtPrintln犯错返回}推迟res身体关闭身体犯错:=ioReadAllres身体如果犯错! ={fmtPrintln犯错返回}fmtPrintln字符串身体}
Java
              
进口comsquareupokhttpOkHttpClient客户端=OkHttpClientHttpUrl构建器urlBuilder=HttpUrl解析“https://support.亚博zendesk.com/api/v2/agents/email/(电子邮件保护)newBuilder请求请求=请求构建器urlurlBuilder构建方法“获得”addHeader“内容类型”“application / json”构建响应响应=客户端newCall请求执行
Nodejs
              
varaxios=需要“axios”var配置={方法“得到”url“https://support.亚博zendesk.com/api/v2/agents/email/(电子邮件保护){“内容类型”“application / json”}}axios配置然后函数响应{控制台日志JSONstringify响应数据}函数错误{控制台日志错误}
Python
              
进口请求url=“https://support.亚博zendesk.com/api/v2/agents/email/(电子邮件保护)={“内容类型”“application / json”}响应=请求请求“获得”url=打印响应文本
鲁比(人名)
              
需要“net/http”uri=URI“https://support.亚博zendesk.com/api/v2/agents/email/(电子邮件保护)请求=HTTP得到uri“内容类型”“application / json”响应=HTTP开始uri主机名uri港口use_ssl真正的|http|http请求请求结束

示例响应(年代)

200好了
              
//状态200 OK{“create_date”“2014 - 09 - 30 - t08:25:09z”“部门”“display_name”“约翰”“电子邮件”(电子邮件保护)“启用”1“enabled_departments”“first_name”“约翰。”“id”5“last_name”“母鹿”“role_id”3.“角色”{“管理员”“所有者”}}

显示请求代理

  • GET / api / v2 /代理/我

获取您的数据。

允许

  • 代理

代码示例

旋度
              
旋度https://www.zopim.com/api/v2/agents/me- v - u{email_address}{密码}
              
进口“fmt”“输入输出”“net/http”函数主要{url:=“https://support.亚博zendesk.com/api/v2/agents/me”方法:=“获得”要求的事情犯错:=httpNewRequest方法url如果犯错! ={fmtPrintln犯错返回}要求的事情添加“内容类型”“application / json”客户端:=http客户端{}res犯错:=客户端要求的事情如果犯错! ={fmtPrintln犯错返回}推迟res身体关闭身体犯错:=ioReadAllres身体如果犯错! ={fmtPrintln犯错返回}fmtPrintln字符串身体}
Java
              
进口comsquareupokhttpOkHttpClient客户端=OkHttpClientHttpUrl构建器urlBuilder=HttpUrl解析“https://support.亚博zendesk.com/api/v2/agents/me”newBuilder请求请求=请求构建器urlurlBuilder构建方法“获得”addHeader“内容类型”“application / json”构建响应响应=客户端newCall请求执行
Nodejs
              
varaxios=需要“axios”var配置={方法“得到”url“https://support.亚博zendesk.com/api/v2/agents/me”{“内容类型”“application / json”}}axios配置然后函数响应{控制台日志JSONstringify响应数据}函数错误{控制台日志错误}
Python
              
进口请求url=“https://support.亚博zendesk.com/api/v2/agents/me”={“内容类型”“application / json”}响应=请求请求“获得”url=打印响应文本
鲁比(人名)
              
需要“net/http”uri=URI“https://support.亚博zendesk.com/api/v2/agents/me”请求=HTTP得到uri“内容类型”“application / json”响应=HTTP开始uri主机名uri港口use_ssl真正的|http|http请求请求结束

示例响应(年代)

200好了
              
//状态200 OK{“create_date”“2014 - 09 - 30 - t08:25:09z”“部门”“display_name”“约翰”“电子邮件”(电子邮件保护)“启用”1“enabled_departments”“first_name”“约翰。”“id”5“last_name”“母鹿”“role_id”3.“角色”{“管理员”“所有者”}}

创建代理

  • POST / api / v2 /代理

在帐号中创建座席。注意:一个额外的领域,密码,需要在创建时提供。

允许

  • 管理员

代码示例

旋度
              
旋度https://www.zopim.com/api/v2/agents- d”{“电子邮件”:“(电子邮件保护)",“密码”:“secretpassword”,“first_name”:“约翰”,“last_name”:“史密斯”,“display_name”:“史密斯”,“启用”:1} '- v - u{email_address}{密码}-x post -h“application / json内容类型:
              
进口“fmt”“输入输出”“net/http”函数主要{url:=“https://support.亚博zendesk.com/api/v2/agents”方法:=“职位”要求的事情犯错:=httpNewRequest方法url如果犯错! ={fmtPrintln犯错返回}要求的事情添加“内容类型”“application / json”客户端:=http客户端{}res犯错:=客户端要求的事情如果犯错! ={fmtPrintln犯错返回}推迟res身体关闭身体犯错:=ioReadAllres身体如果犯错! ={fmtPrintln犯错返回}fmtPrintln字符串身体}
Java
              
进口comsquareupokhttpOkHttpClient客户端=OkHttpClientHttpUrl构建器urlBuilder=HttpUrl解析“https://support.亚博zendesk.com/api/v2/agents”newBuilderRequestBody身体=RequestBody创建MediaType解析“application / json””“”“请求请求=请求构建器urlurlBuilder构建方法“职位”身体addHeader“内容类型”“application / json”构建响应响应=客户端newCall请求执行
Nodejs
              
varaxios=需要“axios”var配置={方法“职位”url“https://support.亚博zendesk.com/api/v2/agents”{“内容类型”“application / json”}}axios配置然后函数响应{控制台日志JSONstringify响应数据}函数错误{控制台日志错误}
Python
              
进口请求url=“https://support.亚博zendesk.com/api/v2/agents”={“内容类型”“application / json”}响应=请求请求“职位”url=打印响应文本
鲁比(人名)
              
需要“net/http”uri=URI“https://support.亚博zendesk.com/api/v2/agents”请求=HTTP帖子uri“内容类型”“application / json”响应=HTTP开始uri主机名uri港口use_ssl真正的|http|http请求请求结束

示例响应(年代)

201年创建
              
//状态201创建{“display_name”“史密斯”“电子邮件”(电子邮件保护)“启用”1“first_name”“约翰。”“last_name”“史密斯”}

更新代理

  • 把/ api / v2 /代理/ {agent_id}

更新座席的详细信息。

允许

  • 管理员

参数

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

代码示例

旋度
              
旋度https://www.zopim.com/api/v2/agents/{agent_id}- d”{first_name”:“约翰”,“last_name”:“史密斯”,“role_id”:2}”- v - u{email_address}{密码}-x放-h“application / json内容类型:
              
进口“fmt”“输入输出”“net/http”函数主要{url:=“https://support.亚博zendesk.com/api/v2/agents/1”方法:=“把”要求的事情犯错:=httpNewRequest方法url如果犯错! ={fmtPrintln犯错返回}要求的事情添加“内容类型”“application / json”客户端:=http客户端{}res犯错:=客户端要求的事情如果犯错! ={fmtPrintln犯错返回}推迟res身体关闭身体犯错:=ioReadAllres身体如果犯错! ={fmtPrintln犯错返回}fmtPrintln字符串身体}
Java
              
进口comsquareupokhttpOkHttpClient客户端=OkHttpClientHttpUrl构建器urlBuilder=HttpUrl解析“https://support.亚博zendesk.com/api/v2/agents/1”newBuilderRequestBody身体=RequestBody创建MediaType解析“application / json””“”“请求请求=请求构建器urlurlBuilder构建方法“把”身体addHeader“内容类型”“application / json”构建响应响应=客户端newCall请求执行
Nodejs
              
varaxios=需要“axios”var配置={方法“把”url“https://support.亚博zendesk.com/api/v2/agents/1”{“内容类型”“application / json”}}axios配置然后函数响应{控制台日志JSONstringify响应数据}函数错误{控制台日志错误}
Python
              
进口请求url=“https://support.亚博zendesk.com/api/v2/agents/1”={“内容类型”“application / json”}响应=请求请求“把”url=打印响应文本
鲁比(人名)
              
需要“net/http”uri=URI“https://support.亚博zendesk.com/api/v2/agents/1”请求=HTTPuri“内容类型”“application / json”响应=HTTP开始uri主机名uri港口use_ssl真正的|http|http请求请求结束

示例响应(年代)

200好了
              
//状态200 OK{“display_name”“史密斯”“电子邮件”(电子邮件保护)“启用”1“first_name”“约翰。”“last_name”“史密斯”}

更新请求代理

  • 把/ api / v2 /代理/我

更新您的数据。

允许

  • 管理员

代码示例

旋度
              
旋度https://www.zopim.com/api/v2/agents/me- d'{"first_name": "Jonathan"}'- v - u{email_address}{密码}-x放-h“application / json内容类型:
              
进口“fmt”“输入输出”“net/http”函数主要{url:=“https://support.亚博zendesk.com/api/v2/agents/me”方法:=“把”要求的事情犯错:=httpNewRequest方法url如果犯错! ={fmtPrintln犯错返回}要求的事情添加“内容类型”“application / json”客户端:=http客户端{}res犯错:=客户端要求的事情如果犯错! ={fmtPrintln犯错返回}推迟res身体关闭身体犯错:=ioReadAllres身体如果犯错! ={fmtPrintln犯错返回}fmtPrintln字符串身体}
Java
              
进口comsquareupokhttpOkHttpClient客户端=OkHttpClientHttpUrl构建器urlBuilder=HttpUrl解析“https://support.亚博zendesk.com/api/v2/agents/me”newBuilderRequestBody身体=RequestBody创建MediaType解析“application / json””“”“请求请求=请求构建器urlurlBuilder构建方法“把”身体addHeader“内容类型”“application / json”构建响应响应=客户端newCall请求执行
Nodejs
              
varaxios=需要“axios”var配置={方法“把”url“https://support.亚博zendesk.com/api/v2/agents/me”{“内容类型”“application / json”}}axios配置然后函数响应{控制台日志JSONstringify响应数据}函数错误{控制台日志错误}
Python
              
进口请求url=“https://support.亚博zendesk.com/api/v2/agents/me”={“内容类型”“application / json”}响应=请求请求“把”url=打印响应文本
鲁比(人名)
              
需要“net/http”uri=URI“https://support.亚博zendesk.com/api/v2/agents/me”请求=HTTPuri“内容类型”“application / json”响应=HTTP开始uri主机名uri港口use_ssl真正的|http|http请求请求结束

示例响应(年代)

200好了
              
//状态200 OK{“display_name”“史密斯”“电子邮件”(电子邮件保护)“启用”1“first_name”“约翰。”“last_name”“史密斯”}

删除代理

  • 删除/ api / v2 /代理/ {agent_id}

从帐号中删除座席。

允许

  • 管理员

参数

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

代码示例

旋度
              
旋度https://www.zopim.com/api/v2/agents/{agent_id}- v - u{email_address}{密码}- x删除
              
进口“fmt”“输入输出”“net/http”函数主要{url:=“https://support.亚博zendesk.com/api/v2/agents/1”方法:=“删除”要求的事情犯错:=httpNewRequest方法url如果犯错! ={fmtPrintln犯错返回}要求的事情添加“内容类型”“application / json”客户端:=http客户端{}res犯错:=客户端要求的事情如果犯错! ={fmtPrintln犯错返回}推迟res身体关闭身体犯错:=ioReadAllres身体如果犯错! ={fmtPrintln犯错返回}fmtPrintln字符串身体}
Java
              
进口comsquareupokhttpOkHttpClient客户端=OkHttpClientHttpUrl构建器urlBuilder=HttpUrl解析“https://support.亚博zendesk.com/api/v2/agents/1”newBuilder请求请求=请求构建器urlurlBuilder构建方法“删除”addHeader“内容类型”“application / json”构建响应响应=客户端newCall请求执行
Nodejs
              
varaxios=需要“axios”var配置={方法“删除”url“https://support.亚博zendesk.com/api/v2/agents/1”{“内容类型”“application / json”}}axios配置然后函数响应{控制台日志JSONstringify响应数据}函数错误{控制台日志错误}
Python
              
进口请求url=“https://support.亚博zendesk.com/api/v2/agents/1”={“内容类型”“application / json”}响应=请求请求“删除”url=打印响应文本
鲁比(人名)
              
需要“net/http”uri=URI“https://support.亚博zendesk.com/api/v2/agents/1”请求=HTTP删除uri“内容类型”“application / json”响应=HTTP开始uri主机名uri港口use_ssl真正的|http|http请求请求结束

示例响应(年代)

204无内容
              
//状态204无内容

按座席号删除快捷方式

  • 删除/ api / v2 /代理/ {agent_id} /快捷方式

根据座席ID删除座席快捷方式。

警告:删除的快捷方式不可恢复。

允许

  • 管理员

参数

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

代码示例

旋度
              
旋度https://www.zopim.com/api/v2/agents/{agent_id}/快捷方式- v - u{email_address}{密码}- x删除
              
进口“fmt”“输入输出”“net/http”函数主要{url:=“https://support.亚博zendesk.com/api/v2/agents/1/shortcuts”方法:=“删除”要求的事情犯错:=httpNewRequest方法url如果犯错! ={fmtPrintln犯错返回}要求的事情添加“内容类型”“application / json”客户端:=http客户端{}res犯错:=客户端要求的事情如果犯错! ={fmtPrintln犯错返回}推迟res身体关闭身体犯错:=ioReadAllres身体如果犯错! ={fmtPrintln犯错返回}fmtPrintln字符串身体}
Java
              
进口comsquareupokhttpOkHttpClient客户端=OkHttpClientHttpUrl构建器urlBuilder=HttpUrl解析“https://support.亚博zendesk.com/api/v2/agents/1/shortcuts”newBuilder请求请求=请求构建器urlurlBuilder构建方法“删除”addHeader“内容类型”“application / json”构建响应响应=客户端newCall请求执行
Nodejs
              
varaxios=需要“axios”var配置={方法“删除”url“https://support.亚博zendesk.com/api/v2/agents/1/shortcuts”{“内容类型”“application / json”}}axios配置然后函数响应{控制台日志JSONstringify响应数据}函数错误{控制台日志错误}
Python
              
进口请求url=“https://support.亚博zendesk.com/api/v2/agents/1/shortcuts”={“内容类型”“application / json”}响应=请求请求“删除”url=打印响应文本
鲁比(人名)
              
需要“net/http”uri=URI“https://support.亚博zendesk.com/api/v2/agents/1/shortcuts”请求=HTTP删除uri“内容类型”“application / json”响应=HTTP开始uri主机名uri港口use_ssl真正的|http|http请求请求结束

示例响应(年代)

204无内容
              
//状态204无内容