动态内容是一些文本的默认版本和其他语言的文本变体的组合。组合的内容由占位符表示,例如{{dc.my_placeholder}}.动态内容仅适用于专业计划及以上版本。了解更多在支持帮助中心。

本页包含动态内容项的API引用。看到动态内容项变体供变体参考。

的一些属性,可以使用API的动态内容来设置票字段票形式用户字段,组织领域.例如,您可以为票据字段的标题使用动态内容。在这种情况下,为字段的值使用动态内容占位符raw_title属性,并将文本的默认版本作为值标题财产。例子:

"title": "航班号","raw_title": "{{dc. "my_field_title}}”,……

如果属性未使用动态内容,则两个值相同:

"title": "航班号","raw_title": "航班号",…

数据层次结构

动态内容的数据结构是父-子层次结构,其中变量属于项。

  • 项目

    这些是由内容创建者定义的动态内容占位符。每一项都为特定的内容定义了一个名称空间,比如关于如何重置密码或升级计划的说明。项目的唯一内容是项目本身的标题(由您定义)和该项的占位符(由Zendesk Support定义)。亚博内容本身包含在变体中。

  • 变体

    这些是特定于区域设置的内容片段,其中的上下文基于它们所属的项。每个地区、每个项目只能有一个变体。例如,如果一个项目有3个变体,它们必须每个都有一个唯一的语言环境,如英语、西班牙语和法语。它们不能是英语、英语和西班牙语(尽管有可能是英语-美国和英语-英国)。

每个项目都有唯一的ID和唯一的动态内容占位符。每个项目下面都有一些变体,它们都有自己的唯一ID和区域设置。项目可以包含任意数量的变体。

分页和排序

这个API使用标准的分页和排序参数。看到分页

您可以通过以下属性对任何列表端点(包括asc和desc)的结果进行排序:语言环境过时的活跃的updated_at,created_at.默认的排序方式是按id按降序排列。

指定项目变量

创建更新项,指定该项中的变量变体数组中。每个变体由一个locale_id默认的,内容财产。看到动态内容项变体为变量API参考。

亚博Zendesk Support使用默认的如果找不到与用户语言环境匹配的变体,则使用。

示例,为清晰起见格式化:

             
“项目”“名称”“滑雪板的问题”“default_locale_id”1“变异”“locale_id”1“默认”真正的“内容”“C'est mon contenu dynamique en français”“locale_id”2“默认”“内容”“Este es mi contenido dinámico en español”

如果您只有一个变体,您可以使用内容属性,而不是变体属性:

             
“项目”“名称”“滑雪板的问题”“default_locale_id”1“内容”“C'est mon contenu dynamique en français”

但是,我们建议传递一个变量数组,即使您只有一个变量。

JSON格式

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

名字 类型 只读 强制性的 描述
created_at 字符串 真正的 当创建此记录时
default_locale_id 整数 真正的 项的默认区域设置。一定是其中之一吧帐户已激活的区域设置
id 整数 真正的 创建项目时自动分配
名字 字符串 真正的 项目的唯一名称
过时的 布尔 真正的 指示项目中有过时的变体
占位符 字符串 真正的 自动为项目生成占位符,由名称派生
updated_at 字符串 真正的 该记录最后一次更新的时间
url 字符串 真正的 该项的API url
变体 数组 真正的 该项内的所有变量。看到动态内容项变体

列表项

  • GET / api / v2 / dynamic_content /项目

如果作为管理员或具有管理动态内容权限的代理访问,则返回帐户的所有动态内容项的列表。

允许

  • 管理员、代理商

代码示例

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

示例响应(年代)

200好了
              
// Status 200 OK“项目”“created_at”“2015 - 05 - 13 - t22:33:12z”“default_locale_id”1“id”47“名称”“滑雪板的问题”“过时的”真正的“占位符”“{{dc.snowboard_problem}}”“updated_at”“2015 - 05 - 13 - t22:33:12z”“url”“https://company.亚博zendesk.com/api/v2/dynamic_content/items/47.json”“变异”“活跃”真正的“内容”“C'est mon contenu dynamique en français”“created_at”“2015 - 05 - 13 - t22:33:12z”“默认”真正的“id”47“locale_id”1“过时的”“updated_at”“2015 - 05 - 13 - t22:33:12z”“url”“https://company.亚博zendesk.com/api/v2/dynamic_content/items/47/variants/47.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. json- v - uemail_address密码
              
进口“fmt”“输入输出”“net/http”函数主要url: =“https://example.亚博zendesk.com/api/v2/dynamic_content/items/47”方法: =“获得”要求的事情犯错: =httpNewRequest方法url如果犯错! =fmtPrintln犯错返回要求的事情添加“内容类型”“application / json”要求的事情添加“授权”“基本< auth-value >”// Base64编码的"username:password"客户端: =http客户端res犯错: =客户端要求的事情如果犯错! =fmtPrintln犯错返回推迟res身体关闭身体犯错: =ioReadAllres身体如果犯错! =fmtPrintln犯错返回fmtPrintln字符串身体
Java
              
进口comsquareupokhttpOkHttpClient客户端OkHttpClientHttpUrl构建器urlBuilderHttpUrl解析“https://example.亚博zendesk.com/api/v2/dynamic_content/items/47”newBuilder请求请求请求构建器urlurlBuilder构建方法“获得”addHeader“内容类型”“application / json”addHeader“授权”凭证基本“电子邮件”“你的密码”构建响应响应客户端newCall请求执行
Nodejs
              
varaxios需要“axios”var配置方法“得到”url“https://example.亚博zendesk.com/api/v2/dynamic_content/items/47”“内容类型”“application / json”“授权”的基本< auth-value >”// Base64编码的"username:password"axios配置然后函数响应控制台日志JSONstringify响应数据函数错误控制台日志错误
Python
              
进口请求url“https://example.亚博zendesk.com/api/v2/dynamic_content/items/47”“内容类型”“application / json”响应请求请求“获得”url身份验证“<用户名>”' <密码> '打印响应文本
鲁比(人名)
              
需要“net/http”uriURI“https://example.亚博zendesk.com/api/v2/dynamic_content/items/47”请求HTTP得到uri“内容类型”“application / json”请求basic_auth“用户名”“密码”响应HTTP开始uri主机名uri港口use_ssl真正的|http|http请求请求结束

示例响应(年代)

200好了
              
// Status 200 OK“项目”“created_at”“2015 - 05 - 13 - t22:33:12z”“default_locale_id”1“id”47“名称”“滑雪板的问题”“过时的”“占位符”“{{dc.snowboard_problem}}”“updated_at”“2015 - 05 - 13 - t22:33:12z”“url”“https://company.亚博zendesk.com/api/v2/dynamic_content/items/47.json”“变异”“活跃”真正的“内容”“我能听到动态的声音français”“created_at”“2015 - 05 - 13 - t22:33:12z”“默认”真正的“id”47“locale_id”16“过时的”“updated_at”“2015 - 05 - 13 - t22:33:12z”“url”“https://company.亚博zendesk.com/api/v2/dynamic_content/items/47/variants/47.json”“活跃”真正的“内容”“Este es mi contenido dinámico en español”“created_at”“2015 - 05 - 13 - t22:33:12z”“默认”“id”48“locale_id”2“过时的”“updated_at”“2015 - 05 - 13 - t22:33:12z”“url”“https://company.亚博zendesk.com/api/v2/dynamic_content/items/47/variants/48.json”

展示许多项目

  • GET / api / v2 / dynamic_content /项目/ show_many

稳定

  • 发展

允许

  • 管理员、代理商

参数

名字 类型 要求 描述
标识符 字符串 查询 动态内容的标识符

代码示例

旋度
              
旋度https://子域名.亚博zendesk.com/api/v2/dynamic_content/items/show_many.json ?标识符item_one, item_two- v - uemail_address密码
              
进口“fmt”“输入输出”“net/http”函数主要url: =“https://example.亚博zendesk.com/api/v2/dynamic_content/items/show_many?identifiers=item1%2Citem2”方法: =“获得”要求的事情犯错: =httpNewRequest方法url如果犯错! =fmtPrintln犯错返回要求的事情添加“内容类型”“application / json”要求的事情添加“授权”“基本< auth-value >”// Base64编码的"username:password"客户端: =http客户端res犯错: =客户端要求的事情如果犯错! =fmtPrintln犯错返回推迟res身体关闭身体犯错: =ioReadAllres身体如果犯错! =fmtPrintln犯错返回fmtPrintln字符串身体
Java
              
进口comsquareupokhttpOkHttpClient客户端OkHttpClientHttpUrl构建器urlBuilderHttpUrl解析“https://example.亚博zendesk.com/api/v2/dynamic_content/items/show_many”newBuilderaddQueryParameter“标识符”“item1,第二条”请求请求请求构建器urlurlBuilder构建方法“获得”addHeader“内容类型”“application / json”addHeader“授权”凭证基本“电子邮件”“你的密码”构建响应响应客户端newCall请求执行
Nodejs
              
varaxios需要“axios”var配置方法“得到”url“https://example.亚博zendesk.com/api/v2/dynamic_content/items/show_many”“内容类型”“application / json”“授权”的基本< auth-value >”// Base64编码的"username:password"参数个数“标识符”“item1 % 2 citem2”axios配置然后函数响应控制台日志JSONstringify响应数据函数错误控制台日志错误
Python
              
进口请求url“https://example.亚博zendesk.com/api/v2/dynamic_content/items/show_many?identifiers=item1%2Citem2”“内容类型”“application / json”响应请求请求“获得”url身份验证“<用户名>”' <密码> '打印响应文本
鲁比(人名)
              
需要“net/http”uriURI“https://example.亚博zendesk.com/api/v2/dynamic_content/items/show_many”uri查询URIencode_www_form“标识符”“item1,第二条”请求HTTP得到uri“内容类型”“application / json”请求basic_auth“用户名”“密码”响应HTTP开始uri主机名uri港口use_ssl真正的|http|http请求请求结束

示例响应(年代)

200好了
              
// Status 200 OK“项目”“created_at”“2015 - 05 - 13 - t22:33:12z”“default_locale_id”1“id”47“名称”“滑雪板的问题”“过时的”真正的“占位符”“{{dc.snowboard_problem}}”“updated_at”“2015 - 05 - 13 - t22:33:12z”“url”“https://company.亚博zendesk.com/api/v2/dynamic_content/items/47.json”“变异”“活跃”真正的“内容”“C'est mon contenu dynamique en français”“created_at”“2015 - 05 - 13 - t22:33:12z”“默认”真正的“id”47“locale_id”1“过时的”“updated_at”“2015 - 05 - 13 - t22:33:12z”“url”“https://company.亚博zendesk.com/api/v2/dynamic_content/items/47/variants/47.json”

创建项目

  • POST / api / v2 / dynamic_content /项目

创建一个新的内容项,在该项中有一个或多个变体变体数组中。看到指定项目变量

default_locale_id和变体locale_id值必须是帐户活动的地区之一。你可以用列表区域端点。

允许

  • 管理员、代理商

代码示例

旋度
              
旋度https://子域名.亚博zendesk.com/api/v2/dynamic_content/items.json- d'{"item": {"name": "Snowboard Problem", "default_locale_id": 16, " constants ": [{"locale_id": 16, "default": true, "content": "Voici mon contenu dynamique en français"}, {"locale_id": 2, "default": false, "content": "Este es mi contenido dinámico en español"}]}}'- v - uemail_address密码
              
进口“fmt”“输入输出”“net/http”函数主要url: =“https://example.亚博zendesk.com/api/v2/dynamic_content/items”方法: =“职位”要求的事情犯错: =httpNewRequest方法url如果犯错! =fmtPrintln犯错返回要求的事情添加“内容类型”“application / json”要求的事情添加“授权”“基本< auth-value >”// Base64编码的"username:password"客户端: =http客户端res犯错: =客户端要求的事情如果犯错! =fmtPrintln犯错返回推迟res身体关闭身体犯错: =ioReadAllres身体如果犯错! =fmtPrintln犯错返回fmtPrintln字符串身体
Java
              
进口comsquareupokhttpOkHttpClient客户端OkHttpClientHttpUrl构建器urlBuilderHttpUrl解析“https://example.亚博zendesk.com/api/v2/dynamic_content/items”newBuilderRequestBody身体RequestBody创建MediaType解析“application / json”""""请求请求请求构建器urlurlBuilder构建方法“职位”身体addHeader“内容类型”“application / json”addHeader“授权”凭证基本“电子邮件”“你的密码”构建响应响应客户端newCall请求执行
Nodejs
              
varaxios需要“axios”var配置方法“职位”url“https://example.亚博zendesk.com/api/v2/dynamic_content/items”“内容类型”“application / json”“授权”的基本< auth-value >”// Base64编码的"username:password"axios配置然后函数响应控制台日志JSONstringify响应数据函数错误控制台日志错误
Python
              
进口请求url“https://example.亚博zendesk.com/api/v2/dynamic_content/items”“内容类型”“application / json”响应请求请求“职位”url身份验证“<用户名>”' <密码> '打印响应文本
鲁比(人名)
              
需要“net/http”uriURI“https://example.亚博zendesk.com/api/v2/dynamic_content/items”请求HTTP帖子uri“内容类型”“application / json”请求basic_auth“用户名”“密码”响应HTTP开始uri主机名uri港口use_ssl真正的|http|http请求请求结束

示例响应(年代)

201年创建
              
//状态201已创建“项目”“created_at”“2015 - 05 - 13 - t22:33:12z”“default_locale_id”1“id”47“名称”“滑雪板的问题”“过时的”“占位符”“{{dc.snowboard_problem}}”“updated_at”“2015 - 05 - 13 - t22:33:12z”“url”“https://company.亚博zendesk.com/api/v2/dynamic_content/items/47.json”“变异”“活跃”真正的“内容”“我能听到动态的声音français”“created_at”“2015 - 05 - 13 - t22:33:12z”“默认”真正的“id”47“locale_id”16“过时的”“updated_at”“2015 - 05 - 13 - t22:33:12z”“url”“https://company.亚博zendesk.com/api/v2/dynamic_content/items/47/variants/47.json”“活跃”真正的“内容”“Este es mi contenido dinámico en español”“created_at”“2015 - 05 - 13 - t22:33:12z”“默认”“id”48“locale_id”2“过时的”“updated_at”“2015 - 05 - 13 - t22:33:12z”“url”“https://company.亚博zendesk.com/api/v2/dynamic_content/items/47/variants/48.json”

更新项目

  • 把/ api / v2 / dynamic_content /项目/ {dynamic_content_item_id}

唯一可以更改的属性是名称。

要向项添加变体,或更新或删除项的变体,请使用项目变量API

允许

  • 管理员、代理商

参数

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

代码示例

旋度
              
旋度https://子域名.亚博zendesk.com/api/v2/dynamic_content/items/dynamic_content_item_id. json- h“application / json内容类型:- d'{"item": {"name": "新名称"}}'- v - uemail_address密码- x将
              
进口“fmt”“输入输出”“net/http”函数主要url: =“https://example.亚博zendesk.com/api/v2/dynamic_content/items/47”方法: =“把”要求的事情犯错: =httpNewRequest方法url如果犯错! =fmtPrintln犯错返回要求的事情添加“内容类型”“application / json”要求的事情添加“授权”“基本< auth-value >”// Base64编码的"username:password"客户端: =http客户端res犯错: =客户端要求的事情如果犯错! =fmtPrintln犯错返回推迟res身体关闭身体犯错: =ioReadAllres身体如果犯错! =fmtPrintln犯错返回fmtPrintln字符串身体
Java
              
进口comsquareupokhttpOkHttpClient客户端OkHttpClientHttpUrl构建器urlBuilderHttpUrl解析“https://example.亚博zendesk.com/api/v2/dynamic_content/items/47”newBuilderRequestBody身体RequestBody创建MediaType解析“application / json”""""请求请求请求构建器urlurlBuilder构建方法“把”身体addHeader“内容类型”“application / json”addHeader“授权”凭证基本“电子邮件”“你的密码”构建响应响应客户端newCall请求执行
Nodejs
              
varaxios需要“axios”var配置方法“把”url“https://example.亚博zendesk.com/api/v2/dynamic_content/items/47”“内容类型”“application / json”“授权”的基本< auth-value >”// Base64编码的"username:password"axios配置然后函数响应控制台日志JSONstringify响应数据函数错误控制台日志错误
Python
              
进口请求url“https://example.亚博zendesk.com/api/v2/dynamic_content/items/47”“内容类型”“application / json”响应请求请求“把”url身份验证“<用户名>”' <密码> '打印响应文本
鲁比(人名)
              
需要“net/http”uriURI“https://example.亚博zendesk.com/api/v2/dynamic_content/items/47”请求HTTPuri“内容类型”“application / json”请求basic_auth“用户名”“密码”响应HTTP开始uri主机名uri港口use_ssl真正的|http|http请求请求结束

示例响应(年代)

200好了
              
// Status 200 OK“项目”“created_at”“2015 - 05 - 13 - t22:33:12z”“default_locale_id”1“id”47“名称”“新名称”“过时的”“占位符”“{{dc.snowboard_problem}}”“updated_at”“2015 - 05 - 13 - t22:33:12z”“url”“https://company.亚博zendesk.com/api/v2/dynamic_content/items/47.json”“变异”“活跃”真正的“内容”“我能听到动态的声音français”“created_at”“2015 - 05 - 13 - t22:33:12z”“默认”真正的“id”47“locale_id”16“过时的”“updated_at”“2015 - 05 - 13 - t22:33:12z”“url”“https://company.亚博zendesk.com/api/v2/dynamic_content/items/47/variants/47.json”“活跃”真正的“内容”“Este es mi contenido dinámico en español”“created_at”“2015 - 05 - 13 - t22:33:12z”“默认”“id”48“locale_id”2“过时的”“updated_at”“2015 - 05 - 13 - t22:33:12z”“url”“https://company.亚博zendesk.com/api/v2/dynamic_content/items/47/variants/48.json”

删除项目

  • 删除/ 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. json-X DELETE -v -uemail_address密码
              
进口“fmt”“输入输出”“net/http”函数主要url: =“https://example.亚博zendesk.com/api/v2/dynamic_content/items/47”方法: =“删除”要求的事情犯错: =httpNewRequest方法url如果犯错! =fmtPrintln犯错返回要求的事情添加“内容类型”“application / json”要求的事情添加“授权”“基本< auth-value >”// Base64编码的"username:password"客户端: =http客户端res犯错: =客户端要求的事情如果犯错! =fmtPrintln犯错返回推迟res身体关闭身体犯错: =ioReadAllres身体如果犯错! =fmtPrintln犯错返回fmtPrintln字符串身体
Java
              
进口comsquareupokhttpOkHttpClient客户端OkHttpClientHttpUrl构建器urlBuilderHttpUrl解析“https://example.亚博zendesk.com/api/v2/dynamic_content/items/47”newBuilder请求请求请求构建器urlurlBuilder构建方法“删除”addHeader“内容类型”“application / json”addHeader“授权”凭证基本“电子邮件”“你的密码”构建响应响应客户端newCall请求执行
Nodejs
              
varaxios需要“axios”var配置方法“删除”url“https://example.亚博zendesk.com/api/v2/dynamic_content/items/47”“内容类型”“application / json”“授权”的基本< auth-value >”// Base64编码的"username:password"axios配置然后函数响应控制台日志JSONstringify响应数据函数错误控制台日志错误
Python
              
进口请求url“https://example.亚博zendesk.com/api/v2/dynamic_content/items/47”“内容类型”“application / json”响应请求请求“删除”url身份验证“<用户名>”' <密码> '打印响应文本
鲁比(人名)
              
需要“net/http”uriURI“https://example.亚博zendesk.com/api/v2/dynamic_content/items/47”请求HTTP删除uri“内容类型”“application / json”请求basic_auth“用户名”“密码”响应HTTP开始uri主机名uri港口use_ssl真正的|http|http请求请求结束

示例响应(年代)

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