动态内容项变体是动态内容项的特定于区域设置的版本。要了解更多信息,请参见动态内容项

JSON格式

动态内容项变量表示为具有以下属性的JSON对象:

的名字 类型 只读 强制性的 描述
活跃的 布尔 如果变种是活跃的和可用的
内容 字符串 真正的 变体的内容
created_at 字符串 真正的 当变体被创建时
默认的 布尔 如果变量是它所属项目的默认值
id 整数 真正的 在创建变量时自动分配
locale_id 整数 真正的 活动区域
过时的 布尔 真正的 如果该变体已经过时
updated_at 字符串 真正的 最后一次更新该变体的时间
url 字符串 真正的 变量的API url

以下几点值得注意:

  • locale_id-必须是帐户中的活动区域。要获得列表,请参见/ api / v2 /地区

  • 默认的-如果Zendesk Support找不到一个合适的亚博变量来匹配用户的语言环境,则用作后备

  • 过时的—表示该项的默认变量已更新,但其他变量未更改。内容可能已经过时了

  • 活跃的-如果为false, Z亚博endesk Support将不会使用该变量,即使用户的语言环境与该变量匹配

例子

             
“活跃”真正的“内容”“这是我的英文动态内容”“created_at”“2014 - 04 - 09 - t19:53:23z”“默认”真正的“id”23“locale_id”125“过时的”“updated_at”“2014 - 04 - 09 - t19:53:23z”“url”“https://subdomain.亚博zendesk.com/api/v2/dynamic_content/items/3/variants/23.json”

变量列表

  • GET / api / v2 / dynamic_content /项目/ {dynamic_content_item_id} /变异

返回指定动态内容项的所有变体。

允许

  • 管理员
  • 具有动态内容管理权限的代理

参数

的名字 类型 要求 描述
dynamic_content_item_id 整数 路径 真正的 动态内容项的ID

代码示例

旋度
              
旋度https://子域名.亚博zendesk.com/api/v2/dynamic_content/items/dynamic_content_item_id/ variants.json- v - uemail_address密码
              
进口“fmt”“输入输出”“net/http”函数主要url:=“https://example.亚博zendesk.com/api/v2/dynamic_content/items/47/variants”方法:=“获得”要求的事情犯错:=httpNewRequest方法url如果犯错! =fmtPrintln犯错返回要求的事情添加“内容类型”“application / json”要求的事情添加“授权”“基本< auth-value >”// Base64编码的"username:password"客户端:=http客户端res犯错:=客户端要求的事情如果犯错! =fmtPrintln犯错返回推迟res身体关闭身体犯错:=ioReadAllres身体如果犯错! =fmtPrintln犯错返回fmtPrintln字符串身体
Nodejs
              
varaxios需要“axios”var配置方法“得到”url“https://example.亚博zendesk.com/api/v2/dynamic_content/items/47/variants”“内容类型”“application / json”“授权”的基本< auth-value >”// Base64编码的"username:password"axios配置然后函数响应控制台日志JSONstringify响应数据函数错误控制台日志错误
Python
              
进口请求url“https://example.亚博zendesk.com/api/v2/dynamic_content/items/47/variants”“内容类型”“application / json”响应请求请求“获得”url身份验证“<用户名>”' <密码> '打印响应文本
Ruby
              
需要“net/http”uriURI“https://example.亚博zendesk.com/api/v2/dynamic_content/items/47/variants”请求HTTP得到uri“内容类型”“application / json”请求basic_auth“用户名”“密码”响应HTTP开始uri主机名uri港口use_ssl真正的|http|http请求请求结束

示例响应(年代)

200好了
              
// Status 200 OK“变异”“活跃”真正的“内容”“这是我的英文动态内容”“created_at”“2014 - 04 - 09 - t19:53:23z”“默认”真正的“id”23“locale_id”125“过时的”“updated_at”“2014 - 04 - 09 - t19:53:23z”“url”“https://subdomain.亚博zendesk.com/api/v2/dynamic_content/items/3/variants/23.json”“活跃”“内容”“Este es mi contenido dinámico en español”“created_at”“2014 - 04 - 09 - t19:53:23z”“默认”“id”24“locale_id”126“过时的”真正的“updated_at”“2014 - 04 - 09 - t19:53:23z”“url”“https://subdomain.亚博zendesk.com/api/v2/dynamic_content/items/3/variants/24.json”

显示变量

  • GET / api / v2 / dynamic_content /项目/ {dynamic_content_item_id} /变量/ {dynammic_content_variant_id}

允许

  • 管理员、代理商

参数

的名字 类型 要求 描述
dynamic_content_item_id 整数 路径 真正的 动态内容项的ID
dynammic_content_variant_id 整数 路径 真正的 变体的ID

代码示例

旋度
              
旋度https://子域名.亚博zendesk.com/api/v2/dynamic_content/items/dynamic_content_item_id/变量/dynamic_content_variant_id. json- v - uemail_address密码
              
进口“fmt”“输入输出”“net/http”函数主要url:=“https://example.亚博zendesk.com/api/v2/dynamic_content/items/47/variants/23”方法:=“获得”要求的事情犯错:=httpNewRequest方法url如果犯错! =fmtPrintln犯错返回要求的事情添加“内容类型”“application / json”要求的事情添加“授权”“基本< auth-value >”// Base64编码的"username:password"客户端:=http客户端res犯错:=客户端要求的事情如果犯错! =fmtPrintln犯错返回推迟res身体关闭身体犯错:=ioReadAllres身体如果犯错! =fmtPrintln犯错返回fmtPrintln字符串身体
Nodejs
              
varaxios需要“axios”var配置方法“得到”url“https://example.亚博zendesk.com/api/v2/dynamic_content/items/47/variants/23”“内容类型”“application / json”“授权”的基本< auth-value >”// Base64编码的"username:password"axios配置然后函数响应控制台日志JSONstringify响应数据函数错误控制台日志错误
Python
              
进口请求url“https://example.亚博zendesk.com/api/v2/dynamic_content/items/47/variants/23”“内容类型”“application / json”响应请求请求“获得”url身份验证“<用户名>”' <密码> '打印响应文本
Ruby
              
需要“net/http”uriURI“https://example.亚博zendesk.com/api/v2/dynamic_content/items/47/variants/23”请求HTTP得到uri“内容类型”“application / json”请求basic_auth“用户名”“密码”响应HTTP开始uri主机名uri港口use_ssl真正的|http|http请求请求结束

示例响应(年代)

200好了
              
// Status 200 OK“变异”“活跃”真正的“内容”“C'est mon contenu dynamique en français”“created_at”“2014 - 04 - 09 - t19:53:23z”“默认”“id”23“locale_id”127“过时的”“updated_at”“2014 - 04 - 09 - t19:53:23z”“url”“https://subdomain.亚博zendesk.com/api/v2/dynamic_content/items/3/variants/23.json”

创建变体

  • POST / api / v2 / dynamic_content /项目/ {dynamic_content_item_id} /变体

您只能为每个区域设置id创建一个变体。如果区域设置变量已经存在,则拒绝请求。

允许

  • 管理员、代理商

参数

的名字 类型 要求 描述
dynamic_content_item_id 整数 路径 真正的 动态内容项的ID

代码示例

旋度
              
旋度https://子域名.亚博zendesk.com/api/v2/dynamic_content/items/dynamic_content_item_id/ variants.json- d“{"variant": {"locale_id": 127, "active": true, "default": false, "content": "C\ u0027Est mon contenu dynamique en français"}}'- h“application / json内容类型:- x的帖子- v - uemail_address密码
              
进口“fmt”“输入输出”“net/http”函数主要url:=“https://example.亚博zendesk.com/api/v2/dynamic_content/items/47/variants”方法:=“职位”要求的事情犯错:=httpNewRequest方法url如果犯错! =fmtPrintln犯错返回要求的事情添加“内容类型”“application / json”要求的事情添加“授权”“基本< auth-value >”// Base64编码的"username:password"客户端:=http客户端res犯错:=客户端要求的事情如果犯错! =fmtPrintln犯错返回推迟res身体关闭身体犯错:=ioReadAllres身体如果犯错! =fmtPrintln犯错返回fmtPrintln字符串身体
Nodejs
              
varaxios需要“axios”var配置方法“职位”url“https://example.亚博zendesk.com/api/v2/dynamic_content/items/47/variants”“内容类型”“application / json”“授权”的基本< auth-value >”// Base64编码的"username:password"axios配置然后函数响应控制台日志JSONstringify响应数据函数错误控制台日志错误
Python
              
进口请求url“https://example.亚博zendesk.com/api/v2/dynamic_content/items/47/variants”“内容类型”“application / json”响应请求请求“职位”url身份验证“<用户名>”' <密码> '打印响应文本
Ruby
              
需要“net/http”uriURI“https://example.亚博zendesk.com/api/v2/dynamic_content/items/47/variants”请求HTTP帖子uri“内容类型”“application / json”请求basic_auth“用户名”“密码”响应HTTP开始uri主机名uri港口use_ssl真正的|http|http请求请求结束

示例响应(年代)

201年创建
              
//状态201已创建“变异”“活跃”真正的“内容”“C'est mon contenu dynamique en français”“created_at”“2014 - 04 - 09 - t19:53:23z”“默认”“id”23“locale_id”127“过时的”“updated_at”“2014 - 04 - 09 - t19:53:23z”“url”“https://subdomain.亚博zendesk.com/api/v2/dynamic_content/items/3/variants/23.json”

创造多种变体

  • POST / api / v2 / dynamic_content /项目/ {dynamic_content_item_id} / / create_many变体

允许

  • 管理员、代理商

参数

的名字 类型 要求 描述
dynamic_content_item_id 整数 路径 真正的 动态内容项的ID

代码示例

旋度
              
旋度https://子域名.亚博zendesk.com/api/v2/dynamic_content/items/dynamic_content_item_id/ / create_many.json变体- d'{" variables ": [{"locale_id": 127, "active": true, "default": false, "content": "C\ u0027est mon contenu dynamique en français"},{"locale_id": 126, "active": true, "default": false, "content": "Este es mi contenido dinámico en español"}]}'- h“application / json内容类型:- x的帖子- v - uemail_address密码
              
进口“fmt”“输入输出”“net/http”函数主要url:=“https://example.亚博zendesk.com/api/v2/dynamic_content/items/47/variants/create_many”方法:=“职位”要求的事情犯错:=httpNewRequest方法url如果犯错! =fmtPrintln犯错返回要求的事情添加“内容类型”“application / json”要求的事情添加“授权”“基本< auth-value >”// Base64编码的"username:password"客户端:=http客户端res犯错:=客户端要求的事情如果犯错! =fmtPrintln犯错返回推迟res身体关闭身体犯错:=ioReadAllres身体如果犯错! =fmtPrintln犯错返回fmtPrintln字符串身体
Nodejs
              
varaxios需要“axios”var配置方法“职位”url“https://example.亚博zendesk.com/api/v2/dynamic_content/items/47/variants/create_many”“内容类型”“application / json”“授权”的基本< auth-value >”// Base64编码的"username:password"axios配置然后函数响应控制台日志JSONstringify响应数据函数错误控制台日志错误
Python
              
进口请求url“https://example.亚博zendesk.com/api/v2/dynamic_content/items/47/variants/create_many”“内容类型”“application / json”响应请求请求“职位”url身份验证“<用户名>”' <密码> '打印响应文本
Ruby
              
需要“net/http”uriURI“https://example.亚博zendesk.com/api/v2/dynamic_content/items/47/variants/create_many”请求HTTP帖子uri“内容类型”“application / json”请求basic_auth“用户名”“密码”响应HTTP开始uri主机名uri港口use_ssl真正的|http|http请求请求结束

示例响应(年代)

201年创建
              
//状态201已创建“变异”“活跃”真正的“内容”“C'est mon contenu dynamique en français”“created_at”“2014 - 04 - 09 - t19:53:23z”“默认”“id”23“locale_id”127“过时的”“updated_at”“2014 - 04 - 09 - t19:53:23z”“url”“https://subdomain.亚博zendesk.com/api/v2/dynamic_content/items/3/variants/23.json”“活跃”真正的“内容”“Este es mi contenido dinámico en español”“created_at”“2014 - 04 - 09 - t19:53:23z”“默认”“id”24“locale_id”126“过时的”“updated_at”“2014 - 04 - 09 - t19:53:23z”“url”“https://subdomain.亚博zendesk.com/api/v2/dynamic_content/items/3/variants/24.json”

更新版本

  • 把/ api / v2 / dynamic_content /项目/ {dynamic_content_item_id} /变量/ {dynammic_content_variant_id}

更新指定的变量。您不需要包括所有的属性。例如,如果你只是想更新内容,那就只包括它。

不能切换项的默认变体的活动状态。类似地,如果变量为默认值,则不能将默认值切换为false。您必须设置另一个默认变量。

允许

  • 管理员、代理商

参数

的名字 类型 要求 描述
dynamic_content_item_id 整数 路径 真正的 动态内容项的ID
dynammic_content_variant_id 整数 路径 真正的 变体的ID

代码示例

旋度
              
旋度https://子域名.亚博zendesk.com/api/v2/dynamic_content/items/dynamic_content_item_id/变量/dynamic_content_variant_id. json- d'{"variant": {"active": false, "default": false, "content": "C\ u0027Est mon contenu dynamique en français"}}'- h“application / json内容类型:- v - uemail_address密码- x将
              
进口“fmt”“输入输出”“net/http”函数主要url:=“https://example.亚博zendesk.com/api/v2/dynamic_content/items/47/variants/23”方法:=“把”要求的事情犯错:=httpNewRequest方法url如果犯错! =fmtPrintln犯错返回要求的事情添加“内容类型”“application / json”要求的事情添加“授权”“基本< auth-value >”// Base64编码的"username:password"客户端:=http客户端res犯错:=客户端要求的事情如果犯错! =fmtPrintln犯错返回推迟res身体关闭身体犯错:=ioReadAllres身体如果犯错! =fmtPrintln犯错返回fmtPrintln字符串身体
Nodejs
              
varaxios需要“axios”var配置方法“把”url“https://example.亚博zendesk.com/api/v2/dynamic_content/items/47/variants/23”“内容类型”“application / json”“授权”的基本< auth-value >”// Base64编码的"username:password"axios配置然后函数响应控制台日志JSONstringify响应数据函数错误控制台日志错误
Python
              
进口请求url“https://example.亚博zendesk.com/api/v2/dynamic_content/items/47/variants/23”“内容类型”“application / json”响应请求请求“把”url身份验证“<用户名>”' <密码> '打印响应文本
Ruby
              
需要“net/http”uriURI“https://example.亚博zendesk.com/api/v2/dynamic_content/items/47/variants/23”请求HTTPuri“内容类型”“application / json”请求basic_auth“用户名”“密码”响应HTTP开始uri主机名uri港口use_ssl真正的|http|http请求请求结束

示例响应(年代)

200好了
              
// Status 200 OK“变异”“活跃”“内容”“C'est mon contenu dynamique en français”“created_at”“2014 - 04 - 09 - t19:53:23z”“默认”“id”23“locale_id”125“过时的”“updated_at”“2014 - 04 - 09 - t19:53:23z”“url”“https://subdomain.亚博zendesk.com/api/v2/dynamic_content/items/3/variants/23.json”

更新多个变体

  • 把/ api / v2 / dynamic_content /项目/ {dynamic_content_item_id} / / update_many变体

更新一个或多个变量。看到更新版本

必须在主体中通过id指定变量。要获得变量id,请参见变量列表

允许

  • 管理员、代理商

参数

的名字 类型 要求 描述
dynamic_content_item_id 整数 路径 真正的 动态内容项的ID

代码示例

旋度
              
旋度https://子域名.亚博zendesk.com/api/v2/dynamic_content/items/dynamic_content_item_id/ / update_many.json变体- d'{" variables ": [{"id": 2789787, "locale_id": 16, "active": true, "default": false, "content": "C\ u0027est mon contenu dynamique en français"},{"id": 2789807, "locale_id": 2, "active": true, "default": false, "content": "Este es mi contenido dinámico en español"}]}'- h“application / json内容类型:- x的帖子- v - uemail_address密码
              
进口“fmt”“输入输出”“net/http”函数主要url:=“https://example.亚博zendesk.com/api/v2/dynamic_content/items/47/variants/update_many”方法:=“把”要求的事情犯错:=httpNewRequest方法url如果犯错! =fmtPrintln犯错返回要求的事情添加“内容类型”“application / json”要求的事情添加“授权”“基本< auth-value >”// Base64编码的"username:password"客户端:=http客户端res犯错:=客户端要求的事情如果犯错! =fmtPrintln犯错返回推迟res身体关闭身体犯错:=ioReadAllres身体如果犯错! =fmtPrintln犯错返回fmtPrintln字符串身体
Nodejs
              
varaxios需要“axios”var配置方法“把”url“https://example.亚博zendesk.com/api/v2/dynamic_content/items/47/variants/update_many”“内容类型”“application / json”“授权”的基本< auth-value >”// Base64编码的"username:password"axios配置然后函数响应控制台日志JSONstringify响应数据函数错误控制台日志错误
Python
              
进口请求url“https://example.亚博zendesk.com/api/v2/dynamic_content/items/47/variants/update_many”“内容类型”“application / json”响应请求请求“把”url身份验证“<用户名>”' <密码> '打印响应文本
Ruby
              
需要“net/http”uriURI“https://example.亚博zendesk.com/api/v2/dynamic_content/items/47/variants/update_many”请求HTTPuri“内容类型”“application / json”请求basic_auth“用户名”“密码”响应HTTP开始uri主机名uri港口use_ssl真正的|http|http请求请求结束

示例响应(年代)

200好了
              
// Status 200 OK“变异”“活跃”真正的“内容”“C'est mon contenu dynamique en français”“created_at”“2014 - 04 - 09 - t19:53:23z”“默认”“id”23“locale_id”16“过时的”“updated_at”“2014 - 04 - 09 - t19:53:23z”“url”“https://subdomain.亚博zendesk.com/api/v2/dynamic_content/items/3/variants/23.json”“活跃”真正的“内容”“Este es mi contenido dinámico en español”“created_at”“2014 - 04 - 09 - t19:53:23z”“默认”“id”24“locale_id”2“过时的”“updated_at”“2014 - 04 - 09 - t19:53:23z”“url”“https://subdomain.亚博zendesk.com/api/v2/dynamic_content/items/3/variants/24.json”

删除变体

  • 删除/ api / v2 / dynamic_content /项目/ {dynamic_content_item_id} /变量/ {dynammic_content_variant_id}

允许

  • 管理员、代理商

参数

的名字 类型 要求 描述
dynamic_content_item_id 整数 路径 真正的 动态内容项的ID
dynammic_content_variant_id 整数 路径 真正的 变体的ID

代码示例

旋度
              
旋度https://子域名.亚博zendesk.com/api/v2/dynamic_content/items/dynamic_content_item_id/变量/dynamic_content_variant_id. json-X DELETE -v -uemail_address密码
              
进口“fmt”“输入输出”“net/http”函数主要url:=“https://example.亚博zendesk.com/api/v2/dynamic_content/items/47/variants/23”方法:=“删除”要求的事情犯错:=httpNewRequest方法url如果犯错! =fmtPrintln犯错返回要求的事情添加“内容类型”“application / json”要求的事情添加“授权”“基本< auth-value >”// Base64编码的"username:password"客户端:=http客户端res犯错:=客户端要求的事情如果犯错! =fmtPrintln犯错返回推迟res身体关闭身体犯错:=ioReadAllres身体如果犯错! =fmtPrintln犯错返回fmtPrintln字符串身体
Nodejs
              
varaxios需要“axios”var配置方法“删除”url“https://example.亚博zendesk.com/api/v2/dynamic_content/items/47/variants/23”“内容类型”“application / json”“授权”的基本< auth-value >”// Base64编码的"username:password"axios配置然后函数响应控制台日志JSONstringify响应数据函数错误控制台日志错误
Python
              
进口请求url“https://example.亚博zendesk.com/api/v2/dynamic_content/items/47/variants/23”“内容类型”“application / json”响应请求请求“删除”url身份验证“<用户名>”' <密码> '打印响应文本
Ruby
              
需要“net/http”uriURI“https://example.亚博zendesk.com/api/v2/dynamic_content/items/47/variants/23”请求HTTP删除uri“内容类型”“application / json”请求basic_auth“用户名”“密码”响应HTTP开始uri主机名uri港口use_ssl真正的|http|http请求请求结束

示例响应(年代)

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