Channelback允许在Zendesk Support工作的座席回复来自源亚博服务的评论,并将回复显示在源服务中。例如,在Instagram集成中,代理的回复将显示为Instagram照片的附加评论。

要启用该特性,必须构建一个channelback端点,并在属性中指定其url集成清单.例子:

             
“url”{“channelback_url”“https://omniwear.com/integrations/instagram/channelback”

亚博Zendesk Support将使用代理的回复向端点发出POST请求。端点必须实现本文档中描述的请求和响应格式。您的端点负责创建外部资源——例如,用于在Instagram上发布代理的评论。

请求格式

亚博Zendesk Support以url编码的表单POST格式发出POST请求,并将以下信息发送到channelback_url在集成清单中指定的端点。

名字 类型 最大字符 评论
消息 字符串 65535 代理人的回答
parent_id 字符串 511 描述一种“回复”关系。作为响应的外部资源的唯一ID
recipient_id 字符串 255 在原始服务中应该接收此消息的用户的唯一标识符。如果在Zendesk中编辑了票请求者,则可能为空。亚博
元数据 字符串 5000 关于集成实例的字符串化数据。看到元数据和状态
request_unique_identifier 字符串 255 此请求的唯一标识符。如果Z亚博endesk由于网络错误需要重制请求,它将包含相同的request_unique_identifier。
file_urls 数组 指向Zendesk回复的文件附件的url数组。亚博文件可以使用推送访问令牌.只有在清单显示支持时才相关channelback文件
thread_id 字符串 511 此项目所属线程的任意标识符。看到对话线程

例子

             
file_urls5B5Dhttps3.一个2F2Fendgames亚博com2Fattachments2Ftoken2FABCD12342F3.3.Dlenspng消息+检查+你的+相机+镜头元数据7B22instagram_username223.一个22endgames_improv222C22instagram_oauth_token223.一个22xyzabc222C22last_message_id223.一个2220151210093200-227Dparent_id20151210093000-recipient_idb3489request_unique_identifier30624700-发球直接得分-4069--534202139424thread_id234

解码字符串:

             
file_urls(https//结局亚博com/附件/令牌/这样的/名字镜头png消息检查你的相机镜头元数据{“instagram_username”“endgames_improv”“instagram_oauth_token”“xyzabc”“last_message_id”“20151210093200本”parent_id20151210093000-recipient_idb3489request_unique_identifier30624700-发球直接得分-4069--534202139424thread_id234

响应格式

如果您的端点成功创建了外部资源,则发送一个HTTP状态为200的响应和一个包含新创建资源的外部id的JSON对象。亚博Zendesk Support使用外部id来防止重复的评论。

名字 类型 最大字符 强制性的 评论
external_id 字符串 511 是的 所创建的外部资源的唯一标识符(字符串)
allow_channelback 布尔 没有 如果,阻止座席在Zendesk Support界面上对消息进行额外评论亚博
metadata_needs_update 布尔 没有 是否应该要求Zende亚博sk Support管理员重新访问集成帐户的UI以重置元数据?
元数据 字符串 5000 没有 关于集成实例的字符串化数据。看到元数据和状态

例子

             
200好吧{“external_id”“20151210123400 - omniwear”“allow_channelback”

报告信道返回错误

当您的端点无法正确处理通道回传POST时,您应该使用500-599范围内的HTTP状态码进行响应。亚博Zendesk Support识别这些响应,并通知Zendesk用户有关问题。

如果您的端点接受POST并返回一个200 HTTP状态码,但是您随后发现无法实现Channelback响应,则可以调用信道返回错误端点报告异常。您应该使用与调用推送端点相同的访问令牌。看到获取访问令牌

无效的请求

通道返回错误端点使用通道框架模式.发送错误类型的JSON值将导致400 Bad Request响应。

             
POST / api / v2 / any_channel / channelback / report_error。json HTTP / 1.1主持人:sample.ze亚博ndesk.com内容类型:application / jsonHTTP / 1.1400坏的请求{“错误”{“消息”("模式文件//bundle/gems/any_channel_json_schemas-0.4.0/json_schemas/report_channelback_error.json#中属性'#没有包含必需的'instance_push_id'属性"