事件API
事件API允许您构建来自任何来源的所有客户交互的时间轴。事件可以是应用程序或系统可以与用户关联的任何编程式事件。例如购买交易、网站访问或客户服务交互。
每个事件都与触发该事件的客户相关联。
事件API可在Suite Team计划及以上版本中使用。它是由管理员在管理中心激活的。
除了这个API参考之外,开发帮助中心还提供了以下资源:亚博电脑端
- 要开始,请看从Sunshine用户事件开始在开发帮助中心
- 要了解有关使用API的更多信息,请参见事件API开发人员指南
- 要提出问题、提供答案和参加讨论,请访问亚博Zendesk api社区
跑进邮差
您可以将Events API端点作为集合导入到Postman应用程序中,然后尝试不同的请求以了解API是如何工作的。请按以下按钮下载有关图集:
有关使用Postman For Sunshine api的信息,请参见为阳光设置邮递员API调用.
JSON格式
事件被表示为具有以下属性的JSON对象:
的名字 | 类型 | 只读 | 强制性的 | 描述 |
---|---|---|---|---|
created_at | 字符串 | 假 | 假 | 符合ISO-8601的日期-时间,反映事件创建的时间。如果未设置,API将在接收到事件时设置该值 |
描述 | 字符串 | 假 | 假 | 事件描述 |
id | 字符串 | 真正的 | 假 | 事件ID |
属性 | 对象 | 假 | 真正的 | 带有事件详细信息的自定义JSON对象。必须遵守JSON模式规范 |
received_at | 字符串 | 真正的 | 假 | 符合ISO-8601的日期-时间,反映事件被接收的时间 |
源 | 字符串 | 假 | 真正的 | 发送事件的应用程序。注意:'zen亚博desk'是zendesk标准事件的受保护源名称。在创建事件时,任何使用此源的尝试都会导致错误 |
类型 | 字符串 | 假 | 真正的 | 事件名称 |
事件由描述事件和触发事件的用户的JSON对象组成。
配置文件对象
配置文件对象描述与应用程序或系统相关联的用户。该对象具有以下属性:
的名字 | 类型 | 要求 | 描述 |
---|---|---|---|
源 | 字符串 | 是的 | 与概要文件相关联的产品或服务。例如,“Support”、“Salesforce”或“Chat” |
类型 | 字符串 | 是的 | 配置文件的类型。例如,"Contact"或"Lead" |
标识符 | 对象 | 是的 | 一个或多个用户标识。看到数组标识符 |
例子
{
“配置文件”:{
“源”:“shoppingnow”,
“类型”:“客户”,
“标识符”:[
{
“类型”:“shoppingnow_id”,
“价值”:“361959350832”
},
{
“类型”:“external_id”,
“价值”:“0987654321”
}
]
},
“事件”:{
“源”:“shoppingnow”,
“类型”:“order_completed”,
“created_at”:“2018 - 11 - 05 - t22:26:00z”,
“描述”:“已添加项目到购物车”,
“属性”:{
“项目”:{
“名称”:“佳能429 EOS HD”,
“查询”:“相机”,
“价格”:“499.99”
},
“运输”:{
“eta_date”:“2019/01/02”,
“地址”:{
“address1”:“街市街1019号”,
“城市”:“旧金山”,
“状态”:“CA”,
“zipcode”:“94103”
}
}
}
}
}
获取Ze亚博ndesk用户事件
GET / api / v2 /用户/ {user_id} /事件
返回给定Zendesk用户的事件。亚博
允许
- 代理
参数
的名字 | 类型 | 在 | 要求 | 描述 |
---|---|---|---|---|
过滤器(end_time) | 字符串 | 查询 | 假 | 属性之前的事件created_at 时间 |
过滤器(源) | 字符串 | 查询 | 假 | 包括指定源的事件 |
过滤器(start_time) | 字符串 | 查询 | 假 | 类型的事件等于或晚于created_at 时间 |
过滤器(类型) | 字符串 | 查询 | 假 | 为给定的事件源包含指定类型的事件。的过滤器(源) 参数必须包括在内 |
页面(大小) | 字符串 | 查询 | 假 | 包括指定数量的事件 |
user_id | 字符串 | 路径 | 真正的 | 亚博Zendesk用户ID |
代码示例
旋度
旋度“https://{子域名}.zendes亚博k.com/api/v2/users/ {user_id} /事件”\
- u{email_address}:{密码}
去
进口(
“fmt”
“输入输出”
“net/http”
)
函数主要(){
url: =“https://support.亚博zendesk.com/api/v2/users/120077332/events?filter [end_time] =过滤器[源]=过滤器[start_time] =过滤器[型]=和页面大小=”
方法: =“获得”
要求的事情,犯错: =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/users/120077332/events”)
.newBuilder()
.addQueryParameter(“过滤器(end_time)”,"")
.addQueryParameter(“过滤器”[源],"")
.addQueryParameter(“过滤器(start_time)”,"")
.addQueryParameter(“过滤器”(类型),"")
.addQueryParameter(“页面大小”,"");
请求请求=新请求.构建器()
.url(urlBuilder.构建())
.方法(“获得”,零)
.addHeader(“内容类型”,“application / json”)
.addHeader(“授权”,凭证.基本(“电子邮件”,“你的密码”))
.构建();
响应响应=客户端.newCall(请求).执行();
Nodejs
varaxios=需要(“axios”);
var配置={
方法:“得到”,
url:“https://support.亚博zendesk.com/api/v2/users/120077332/events”,
头:{
“内容类型”:“application / json”,
“授权”:的基本< auth-value >”,// Base64编码的"username:password"
},
参数个数:{
“过滤器(end_time)”:”,
“过滤器[源]”:”,
“过滤器(start_time)”:”,
过滤器(型)的:”,
页面(大小)的:”,
},
};
axios(配置)
.然后(函数(响应){
控制台.日志(JSON.stringify(响应.数据));
})
.抓(函数(错误){
控制台.日志(错误);
});
Python
进口请求
url=“https://support.亚博zendesk.com/api/v2/users/120077332/events?filter [end_time] =过滤器[源]=过滤器[start_time] =过滤器[型]=和页面大小=”
头={
“内容类型”:“application / json”,
}
响应=请求.请求(
“获得”,
url,
身份验证=(“<用户名>”,' <密码> '),
头=头
)
打印(响应.文本)
鲁比(人名)
需要“net/http”
uri=URI(“https://support.亚博zendesk.com/api/v2/users/120077332/events”)
uri.查询=URI.encode_www_form(“过滤器(end_time)”:"",“过滤器”[源]:"",“过滤器(start_time)”:"",“过滤器”(类型):"",“页面大小”:"")
请求=网::HTTP::得到.新(uri,“内容类型”:“application / json”)
请求.basic_auth“用户名”,“密码”
响应=网::HTTP.开始uri.主机名,uri.港口,use_ssl:真正的做|http|
http.请求(请求)
结束
示例响应(年代)
200好了
// Status 200 OK
{
“事件”:[
{
“created_at”:“2020 - 01 - 31 - t00:44:07 + 00:00”,
“描述”:“完成”,
“属性”:{
“账单”:{
“address1”:“市场街1019号”,
“城市”:“旧金山”,
“状态”:“CA”,
“zipcode”:“94103”
},
“项目”:{
“名称”:“亚博Zendesk赃物”
}
},
“源”:“shoppingnow”,
“类型”:“签出”
}
],
“链接”:[
{
“下一个”:“https://yoursubdomain.亚博zendesk.com/api/v2/user_profiles/1/events?page[在]= hkjhdjk”
}
],
“元”:{
“after_cursor”:“hkjhdjk”,
“has_more”:真正的
}
}
400错误请求
//状态400错误请求
{
“错误”:{
“消息”:"您为id属性传递了无效值。无效参数:id必须是api/v2/users/show的整数",
“标题”:“无效的属性”
}
}
通过Sunshine Profile获取事件
/ api / v2 / user_profiles /事件吗?标识符={标识符}
返回Sunshine概要文件的事件。
要定位特定的概要文件,必须在请求中指定标识符查询作为URL参数。有关更多信息,请参见标识符的查询.
还可以包含以下格式的任意可选查询字符串参数过滤器[{可选参数}]=
:
- 源—只包含指定来源的事件。例如,
过滤器[源]=亚马逊
- 类型—对于给定的事件源,只包含指定类型的事件。例如,
过滤器[源]= amazon&filter[型]=结帐
- start_time-只包含晚于或等于的事件
过滤器(created_at)
时间 - end_time—只包含早于或等于的事件
过滤器(created_at)
时间
页面(大小)
事件个数。注意,它本身是一个参数,而不是过滤器[]
参数值。
了解如何使用可选选项过滤器[]
路径参数,请参见过滤阳光事件.
在发送请求之前,查询字符串必须进行url编码。在cURL中,使用——data-urlencode
选项中的- g
国旗。的- g
flag强制命令发出GET请求,而不是默认的POST请求。
允许
- 代理
参数
的名字 | 类型 | 在 | 要求 | 描述 |
---|---|---|---|---|
过滤器(end_time) | 字符串 | 查询 | 假 | 属性之前的事件created_at 时间 |
过滤器(源) | 字符串 | 查询 | 假 | 包括指定源的事件 |
过滤器(start_time) | 字符串 | 查询 | 假 | 类型的事件等于或晚于created_at 时间 |
过滤器(类型) | 字符串 | 查询 | 假 | 为给定的事件源包含指定类型的事件。的过滤器(源) 参数必须包括在内 |
标识符 | 字符串 | 查询 | 真正的 | 传递一个配置文件标识符查询以过滤格式中的特定配置文件来源:类型:identifier_type: identifier_value .有关更多信息,请参见标识符的查询 |
页面(大小) | 字符串 | 查询 | 假 | 包括指定数量的事件 |
代码示例
旋度
旋度“https://{子域名}.zendes亚博k.com/api/v2/user_profiles/events ?标识符= {identifier_query} "\
- u{email_address}:{密码}
去
进口(
“fmt”
“输入输出”
“net/http”
)
函数主要(){
url: =“https://support.亚博zendesk.com/api/v2/user_profiles/events?filter [end_time] =过滤器[源]=过滤器[start_time] =过滤器[型]=标识符= shoppingnow % 3 acustomer % 3 aemail % 3 aexample % 40 example.com&page(大小)= "
方法: =“获得”
要求的事情,犯错: =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/user_profiles/events”)
.newBuilder()
.addQueryParameter(“过滤器(end_time)”,"")
.addQueryParameter(“过滤器”[源],"")
.addQueryParameter(“过滤器(start_time)”,"")
.addQueryParameter(“过滤器”(类型),"")
.addQueryParameter(“标识符”,“shoppingnow:顾客:电子邮件:(电子邮件保护)")
.addQueryParameter(“页面大小”,"");
请求请求=新请求.构建器()
.url(urlBuilder.构建())
.方法(“获得”,零)
.addHeader(“内容类型”,“application / json”)
.addHeader(“授权”,凭证.基本(“电子邮件”,“你的密码”))
.构建();
响应响应=客户端.newCall(请求).执行();
Nodejs
varaxios=需要(“axios”);
var配置={
方法:“得到”,
url:“https://support.亚博zendesk.com/api/v2/user_profiles/events”,
头:{
“内容类型”:“application / json”,
“授权”:的基本< auth-value >”,// Base64编码的"username:password"
},
参数个数:{
“过滤器(end_time)”:”,
“过滤器[源]”:”,
“过滤器(start_time)”:”,
过滤器(型)的:”,
“标识符”:“shoppingnow % 3 acustomer % 3 aemail % 3 aexample % 40 example.com,
页面(大小)的:”,
},
};
axios(配置)
.然后(函数(响应){
控制台.日志(JSON.stringify(响应.数据));
})
.抓(函数(错误){
控制台.日志(错误);
});
Python
进口请求
url=“https://support.亚博zendesk.com/api/v2/user_profiles/events?filter [end_time] =过滤器[源]=过滤器[start_time] =过滤器[型]=标识符= shoppingnow % 3 acustomer % 3 aemail % 3 aexample % 40 example.com&page(大小)= "
头={
“内容类型”:“application / json”,
}
响应=请求.请求(
“获得”,
url,
身份验证=(“<用户名>”,' <密码> '),
头=头
)
打印(响应.文本)
鲁比(人名)
需要“net/http”
uri=URI(“https://support.亚博zendesk.com/api/v2/user_profiles/events”)
uri.查询=URI.encode_www_form(“过滤器(end_time)”:"",“过滤器”[源]:"",“过滤器(start_time)”:"",“过滤器”(类型):"",“标识符”:“shoppingnow:顾客:电子邮件:(电子邮件保护)",“页面大小”:"")
请求=网::HTTP::得到.新(uri,“内容类型”:“application / json”)
请求.basic_auth“用户名”,“密码”
响应=网::HTTP.开始uri.主机名,uri.港口,use_ssl:真正的做|http|
http.请求(请求)
结束
示例响应(年代)
200好了
// Status 200 OK
{
“事件”:[
{
“created_at”:“2020 - 01 - 31 - t00:44:07 + 00:00”,
“描述”:“完成”,
“属性”:{
“账单”:{
“address1”:“市场街1019号”,
“城市”:“旧金山”,
“状态”:“CA”,
“zipcode”:“94103”
},
“项目”:{
“名称”:“亚博Zendesk赃物”
}
},
“源”:“shoppingnow”,
“类型”:“签出”
}
],
“链接”:[
{
“下一个”:“https://yoursubdomain.亚博zendesk.com/api/v2/user_profiles/1/events?page[在]= hkjhdjk”
}
],
“元”:{
“after_cursor”:“hkjhdjk”,
“has_more”:真正的
}
}
400错误请求
//状态400错误请求
{
“错误”:[
{
“代码”:“StartTimestampNotValid”,
“id”:“c21d8981 - 8940 - 419 - b - 907 - b - 7 - f7a2ba22cca”,
“标题”:"开始时间戳无效"
}
]
}
404未找到
//状态404 Not Found
{
“错误”:[
{
“代码”:“StartTimestampNotValid”,
“id”:“c21d8981 - 8940 - 419 - b - 907 - b - 7 - f7a2ba22cca”,
“标题”:"开始时间戳无效"
}
]
}
通过Sunshine Profile ID获取事件
GET / api / v2 / user_profiles / {profile_id} /事件
返回给定Sunshine概要文件的事件。要检索概要ID,请参见按标识符获取概要文件.
允许
- 代理
参数
的名字 | 类型 | 在 | 要求 | 描述 |
---|---|---|---|---|
过滤器(end_time) | 字符串 | 查询 | 假 | 属性之前的事件created_at 时间 |
过滤器(源) | 字符串 | 查询 | 假 | 包括指定源的事件 |
过滤器(start_time) | 字符串 | 查询 | 假 | 类型的事件等于或晚于created_at 时间 |
过滤器(类型) | 字符串 | 查询 | 假 | 为给定的事件源包含指定类型的事件。这需要过滤器(源) 要包含的参数 |
页面(大小) | 字符串 | 查询 | 假 | 包括指定数量的事件 |
profile_id | 字符串 | 路径 | 真正的 | 阳光档案ID |
代码示例
旋度
旋度“https://{子域名}.zendes亚博k.com/api/v2/user_profiles/ {profile_id} /事件”\
- u{email_address}:{密码}
去
进口(
“fmt”
“输入输出”
“net/http”
)
函数主要(){
url: =“https://support.亚博zendesk.com/api/v2/user_profiles//events?filter [end_time] =过滤器[源]=过滤器[start_time] =过滤器[型]=和页面大小=”
方法: =“获得”
要求的事情,犯错: =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/user_profiles//events”)
.newBuilder()
.addQueryParameter(“过滤器(end_time)”,"")
.addQueryParameter(“过滤器”[源],"")
.addQueryParameter(“过滤器(start_time)”,"")
.addQueryParameter(“过滤器”(类型),"")
.addQueryParameter(“页面大小”,"");
请求请求=新请求.构建器()
.url(urlBuilder.构建())
.方法(“获得”,零)
.addHeader(“内容类型”,“application / json”)
.addHeader(“授权”,凭证.基本(“电子邮件”,“你的密码”))
.构建();
响应响应=客户端.newCall(请求).执行();
Nodejs
varaxios=需要(“axios”);
var配置={
方法:“得到”,
url:“https://support.亚博zendesk.com/api/v2/user_profiles//events”,
头:{
“内容类型”:“application / json”,
“授权”:的基本< auth-value >”,// Base64编码的"username:password"
},
参数个数:{
“过滤器(end_time)”:”,
“过滤器[源]”:”,
“过滤器(start_time)”:”,
过滤器(型)的:”,
页面(大小)的:”,
},
};
axios(配置)
.然后(函数(响应){
控制台.日志(JSON.stringify(响应.数据));
})
.抓(函数(错误){
控制台.日志(错误);
});
Python
进口请求
url=“https://support.亚博zendesk.com/api/v2/user_profiles//events?filter [end_time] =过滤器[源]=过滤器[start_time] =过滤器[型]=和页面大小=”
头={
“内容类型”:“application / json”,
}
响应=请求.请求(
“获得”,
url,
身份验证=(“<用户名>”,' <密码> '),
头=头
)
打印(响应.文本)
鲁比(人名)
需要“net/http”
uri=URI(“https://support.亚博zendesk.com/api/v2/user_profiles//events”)
uri.查询=URI.encode_www_form(“过滤器(end_time)”:"",“过滤器”[源]:"",“过滤器(start_time)”:"",“过滤器”(类型):"",“页面大小”:"")
请求=网::HTTP::得到.新(uri,“内容类型”:“application / json”)
请求.basic_auth“用户名”,“密码”
响应=网::HTTP.开始uri.主机名,uri.港口,use_ssl:真正的做|http|
http.请求(请求)
结束
示例响应(年代)
200好了
// Status 200 OK
{
“事件”:[
{
“created_at”:“2020 - 01 - 31 - t00:44:07 + 00:00”,
“描述”:“完成”,
“属性”:{
“账单”:{
“address1”:“市场街1019号”,
“城市”:“旧金山”,
“状态”:“CA”,
“zipcode”:“94103”
},
“项目”:{
“名称”:“亚博Zendesk赃物”
}
},
“源”:“shoppingnow”,
“类型”:“签出”
}
],
“链接”:[
{
“下一个”:“https://yoursubdomain.亚博zendesk.com/api/v2/user_profiles/1/events?page[在]= hkjhdjk”
}
],
“元”:{
“after_cursor”:“hkjhdjk”,
“has_more”:真正的
}
}
400错误请求
//状态400错误请求
{
“错误”:[
{
“代码”:“StartTimestampNotValid”,
“id”:“c21d8981 - 8940 - 419 - b - 907 - b - 7 - f7a2ba22cca”,
“标题”:"开始时间戳无效"
}
]
}
404未找到
//状态404 Not Found
{
“错误”:[
{
“代码”:“StartTimestampNotValid”,
“id”:“c21d8981 - 8940 - 419 - b - 907 - b - 7 - f7a2ba22cca”,
“标题”:"开始时间戳无效"
}
]
}
针对Zendesk用户和给定配置文件跟踪亚博事件
POST / api / v2 /用户/ {user_id} /事件
存储给定Zendesk用户和配置文件的事件。亚博
允许
- 代理
访问还取决于设置的代理角色权限支持>人>角色>人.
参数
的名字 | 类型 | 在 | 要求 | 描述 |
---|---|---|---|---|
user_id | 字符串 | 路径 | 真正的 | 亚博Zendesk用户ID |
例子的身体
{
“事件”:{
“created_at”:“2020 - 01 - 31 - t00:44:07 + 00:00”,
“描述”:“完成”,
“属性”:{
“账单”:{
“address1”:“市场街1019号”,
“城市”:“旧金山”,
“状态”:“CA”,
“zipcode”:“94103”
},
“项目”:{
“名称”:“亚博Zendesk赃物”
}
},
“源”:“shoppingnow”,
“类型”:“签出”
},
“配置文件”:{
“标识符”:[
{
“类型”:“电子邮件”,
“价值”:"(电子邮件保护)"
},
{
“类型”:“external_id”,
“价值”:“0987654321”
}
],
“名称”:“简·史密斯”,
“源”:“shoppingnow”,
“类型”:“客户”
}
}
代码示例
旋度
旋度“https://{子域名}.zendes亚博k.com/api/v2/users/ {user_id} /事件”\
- d{“配置文件”:{“名称”:“简·史密斯”,“源”:“shoppingnow”,“类型”:“客户”,“标识符”:[{“类型”:“电子邮件”,“价值”:"(电子邮件保护)"}]},“事件”:{“源”:“shoppingnow”,“类型”:“签出”,“描述”:“完成”,“created_at”:“2020 - 01 - 31 - t00:44:07.000z”,“属性”:{“项目”:{“名称”:“亚博Zendesk赃物”},“账单”:{“address1”:“市场街1019号”,“城市”:“旧金山”,“状态”:“CA”,“zipcode”:“94103”}}}}\
- h“application / json内容类型:\
- u{email_address}:{密码}
去
进口(
“fmt”
“输入输出”
“net/http”
“弦”
)
函数主要(){
url: =“https://support.亚博zendesk.com/api/v2/users/120077332/events”
方法: =“职位”
有效载荷: =字符串.NewReader(”{
"事件":{
“created_at”:“2020 - 01 - 31 - t00:44:07 + 00:00”,
"description": "订单完成",
"属性":{
“账单”:{
地址1:市场街1019号
"city": "San Francisco",
“状态”:“CA”,
“zipcode”:“94103”
},
"项目":{
"name": "亚博Zendesk Swag"
}
},
“源”:“shoppingnow”,
“类型”:“结帐”
},
“简介”:{
“标识符”:[
{
“类型”:“电子邮件”,
“价值”:“(电子邮件保护)"
},
{
“类型”:“external_id”,
“价值”:“0987654321”
}
],
“姓名”:“简·史密斯”,
“源”:“shoppingnow”,
“类型”:“客户”
}
} ')
要求的事情,犯错: =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/users/120077332/events”)
.newBuilder();
RequestBody身体=RequestBody.创建(MediaType.解析(“application / json”),
"""
{
\ \”事件”:{
created_at \“\”:\”2020-01-31T00:44:07+00:00\”,
\ \“描述”:\”订单完成\”,
\ \“属性”:{
\“计费\”:{
address1 \“\”:\”1019市场圣\”,
\“\”:\”圣旧金山\”,
\“\”:\”CA\”,
\ " zipcode \”:\”94103\”
},
\ \“项目”:{
\“\”:\”亚博赃物\”
}
},
\ \“来源”:shoppingnow \“\”,
\”类型\”:\“结帐\”
},
\“形象\”:{
\ \“标识符”:[
{
\”类型\”:\“邮件\”,
\“价值\”:\”(电子邮件保护).com \”
},
{
\”类型\”:external_id \“\”,
\“价值\”:\”0987654321\”
}
],
\“\”:\”简史密斯\”,
\ \“来源”:shoppingnow \“\”,
\”类型\”:“客户\ \”
}
}""");
请求请求=新请求.构建器()
.url(urlBuilder.构建())
.方法(“职位”,身体)
.addHeader(“内容类型”,“application / json”)
.addHeader(“授权”,凭证.基本(“电子邮件”,“你的密码”))
.构建();
响应响应=客户端.newCall(请求).执行();
Nodejs
varaxios=需要(“axios”);
var数据=JSON.stringify({
“事件”:{
“created_at”:“2020 - 01 - 31 - t00:44:07 + 00:00”,
“描述”:“完成”,
“属性”:{
“账单”:{
“address1”:“市场街1019号”,
“城市”:“旧金山”,
“状态”:“CA”,
“zipcode”:“94103”
},
“项目”:{
“名称”:“亚博Zendesk赃物”
}
},
“源”:“shoppingnow”,
“类型”:“签出”
},
“配置文件”:{
“标识符”:[
{
“类型”:“电子邮件”,
“价值”:"(电子邮件保护)"
},
{
“类型”:“external_id”,
“价值”:“0987654321”
}
],
“名称”:“简·史密斯”,
“源”:“shoppingnow”,
“类型”:“客户”
}
});
var配置={
方法:“职位”,
url:“https://support.亚博zendesk.com/api/v2/users/120077332/events”,
头:{
“内容类型”:“application / json”,
“授权”:的基本< auth-value >”,// Base64编码的"username:password"
},
数据:数据,
};
axios(配置)
.然后(函数(响应){
控制台.日志(JSON.stringify(响应.数据));
})
.抓(函数(错误){
控制台.日志(错误);
});
Python
进口请求
进口json
url=“https://support.亚博zendesk.com/api/v2/users/120077332/events”
有效载荷=json.加载(”““{
"事件":{
“created_at”:“2020 - 01 - 31 - t00:44:07 + 00:00”,
"description": "订单完成",
"属性":{
“账单”:{
地址1:市场街1019号
"city": "San Francisco",
“状态”:“CA”,
“zipcode”:“94103”
},
"项目":{
"name": "亚博Zendesk Swag"
}
},
“源”:“shoppingnow”,
“类型”:“结帐”
},
“简介”:{
“标识符”:[
{
“类型”:“电子邮件”,
“价值”:“(电子邮件保护)"
},
{
“类型”:“external_id”,
“价值”:“0987654321”
}
],
“姓名”:“简·史密斯”,
“源”:“shoppingnow”,
“类型”:“客户”
}
}”“”)
头={
“内容类型”:“application / json”,
}
响应=请求.请求(
“职位”,
url,
身份验证=(“<用户名>”,' <密码> '),
头=头,
json=有效载荷
)
打印(响应.文本)
鲁比(人名)
需要“net/http”
uri=URI(“https://support.亚博zendesk.com/api/v2/users/120077332/events”)
请求=网::HTTP::帖子.新(uri,“内容类型”:“application / json”)
请求.身体=%问({
“事件”:{
“created_at”:“2020 - 01 - 31 - t00:44:07 + 00:00”,
“描述”:“完成”,
“属性”:{
“账单”:{
“address1”:“市场街1019号”,
“城市”:“旧金山”,
“状态”:“CA”,
“zipcode”:“94103”
},
“项目”:{
“名称”:“亚博Zendesk赃物”
}
},
“源”:“shoppingnow”,
“类型”:“签出”
},
“配置文件”:{
“标识符”:[
{
“类型”:“电子邮件”,
“价值”:"(电子邮件保护)"
},
{
“类型”:“external_id”,
“价值”:“0987654321”
}
],
“名称”:“简·史密斯”,
“源”:“shoppingnow”,
“类型”:“客户”
}
})
请求.basic_auth“用户名”,“密码”
响应=网::HTTP.开始uri.主机名,uri.港口,use_ssl:真正的做|http|
http.请求(请求)
结束
示例响应(年代)
202年接受
//状态202已接受
{
“profile_id”:“01 e1dpyaa7hw7645kmjey9cxrj”,
“状态”:“收到”,
“user_id”:“123456”
}
400错误请求
//状态400错误请求
{
“错误”:[
{
“代码”:“StartTimestampNotValid”,
“id”:“c21d8981 - 8940 - 419 - b - 907 - b - 7 - f7a2ba22cca”,
“标题”:"开始时间戳无效"
}
]
}
404未找到
//状态404 Not Found
{
“错误”:[
{
“代码”:“StartTimestampNotValid”,
“id”:“c21d8981 - 8940 - 419 - b - 907 - b - 7 - f7a2ba22cca”,
“标题”:"开始时间戳无效"
}
]
}
径赛对抗阳光轮廓
POST / api / v2 / user_profiles /事件
根据给定的Sunshine配置文件存储一个事件。如果配置文件不存在,则会创建它。提供的任何其他标识符信息都被添加到概要文件中。
允许
- 代理
访问还取决于设置的代理角色权限支持>人>角色>人.
例子的身体
{
“事件”:{
“created_at”:“2020 - 01 - 31 - t00:44:07 + 00:00”,
“描述”:“完成”,
“属性”:{
“账单”:{
“address1”:“市场街1019号”,
“城市”:“旧金山”,
“状态”:“CA”,
“zipcode”:“94103”
},
“项目”:{
“名称”:“亚博Zendesk赃物”
}
},
“源”:“shoppingnow”,
“类型”:“签出”
},
“配置文件”:{
“标识符”:[
{
“类型”:“电子邮件”,
“价值”:"(电子邮件保护)"
},
{
“类型”:“external_id”,
“价值”:“0987654321”
}
],
“名称”:“简·史密斯”,
“源”:“shoppingnow”,
“类型”:“客户”
}
}
代码示例
旋度
旋度“https://{子域名}.zendes亚博k.com/api/v2/user_profiles/events”\
- d{“配置文件”:{“名称”:“简·史密斯”,“源”:“shoppingnow”,“类型”:“客户”,“标识符”:[{“类型”:“电子邮件”,“价值”:"(电子邮件保护)"},{“类型”:“external_id”,“价值”:“0987654321”}]},“事件”:{“源”:“shoppingnow”,“类型”:“签出”,“描述”:“完成”,“created_at”:“2020 - 01 - 31 - t00:44:07.000z”,“属性”:{“项目”:{“名称”:“亚博Zendesk赃物”},“账单”:{“address1”:“市场街1019号”,“城市”:“旧金山”,“状态”:“CA”,“zipcode”:“94103”}}}}\
- h“application / json内容类型:\
- u{email_address}:{密码}
去
进口(
“fmt”
“输入输出”
“net/http”
“弦”
)
函数主要(){
url: =“https://support.亚博zendesk.com/api/v2/user_profiles/events”
方法: =“职位”
有效载荷: =字符串.NewReader(”{
"事件":{
“created_at”:“2020 - 01 - 31 - t00:44:07 + 00:00”,
"description": "订单完成",
"属性":{
“账单”:{
地址1:市场街1019号
"city": "San Francisco",
“状态”:“CA”,
“zipcode”:“94103”
},
"项目":{
"name": "亚博Zendesk Swag"
}
},
“源”:“shoppingnow”,
“类型”:“结帐”
},
“简介”:{
“标识符”:[
{
“类型”:“电子邮件”,
“价值”:“(电子邮件保护)"
},
{
“类型”:“external_id”,
“价值”:“0987654321”
}
],
“姓名”:“简·史密斯”,
“源”:“shoppingnow”,
“类型”:“客户”
}
} ')
要求的事情,犯错: =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/user_profiles/events”)
.newBuilder();
RequestBody身体=RequestBody.创建(MediaType.解析(“application / json”),
"""
{
\ \”事件”:{
created_at \“\”:\”2020-01-31T00:44:07+00:00\”,
\ \“描述”:\”订单完成\”,
\ \“属性”:{
\“计费\”:{
address1 \“\”:\”1019市场圣\”,
\“\”:\”圣旧金山\”,
\“\”:\”CA\”,
\ " zipcode \”:\”94103\”
},
\ \“项目”:{
\“\”:\”亚博赃物\”
}
},
\ \“来源”:shoppingnow \“\”,
\”类型\”:\“结帐\”
},
\“形象\”:{
\ \“标识符”:[
{
\”类型\”:\“邮件\”,
\“价值\”:\”(电子邮件保护).com \”
},
{
\”类型\”:external_id \“\”,
\“价值\”:\”0987654321\”
}
],
\“\”:\”简史密斯\”,
\ \“来源”:shoppingnow \“\”,
\”类型\”:“客户\ \”
}
}""");
请求请求=新请求.构建器()
.url(urlBuilder.构建())
.方法(“职位”,身体)
.addHeader(“内容类型”,“application / json”)
.addHeader(“授权”,凭证.基本(“电子邮件”,“你的密码”))
.构建();
响应响应=客户端.newCall(请求).执行();
Nodejs
varaxios=需要(“axios”);
var数据=JSON.stringify({
“事件”:{
“created_at”:“2020 - 01 - 31 - t00:44:07 + 00:00”,
“描述”:“完成”,
“属性”:{
“账单”:{
“address1”:“市场街1019号”,
“城市”:“旧金山”,
“状态”:“CA”,
“zipcode”:“94103”
},
“项目”:{
“名称”:“亚博Zendesk赃物”
}
},
“源”:“shoppingnow”,
“类型”:“签出”
},
“配置文件”:{
“标识符”:[
{
“类型”:“电子邮件”,
“价值”:"(电子邮件保护)"
},
{
“类型”:“external_id”,
“价值”:“0987654321”
}
],
“名称”:“简·史密斯”,
“源”:“shoppingnow”,
“类型”:“客户”
}
});
var配置={
方法:“职位”,
url:“https://support.亚博zendesk.com/api/v2/user_profiles/events”,
头:{
“内容类型”:“application / json”,
“授权”:的基本< auth-value >”,// Base64编码的"username:password"
},
数据:数据,
};
axios(配置)
.然后(函数(响应){
控制台.日志(JSON.stringify(响应.数据));
})
.抓(函数(错误){
控制台.日志(错误);
});
Python
进口请求
进口json
url=“https://support.亚博zendesk.com/api/v2/user_profiles/events”
有效载荷=json.加载(”““{
"事件":{
“created_at”:“2020 - 01 - 31 - t00:44:07 + 00:00”,
"description": "订单完成",
"属性":{
“账单”:{
地址1:市场街1019号
"city": "San Francisco",
“状态”:“CA”,
“zipcode”:“94103”
},
"项目":{
"name": "亚博Zendesk Swag"
}
},
“源”:“shoppingnow”,
“类型”:“结帐”
},
“简介”:{
“标识符”:[
{
“类型”:“电子邮件”,
“价值”:“(电子邮件保护)"
},
{
“类型”:“external_id”,
“价值”:“0987654321”
}
],
“姓名”:“简·史密斯”,
“源”:“shoppingnow”,
“类型”:“客户”
}
}”“”)
头={
“内容类型”:“application / json”,
}
响应=请求.请求(
“职位”,
url,
身份验证=(“<用户名>”,' <密码> '),
头=头,
json=有效载荷
)
打印(响应.文本)
鲁比(人名)
需要“net/http”
uri=URI(“https://support.亚博zendesk.com/api/v2/user_profiles/events”)
请求=网::HTTP::帖子.新(uri,“内容类型”:“application / json”)
请求.身体=%问({
“事件”:{
“created_at”:“2020 - 01 - 31 - t00:44:07 + 00:00”,
“描述”:“完成”,
“属性”:{
“账单”:{
“address1”:“市场街1019号”,
“城市”:“旧金山”,
“状态”:“CA”,
“zipcode”:“94103”
},
“项目”:{
“名称”:“亚博Zendesk赃物”
}
},
“源”:“shoppingnow”,
“类型”:“签出”
},
“配置文件”:{
“标识符”:[
{
“类型”:“电子邮件”,
“价值”:"(电子邮件保护)"
},
{
“类型”:“external_id”,
“价值”:“0987654321”
}
],
“名称”:“简·史密斯”,
“源”:“shoppingnow”,
“类型”:“客户”
}
})
请求.basic_auth“用户名”,“密码”
响应=网::HTTP.开始uri.主机名,uri.港口,use_ssl:真正的做|http|
http.请求(请求)
结束
示例响应(年代)
202年接受
//状态202已接受
{
“profile_id”:“01 e1dpyaa7hw7645kmjey9cxrj”,
“状态”:“收到”,
“user_id”:“123456”
}
400错误请求
//状态400错误请求
{
“错误”:[
{
“代码”:“StartTimestampNotValid”,
“id”:“c21d8981 - 8940 - 419 - b - 907 - b - 7 - f7a2ba22cca”,
“标题”:"开始时间戳无效"
}
]
}
通过配置文件ID跟踪针对Sunshine配置文件的事件
POST / api / v2 / user_profiles / {profile_id} /事件
根据给定的Sunshine配置文件存储一个事件。如果概要文件不存在,它将返回一个错误。
允许
- 代理
访问还取决于设置的代理角色权限支持>人>角色>人.
参数
的名字 | 类型 | 在 | 要求 | 描述 |
---|---|---|---|---|
profile_id | 字符串 | 路径 | 真正的 | 阳光档案ID |
例子的身体
{
“事件”:{
“created_at”:“2020 - 01 - 31 - t00:44:07 + 00:00”,
“描述”:“完成”,
“属性”:{
“账单”:{
“address1”:“市场街1019号”,
“城市”:“旧金山”,
“状态”:“CA”,
“zipcode”:“94103”
},
“项目”:{
“名称”:“亚博Zendesk赃物”
}
},
“源”:“shoppingnow”,
“类型”:“签出”
}
}
代码示例
旋度
旋度“https://{子域名}.zendes亚博k.com/api/v2/user_profiles/ {profile_id} /事件”\
- d{“配置文件”:{“名称”:“简·史密斯”,“源”:“shoppingnow”,“类型”:“客户”,“标识符”:[{“类型”:“电子邮件”,“价值”:"(电子邮件保护)"},{“类型”:“external_id”,“价值”:“0987654321”}]},“事件”:{“源”:“shoppingnow”,“类型”:“签出”,“描述”:“完成”,“created_at”:“2020 - 01 - 31 - t00:44:07.000z”,“属性”:{“项目”:{“名称”:“亚博Zendesk赃物”},“账单”:{“address1”:“市场街1019号”,“城市”:“旧金山”,“状态”:“CA”,“zipcode”:“94103”}}}}\
- h“application / json内容类型:\
- u{email_address}:{密码}
去
进口(
“fmt”
“输入输出”
“net/http”
“弦”
)
函数主要(){
url: =“https://support.亚博zendesk.com/api/v2/user_profiles//events”
方法: =“职位”
有效载荷: =字符串.NewReader(”{
"事件":{
“created_at”:“2020 - 01 - 31 - t00:44:07 + 00:00”,
"description": "订单完成",
"属性":{
“账单”:{
地址1:市场街1019号
"city": "San Francisco",
“状态”:“CA”,
“zipcode”:“94103”
},
"项目":{
"name": "亚博Zendesk Swag"
}
},
“源”:“shoppingnow”,
“类型”:“结帐”
}
} ')
要求的事情,犯错: =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/user_profiles//events”)
.newBuilder();
RequestBody身体=RequestBody.创建(MediaType.解析(“application / json”),
"""
{
\ \”事件”:{
created_at \“\”:\”2020-01-31T00:44:07+00:00\”,
\ \“描述”:\”订单完成\”,
\ \“属性”:{
\“计费\”:{
address1 \“\”:\”1019市场圣\”,
\“\”:\”圣旧金山\”,
\“\”:\”CA\”,
\ " zipcode \”:\”94103\”
},
\ \“项目”:{
\“\”:\”亚博赃物\”
}
},
\ \“来源”:shoppingnow \“\”,
\”类型\”:\“结帐\”
}
}""");
请求请求=新请求.构建器()
.url(urlBuilder.构建())
.方法(“职位”,身体)
.addHeader(“内容类型”,“application / json”)
.addHeader(“授权”,凭证.基本(“电子邮件”,“你的密码”))
.构建();
响应响应=客户端.newCall(请求).执行();
Nodejs
varaxios=需要(“axios”);
var数据=JSON.stringify({
“事件”:{
“created_at”:“2020 - 01 - 31 - t00:44:07 + 00:00”,
“描述”:“完成”,
“属性”:{
“账单”:{
“address1”:“市场街1019号”,
“城市”:“旧金山”,
“状态”:“CA”,
“zipcode”:“94103”
},
“项目”:{
“名称”:“亚博Zendesk赃物”
}
},
“源”:“shoppingnow”,
“类型”:“签出”
}
});
var配置={
方法:“职位”,
url:“https://support.亚博zendesk.com/api/v2/user_profiles//events”,
头:{
“内容类型”:“application / json”,
“授权”:的基本< auth-value >”,// Base64编码的"username:password"
},
数据:数据,
};
axios(配置)
.然后(函数(响应){
控制台.日志(JSON.stringify(响应.数据));
})
.抓(函数(错误){
控制台.日志(错误);
});
Python
进口请求
进口json
url=“https://support.亚博zendesk.com/api/v2/user_profiles//events”
有效载荷=json.加载(”““{
"事件":{
“created_at”:“2020 - 01 - 31 - t00:44:07 + 00:00”,
"description": "订单完成",
"属性":{
“账单”:{
地址1:市场街1019号
"city": "San Francisco",
“状态”:“CA”,
“zipcode”:“94103”
},
"项目":{
"name": "亚博Zendesk Swag"
}
},
“源”:“shoppingnow”,
“类型”:“结帐”
}
}”“”)
头={
“内容类型”:“application / json”,
}
响应=请求.请求(
“职位”,
url,
身份验证=(“<用户名>”,' <密码> '),
头=头,
json=有效载荷
)
打印(响应.文本)
鲁比(人名)
需要“net/http”
uri=URI(“https://support.亚博zendesk.com/api/v2/user_profiles//events”)
请求=网::HTTP::帖子.新(uri,“内容类型”:“application / json”)
请求.身体=%问({
“事件”:{
“created_at”:“2020 - 01 - 31 - t00:44:07 + 00:00”,
“描述”:“完成”,
“属性”:{
“账单”:{
“address1”:“市场街1019号”,
“城市”:“旧金山”,
“状态”:“CA”,
“zipcode”:“94103”
},
“项目”:{
“名称”:“亚博Zendesk赃物”
}
},
“源”:“shoppingnow”,
“类型”:“签出”
}
})
请求.basic_auth“用户名”,“密码”
响应=网::HTTP.开始uri.主机名,uri.港口,use_ssl:真正的做|http|
http.请求(请求)
结束
示例响应(年代)
202年接受
//状态202已接受
{
“profile_id”:“01 e1dpyaa7hw7645kmjey9cxrj”,
“状态”:“收到”,
“user_id”:“123456”
}
400错误请求
//状态400错误请求
{
“错误”:[
{
“代码”:“StartTimestampNotValid”,
“id”:“c21d8981 - 8940 - 419 - b - 907 - b - 7 - f7a2ba22cca”,
“标题”:"开始时间戳无效"
}
]
}
404未找到
//状态404 Not Found
{
“错误”:[
{
“代码”:“StartTimestampNotValid”,
“id”:“c21d8981 - 8940 - 419 - b - 907 - b - 7 - f7a2ba22cca”,
“标题”:"开始时间戳无效"
}
]
}