亚博企业计划或更高版本的Zendesk Support帐户可以通过定义自定义代理角色来提供对其代理的更细粒度访问。有关更多信息,请参见创建自定义角色并分配代理在支持帮助中心。

JSON格式

自定义代理角色表示为具有以下属性的JSON对象:

名字 类型 只读 强制性的 描述
配置 对象 角色的配置设置。看到配置
created_at 字符串 真正的 记录被创造的时间
描述 字符串 角色的描述
id 整数 真正的 创建时自动分配
名字 字符串 真正的 自定义角色的名称
role_type 整数 真正的 真正的 用户的角色id。对于客户代理,它是0。
team_member_count 整数 真正的 分配给此角色的团队成员的数量
updated_at 字符串 真正的 记录最后更新的时间

配置

配置对象具有以下属性,这些属性都是可选的。

名字 类型 只读 评论
assign_tickets_to_any_group 布尔 没有 代理是否可以将票分配给任何团体
chat_access 布尔 是的 代理是否可以访问聊天
end_user_list_access 字符串 没有 代理是否可以查看用户配置文件列表。允许值:"full", "none"
end_user_profile_access 字符串 没有 代理可以对最终用户配置文件做什么。取值:edit, edit-within-org, full, readonly
explore_access 字符串 没有 取值:edit, full, none, readonly
forum_access 字符串 没有 代理对Guide的访问权限。允许值:"edit-topics", "full", "readonly"
forum_access_restricted_content 布尔 没有
group_access 布尔 是的 代理是否可以添加或修改组
light_agent 布尔 是的
macro_access 字符串 没有 代理可以用宏做什么。取值:full, manage-group, manage-personal, readonly
manage_automations 布尔 没有 代理是否可以创建和管理自动化
manage_business_rules 布尔 没有 代理是否可以创建和管理调度以及查看规则分析
manage_contextual_workspaces 布尔 没有 代理是否可以查看、添加和编辑上下文工作区
manage_dynamic_content 布尔 没有 代理是否可以访问动态内容
manage_extensions_and_channels 布尔 没有 代理是否可以管理通道和扩展
manage_facebook 布尔 没有 代理是否可以管理facebook页面
manage_group_memberships 布尔 没有 代理是否可以创建和管理组成员关系
manage_groups 布尔 没有 代理是否可以创建和修改组
manage_organization_fields 布尔 没有 代理是否可以创建和管理组织字段
manage_organizations 布尔 没有 代理是否可以创建和修改组织
manage_roles 字符串 没有 代理是否可以创建和管理自定义角色,但当前分配的角色除外。不允许代理更新其他代理的角色分配。允许值:"all-except-self", "none"
manage_skills 布尔 没有 代理是否能够创造和管理技能
manage_slas 布尔 没有 代理是否可以创建和管理sla
manage_ticket_fields 布尔 没有 代理是否可以创建和管理票证字段
manage_ticket_forms 布尔 没有 代理是否可以创建和管理票务表单
manage_triggers 布尔 没有 代理是否可以创建和管理触发器
manage_user_fields 布尔 没有 代理是否可以创建和管理用户字段
moderate_forums 布尔 是的
organization_editing 布尔 没有 座席是否可以添加或修改组织
organization_notes_editing 布尔 是的 代理是否可以添加或修改组织注释
report_access 字符串 没有 代理可以对报告做什么。取值范围:"full", "none", "readonly"
side_conversation_create 布尔 没有 代理人是否能对谈话做出贡献
ticket_access 字符串 没有 代理可以访问什么样的票。允许的值:"all", "assigned-only", "within-groups", "within-groups-and-public-groups", "within-organization"
ticket_comment_access 字符串 没有 代理可以发表什么类型的评论。允许值:"public", "none"
ticket_deletion 布尔 没有 代理是否可以删除机票
ticket_editing 布尔 没有 代理是否可以编辑票证属性
ticket_merge 布尔 没有 代理是否可以合并门票
ticket_redaction 布尔 没有 代理是否可以编辑票务中的内容。仅适用于ticket_access允许的门票
ticket_tag_editing 布尔 没有 代理是否可以编辑票证标签
twitter_search_access 布尔 没有
user_view_access 字符串 没有 代理如何处理客户名单。取值:full, manage-group, manage-personal, none, readonly
view_access 字符串 没有 代理可以对视图做什么。取值:full, manage-group, manage-personal, playonly, readonly
view_deleted_tickets 布尔 没有 代理是否可以查看已删除的门票
voice_access 布尔 没有 座席是否能够接听和拨打最终用户的电话
voice_dashboard_access 布尔 没有 座席是否可以在Talk仪表板上查看通话详情

例子

             
{“id”35436“名称”“合作伙伴”“描述”"只能对指定的票发表私人意见"“created_at”“2012 - 02年- 20 - t22:55:29z”“updated_at”“2012 - 02年- 20 - t22:55:29z”“配置”{“assign_tickets_to_any_group”“chat_access”真正的“end_user_profile_access”“readonly”“explore_access”“编辑”“forum_access”“readonly”“forum_access_restricted_content”“light_agent”“macro_access”“全部”“manage_automations”真正的“manage_business_rules”真正的“manage_contextual_workspaces”“manage_dynamic_content”“manage_extensions_and_channels”真正的“manage_facebook”“manage_group_memberships”“manage_groups”“manage_organization_fields”“manage_organizations”“manage_roles”“没有”“manage_skills”“manage_slas”“manage_ticket_fields”“manage_ticket_forms”“manage_triggers”真正的“manage_user_fields”“organization_editing”“organization_notes_editing”“report_access”“没有”“side_conversation_create”真正的“ticket_access”“群体内部”“ticket_comment_access”“没有”“ticket_deletion”“ticket_redaction”真正的“view_deleted_tickets”“ticket_editing”真正的“ticket_merge”“ticket_tag_editing”真正的“twitter_search_access”真正的“view_access”“全部”“voice_access”真正的“voice_dashboard_access”}}

列表自定义角色

  • GET / api / v2 / custom_roles

可用性

  • 企业计划或以上帐户

允许

  • 代理

代码示例

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

示例响应(年代)

200好了
              
//状态200 OK{“custom_roles”{“配置”{“assign_tickets_to_any_group”“chat_access”真正的“end_user_list_access”“全部”“end_user_profile_access”“readonly”“explore_access”“编辑”“forum_access”“readonly”“forum_access_restricted_content”“group_access”真正的“light_agent”“macro_access”“全部”“manage_business_rules”真正的“manage_contextual_workspaces”“manage_dynamic_content”“manage_extensions_and_channels”真正的“manage_facebook”“manage_organization_fields”“manage_ticket_fields”“manage_ticket_forms”“manage_user_fields”“moderate_forums”“organization_editing”“organization_notes_editing”“report_access”“没有”“side_conversation_create”真正的“ticket_access”“群体内部”“ticket_comment_access”“没有”“ticket_deletion”“ticket_editing”真正的“ticket_merge”“ticket_tag_editing”真正的“twitter_search_access”真正的“user_view_access”“readonly”“view_access”“全部”“view_deleted_tickets”“voice_access”真正的“voice_dashboard_access”}“created_at”“2012 - 03 - 12 - t16:32:22z”“描述”顾问管理工作流程并配置帮助台。他们创建或管理自动化、宏、触发器、视图和SLA目标。他们还建立了通道和扩展。顾问不能解决问题,他们只能私下发表意见。”“id”16“名称”“顾问”“role_type”0“team_member_count”10“updated_at”“2012 - 03 - 12 - t16:32:22z”}{“配置”{“assign_tickets_to_any_group”“chat_access”真正的“end_user_list_access”“全部”“end_user_profile_access”“readonly”“explore_access”“编辑”“forum_access”“readonly”“forum_access_restricted_content”“group_access”真正的“light_agent”“macro_access”“全部”“manage_business_rules”真正的“manage_contextual_workspaces”“manage_dynamic_content”“manage_extensions_and_channels”真正的“manage_facebook”“manage_organization_fields”“manage_ticket_fields”“manage_ticket_forms”“manage_user_fields”“moderate_forums”“organization_editing”“organization_notes_editing”“report_access”“没有”“side_conversation_create”真正的“ticket_access”“群体内部”“ticket_comment_access”“没有”“ticket_deletion”“ticket_editing”真正的“ticket_merge”“ticket_tag_editing”真正的“twitter_search_access”真正的“user_view_access”“readonly”“view_access”“全部”“view_deleted_tickets”“voice_access”真正的“voice_dashboard_access”}“created_at”“2011 - 07 - 20 - t04:31:29z”“描述”“员工代理的主要职责是解决购票问题。他们可以在组内编辑票据,查看报告,添加或编辑个人视图和宏。”“id”6“名称”“员工”“role_type”0“team_member_count”10“updated_at”“2012 - 02 - 02 - t10:32:59z”}]}

显示自定义角色

  • GET / api / v2 / custom_roles / {custom_role_id}

可用性

  • 企业计划或以上帐户

允许

  • 管理员
  • 代理人manage_roles许可

参数

名字 类型 要求 描述
custom_role_id 整数 路径 真正的 自定义代理角色的ID

代码示例

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

示例响应(年代)

200好了
              
//状态200 OK{“custom_role”{“配置”{“assign_tickets_to_any_group”“chat_access”真正的“end_user_list_access”“全部”“end_user_profile_access”“readonly”“explore_access”“编辑”“forum_access”“readonly”“forum_access_restricted_content”“group_access”真正的“light_agent”“macro_access”“全部”“manage_business_rules”真正的“manage_contextual_workspaces”“manage_dynamic_content”“manage_extensions_and_channels”真正的“manage_facebook”“manage_organization_fields”“manage_ticket_fields”“manage_ticket_forms”“manage_user_fields”“moderate_forums”“organization_editing”“organization_notes_editing”“report_access”“没有”“side_conversation_create”真正的“ticket_access”“群体内部”“ticket_comment_access”“没有”“ticket_deletion”“ticket_editing”真正的“ticket_merge”“ticket_tag_editing”真正的“twitter_search_access”真正的“user_view_access”“readonly”“view_access”“全部”“view_deleted_tickets”“voice_access”真正的“voice_dashboard_access”}“created_at”“2012 - 03 - 12 - t16:32:22z”“描述”“样本描述”“id”10127“名称”“样本作用”“role_type”0“team_member_count”10“updated_at”“2012 - 03 - 12 - t16:32:22z”}}

创建自定义角色

  • POST / api / v2 / custom_roles

可用性

  • 企业计划或以上帐户

允许

  • 管理员
  • 代理人manage_roles许可

代码示例

旋度
              
旋度https://{子域名}.亚博zendesk.com/api/v2/custom_roles.json- v - u{email_address}{密码}
              
进口“fmt”“输入输出”“net/http”函数主要{url:=“https://example.亚博zendesk.com/api/v2/custom_roles”方法:=“职位”要求的事情犯错:=httpNewRequest方法url如果犯错! ={fmtPrintln犯错返回}要求的事情添加“内容类型”“application / json”要求的事情添加“授权”“基本< auth-value >”// Base64编码的"username:password"客户端:=http客户端{}res犯错:=客户端要求的事情如果犯错! ={fmtPrintln犯错返回}推迟res身体关闭身体犯错:=ioReadAllres身体如果犯错! ={fmtPrintln犯错返回}fmtPrintln字符串身体}
Java
              
进口comsquareupokhttpOkHttpClient客户端=OkHttpClientHttpUrl构建器urlBuilder=HttpUrl解析“https://example.亚博zendesk.com/api/v2/custom_roles”newBuilderRequestBody身体=RequestBody创建MediaType解析“application / json””“”“请求请求=请求构建器urlurlBuilder构建方法“职位”身体addHeader“内容类型”“application / json”addHeader“授权”凭证基本“电子邮件”“你的密码”构建响应响应=客户端newCall请求执行
Nodejs
              
varaxios=需要“axios”var配置={方法“职位”url“https://example.亚博zendesk.com/api/v2/custom_roles”{“内容类型”“application / json”“授权”的基本< auth-value >”// Base64编码的"username:password"}}axios配置然后函数响应{控制台日志JSONstringify响应数据}函数错误{控制台日志错误}
Python
              
进口请求url=“https://example.亚博zendesk.com/api/v2/custom_roles”={“内容类型”“application / json”}响应=请求请求“职位”url身份验证=“<用户名>”' <密码> '=打印响应文本
鲁比(人名)
              
需要“net/http”uri=URI“https://example.亚博zendesk.com/api/v2/custom_roles”请求=HTTP帖子uri“内容类型”“application / json”请求basic_auth“用户名”“密码”响应=HTTP开始uri主机名uri港口use_ssl真正的|http|http请求请求结束

示例响应(年代)

200好了
              
//状态200 OK{“custom_role”{“配置”{“assign_tickets_to_any_group”“chat_access”真正的“end_user_list_access”“全部”“end_user_profile_access”“readonly”“explore_access”“编辑”“forum_access”“readonly”“forum_access_restricted_content”“group_access”真正的“light_agent”“macro_access”“全部”“manage_business_rules”真正的“manage_contextual_workspaces”“manage_dynamic_content”“manage_extensions_and_channels”真正的“manage_facebook”“manage_organization_fields”“manage_ticket_fields”“manage_ticket_forms”“manage_user_fields”“moderate_forums”“organization_editing”“organization_notes_editing”“report_access”“没有”“side_conversation_create”真正的“ticket_access”“群体内部”“ticket_comment_access”“没有”“ticket_deletion”“ticket_editing”真正的“ticket_merge”“ticket_tag_editing”真正的“twitter_search_access”真正的“user_view_access”“readonly”“view_access”“全部”“view_deleted_tickets”“voice_access”真正的“voice_dashboard_access”}“created_at”“2012 - 03 - 12 - t16:32:22z”“描述”“样本描述”“id”10127“名称”“样本作用”“role_type”0“team_member_count”10“updated_at”“2012 - 03 - 12 - t16:32:22z”}}

更新自定义角色

  • 把/ api / v2 / custom_roles / {custom_role_id}

可用性

  • 企业计划或以上帐户

允许

  • 管理员

代理人manage_roles许可

参数

名字 类型 要求 描述
custom_role_id 整数 路径 真正的 自定义代理角色的ID

代码示例

旋度
              
旋度https://{子域名}.亚博zendesk.com/api/v2/custom_roles/{custom_role_id}. json- v - u{email_address}{密码}- h“application / json内容类型:- x将- d'{"custom_role": {name:更新后的样例角色;“description”:“样品描述”;"配置":{“chat_access”:没错,“user_view_access”:“readonly”}}}’
              
进口“fmt”“输入输出”“net/http”函数主要{url:=“https://example.亚博zendesk.com/api/v2/custom_roles/10127”方法:=“把”要求的事情犯错:=httpNewRequest方法url如果犯错! ={fmtPrintln犯错返回}要求的事情添加“内容类型”“application / json”要求的事情添加“授权”“基本< auth-value >”// Base64编码的"username:password"客户端:=http客户端{}res犯错:=客户端要求的事情如果犯错! ={fmtPrintln犯错返回}推迟res身体关闭身体犯错:=ioReadAllres身体如果犯错! ={fmtPrintln犯错返回}fmtPrintln字符串身体}
Java
              
进口comsquareupokhttpOkHttpClient客户端=OkHttpClientHttpUrl构建器urlBuilder=HttpUrl解析“https://example.亚博zendesk.com/api/v2/custom_roles/10127”newBuilderRequestBody身体=RequestBody创建MediaType解析“application / json””“”“请求请求=请求构建器urlurlBuilder构建方法“把”身体addHeader“内容类型”“application / json”addHeader“授权”凭证基本“电子邮件”“你的密码”构建响应响应=客户端newCall请求执行
Nodejs
              
varaxios=需要“axios”var配置={方法“把”url“https://example.亚博zendesk.com/api/v2/custom_roles/10127”{“内容类型”“application / json”“授权”的基本< auth-value >”// Base64编码的"username:password"}}axios配置然后函数响应{控制台日志JSONstringify响应数据}函数错误{控制台日志错误}
Python
              
进口请求url=“https://example.亚博zendesk.com/api/v2/custom_roles/10127”={“内容类型”“application / json”}响应=请求请求“把”url身份验证=“<用户名>”' <密码> '=打印响应文本
鲁比(人名)
              
需要“net/http”uri=URI“https://example.亚博zendesk.com/api/v2/custom_roles/10127”请求=HTTPuri“内容类型”“application / json”请求basic_auth“用户名”“密码”响应=HTTP开始uri主机名uri港口use_ssl真正的|http|http请求请求结束

示例响应(年代)

200好了
              
//状态200 OK{“custom_role”{“配置”{“assign_tickets_to_any_group”“chat_access”真正的“end_user_list_access”“全部”“end_user_profile_access”“readonly”“explore_access”“编辑”“forum_access”“readonly”“forum_access_restricted_content”“group_access”真正的“light_agent”“macro_access”“全部”“manage_business_rules”真正的“manage_contextual_workspaces”“manage_dynamic_content”“manage_extensions_and_channels”真正的“manage_facebook”“manage_organization_fields”“manage_ticket_fields”“manage_ticket_forms”“manage_user_fields”“moderate_forums”“organization_editing”“organization_notes_editing”“report_access”“没有”“side_conversation_create”真正的“ticket_access”“群体内部”“ticket_comment_access”“没有”“ticket_deletion”“ticket_editing”真正的“ticket_merge”“ticket_tag_editing”真正的“twitter_search_access”真正的“user_view_access”“readonly”“view_access”“全部”“view_deleted_tickets”“voice_access”真正的“voice_dashboard_access”}“created_at”“2012 - 03 - 12 - t16:32:22z”“描述”“样本描述”“id”10127“名称”“样本作用”“role_type”0“team_member_count”10“updated_at”“2012 - 03 - 12 - t16:32:22z”}}

删除自定义角色

  • 删除/ api / v2 / custom_roles / {custom_role_id}

可用性

  • 企业计划或以上帐户

允许

  • 管理员
  • 代理人manage_roles许可

参数

名字 类型 要求 描述
custom_role_id 整数 路径 真正的 自定义代理角色的ID

代码示例

旋度
              
旋度https://{子域名}.亚博zendesk.com/api/v2/custom_roles/{custom_role_id}. json- v - u{email_address}{密码}- x删除
              
进口“fmt”“输入输出”“net/http”函数主要{url:=“https://example.亚博zendesk.com/api/v2/custom_roles/10127”方法:=“删除”要求的事情犯错:=httpNewRequest方法url如果犯错! ={fmtPrintln犯错返回}要求的事情添加“内容类型”“application / json”要求的事情添加“授权”“基本< auth-value >”// Base64编码的"username:password"客户端:=http客户端{}res犯错:=客户端要求的事情如果犯错! ={fmtPrintln犯错返回}推迟res身体关闭身体犯错:=ioReadAllres身体如果犯错! ={fmtPrintln犯错返回}fmtPrintln字符串身体}
Java
              
进口comsquareupokhttpOkHttpClient客户端=OkHttpClientHttpUrl构建器urlBuilder=HttpUrl解析“https://example.亚博zendesk.com/api/v2/custom_roles/10127”newBuilder请求请求=请求构建器urlurlBuilder构建方法“删除”addHeader“内容类型”“application / json”addHeader“授权”凭证基本“电子邮件”“你的密码”构建响应响应=客户端newCall请求执行
Nodejs
              
varaxios=需要“axios”var配置={方法“删除”url“https://example.亚博zendesk.com/api/v2/custom_roles/10127”{“内容类型”“application / json”“授权”的基本< auth-value >”// Base64编码的"username:password"}}axios配置然后函数响应{控制台日志JSONstringify响应数据}函数错误{控制台日志错误}
Python
              
进口请求url=“https://example.亚博zendesk.com/api/v2/custom_roles/10127”={“内容类型”“application / json”}响应=请求请求“删除”url身份验证=“<用户名>”' <密码> '=打印响应文本
鲁比(人名)
              
需要“net/http”uri=URI“https://example.亚博zendesk.com/api/v2/custom_roles/10127”请求=HTTP删除uri“内容类型”“application / json”请求basic_auth“用户名”“密码”响应=HTTP开始uri主机名uri港口use_ssl真正的|http|http请求请求结束

示例响应(年代)

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