文档 API参考

NPS®调查

注意:此API端点已被弃用。有关更多信息，请参见宣布取消净推荐值(NPS)．

调查API可用于列出所有调查或检索和更新现有的调查。您可以自定义调查问卷的内容和设置，然后再使用邀请API自动将您的调查问卷发送给收件人。

JSON格式

调查被表示为具有以下属性的JSON对象:

名字 类型 只读 强制性的 描述
comments_question 字符串 假 假 请求反馈的问题。支持动态内容。
created_at 字符串 真正的 假 当调查被创建时。
delivery_method 字符串 假 假 调查的交付方式。默认值:“电子邮件”。允许的值是“email”或“web_widget”。
email_subject 字符串 假 假 电子邮件的主题文本。默认:“你推荐[公司]的可能性有多大?”
from_email_id 整数 假 假 选择的发件人电子邮件ID。Default:帐号默认支持地址的ID。
highlight_color 字符串 假 假 用于突出显示调查邮件和调查页面中某些元素的颜色。
id 整数 真正的 假 创建调查时自动分配。
intro_text 字符串 假 假 电子邮件的介绍性文字。默认值:(空字符串)。
名字 字符串 假 假 供您内部使用的调查名称。
relationship_id 整数 假 假 用于调查问题的关系值的ID。
状态 字符串 真正的 假 调查的状态。允许的值为“closed”、“draft”或“open”。
主题 字符串 假 假 调查的对象。例如，你的公司名称。
updated_at 字符串 真正的 假 调查最后一次更新的时间。

有效的relationship_id值:

  • 0:朋友或同事
  • 1:朋友
  • 2:朋友或家人
  • 3:同事
  • 4:你认识的人

例子

             

              
｛“comments_question”:“你能告诉我为什么吗?”，“created_at”:“2013 - 08 - 29 - t00:00:00 07:00”，“delivery_method”:“电子邮件”，“email_subject”:“你推荐(公司)的可能性有多大?”，“from_email_id”:10001，“highlight_color”:“# 77 a500”，“id”:1，“intro_text”:“嗨，理查德，你今天好吗?”，“名称”:“购后调查”，“relationship_id”:4，“状态”:“开放”，“主题”:“亚博Zendesk支持”，“updated_at”:“2013 - 08 - 29 - t00:00:00 07:00”}

列表的调查

  • GET / api / v2 / nps /调查

列出现有的调查。

允许

  • 管理员

代码示例

旋度 
              

               
旋度https://｛子域名}.亚博zendesk.com/api/v2/nps/surveys.json＼- v - u｛email_address}:｛密码}
去 
              

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

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

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

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

示例响应(年代)

200好了 
              

               
//状态200 OK｛“调查”:［｛“comments_question”:“你能告诉我们为什么吗?”，“created_at”:“2020 - 06 - 01 - t00:00:00 07:00”，“delivery_method”:“电子邮件”，“email_subject”:“你推荐我们的可能性有多大?”，“from_email_id”:10001，“highlight_color”:“# 77 a500”，“id”:1，“intro_text”:“你好，这是您最近购买的后续产品。”，“名称”:“购后调查”，“relationship_id”:4，“状态”:“开放”，“主题”:“亚博Zendesk支持”，“updated_at”:“2020 - 06 - 01 - t00:00:00 07:00”}]}

调查显示

  • GET / api / v2 / nps /调查/ {survey_id}

显示现有的调查。

允许

  • 管理员

参数

名字 类型 在 要求 描述
survey_id 整数 路径 真正的 调查ID。

代码示例

旋度 
              

               
旋度https://｛子域名}.亚博zendesk.com/api/v2/nps/surveys/｛survey_id}. json＼- v - u｛email_address}:｛密码}
去 
              

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

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

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

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

示例响应(年代)

200好了 
              

               
//状态200 OK｛“调查”:｛“comments_question”:“你能告诉我们为什么吗?”，“created_at”:“2020 - 06 - 01 - t00:00:00 07:00”，“delivery_method”:“电子邮件”，“email_subject”:“你推荐我们的可能性有多大?”，“from_email_id”:10001，“highlight_color”:“# 77 a500”，“id”:1，“intro_text”:“你好，这是您最近购买的后续产品。”，“名称”:“购后调查”，“relationship_id”:4，“状态”:“开放”，“主题”:“亚博Zendesk支持”，“updated_at”:“2020 - 06 - 01 - t00:00:00 07:00”}}

更新调查

  • 把/ api / v2 / nps /调查/ {survey_id}

更新现有的调查。

允许

  • 管理员

参数

名字 类型 在 要求 描述
survey_id 整数 路径 真正的 调查ID。

例子的身体

             

              
｛“调查”:｛“comments_question”:“你能告诉我们为什么吗?”，“email_subject”:“你推荐(公司)的可能性有多大?”，“from_email_id”:10001，“highlight_color”:“# 77 a500”，“intro_text”:“嗨，理查德，你今天好吗?”，“名称”:“购后调查”，“relationship_id”:4，“主题”:“亚博Zendesk支持”}}

代码示例

旋度 
              

               
旋度＼——数据＼'{“调查”:{\"comments_question": "你能告诉我们为什么吗?"，\"created_at": "2020-06-01T00:00:00-07:00"， \"delivery_method": "email"， \"email_subject": "你有多大可能推荐我们?"，\"from_email_id": 10001， \"highlight_color": "#77a500"， \"id": 1， \"intro_text": "你好，这是你最近购买的后续服务。“名称”:“购后调查”，\"relationship_id": 4， \"status": "open"， \"subject": "亚博Zendesk Support"， \"updated_at": "2020-06-01T00:00:00-07:00" \}}’＼——头“application / json内容类型:＼——请求把＼- v - u｛email_address}:｛密码}＼https://｛子域名}.亚博zendesk.com/api/v2/nps/surveys/｛survey_id}. json
去 
              

               
进口（“fmt”“输入输出”“net/http”“弦”）函数主要（）｛url：=“https://support.亚博zendesk.com/api/v2/nps/surveys/1234”方法：=“把”有效载荷：=字符串．NewReader（”{"调查":{"comments_question": "你能告诉我们为什么吗?""email_subject": "你有多大可能推荐[公司]?"，“from_email_id”:10001年,“highlight_color”:“# 77 a500”,"intro_text": "嗨，Richard，你今天好吗?"“名称”:“购后调查”;“relationship_id”:4“主题”:“Zendes亚博k支持”}} '）要求的事情，犯错：=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/nps/surveys/1234”）．newBuilder（）；RequestBody身体=RequestBody．创建（MediaType．解析（“application / json”），＂＂＂｛\ \“调查”:｛comments_question \“\”:\”将你让我们知道为什么？\”，email_subject \“\”:\”如何你可能会推荐［公司]？\”，from_email_id \“\”:10001，highlight_color \“\”:\ " #77a500 \”，intro_text \“\”:\”嗨理查德。，你今天好吗?？\”，\“\”:\”后购买调查\”，relationship_id \“\”:4，\“主题\”:\”亚博支持\”}}＂＂＂）；请求请求=新请求．构建器（）．url（urlBuilder．构建（））．方法（“把”，身体）．addHeader（“内容类型”，“application / json”）．addHeader（“授权”，凭证．基本（“电子邮件”，“你的密码”））．构建（）；响应响应=客户端．newCall（请求）．执行（）；
Nodejs 
              

               
varaxios=需要（“axios”）；var数据=JSON．stringify（｛“调查”:｛“comments_question”:“你能告诉我们为什么吗?”，“email_subject”:“你推荐(公司)的可能性有多大?”，“from_email_id”:10001，“highlight_color”:“# 77 a500”，“intro_text”:“嗨，理查德，你今天好吗?”，“名称”:“购后调查”，“relationship_id”:4，“主题”:“亚博Zendesk支持”}}）；var配置=｛方法:“把”，url:“https://support.亚博zendesk.com/api/v2/nps/surveys/1234”，头:｛“内容类型”:“application / json”，“授权”:的基本< auth-value >”，// Base64编码的"username:password"}，数据:数据，}；axios（配置）．然后（函数（响应）｛控制台．日志（JSON．stringify（响应．数据））；}）．抓（函数（错误）｛控制台．日志（错误）；}）；
Python 
              

               
进口请求进口jsonurl=“https://support.亚博zendesk.com/api/v2/nps/surveys/1234”有效载荷=json．加载（”““{"调查":{"comments_question": "你能告诉我们为什么吗?""email_subject": "你有多大可能推荐[公司]?"，“from_email_id”:10001年,“highlight_color”:“# 77 a500”,"intro_text": "嗨，Richard，你今天好吗?"“名称”:“购后调查”;“relationship_id”:4“主题”:“Zendes亚博k支持”}}”“”）头=｛“内容类型”:“application / json”，}响应=请求．请求（“把”，url，身份验证=（“<用户名>”，' <密码> '），头=头，json=有效载荷）打印（响应．文本）
鲁比（人名） 
              

               
需要“net/http”uri=URI（“https://support.亚博zendesk.com/api/v2/nps/surveys/1234”）请求=网::HTTP::把．新（uri，“内容类型”:“application / json”）请求．身体=%问（｛“调查”:｛“comments_question”:“你能告诉我们为什么吗?”，“email_subject”:“你推荐(公司)的可能性有多大?”，“from_email_id”:10001，“highlight_color”:“# 77 a500”，“intro_text”:“嗨，理查德，你今天好吗?”，“名称”:“购后调查”，“relationship_id”:4，“主题”:“亚博Zendesk支持”}}）请求．basic_auth“用户名”，“密码”响应=网::HTTP．开始uri．主机名，uri．港口，use_ssl:真正的做|http|http．请求（请求）结束

示例响应(年代)

200好了 
              

               
//状态200 OK｛“调查”:｛“comments_question”:“你能告诉我们为什么吗?”，“created_at”:“2020 - 06 - 01 - t00:00:00 07:00”，“delivery_method”:“电子邮件”，“email_subject”:“你推荐我们的可能性有多大?”，“from_email_id”:10001，“highlight_color”:“# 77 a500”，“id”:1，“intro_text”:“你好，这是您最近购买的后续产品。”，“名称”:“购后调查”，“relationship_id”:4，“状态”:“开放”，“主题”:“亚博Zendesk支持”，“updated_at”:“2020 - 06 - 01 - t00:00:00 07:00”}}

近的调查

  • POST / api / v2 / nps /调查/ {survey_id} /关闭

关闭现有调查。

允许

  • 管理员

参数

名字 类型 在 要求 描述
survey_id 整数 路径 真正的 调查ID。

代码示例

旋度 
              

               
旋度＼——数据＇＇＼——请求后＼- v - u｛email_address}:｛密码}＼https://｛子域名}.亚博zendesk.com/api/v2/nps/surveys/｛survey_id}/关闭
去 
              

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

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

               
进口请求url=“https://support.亚博zendesk.com/api/v2/nps/surveys/1234/close”头=｛“内容类型”:“application / json”，}响应=请求．请求（“职位”，url，身份验证=（“<用户名>”，' <密码> '），头=头）打印（响应．文本）
鲁比（人名） 
              

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

示例响应(年代)

200好了 
              

               
//状态200 OK｛“调查”:｛“comments_question”:“你能告诉我们为什么吗?”，“created_at”:“2020 - 06 - 01 - t00:00:00 07:00”，“delivery_method”:“电子邮件”，“email_subject”:“你推荐我们的可能性有多大?”，“from_email_id”:10001，“highlight_color”:“# 77 a500”，“id”:1，“intro_text”:“你好，这是您最近购买的后续产品。”，“名称”:“购后调查”，“relationship_id”:4，“状态”:“开放”，“主题”:“亚博Zendesk支持”，“updated_at”:“2020 - 06 - 01 - t00:00:00 07:00”}}

预览调查

  • GET / api / v2 / nps /调查/ {survey_id} /预览吗?语言环境={地区}

预览特定区域的调查。

允许

  • 管理员

参数

名字 类型 在 要求 描述
语言环境 字符串 查询 真正的 渲染的区域设置用于预览。
survey_id 整数 路径 真正的 调查ID。

代码示例

旋度 
              

               
旋度https://｛子域名}.亚博zendesk.com/api/v2/nps/surveys/｛survey_id}/ preview.json吗?语言环境=｛语言环境}＼- v - u｛email_address}:｛密码}
去 
              

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

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

               
进口请求url=“https://support.亚博zendesk.com/api/v2/nps/surveys/1234/preview?locale=en-US”头=｛“内容类型”:“application / json”，}响应=请求．请求（“获得”，url，身份验证=（“<用户名>”，' <密码> '），头=头）打印（响应．文本）
鲁比（人名） 
              

               
需要“net/http”uri=URI（“https://support.亚博zendesk.com/api/v2/nps/surveys/1234/preview”）uri．查询=URI．encode_www_form（“场所”:“en - us”）请求=网::HTTP::得到．新（uri，“内容类型”:“application / json”）请求．basic_auth“用户名”，“密码”响应=网::HTTP．开始uri．主机名，uri．港口，use_ssl:真正的做|http|http．请求（请求）结束

示例响应(年代)

200好了 
              

               
//状态200 OK｛“survey_preview”:｛“comments_question”:“你能告诉我们为什么吗?”，“feedback_placeholder”:“在这里写下你的评论……”，“highlight_color”:“# 77 a500”，“id”:1，“likely_label”:“极有可能”，“logo_url”:“http://example.com/logo.jpg”，“not_likely_label”:“完全不可能。”，“问题”:“你有多大可能向你认识的人推荐Zendesk Support ?”亚博，“状态”:“开放”，“thank_you”:“谢谢你的反馈。”，“you_rated”:“你给我们的评级是%{评级}”}}