消息渠道接入

更新时间:
复制为 MD 格式

本文介绍JVS Crew支持的消息渠道的具体接入方法。

钉钉接入

创建钉钉应用

  1. 前往钉钉开放平台

    说明
    • 需选择具备开发者权限的组织,或者选择某个组织后选择获取开发者权限

    • 如果没有合适的组织,可使用移动端钉钉扫描下方二维码,快速创建一个组织。image

  2. 点击顶部导航栏应用开发,在钉钉应用页面点击创建应用

  3. 选择左侧导航栏的凭证与基础信息,查看并记录Client ID 以及Client Secret

  4. 返回JVS Crew消息渠道页面。

  5. 开启钉钉卡片下方立即接入,将复制的Client IDClient Secret分别填入App IDApp Secret中。

创建钉钉机器人

  1. 应用创建完毕后在左侧导航栏选择添加应用能力,点击右侧机器人卡片下方添加按钮。

  2. 在机器人配置页面,开启机器人配置

  3. 消息接收模式选择Stream模式,并点击发布完成对机器人的配置。

  4. 选择左侧导航栏的版本管理与发布,并点击创建新版本

  5. 完成配置后点击下方的保存完成版本的发布。

(可选)创建消息卡片

钉钉机器人通过卡片消息支持流式返回结果,需要创建卡片模板供消息发送使用。

  1. 前往卡片平台,点击新建模板

  2. 在创建模板输入框,根据以下信息创建模板。

    • 卡片类型:选择消息卡片

    • 卡片模板场景:选择AI卡片

    • 关联应用:填入先前步骤创建的应用名称。

  3. 在卡片编辑页面右上角点击保存,然后单击发布

  4. 复制卡片ID并填入钉钉卡片的Card Template ID中。

发布应用

应用发布后,企业员工方可搜索并使用。

  1. 返回应用列表,选择目标应用,进入目标详情页。

  2. 权限管理中开通Card.Streaming.WriteCard.Instance.Writeqyapi_robot_sendmsg三个权限。

  3. 在左侧菜单中选中版本管理与发布,并点击创建新版本

  4. 在版本详情中,填写应用版本号版本描述,并选择应用的可用范围,最后单击保存即可。

    说明

    在选择应用可用范围时,请根据业务实际需求选择可见范围,若选择全部员工,则当应用发布后当前企业下所有的员工都可见。

接入验证

在群聊中与机器人对话

  1. 打开钉钉客户端,进入任意群聊。

    • 如果已有群聊,需要确保群归属组织与创建机器人时的组织相同。

    • 创建新的群聊,请确保创建时候选择的归属组织与创建机器人时的组织相同。

  2. 单击群设置(右上角),进入群设置,然后选择机器人

  3. 在机器人管理模块下,选择添加机器人

  4. 在添加机器人界面,通过搜索已经创建并发布的机器人,点击机器人进行添加即可。

  5. 机器人添加成功后,通过@机器人,实现自动回复。

与机器人直接对话

  1. 在钉钉顶部搜索框中搜索已创建机器人名称直接使用。

  2. 发送消息与机器人进行单独对话。

飞书接入

创建飞书应用

  1. 访问 飞书开放平台,点击右上角开发者后台

  2. 点击创建企业自建应用,填写必要信息并点击创建

  3. 在应用的凭证与基础信息页面,复制App ID(格式如cli_xxx)和App Secret。

  4. 返回JVS Crew消息渠道页面。

  5. 开启飞书卡片下方立即接入,填入App ID以及App Secret

配置飞书应用及机器人

添加并配置机器人

  1. 在左侧导航栏选择添加应用能力,点击机器人卡片的添加按钮。

  2. 点击机器人配置卡片如何开始使用右侧编辑图标。

  3. 消息卡片回调请求方式区域点击去配置

  4. 订阅方式选择使用长连接接收回调保存配置。

  5. 点击事件配置,订阅方式同样选择使用长连接接收回调保存配置。

  6. 事件配置页面添加如下四个事件并保存

    • 机器人进群

    • 机器人被移出群

    • 消息已读

    • 接收消息

配置应用权限

  1. 点击权限管理>开通权限,单击批量导入/导出权限按钮。

  2. 粘贴以下JSON 配置一键导入所需权限,单击下一步,确认新增权限按钮。

    {
      "scopes": {
        "tenant": [
          "contact:contact.base:readonly",
          "docx:document:readonly",
          "im:chat:read",
          "im:chat:update",
          "im:message.group_at_msg:readonly",
          "im:message.p2p_msg:readonly",
          "im:message.pins:read",
          "im:message.pins:write_only",
          "im:message.reactions:read",
          "im:message.reactions:write_only",
          "im:message:readonly",
          "im:message:recall",
          "im:message:send_as_bot",
          "im:message:send_multi_users",
          "im:message:send_sys_msg",
          "im:message:update",
          "im:resource",
          "application:application:self_manage",
          "cardkit:card:write",
          "cardkit:card:read"
        ],
        "user": [
          "contact:user.employee_id:readonly",
          "offline_access",
          "base:app:copy",
          "base:field:create",
          "base:field:delete",
          "base:field:read",
          "base:field:update",
          "base:record:create",
          "base:record:delete",
          "base:record:retrieve",
          "base:record:update",
          "base:table:create",
          "base:table:delete",
          "base:table:read",
          "base:table:update",
          "base:view:read",
          "base:view:write_only",
          "base:app:create",
          "base:app:update",
          "base:app:read",
          "board:whiteboard:node:create",
          "board:whiteboard:node:read",
          "calendar:calendar:read",
          "calendar:calendar.event:create",
          "calendar:calendar.event:delete",
          "calendar:calendar.event:read",
          "calendar:calendar.event:reply",
          "calendar:calendar.event:update",
          "calendar:calendar.free_busy:read",
          "contact:contact.base:readonly",
          "contact:user.base:readonly",
          "contact:user:search",
          "docs:document.comment:create",
          "docs:document.comment:read",
          "docs:document.comment:update",
          "docs:document.media:download",
          "docs:document:copy",
          "docx:document:create",
          "docx:document:readonly",
          "docx:document:write_only",
          "drive:drive.metadata:readonly",
          "drive:file:download",
          "drive:file:upload",
          "im:chat.members:read",
          "im:chat:read",
          "im:message",
          "im:message.group_msg:get_as_user",
          "im:message.p2p_msg:get_as_user",
          "im:message:readonly",
          "search:docs:read",
          "search:message",
          "space:document:delete",
          "space:document:move",
          "space:document:retrieve",
          "task:comment:read",
          "task:comment:write",
          "task:task:read",
          "task:task:write",
          "task:task:writeonly",
          "task:tasklist:read",
          "task:tasklist:write",
          "wiki:node:copy",
          "wiki:node:create",
          "wiki:node:move",
          "wiki:node:read",
          "wiki:node:retrieve",
          "wiki:space:read",
          "wiki:space:retrieve",
          "wiki:space:write_only"
        ]
      }
    }
  3. 在弹窗中确认权限无误后,单击申请开通按钮,完成操作。

发布应用

  1. 在左侧导航栏选择版本管理与发布。

  2. 点击创建版本,填写必要信息后点击保存

接入验证

  1. 在飞书中找到创建的机器人。

  2. 向机器人发送任务指令。

QQ接入

创建QQ机器人

  1. 登录QQ开放平台官网,注册账号并绑定QQ账号。

    重要

    不要直接使用QQ账号登录,需先注册账户并完成QQ绑定。

  2. 点击创建机器人,完成机器人信息填写并点击确定

配置机器人认证信息

  1. 在机器人首页点击管理>开发管理

  2. 复制AppID以及AppSecret

  3. 返回JVS Crew消息渠道页面。

  4. 开启QQ卡片下方立即接入,填入AppID以及AppSecret

完成沙箱配置

  1. 在机器人首页点击开发>沙箱配置。

  2. 选择在消息列表配置,点击左侧添加成员。

接入验证

  1. 添加成员完毕后,点击二维码按钮,并扫描弹出的二维码。

  2. 返回手机QQ后,即可与机器人进行对话。

企业微信接入

配置智能机器人

  1. 访问企业微信管理后台,在左侧导航栏单击安全与管理>管理工具。单击创建机器人,然后单击手动创建

  2. 配置机器人可见范围

  3. 下拉到页面底部单击API模式创建

  4. 连接方式选择使用长连接

  5. 配置方法Secret区域单击点击获取保存Bot IDSecret

  6. 返回JVS Crew消息渠道页面。

  7. 单击企业微信卡片下方立即接入,填入Bot IDSecret

接入验证

  1. 在群聊中添加群成员,然后选择智能机器人。

  2. 搜索创建完成的机器人名称加入群聊。

  3. 在已添加机器人的群中@机器人,向机器人下发指令。