您必须在Zendesk Support中启用用户和组织的标记才能使API调用正常工作。亚博在Support中,单击侧栏中的Admin图标,选择设置>客户,并启用该选项。

JSON格式

标签被表示为具有以下属性的JSON对象:

名字 类型 只读 强制性的 描述
标签 数组 真正的 字符串数组

列表标签

  • GET / api / v2 /标记

列出过去60天内最多20,000个最受欢迎的标签,受欢迎程度呈递减趋势。

分页

  • 游标分页(推荐)
  • 抵消分页

看到分页

每页最多返回100条记录。

允许

  • 代理

代码示例

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

示例响应(年代)

200好了
              
//状态200 OK{“数”1“next_page”“previous_page”“标签”{“数”10“名称”“分类”}]}

搜索标签

  • GET / api / v2 /自动完成/标记

属性中指定的字符开头的已注册和最近使用的标记名数组名字查询参数。必须指定至少2个字符。

分页

  • 仅偏移分页

看到使用偏移分页

允许

  • 代理

参数

名字 类型 要求 描述
tag_name_fragment 字符串 查询 要搜索的标记的子字符串

代码示例

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

示例响应(年代)

200好了
              
//状态200 OK{“标签”“关注”“攻击”]}

数的标签

  • GET / api / v2 /标签/计数

返回标记的大致计数。如果超过100,000,则每24小时更新一次。

refreshed_at的性质对象是一个时间戳,它指示计数最后更新的时间。

请注意:当计数超过100,000时,refreshed_at的财产对象有时可能为空。这表明计数正在后台更新价值的财产对象被限制为100,000,直到更新完成。

允许

  • 管理员

代码示例

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

示例响应(年代)

200好了
              
//状态200 OK{“数”{“refreshed_at”“2020 - 04 - 06 - t02:18:17z”“价值”102}}

列出资源标签

  • 拿到票/ api / v2 / / {ticket_id} /标记
  • GET / api / v2 /组织/ {organization_id} /标记
  • GET / api / v2 /用户/ {user_id} /标记

允许

  • 代理

参数

名字 类型 要求 描述
ticket_id 整数 路径 真正的 机票的ID

代码示例

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

示例响应(年代)

200好了
              
//状态200 OK{“标签”“紧急”“打印机”“火”]}

添加标签

  • 把/ api / v2 /票/ {ticket_id} /标记
  • 把/ api / v2 /组织/ {organization_id} /标记
  • 把/ api / v2 /用户/ {user_id} /标记

也可以为多个票添加标签更新多张票端点。

安全更新

如果同一个票证被多个API请求同时更新,一些标签可能会因为票证更新冲突而丢失。包括updated_stampsafe_update属性以进行安全更新。

updated_stamp,检索并指定票证的最新日期updated_at时间戳。标记更新仅在updated_stamp时间戳与票据的实际相符updated_at请求时的时间戳。如果时间戳不匹配(换句话说,如果自上次检索票据以来更新了票据updated_at时间戳),请求返回一个409冲突错误。

例子

             
{“标签”“客户”]“updated_stamp”“2019 - 09 - 12 - t21:45:16z”“safe_update”“真正的”}

有关详情,请参阅防止票证更新冲突

允许

  • 代理

参数

名字 类型 要求 描述
ticket_id 整数 路径 真正的 机票的ID

代码示例

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

示例响应(年代)

200好了
              
//状态200 OK{“标签”“紧急”“打印机”“火”]}

设置标签

  • POST / api / v2 /票/ {ticket_id} /标记
  • POST / api / v2 /组织/ {organization_id} /标记
  • POST / api / v2 /用户/ {user_id} /标记

允许

  • 代理

参数

名字 类型 要求 描述
ticket_id 整数 路径 真正的 机票的ID

代码示例

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

示例响应(年代)

201年创建
              
//状态201创建{“标签”“紧急”“打印机”“火”]}

删除标签

  • 删除/ api / v2 /票/ {ticket_id} /标记
  • 删除/ api / v2 /组织/ {organization_id} /标记
  • 删除/ api / v2 /用户/ {user_id} /标记

也可以从多个票据中删除标签更新多张票端点。

此端点支持安全更新。看到安全更新

允许

  • 代理

参数

名字 类型 要求 描述
ticket_id 整数 路径 真正的 机票的ID

代码示例

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

示例响应(年代)

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