第三方应用开发 服务端API 数据分析专区 概述
概述
最后更新:2024/03/08
可联系渠道经理采购或代理智慧硬件接口已支持设备 联系渠道经理
概述
最后更新:2024/03/08

目录

  • 接入指引
  • 数据分析专区接口
  • 接口调用流程
  • 数据分析专区限制
  • 安全规范说明
  • 服务商基于会话内容实现的产品功能中,有部分为对消息内容的AI分析。针对该部分功能,企业微信提供了数据分析专区的方案,服务商可将代码打包成镜像部署到企业微信的数据分析专区,数据分析专区与外界网络隔离,只能通过专属网络访问专区接口,以拉取消息内容到专区服务上进行分析。既保证服务商功能的完整性,同时保证数据的安全性。数据分析专区整体架构如下图所示:

    enter image description here

    接入指引

    合作伙伴可按照以下流程接入:

    1. 接入会话存档接口授权:参考会话存档接口授权接入指引。

    2. 镜像管理:在「服务商后台-应用管理-开发配置-会话存档接口授权-数据分析专区」或「桌面端服务商助手-工具-通用配置-开发配置-会话存档接口授权-数据分析专区」前往导入镜像,并可查看镜像的系统监控与运行日志。

    3. 接入数据分析专区接口:合作伙伴在产品中接入「数据分析专区接口」,实现对应产品功能,详细接口列表及介绍详见「数据分析专区接口」。

    数据分析专区接口

    数据分析专区接口包含任务管理以及专区接口,其中任务管理接口由服务商后台调用,专区接口由专区调用。接口列表如下:

    序号接口接口描述调用来源
    1创建任务由服务商后台调用,创建专区执行的任务● 服务商后台
    2获取任务结果由服务商后台调用,获取专区任务执行状态以及结果● 服务商后台
    3获取数据分析专区接口调用凭证通过专区secret获取专区专用access_token● 数据分析专区
    4轮训获取任务轮训到未执行的任务● 数据分析专区
    5执行任务以及上报进度或结果上报任务执行进度以及结果● 数据分析专区
    6拉取消息拉取消息明文内容● 数据分析专区
    7下载消息素材下载多媒体资源内容● 数据分析专区

    接口调用流程

    数据分析专区接口调用流程如下图所示:
    enter image description here

    步骤1.1 获取数据分析专区接口调用凭证 接口中的secret可由服务商管理端「数据分析专区」- 「镜像管理」中查看
    enter image description here

    步骤2.1 创建任务 时可指定需要分析的消息列表,该列表可通过会话存档接口授权中的 获取会话记录 接口获取。

     

    数据分析专区限制

    ● 网络限制
    专区内的服务只能访问专用的接口服务

    ● 资源和权限限制
    挂载的文件只读、独立的本地CBS磁盘(目前处于免费试用阶段,旨在供服务商调通功能,故机器资源相对有限)

    ● 日志限制
    服务执行日志直接打到标准输出,专区框架层自动收集。每个小时一个日志文件,单个日志文件不超过1G,若达到1G的上限,后续的日志将被丢弃,直到下一个小时才生成新的文件。
    日志格式:
    任务id,时间,程序文件名,程序行号,错误码

    日志字段说明长度限制(字节)
    任务id轮询任务拿到的jobid,非法丢弃该行日志-
    时间仅支持格式2024-01-01 10:00:01,非法丢弃该行日志-
    程序文件名支持格式:^[A-Za-z0-9/]{0,1}[A-Za-z0-9-+_/.]{0,127}[A-Za-z0-9]$ ,否则替换为"invalid file name"128
    程序行号仅支持正整数,否则替换为*10
    错误码仅支持数字,支持负数,否则替换为*10

     

    ● 分析结果限制
    任务输出的结果要指定任务类型,并且任务结果输出json格式必须跟任务类型登记的协议一致。json中每个字段长度限制为10个字节,结果总大小上限为10*任务中消息条数个字节(目前最大为10K个字节),若超过该长度则会报错。
    enter image description here

    安全规范说明

    不允许在分析结果和日志里,以任何形式(明文或编码)输出用户的消息内容,否则将限制服务商数据分析专区使用以及可能承担相应法律责任。

    上一篇
    命中关键词规则通知
    下一篇
    导入镜像指引