文档 API参考

角色

您可以使用API来创建、获取或设置角色信息。

注意:要将座席分配给角色，请参见代理．

JSON格式

角色被表示为具有以下属性的JSON对象:

名字 类型 只读 强制性的 描述
描述 字符串 真正的 假 角色的描述。请注意: Owner、Admin、Agent角色不能修改描述。您可以为自定义角色更改它
启用 布尔 真正的 假 描述角色是否已启用。请注意: Owner、Admin、Agent角色不可禁用。您可以禁用自定义角色
id 整数 真正的 假 角色ID
members_count 整数 真正的 假 此角色的成员数
名字 字符串 真正的 假 角色的名称。请注意: Owner、Admin、Agent角色不可修改。您可以为自定义角色更改它
权限 对象 真正的 假 角色的权限(如下所述)。请注意: Owner和Admin角色不能修改权限。您可以为Agent和自定义角色更改它们。看到权限

权限

的权限属性是包含角色权限设置的对象。

名字 类型 可能的值 描述
visitors_seen 字符串 "account"， "department"， "own" 允许在您的网站上看到访问者
proactive_chatting 字符串 "listen-join"， "listen"， "own" 允许收听聊天和/或主动加入聊天
edit_visitor_information 布尔 真的,假的 是否可以通过聊天面板或历史记录编辑用户名、电子邮件和电话
edit_visitor_notes 布尔 真的,假的 可以通过聊天面板或历史记录编辑笔记吗
view_past_chats 字符串 "account"， "department"， "own"， "none" 查看过去聊天记录的权限
edit_chat_tags 布尔 真的,假的 可以在历史记录中添加或删除过去聊天的聊天标签吗
manage_bans 字符串 “账户”,“没有” 可以在聊天时通过浏览器cookie暂时禁止访问者，或者通过IP管理更永久的禁令
access_analytics 字符串 “账户”,“没有” 可以访问分析和电子邮件报告(在个人设置下)
view_monitor 字符串 “账户”,“没有” 可以在Monitor上查看整个帐户的实时指标吗
edit_department_agents 字符串 “账户”,“没有” 可以在部门中添加或编辑座席吗
set_agent_chat_limit 字符串 “账户”,“没有” 如果启用了座席限制，是否可以设置座席的聊天限制
manage_shortcuts 字符串 “账户”,“没有” 是否可以添加、编辑或删除任何人在与访问者聊天时都可以使用的快捷方式
权限字符串值
  • “监听”-监听任何对代理可见的聊天
  • “Listen -join”-监听任何聊天，并主动加入聊天与任何访问者可见的代理
  • “自己的”-不能听任何聊天或主动聊天与访问者列表上的任何访问者
  • "account" -整个帐户的权限
  • "department" -权限仅限于用户所在的部门
  • "own" -权限仅限于用户自己的信息
  • "none" -没有许可

例子

             

              
{“描述”："开这个账号的人。除了代理和管理员权限外，该角色还可以调整帐户的计划、更改计费信息、取消帐户。无法修改Owner角色的权限。\n"，“启用”：真正的，“id”：1，“members_count”：1，“名称”：“所有者”，“权限”：{“access_analytics”：“账户”，“edit_chat_tags”：真正的，“edit_department_agents”：“账户”，“edit_visitor_information”：真正的，“edit_visitor_notes”：真正的，“manage_bans”：“账户”，“manage_shortcuts”：“账户”，“proactive_chatting”：“listen-join”，“set_agent_chat_limit”：“账户”，“view_monitor”：“账户”，“view_past_chats”：“账户”，“visitors_seen”：“账户”｝｝

角色列表

  • GET / api / v2 /角色

列出您帐户的所有角色。

允许

  • 管理员

代码示例

旋度 
              

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

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

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

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

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

示例响应(年代)

200好了 
              

               
//状态200 OK［{“描述”："开这个账号的人。除了代理和管理员权限外，该角色还可以调整帐户的计划、更改计费信息和取消帐户。无法修改Owner角色的权限。"，“启用”：真正的，“id”：1，“members_count”：1，“名称”：“所有者”，“权限”：{“access_analytics”：“账户”，“edit_chat_tags”：真正的，“edit_department_agents”：“账户”，“edit_visitor_information”：真正的，“edit_visitor_notes”：真正的，“manage_bans”：“账户”，“manage_shortcuts”：“账户”，“proactive_chatting”：“listen-join”，“set_agent_chat_limit”：“账户”，“view_monitor”：“账户”，“view_past_chats”：“账户”，“visitors_seen”：“账户”｝｝，{“描述”：“团队领导”，“启用”：真正的，“id”：8，“members_count”：10，“名称”：“团队领导”，“权限”：{“access_analytics”：“账户”，“edit_chat_tags”：真正的，“edit_department_agents”：“账户”，“edit_visitor_information”：真正的，“edit_visitor_notes”：真正的，“manage_bans”：“账户”，“manage_shortcuts”：“账户”，“proactive_chatting”：“拥有”，“set_agent_chat_limit”：“账户”，“view_monitor”：“账户”，“view_past_chats”：“拥有”，“visitors_seen”：“拥有”｝｝］

显示角色

  • GET / api / v2 /角色/ {role_id}

允许

  • 管理员

参数

名字 类型 在 要求 描述
role_id 整数 路径 真正的 角色ID

代码示例

旋度 
              

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

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

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

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

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

示例响应(年代)

200好了 
              

               
//状态200 OK{“描述”："开这个账号的人。除了代理和管理员权限外，该角色还可以调整帐户的计划、更改计费信息和取消帐户。无法修改Owner角色的权限。"，“启用”：真正的，“id”：1，“members_count”：1，“名称”：“所有者”，“权限”：{“access_analytics”：“账户”，“edit_chat_tags”：真正的，“edit_department_agents”：“账户”，“edit_visitor_information”：真正的，“edit_visitor_notes”：真正的，“manage_bans”：“账户”，“manage_shortcuts”：“账户”，“proactive_chatting”：“listen-join”，“set_agent_chat_limit”：“账户”，“view_monitor”：“账户”，“view_past_chats”：“账户”，“visitors_seen”：“账户”｝｝

创建角色

  • POST / api / v2 /角色

允许

  • 管理员

代码示例

旋度 
              

               
旋度https://www.zopim.com/api/v2/roles＼- d”{“name”:“Team leader”} '＼- v - u{email_address｝：{密码｝＼-x post -h“application / json内容类型:
去 
              

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

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

               
进口请求url=“https://support.亚博zendesk.com/api/v2/roles”头={“内容类型”：“application / json”，｝响应=请求．请求（“职位”，url，头=头）打印（响应．文本）
鲁比（人名） 
              

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

示例响应(年代)

201年创建 
              

               
//状态201创建{“描述”：”“，“启用”：真正的，“id”：10000，“members_count”：0，“名称”：“团队领导”，“权限”：{“access_analytics”：“没有”，“edit_chat_tags”：假，“edit_department_agents”：“没有”，“edit_visitor_information”：真正的，“edit_visitor_notes”：真正的，“manage_bans”：“账户”，“manage_shortcuts”：“账户”，“proactive_chatting”：“listen-join”，“set_agent_chat_limit”：“没有”，“view_monitor”：“账户”，“view_past_chats”：“账户”，“visitors_seen”：“账户”｝｝

更新的作用

  • 把/ api / v2 /角色/ {role_id}

允许

  • 管理员

参数

名字 类型 在 要求 描述
role_id 整数 路径 真正的 角色ID

代码示例

旋度 
              

               
旋度https://www.zopim.com/api/v2/roles/{role_id｝＼- d”{“启用”:没错,“description”:“更新的描述”;"权限":{“edit_visitor_information”:假的｝} '＼- v - u{email_address｝：{密码｝-x放-h“application / json内容类型:
去 
              

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

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

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

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

示例响应(年代)

200好了 
              

               
//状态200 OK{“描述”：“更新描述”，“启用”：真正的，“id”：1，“members_count”：1，“名称”：“所有者”，“权限”：{“access_analytics”：“账户”，“edit_chat_tags”：真正的，“edit_department_agents”：“账户”，“edit_visitor_information”：假，“edit_visitor_notes”：真正的，“manage_bans”：“账户”，“manage_shortcuts”：“账户”，“proactive_chatting”：“listen-join”，“set_agent_chat_limit”：“账户”，“view_monitor”：“账户”，“view_past_chats”：“账户”，“visitors_seen”：“账户”｝｝

删除角色

  • 删除/ api / v2 /角色/ {role_id}

允许

  • 管理员

参数

名字 类型 在 要求 描述
role_id 整数 路径 真正的 角色ID

代码示例

旋度 
              

               
旋度https://www.zopim.com/api/v2/roles/{role_id｝＼- v - u{email_address｝：{密码｝- x删除
去 
              

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

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

               
进口请求url=“https://support.亚博zendesk.com/api/v2/roles/1”头={“内容类型”：“application / json”，｝响应=请求．请求（“删除”，url，头=头）打印（响应．文本）
鲁比（人名） 
              

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

示例响应(年代)

204无内容 
              

               
//状态204无内容零