文档 API参考

广度、

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

JSON格式

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

名字 类型 只读 强制性的 描述
id 整数 真正的 假 IVR ID
菜单 数组 假 假 IVR菜单列表
名字 字符串 假 假 IVR的名称
phone_number_ids 数组 假 假 该IVR配置的所有电话号码id列表
phone_number_names 数组 真正的 假 该IVR中配置的所有电话号码名称列表

例子

             

              
｛“id”：10001，“菜单”：［｛“默认”：真正的，“greeting_id”：10001，“id”：10001，“名称”：“主菜单”，“路线”：［｛“行动”：“集团”，“问候”：零，“id”：10001，“按键响应”：“0”，“option_text”：“支持组织”，“选项”：｛“group_ids”：［10001］｝｝］｝］，“名称”：“这套菜单”，“phone_number_ids”：［1］，“phone_number_names”：［“主菜单”］｝

列表自动

  • GET / api / v2 /渠道/声音/ ivr

允许

  • 代理

代码示例

旋度 
              

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

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

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

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

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

示例响应(年代)

200好了 
              

               
//状态200 OK｛“数”：1，“自动”：［｛“id”：10001，“菜单”：［｛“默认”：真正的，“greeting_id”：10001，“id”：10001，“名称”：“主菜单”，“路线”：［｛“行动”：“集团”，“问候”：零，“id”：10001，“按键响应”：“0”，“option_text”：“支持组织”，“选项”：｛“group_ids”：［10001］｝｝］｝］，“名称”：“这套菜单”，“phone_number_ids”：［］，“phone_number_names”：［］｝］，“next_page”：零，“previous_page”：零｝

展示这套

  • GET / api / v2 /渠道/声音/ ivr / {ivr_id}

允许

  • 代理

参数

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

代码示例

旋度 
              

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

               
进口（“fmt”“输入输出”“net/http”）函数主要（）｛url：=“https://support.亚博zendesk.com/api/v2/channels/voice/ivr/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”）．newBuilder（）；请求请求＝新请求．构建器（）．url（urlBuilder．构建（））．方法（“获得”，零）．addHeader（“内容类型”，“application / json”）．addHeader（“授权”，凭证．基本（“电子邮件”，“你的密码”））．构建（）；响应响应＝客户端．newCall（请求）．执行（）；
Nodejs 
              

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

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

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

示例响应(年代)

200好了 
              

               
//状态200 OK｛“这套”：｛“id”：10001，“菜单”：［｛“默认”：真正的，“greeting_id”：10001，“id”：10001，“名称”：“主菜单”，“路线”：［｛“行动”：“集团”，“问候”：零，“id”：10001，“按键响应”：“0”，“option_text”：“支持组织”，“选项”：｛“group_ids”：［10001］｝｝］｝］，“名称”：“这套菜单”，“phone_number_ids”：［6］，“phone_number_names”：［“很棒的支持线”］｝｝

创建IVR

  • POST / api / v2 /渠道/声音/ ivr

允许

  • 代理

例子的身体

             

              
｛“这套”：｛“名称”：“这套菜单”｝｝

代码示例

旋度 
              

               
旋度https://｛子域名｝.亚博zendesk.com/api/v2/channels/voice/ivr.json＼- h“application / json内容类型:- d'{"ivr": {"name": "ivr菜单"}}'＼- v - u｛email_address｝：｛密码｝- x的帖子
去 
              

               
进口（“fmt”“输入输出”“net/http”“弦”）函数主要（）｛url：=“https://support.亚博zendesk.com/api/v2/channels/voice/ivr”方法：=“职位”有效载荷：=字符串．NewReader（”{" ivr ": {name: IVR菜单｝} '）要求的事情，犯错：=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”）．newBuilder（）；RequestBody身体＝RequestBody．创建（MediaType．解析（“application / json”），＂＂”｛ivr \“\”：｛\“\”：\”这套菜单\”｝｝＂＂”）；请求请求＝新请求．构建器（）．url（urlBuilder．构建（））．方法（“职位”，身体）．addHeader（“内容类型”，“application / json”）．addHeader（“授权”，凭证．基本（“电子邮件”，“你的密码”））．构建（）；响应响应＝客户端．newCall（请求）．执行（）；
Nodejs 
              

               
varaxios＝需要（“axios”）；var数据＝JSON．stringify（｛“这套”：｛“名称”：“这套菜单”｝｝）；var配置＝｛方法：“职位”，url：“https://support.亚博zendesk.com/api/v2/channels/voice/ivr”，头：｛“内容类型”：“application / json”，“授权”：的基本< auth-value >”，// Base64编码的"username:password"｝，数据：数据，｝；axios（配置）．然后（函数（响应）｛控制台．日志（JSON．stringify（响应．数据））；｝）．抓（函数（错误）｛控制台．日志（错误）；｝）；
Python 
              

               
进口请求进口jsonurl＝“https://support.亚博zendesk.com/api/v2/channels/voice/ivr”有效载荷＝json．加载（”““{" ivr ": {name: IVR菜单｝}”“”）头＝｛“内容类型”：“application / json”，｝响应＝请求．请求（“职位”，url，身份验证＝（“<用户名>”，' <密码> '），头＝头，json＝有效载荷）打印（响应．文本）
鲁比（人名） 
              

               
需要“net/http”uri＝URI（“https://support.亚博zendesk.com/api/v2/channels/voice/ivr”）请求＝网：：HTTP：：帖子．新（uri，“内容类型”：“application / json”）请求．身体＝％问（｛“这套”：｛“名称”：“这套菜单”｝｝）请求．basic_auth“用户名”，“密码”响应＝网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束

示例响应(年代)

201年创建 
              

               
//状态201创建｛“这套”：｛“id”：10001，“菜单”：［｛“默认”：真正的，“greeting_id”：10001，“id”：10001，“名称”：“主菜单”，“路线”：［｛“行动”：“集团”，“问候”：零，“id”：10001，“按键响应”：“0”，“option_text”：“支持组织”，“选项”：｛“group_ids”：［10001］｝｝］｝］，“名称”：“这套菜单”，“phone_number_ids”：［6］，“phone_number_names”：［“很棒的支持线”］｝｝

更新IVR

  • 把/ api / v2 /渠道/声音/ ivr / {ivr_id}

允许

  • 代理

参数

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

例子的身体

             

              
｛“这套”：｛“名称”：“这套菜单”｝｝

代码示例

旋度 
              

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

               
进口（“fmt”“输入输出”“net/http”“弦”）函数主要（）｛url：=“https://support.亚博zendesk.com/api/v2/channels/voice/ivr/10001”方法：=“把”有效载荷：=字符串．NewReader（”{" ivr ": {name: IVR菜单｝} '）要求的事情，犯错：=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”）．newBuilder（）；RequestBody身体＝RequestBody．创建（MediaType．解析（“application / json”），＂＂”｛ivr \“\”：｛\“\”：\”这套菜单\”｝｝＂＂”）；请求请求＝新请求．构建器（）．url（urlBuilder．构建（））．方法（“把”，身体）．addHeader（“内容类型”，“application / json”）．addHeader（“授权”，凭证．基本（“电子邮件”，“你的密码”））．构建（）；响应响应＝客户端．newCall（请求）．执行（）；
Nodejs 
              

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

               
进口请求进口jsonurl＝“https://support.亚博zendesk.com/api/v2/channels/voice/ivr/10001”有效载荷＝json．加载（”““{" ivr ": {name: IVR菜单｝}”“”）头＝｛“内容类型”：“application / json”，｝响应＝请求．请求（“把”，url，身份验证＝（“<用户名>”，' <密码> '），头＝头，json＝有效载荷）打印（响应．文本）
鲁比（人名） 
              

               
需要“net/http”uri＝URI（“https://support.亚博zendesk.com/api/v2/channels/voice/ivr/10001”）请求＝网：：HTTP：：把．新（uri，“内容类型”：“application / json”）请求．身体＝％问（｛“这套”：｛“名称”：“这套菜单”｝｝）请求．basic_auth“用户名”，“密码”响应＝网：：HTTP．开始uri．主机名，uri．港口，use_ssl：真正的做|http|http．请求（请求）结束

示例响应(年代)

200好了 
              

               
//状态200 OK｛“这套”：｛“id”：10001，“菜单”：［｛“默认”：真正的，“greeting_id”：10001，“id”：10001，“名称”：“主菜单”，“路线”：［｛“行动”：“集团”，“问候”：零，“id”：10001，“按键响应”：“0”，“option_text”：“支持组织”，“选项”：｛“group_ids”：［10001］｝｝］｝］，“名称”：“这套菜单”，“phone_number_ids”：［6］，“phone_number_names”：［“很棒的支持线”］｝｝

删除IVR

  • 删除/ api / v2 /渠道/声音/ ivr / {ivr_id}

允许

  • 代理

参数

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

代码示例

旋度 
              

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

               
进口（“fmt”“输入输出”“net/http”）函数主要（）｛url：=“https://support.亚博zendesk.com/api/v2/channels/voice/ivr/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”）．newBuilder（）；请求请求＝新请求．构建器（）．url（urlBuilder．构建（））．方法（“删除”，零）．addHeader（“内容类型”，“application / json”）．addHeader（“授权”，凭证．基本（“电子邮件”，“你的密码”））．构建（）；响应响应＝客户端．newCall（请求）．执行（）；
Nodejs 
              

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

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

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

示例响应(年代)

200好了 
              

               
//状态200 OK｛“这套”：｛“id”：10001，“菜单”：［｛“默认”：真正的，“greeting_id”：10001，“id”：10001，“名称”：“主菜单”，“路线”：［｛“行动”：“集团”，“问候”：零，“id”：10001，“按键响应”：“0”，“option_text”：“支持组织”，“选项”：｛“group_ids”：［10001］｝｝］｝］，“名称”：“这套菜单”，“phone_number_ids”：［6］，“phone_number_names”：［“很棒的支持线”］｝｝