快捷键

您可以使用API来获取或设置快捷方式信息。

请注意:帐户最多可定义15,000个快捷方式。一旦您达到了这个限制，任何创建新快捷方式的额外API调用都会导致一个错误代码429，“超过了该帐户所允许的快捷方式的数量”。

JSON格式

快捷方式表示为具有以下属性的JSON对象:

的名字	类型	只读	强制性的	描述
代理	数组	假	假	代理的快捷方式属于if`范围`是“代理”。目前只考虑到第一个因素
部门	数组	假	假	部门快捷方式属于if`范围`“部门”
id	字符串	真正的	假	快捷方式的唯一ID。不允许的值:"/"，"\"，"$"
消息	字符串	假	真正的	快捷方式的信息
的名字	字符串	假	真正的	快捷方式的名称。不允许的值:"/"，"\"，"$"
选项	字符串	假	假	快捷方式的选项
范围	字符串	假	假	快捷方式的适用范围。允许取值为all、agent或department。
标签	数组	假	假	如果使用快捷方式，将添加到聊天的标签列表

请注意,范围，部门而且代理只有启用了这些功能的帐户才会考虑字段。

为了向后兼容，的名字等于id．使用id而不是的名字．

例子

             
              ｛“id”：“问题”，“消息”：“嗨!你需要帮助吗?”，“名称”：“问题”，“选项”：“是/否”，“范围”：“所有”，“标签”：［“问题”，“调查”］｝

快捷键列表

GET / api / v2 /快捷方式

列出该帐户的所有快捷方式。

允许

管理员

代码示例

旋度

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

去

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

Nodejs

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

Python

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

鲁比（人名）

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

示例响应(年代)

200好了

              
               // Status 200 OK［｛“id”：“问题”，“消息”：“嗨!你需要帮助吗?”，“名称”：“问题”，“选项”：“是/否”，“范围”：“所有”，“标签”：［“问题”，“调查”］｝，｛“id”：“注册”，“消息”：“你想什么时候报名?”，“名称”：“注册”，“选项”：“现在/后”，“范围”：“所有”，“标签”：［“问题”，“注册”］｝］

显示快捷方式

GET / api / v2 /快捷方式/ {shortcut_id}

通过指定快捷方式名称返回快捷方式信息。

允许

管理员

参数

的名字	类型	在	要求	描述
shortcut_id	整数	路径	真正的	快捷方式的ID

代码示例

旋度

              
               旋度https://www.zopim.com/api/v2/shortcuts/（shortcut_id）＼- v - u｛email_address｝：｛密码｝

去

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

Nodejs

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

Python

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

鲁比（人名）

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

示例响应(年代)

200好了

              
               // Status 200 OK｛“id”：“介绍”，“消息”：“嗨!你需要帮助吗?”，“名称”：“介绍”，“选项”：“是/否”，“范围”：“所有”，“标签”：［“问题”，“调查”］｝

创建快捷方式

POST / api / v2 /快捷方式

向帐户添加快捷方式。

允许

管理员

代码示例

旋度

              
               旋度https://www.zopim.com/api/v2/shortcuts＼- d”{"name": "intro"，“消息”:“嗨!你需要帮助吗?”"options": "Yes/No"} '＼- v - u｛email_address｝：｛密码｝＼-x post -h“application / json内容类型:

去

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

Nodejs

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

Python

              
               进口请求url＝“https://support.亚博zendesk.com/api/v2/shortcuts”头＝｛“内容类型”：“application / json”，｝响应＝请求．请求（“职位”，url，头＝头）打印（响应．文本）

鲁比（人名）

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

示例响应(年代)

201年创建

              
               //状态201已创建｛“id”：“介绍”，“消息”：“嗨!你需要帮助吗?”，“名称”：“介绍”，“选项”：“是/否”，“范围”：“所有”，“标签”：［］｝

更新快捷方式

把/ api / v2 /快捷方式/ {shortcut_id}

更新指定的快捷方式。

允许

管理员

参数

的名字	类型	在	要求	描述
shortcut_id	整数	路径	真正的	快捷方式的ID

代码示例

旋度

              
               旋度https://www.zopim.com/api/v2/shortcuts/｛shortcut_id｝＼- d”{“消息”:“嗨!你糊涂了吗?”“选项”:“是/否/肯定可能”，"tags": ["Question"]} '＼- v - u｛email_address｝：｛密码｝＼-x乘以-h“application / json内容类型:

去

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

Nodejs

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

Python

              
               进口请求url＝“https://support.亚博zendesk.com/api/v2/shortcuts/1”头＝｛“内容类型”：“application / json”，｝响应＝请求．请求（“把”，url，头＝头）打印（响应．文本）

鲁比（人名）

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

示例响应(年代)

200好了

              
               // Status 200 OK｛“id”：“介绍”，“消息”：“嗨!你糊涂了吗?”，“名称”：“介绍”，“选项”：“是的/不/绝对可能”，“范围”：“所有”，“标签”：［“问题”］｝

删除快捷方式

删除/ api / v2 /快捷方式/ {shortcut_id}

删除指定的快捷方式。

允许

管理员

参数

的名字	类型	在	要求	描述
shortcut_id	整数	路径	真正的	快捷方式的ID

代码示例

旋度

              
               旋度https://www.zopim.com/api/v2/shortcuts/｛shortcut_id｝＼- v - u｛email_address｝：｛密码｝- x删除

去

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

Nodejs

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

Python

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

鲁比（人名）

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

示例响应(年代)

204无内容

              
               //状态204无内容零

聊天API

实时聊天API

聊天对话API

快捷键

JSON格式

例子

快捷键列表

允许

代码示例

示例响应(年代)

显示快捷方式

允许

参数

代码示例

示例响应(年代)

创建快捷方式

允许

代码示例

示例响应(年代)

更新快捷方式

允许

参数

代码示例

示例响应(年代)

删除快捷方式

允许

参数

代码示例

示例响应(年代)