文档 API参考

IVR路线

交互式语音应答(Interactive voice response, IVR)通过键盘音将客户转接到相应的座席或部门，对常见问题提供录音应答，并允许主叫方切换到文本交互方式来转移呼叫。IVR在Talk专业版和Talk企业版中都有。有关更多信息，请参见通过IVR路由呼入在Zendes亚博k帮助中心。

JSON格式

IVR路由由JSON对象表示，具有以下属性:

名字 类型 只读 强制性的 描述
行动 字符串 假 假 IVR路由将要执行的动作。看到有效的IVR路由操作。取值为group、voicemail、phone_number、textback、menu。
问候 字符串 真正的 假 与IVR路由关联的欢迎语名称
id 整数 真正的 假 IVR路由号
键盘按键 字符串 假 假 与IVR路由关联的按键。允许的值是“0”,“1”、“2”、“3”、“4”、“5”、“6”、“7”、“8”、“9 ", "*", "#", 或“违约”。
option_text 字符串 真正的 假 描述路由选项的文本。示例:当选项为集团，“option_text”将是关联组的名称
选项 对象 假 假 IVR路由的选项取决于动作。看到有效的IVR路由操作
overflow_options 数组 假 假 管理溢出调用的选项

有效的IVR路由操作

行动 选项 类型 描述
集团 group_ids 数组 有效的组id
语音信箱 group_ids 数组 有效的组id
phone_number phone_number 字符串 有效电话号码
textback sms_textstring 字符串 短信中要发送的文字
textback textback_phone_number_id 整数 启用文本的电话号码的有效id
菜单 menu_id 整数 有效的IVR菜单id

例子

             

              
｛“行动”：“集团”，“问候”：零，“id”：10001，“按键响应”：“0”，“option_text”：“支持组织”，“选项”：｛“group_ids”：［360001381413]}}

列出IVR路由

  • GET / api / v2 /渠道/声音/ ivr / {ivr_id} /菜单/ {menu_id} /路线

允许

  • 代理

参数

名字 类型 在 要求 描述
ivr_id 整数 路径 真正的 IVR的ID
menu_id 整数 路径 真正的 IVR菜单的ID

代码示例

旋度 
              

               
旋度https://｛子域名}.亚博zendesk.com/api/v2/channels/voice/ivr/｛ivr_id}/菜单/｛menu_id}/ routes.json＼- v - u｛email_address}：｛密码}- x得到
去 
              

               
进口（“fmt”“输入输出”“net/http”）函数主要（）｛url：=“https://support.亚博zendesk.com/api/v2/channels/voice/ivr/10001/menus/10001/routes”方法：=“获得”要求的事情，犯错：=http。NewRequest（方法，url，零）如果犯错! =零｛fmt。Println（犯错）返回}要求的事情。头。添加（“内容类型”，“application / json”）要求的事情。头。添加（“授权”，“基本< auth-value >”）// Base64编码的"username:password"客户端：=&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/channels/voice/ivr/10001/menus/10001/routes”）。newBuilder（）；请求请求=新请求。构建器（）。url（urlBuilder。构建（））。方法（“获得”，零）。addHeader（“内容类型”，“application / json”）。addHeader（“授权”，凭证。基本（“电子邮件”，“你的密码”））。构建（）；响应响应=客户端。newCall（请求）。执行（）；
Nodejs 
              

               
varaxios=需要（“axios”）；var配置=｛方法：“得到”，url：“https://support.亚博zendesk.com/api/v2/channels/voice/ivr/10001/menus/10001/routes”，头：｛“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"}，}；axios（配置）。然后（函数（响应）｛控制台。日志（JSON。stringify（响应。数据））；}）。抓（函数（错误）｛控制台。日志（错误）；}）；
Python 
              

               
进口请求url=“https://support.亚博zendesk.com/api/v2/channels/voice/ivr/10001/menus/10001/routes”头=｛“内容类型”：“application / json”，}响应=请求。请求（“获得”，url，身份验证=（“<用户名>”，' <密码> '），头=头）打印（响应。文本）
鲁比（人名） 
              

               
需要“net/http”uri=URI（“https://support.亚博zendesk.com/api/v2/channels/voice/ivr/10001/menus/10001/routes”）请求=网：：HTTP：：得到。新（uri，“内容类型”：“application / json”）请求。basic_auth“用户名”，“密码”响应=网：：HTTP。开始uri。主机名，uri。港口，use_ssl：真正的做|http|http。请求（请求）结束

示例响应(年代)

200好了 
              

               
//状态200 OK｛“数”：1，“ivr_routes”：［｛“行动”：“集团”，“问候”：零，“id”：10001，“按键响应”：“0”，“option_text”：“支持组织”，“选项”：｛“group_ids”：［360001381413]}}]，“next_page”：零，“previous_page”：零}

显示IVR路由

  • GET / api / v2 /渠道/声音/ ivr / {ivr_id} /菜单/ {menu_id} /线路/ {route_id}

允许

  • 代理

参数

名字 类型 在 要求 描述
ivr_id 整数 路径 真正的 IVR的ID
menu_id 整数 路径 真正的 IVR菜单的ID
route_id 整数 路径 真正的 IVR路由的ID

代码示例

旋度 
              

               
旋度https://｛子域名}.亚博zendesk.com/api/v2/channels/voice/ivr/｛ivr_id}/菜单/｛menu_id}/线路/｛route_id}. json＼- v - u｛email_address}：｛密码}- x得到
去 
              

               
进口（“fmt”“输入输出”“net/http”）函数主要（）｛url：=“https://support.亚博zendesk.com/api/v2/channels/voice/ivr/10001/menus/10001/routes/10001”方法：=“获得”要求的事情，犯错：=http。NewRequest（方法，url，零）如果犯错! =零｛fmt。Println（犯错）返回}要求的事情。头。添加（“内容类型”，“application / json”）要求的事情。头。添加（“授权”，“基本< auth-value >”）// Base64编码的"username:password"客户端：=&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/channels/voice/ivr/10001/menus/10001/routes/10001”）。newBuilder（）；请求请求=新请求。构建器（）。url（urlBuilder。构建（））。方法（“获得”，零）。addHeader（“内容类型”，“application / json”）。addHeader（“授权”，凭证。基本（“电子邮件”，“你的密码”））。构建（）；响应响应=客户端。newCall（请求）。执行（）；
Nodejs 
              

               
varaxios=需要（“axios”）；var配置=｛方法：“得到”，url：“https://support.亚博zendesk.com/api/v2/channels/voice/ivr/10001/menus/10001/routes/10001”，头：｛“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"}，}；axios（配置）。然后（函数（响应）｛控制台。日志（JSON。stringify（响应。数据））；}）。抓（函数（错误）｛控制台。日志（错误）；}）；
Python 
              

               
进口请求url=“https://support.亚博zendesk.com/api/v2/channels/voice/ivr/10001/menus/10001/routes/10001”头=｛“内容类型”：“application / json”，}响应=请求。请求（“获得”，url，身份验证=（“<用户名>”，' <密码> '），头=头）打印（响应。文本）
鲁比（人名） 
              

               
需要“net/http”uri=URI（“https://support.亚博zendesk.com/api/v2/channels/voice/ivr/10001/menus/10001/routes/10001”）请求=网：：HTTP：：得到。新（uri，“内容类型”：“application / json”）请求。basic_auth“用户名”，“密码”响应=网：：HTTP。开始uri。主机名，uri。港口，use_ssl：真正的做|http|http。请求（请求）结束

示例响应(年代)

200好了 
              

               
//状态200 OK｛“ivr_route”：｛“行动”：“集团”，“问候”：零，“id”：10002，“按键响应”：“1”，“option_text”：“支持组织”，“选项”：｛“group_ids”：［10001]}}}

创建IVR路由

  • POST / api / v2 /渠道/声音/ ivr / {ivr_id} /菜单/ {menu_id} /路线

允许

  • 代理

参数

名字 类型 在 要求 描述
ivr_id 整数 路径 真正的 IVR的ID
menu_id 整数 路径 真正的 IVR菜单的ID

例子的身体

             

              
｛“ivr_route”：｛“行动”：“集团”，“按键响应”：“1”，“选项”：｛“group_ids”：［10001]}}}

代码示例

旋度 
              

               
旋度https://｛子域名}.亚博zendesk.com/api/v2/channels/voice/ivr/｛ivr_id}/菜单/｛menu_id}/ routes.json＼- h“application / json内容类型:- d”{ivr_route”:{“键盘按键”:“1”,“行动”:“集团”,“选项”:{“group_ids”:[10001]}}}”＼- v - u｛email_address}：｛密码}- x的帖子
去 
              

               
进口（“fmt”“输入输出”“net/http”“弦”）函数主要（）｛url：=“https://support.亚博zendesk.com/api/v2/channels/voice/ivr/10001/menus/10001/routes”方法：=“职位”有效载荷：=字符串。NewReader（”{" ivr_route ": {“行动”:“集团”,“键盘按键”:“1”,"选项":{“group_ids”:(10001]}}} '）要求的事情，犯错：=http。NewRequest（方法，url，有效载荷）如果犯错! =零｛fmt。Println（犯错）返回}要求的事情。头。添加（“内容类型”，“application / json”）要求的事情。头。添加（“授权”，“基本< auth-value >”）// Base64编码的"username:password"客户端：=&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/channels/voice/ivr/10001/menus/10001/routes”）。newBuilder（）；RequestBody身体=RequestBody。创建（MediaType。解析（“application / json”），＂＂＂｛ivr_route \“\”：｛\ \”行动”：\”小组\”，按键\ \ " "：\”1\”，\ \“选项”：｛group_ids \“\”：［10001]}}}＂＂＂）；请求请求=新请求。构建器（）。url（urlBuilder。构建（））。方法（“职位”，身体）。addHeader（“内容类型”，“application / json”）。addHeader（“授权”，凭证。基本（“电子邮件”，“你的密码”））。构建（）；响应响应=客户端。newCall（请求）。执行（）；
Nodejs 
              

               
varaxios=需要（“axios”）；var数据=JSON。stringify（｛“ivr_route”：｛“行动”：“集团”，“按键响应”：“1”，“选项”：｛“group_ids”：［10001]}}}）；var配置=｛方法：“职位”，url：“https://support.亚博zendesk.com/api/v2/channels/voice/ivr/10001/menus/10001/routes”，头：｛“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"}，数据：数据，}；axios（配置）。然后（函数（响应）｛控制台。日志（JSON。stringify（响应。数据））；}）。抓（函数（错误）｛控制台。日志（错误）；}）；
Python 
              

               
进口请求进口jsonurl=“https://support.亚博zendesk.com/api/v2/channels/voice/ivr/10001/menus/10001/routes”有效载荷=json。加载（”““{" ivr_route ": {“行动”:“集团”,“键盘按键”:“1”,"选项":{“group_ids”:(10001]}}}”“”）头=｛“内容类型”：“application / json”，}响应=请求。请求（“职位”，url，身份验证=（“<用户名>”，' <密码> '），头=头，json=有效载荷）打印（响应。文本）
鲁比（人名） 
              

               
需要“net/http”uri=URI（“https://support.亚博zendesk.com/api/v2/channels/voice/ivr/10001/menus/10001/routes”）请求=网：：HTTP：：帖子。新（uri，“内容类型”：“application / json”）请求。身体=％问（｛“ivr_route”：｛“行动”：“集团”，“按键响应”：“1”，“选项”：｛“group_ids”：［10001]}}}）请求。basic_auth“用户名”，“密码”响应=网：：HTTP。开始uri。主机名，uri。港口，use_ssl：真正的做|http|http。请求（请求）结束

示例响应(年代)

201年创建 
              

               
//状态201创建｛“ivr_route”：｛“行动”：“集团”，“问候”：零，“id”：10002，“按键响应”：“1”，“option_text”：“支持组织”，“选项”：｛“group_ids”：［10001]}}}

更新IVR路由

  • 把/ api / v2 /渠道/声音/ ivr / {ivr_id} /菜单/ {menu_id} /线路/ {route_id}

允许

  • 代理

参数

名字 类型 在 要求 描述
ivr_id 整数 路径 真正的 IVR的ID
menu_id 整数 路径 真正的 IVR菜单的ID
route_id 整数 路径 真正的 IVR路由的ID

例子的身体

             

              
｛“ivr_route”：｛“行动”：“集团”，“按键响应”：“1”，“选项”：｛“group_ids”：［10001]}}}

代码示例

旋度 
              

               
旋度https://｛子域名}.亚博zendesk.com/api/v2/channels/voice/ivr/｛ivr_id}/菜单/｛menu_id}/线路/｛id}. json＼- h“application / json内容类型:- d'{"ivr_route": {"keypress": "2"}}'＼- v - u｛email_address}：｛密码}- x将
去 
              

               
进口（“fmt”“输入输出”“net/http”“弦”）函数主要（）｛url：=“https://support.亚博zendesk.com/api/v2/channels/voice/ivr/10001/menus/10001/routes/10001”方法：=“把”有效载荷：=字符串。NewReader（”{" ivr_route ": {“行动”:“集团”,“键盘按键”:“1”,"选项":{“group_ids”:(10001]}}} '）要求的事情，犯错：=http。NewRequest（方法，url，有效载荷）如果犯错! =零｛fmt。Println（犯错）返回}要求的事情。头。添加（“内容类型”，“application / json”）要求的事情。头。添加（“授权”，“基本< auth-value >”）// Base64编码的"username:password"客户端：=&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/channels/voice/ivr/10001/menus/10001/routes/10001”）。newBuilder（）；RequestBody身体=RequestBody。创建（MediaType。解析（“application / json”），＂＂＂｛ivr_route \“\”：｛\ \”行动”：\”小组\”，按键\ \ " "：\”1\”，\ \“选项”：｛group_ids \“\”：［10001]}}}＂＂＂）；请求请求=新请求。构建器（）。url（urlBuilder。构建（））。方法（“把”，身体）。addHeader（“内容类型”，“application / json”）。addHeader（“授权”，凭证。基本（“电子邮件”，“你的密码”））。构建（）；响应响应=客户端。newCall（请求）。执行（）；
Nodejs 
              

               
varaxios=需要（“axios”）；var数据=JSON。stringify（｛“ivr_route”：｛“行动”：“集团”，“按键响应”：“1”，“选项”：｛“group_ids”：［10001]}}}）；var配置=｛方法：“把”，url：“https://support.亚博zendesk.com/api/v2/channels/voice/ivr/10001/menus/10001/routes/10001”，头：｛“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"}，数据：数据，}；axios（配置）。然后（函数（响应）｛控制台。日志（JSON。stringify（响应。数据））；}）。抓（函数（错误）｛控制台。日志（错误）；}）；
Python 
              

               
进口请求进口jsonurl=“https://support.亚博zendesk.com/api/v2/channels/voice/ivr/10001/menus/10001/routes/10001”有效载荷=json。加载（”““{" ivr_route ": {“行动”:“集团”,“键盘按键”:“1”,"选项":{“group_ids”:(10001]}}}”“”）头=｛“内容类型”：“application / json”，}响应=请求。请求（“把”，url，身份验证=（“<用户名>”，' <密码> '），头=头，json=有效载荷）打印（响应。文本）
鲁比（人名） 
              

               
需要“net/http”uri=URI（“https://support.亚博zendesk.com/api/v2/channels/voice/ivr/10001/menus/10001/routes/10001”）请求=网：：HTTP：：把。新（uri，“内容类型”：“application / json”）请求。身体=％问（｛“ivr_route”：｛“行动”：“集团”，“按键响应”：“1”，“选项”：｛“group_ids”：［10001]}}}）请求。basic_auth“用户名”，“密码”响应=网：：HTTP。开始uri。主机名，uri。港口，use_ssl：真正的做|http|http。请求（请求）结束

示例响应(年代)

200好了 
              

               
//状态200 OK｛“ivr_route”：｛“行动”：“集团”，“问候”：零，“id”：10002，“按键响应”：“1”，“option_text”：“支持组织”，“选项”：｛“group_ids”：［10001]}}}

删除IVR路由

  • 删除/ api / v2 /渠道/声音/ ivr / {ivr_id} /菜单/ {menu_id} /线路/ {route_id}

允许

  • 代理

参数

名字 类型 在 要求 描述
ivr_id 整数 路径 真正的 IVR的ID
menu_id 整数 路径 真正的 IVR菜单的ID
route_id 整数 路径 真正的 IVR路由的ID

代码示例

旋度 
              

               
旋度https://｛子域名}.亚博zendesk.com/api/v2/channels/voice/ivr/｛ivr_id}/菜单/｛menu_id}/线路/｛route_id}. json＼- v - u｛email_address}：｛密码}- x删除
去 
              

               
进口（“fmt”“输入输出”“net/http”）函数主要（）｛url：=“https://support.亚博zendesk.com/api/v2/channels/voice/ivr/10001/menus/10001/routes/10001”方法：=“删除”要求的事情，犯错：=http。NewRequest（方法，url，零）如果犯错! =零｛fmt。Println（犯错）返回}要求的事情。头。添加（“内容类型”，“application / json”）要求的事情。头。添加（“授权”，“基本< auth-value >”）// Base64编码的"username:password"客户端：=&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/channels/voice/ivr/10001/menus/10001/routes/10001”）。newBuilder（）；请求请求=新请求。构建器（）。url（urlBuilder。构建（））。方法（“删除”，零）。addHeader（“内容类型”，“application / json”）。addHeader（“授权”，凭证。基本（“电子邮件”，“你的密码”））。构建（）；响应响应=客户端。newCall（请求）。执行（）；
Nodejs 
              

               
varaxios=需要（“axios”）；var配置=｛方法：“删除”，url：“https://support.亚博zendesk.com/api/v2/channels/voice/ivr/10001/menus/10001/routes/10001”，头：｛“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"}，}；axios（配置）。然后（函数（响应）｛控制台。日志（JSON。stringify（响应。数据））；}）。抓（函数（错误）｛控制台。日志（错误）；}）；
Python 
              

               
进口请求url=“https://support.亚博zendesk.com/api/v2/channels/voice/ivr/10001/menus/10001/routes/10001”头=｛“内容类型”：“application / json”，}响应=请求。请求（“删除”，url，身份验证=（“<用户名>”，' <密码> '），头=头）打印（响应。文本）
鲁比（人名） 
              

               
需要“net/http”uri=URI（“https://support.亚博zendesk.com/api/v2/channels/voice/ivr/10001/menus/10001/routes/10001”）请求=网：：HTTP：：删除。新（uri，“内容类型”：“application / json”）请求。basic_auth“用户名”，“密码”响应=网：：HTTP。开始uri。主机名，uri。港口，use_ssl：真正的做|http|http。请求（请求）结束

示例响应(年代)

200好了 
              

               
//状态200 OK｛“ivr_route”：｛“行动”：“集团”，“问候”：零，“id”：10002，“按键响应”：“1”，“option_text”：“支持组织”，“选项”：｛“group_ids”：［10001]}}}