文档 API参考

亚博阳光中的Zendesk事件

重要的: Zend亚博esk在Sunshine中的支持、交谈和聚会活动已进入早期访问阶段。他们在管理中心下激活人>配置>事件设置．这可能会发生变化，不应该在生产环境中使用。

事件是对已经发生的活动的描述，例如当用户名被更改时，或者当创建支持请求时。Zendesk产品中的事件都亚博可以在Sunshine中使用。方法可以检索它们事件API，或在客户上下文中查看亚博Zendesk Agent工作区．

支持事件

下表列出了通过Sunshine事件发出的受支持Zendesk事件。亚博有关事件的详细信息和示例，请参阅下面的部分。

事件类型 亚博Zendesk产品 描述 可用性
page_view sdk 查看了安装Web小部件或SDK的页面 遗传算法
answers_suggested 指南 在创建支持请求时建议给用户的文章数 遗传算法
article_instant_search_result_clicked 指南 文章链接在帮助中心下拉搜索结果中被点击 遗传算法
article_search_result_clicked 指南 文章链接在帮助中心搜索结果中被点击 遗传算法
article_viewed 指南 查看帮助中心文章 遗传算法
help_center_searched 指南 用户使用搜索栏搜索帮助中心 遗传算法
suggested_article_clicked 指南 向用户建议的文章在提交支持请求时被单击 遗传算法
article_subscribed 指南 用户订阅了一篇文章 遗传算法
article_vote_added 指南 一个用户为一篇文章添加了投票 遗传算法
article_comment_created 指南 用户为文章添加了评论 遗传算法
community_post_viewed 收集 查看了一个社区职位 遗传算法
community_search_result_clicked 收集 点击社区帖子搜索结果 遗传算法
community_post_created 收集 创建了一个社区职位 遗传算法
community_post_vote_added 收集 一名用户为社区帖子添加了投票 遗传算法
community_post_subscribed 收集 用户订阅了社区帖子 遗传算法
community_comment_created 收集 一个用户为社区帖子添加了一条评论 遗传算法
community_comment_vote_added 收集 一名用户为社区帖子评论添加了投票 遗传算法
identity_created 支持 日志含义向用户添加新的标识符 遗传算法
identity_changed 支持 日志含义更新用户标识符 遗传算法
name_changed 支持 日志含义更新用户名 遗传算法
details_changed 支持 一个用户的详细信息被更新 遗传算法
notes_changed 支持 日志含义更新用户笔记 遗传算法
organization_added 支持 完成向用户添加组织 遗传算法
organization_removed 支持 从用户中删除组织 遗传算法
user_merged 支持 用户与其他用户合并 遗传算法
user_suspension_changed 支持 用户挂起 遗传算法
ticket_requested 支持 请求支持票 遗传算法
ticket_requester_changed 支持 更改了票据请求者 遗传算法

SDK事件

页面查看

查看了安装Web小部件或SDK的页面。页面视图显示给代理客户上下文面板Zend亚博esk即时通讯客户。

例子

             

              
状态200 OK

             
             

              
｛“id”：“01 fy8j3d3x6gwkgr9m14pp6d1q”，“类型”：“page_view”，“源”：“亚博zendesk”，“描述”：＂＂，“created_at”：“2022 - 03 - 16 - t05:09:39.328z”，“received_at”：“2022 - 03 - 16 - t05:09:39.593225847z”，“属性”：｛“通道”：“web_messenger”，“device_id”：“7 e124a8b13a24635881812ah6f5188ce”，“referrer”：“https://some-website.com/en-us/articles/How-do-I-publish-my-content”，“session_id”：“2 e40d024khsa498b81452a70bb693b1e9”，“标题”：“这些部分是什么?”，“url”：“https://some-website.com/en-us/articles/5179514369534-What-are-these-sections”，“user_agent”：“Mozilla / 5.0(麦金塔电脑;Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/99.0.4844.51 Safari/537.36"｝｝

事件中包含以下唯一属性属性对象:

  • 通道—事件发生的通道。取值为mobile_sdk, web_widget, support_sdk或web_messenger
  • device_id—终端用户设备的标识符
  • 介绍人的值HTTP Referer报头在查看的页面上(如果设置)
  • session_id-用户浏览会话的唯一标识符。当浏览器选项卡关闭或30分钟不活动后，这将被重置，以先发生的为准。
  • 标题-所浏览页面的标题
  • url—所浏览页面的URL
  • user_agent的值用户代理头，这是用户浏览器的标识符。

亚博Zendesk指南活动

答案建议

当用户提交新的支持请求时，文章建议。支持请求主题字段用于查询建议的文章。

例子

             

              
｛“id”：“01 eadx8zhnc53ncwv38rwpmpjq”，“类型”：“answers_suggested”，“源”：“亚博zendesk”，“描述”：＂＂，“created_at”：“2020 - 06 - 10 t01:24:53.941314392z”，“received_at”：“2020 - 06 - 10 t01:24:58.143324138z”，“属性”：｛“result_count”：5，“search_query”：“帮助”｝｝

事件中包含以下唯一属性属性对象:

  • result_count-在提交新的支持请求时建议给用户的文章数量
  • search_query—用于提供建议文章的查询

文章即时搜索结果点击

用户在帮助中心页面的即时搜索结果下拉菜单中单击文章链接。

例子

             

              
｛“id”：“01 eagbs4mpc53ncwv38rwpmpjq”，“类型”：“article_instant_search_result_clicked”，“源”：“亚博zendesk”，“描述”：＂＂，“created_at”：“2020 - 06 - 11 t00:16:52.374269872z”，“received_at”：“2020 - 06 - 11 t00:16:54.973520585z”，“属性”：｛“article_id”：360044308092，“文章”：｛“display_name”：“退款选项”，“url”：“url”｝，“场所”：“en - us”｝｝

事件中包含以下唯一属性属性对象:

  • article_id—帮助中心文章标识符
  • article.display_name-帮助中心文章标题
  • article.url-帮助中心文章的URL
  • 语言环境-用于查看文章的语言

点击文章搜索结果

用户点击了出现在帮助中心搜索结果中的文章。

例子

             

              
｛“id”：“01 eadygjdkc53ncwv38rwpmpjq”，“类型”：“article_search_result_clicked”，“源”：“亚博zendesk”，“描述”：＂＂，“created_at”：“2020 - 06 - 10 t01:46:31.219738419z”，“received_at”：“2020 - 06 - 10 t01:46:40.114502688z”，“属性”：｛“article_id”：360043980132，“文章”：｛“display_name”：“退款选项”，“url”：“url”｝，“场所”：“en - us”｝｝

事件中包含以下唯一属性属性对象:

  • article_id—帮助中心文章标识符
  • article.display_name-帮助中心文章标题
  • article.url-帮助中心文章的URL
  • 语言环境-用于查看文章的语言

文章认为

用户查看了帮助中心文章。从帮助中心或移动SDK触发。

例子

             

              
｛“id”：“01 eadw2q2ac53ncwv38rwpmpjq”，“类型”：“article_viewed”，“源”：“亚博zendesk”，“描述”：＂＂，“created_at”：“2020 - 06 - 10 t01:04:00.074320469z”，“received_at”：“2020 - 06 - 10 t01:04:01.908815098z”，“属性”：｛“article_id”：360043980092，“文章”：｛“display_name”：“退款选项”，“url”：“url”｝，“场所”：“en - us”，“通道”：“help_center”｝｝

事件中包含以下唯一属性属性对象:

  • article_id—帮助中心文章标识符
  • article.display_name-帮助中心文章标题
  • article.url-帮助中心文章的URL
  • 语言环境-用于查看文章的语言
  • 通道—事件发生的通道。取值可以是help_center或support_sdk

搜索帮助中心

用户使用搜索字段搜索帮助中心。从帮助中心或移动SDK触发。

例子

             

              
｛“id”：“01 eadxrv4qc53ncwv38rwpmpjq”，“类型”：“help_center_searched”，“源”：“亚博zendesk”，“描述”：＂＂，“created_at”：“2020 - 06 - 10 t01:33:33.71951541z”，“received_at”：“2020 - 06 - 10 t01:33:41.173895146z”，“属性”：｛“result_count”：5，“search_query”：｛“场所”：“en - us”，“页面”：1，“页大小”：10，“查询”：“帮助”，“search_id”：“8 a8a5a55 df2c - 445 f - 9 - bdd eacff9bf83b9”，“通道”：“help_center”｝｝｝

事件中包含以下唯一属性属性对象:

  • result_count-搜索请求返回的文章数量。适用于帮助中心中的事件。

  • 搜索查询：

    • 语言环境—用户使用的语言
    • 页面-所浏览的页面。适用于帮助中心中的事件
    • 页大小—页面显示结果的个数。适用于帮助中心中的事件
    • 查询-输入查询
    • search_id—搜索查询的唯一标识符
    • 通道—事件发生的通道。取值可以是help_center或support_sdk

点击建议文章

用户在提交新的支持请求时单击了建议的文章。

例子

             

              
｛“id”：“01 eadx96yrc53ncwv38rwpmpjq”，“类型”：“suggested_article_clicked”，“源”：“亚博zendesk”，“描述”：＂＂，“created_at”：“2020 - 06 - 10 t01:25:01.528358417z”，“received_at”：“2020 - 06 - 10 t01:25:06.714429248z”，“属性”：｛“article_id”：360043980132，“文章”：｛“display_name”：“退款选项”，“url”：“url”｝，“场所”：“en - us”，｝｝

事件中包含以下唯一属性属性对象:

  • article_id—帮助中心文章标识符
  • article.display_name-帮助中心文章标题
  • article.url-帮助中心文章的URL
  • 语言环境-用于查看文章的语言

亚博Zendesk收集活动

浏览社区帖子

用户点击帮助中心的社区帖子。

例子

             

              
｛“id”：“01 eadz7fqrc53ncwv38rwpmpjq”，“类型”：“community_post_viewed”，“源”：“亚博zendesk”，“描述”：＂＂，“created_at”：“2020 - 06 - 10 t01:59:02.135901062z”，“received_at”：“2020 - 06 - 10 t01:59:07.029595427z”，“属性”：｛“community_post_id”：360067836832｝｝

事件中包含以下唯一属性属性对象:

  • community_post_id—团体帖子标识符

点击社区搜索结果

用户点击了出现在帮助中心搜索结果中的社区帖子。

例子

             

              
｛“id”：“01 eadz7epsc53ncwv38rwpmpjq”，“类型”：“community_search_result_clicked”，“源”：“亚博zendesk”，“描述”：＂＂，“created_at”：“2020 - 06 - 10 t01:59:01.08124078z”，“received_at”：“2020 - 06 - 10 t01:59:06.394860314z”，“属性”：｛“community_post_id”：360067836832｝｝

事件中包含以下唯一属性属性对象:

  • community_post_id—团体帖子标识符

亚博Zendesk支持活动

身份了

日志含义创建用户标识符。下面的示例显示用户的电话号码作为标识符。

例子

             

              
｛“id”：“01 eae0wqwzc9bmcd3469b76rj8”，“类型”：“identity_created”，“源”：“亚博zendesk”，“描述”：＂＂，“created_at”：“2020 - 06 - 10 t02:28:07z”，“received_at”：“2020 - 06 - 10 t02:28:07.201012928z”，“属性”：｛“identity_type”：“phone_number”，“价值”："0412 123 456"｝｝

事件中包含以下唯一属性属性对象:

  • identity_type—标识符类型。例如"phone_number"和"email"
  • 价值—当前分配的标识符值

身份的改变

日志含义更新用户标识符。下面的示例显示用户的电子邮件地址作为标识符。

例子

             

              
｛“id”：“01 eadvyaw4c9bmcd3469b76rj8”，“类型”：“identity_changed”，“源”：“亚博zendesk”，“描述”：＂＂，“created_at”：“2020 - 06 - 10 t01:01:36z”，“received_at”：“2020 - 06 - 10 t01:01:36.536097818z”，“属性”：｛“current_value”：＂(电子邮件保护)* * * *。com”，“identity_type”：“电子邮件”，“previous_value”：＂(电子邮件保护)* * * *。com”｝｝

事件中包含以下唯一属性属性对象:

  • current_value-之前分配的标识符值
  • identity_type—标识符类型。例如"phone_number"和"email"
  • previous_value—当前分配的标识符值

的名字改变了

用户名或代理更新了用户名。

例子

             

              
｛“id”：“01 e8xd4vk9c9bmcd3469b76rj8”，“类型”：“name_changed”，“源”：“亚博zendesk”，“描述”：＂＂，“created_at”：“2020 - 05 - 22 - t05:19:28z”，“received_at”：“2020 - 05 - 22 - t05:19:28.986762787z”，“属性”：｛“current_value”：“简·史密斯”，“previous_value”：“约翰·史密斯”｝｝

事件中包含以下唯一属性属性对象:

  • current_value—当前已分配的名称
  • previous_value—之前分配的名称

细节改变

一个用户的详细信息被更新。

例子

             

              
｛“id”：“01 e8xd4vk9c9bmcd3469b76rj8”，“类型”：“details_changed”，“源”：“亚博zendesk”，“描述”：＂＂，“created_at”：“2020 - 05 - 22 - t05:19:28z”，“received_at”：“2020 - 05 - 22 - t05:19:28.986762787z”，“属性”：｛“current_value”：“简·史密斯”，“previous_value”：“约翰·史密斯”｝｝

事件中包含以下唯一属性属性对象:

  • current_value-当前分配的详细信息
  • previous_value-之前分配的详细信息

指出了

日志含义更新用户笔记。

例子

             

              
｛“id”：“01 e8xd4vk9c9bmcd3469b76rj8”，“类型”：“notes_changed”，“源”：“亚博zendesk”，“描述”：＂＂，“created_at”：“2020 - 05 - 22 - t05:19:28z”，“received_at”：“2020 - 05 - 22 - t05:19:28.986762787z”，“属性”：｛“current_value”：“简·史密斯”，“previous_value”：“约翰·史密斯”｝｝

事件中包含以下唯一属性属性对象:

  • current_value-当前分配的票据
  • previous_value-以前分配的笔记

组织补充说

完成向用户添加组织

例子

             

              
｛“id”：“01 e8xd4vk9c9bmcd3469b76rj8”，“类型”：“organization_added”，“源”：“亚博zendesk”，“描述”：＂＂，“created_at”：“2020 - 05 - 22 - t05:19:28z”，“received_at”：“2020 - 05 - 22 - t05:19:28.986762787z”，“属性”：｛“组织”：“大公司”，｝｝

事件中包含以下唯一属性属性对象:

  • 组织—已添加到用户的组织

组织了

从用户中删除组织

例子

             

              
｛“id”：“01 e8xd4vk9c9bmcd3469b76rj8”，“类型”：“organization_removed”，“源”：“亚博zendesk”，“描述”：＂＂，“created_at”：“2020 - 05 - 22 - t05:19:28z”，“received_at”：“2020 - 05 - 22 - t05:19:28.986762787z”，“属性”：｛“组织”：“大公司”，｝｝

事件中包含以下唯一属性属性对象:

  • 组织—从用户中移除的组织

用户合并

用户与其他用户合并

例子

             

              
｛“id”：“01 e8xd4vk9c9bmcd3469b76rj8”，“类型”：“user_merged”，“源”：“亚博zendesk”，“描述”：＂＂，“created_at”：“2020 - 05 - 22 - t05:19:28z”，“received_at”：“2020 - 05 - 22 - t05:19:28.986762787z”，“属性”：｛“赢家”：“用户”，｝｝

事件中包含以下唯一属性属性对象:

  • 赢家—已被合并的用户。

用户暂停改变

用户与其他用户合并

例子

             

              
｛“id”：“01 e8xd4vk9c9bmcd3469b76rj8”，“类型”：“user_suspension_changed”，“源”：“亚博zendesk”，“描述”：＂＂，“created_at”：“2020 - 05 - 22 - t05:19:28z”，“received_at”：“2020 - 05 - 22 - t05:19:28.986762787z”，“属性”：｛“current_value”：“简·史密斯”，“previous_value”：“约翰·史密斯”｝｝

事件中包含以下唯一属性属性对象:

  • current_value—当前挂起状态
  • previous_value—之前的挂起状态