配置Stream推送

更新于 2023-10-18
Stream 模式是钉钉开放平台推荐使用的事件订阅方式，使用 Stream 模式开发者无需提供公网回调地址和注册加解密秘钥，使用 SDK 接入服务端Stream模式，开发者应用程序即可接收到事件内容推送。

使用场景

在你的业务对数据的实时性要求较高时。例如：在新员工入职或者离职，部门变更，需要应用第一时间变更用户数据，此时就可以订阅通讯录事件

你的应用需要及时响应用户的操作时。例如：某用户加入某群聊时，应用可以订阅群变更事件，在用户进入群聊的时候，向用户发送欢迎等信息。

以上只是几个非常简单的使用场景，开发者可以根据不同的事件，进行不同的处理。

准备工作

拥有所在钉钉组织的开发者权限。

拥有所在钉钉组织的企业内部应用。

拥有访问公网的运行环境。

订阅流程

1. 选择Stream模式推送。

2.服务端接入

2.1 JAVA语言

添加依赖项到工程的pom.xml文件或下载对应的jar包，最新的 SDK 版本可以在这里查看和下载。

<dependency>
  <groupId>com.dingtalk.open</groupId>
  <artifactId>app-stream-client</artifactId>
  <version>{sdk-version}</version>
</dependency>

代码示例

2.2 Golang语言

安装Stream SDK

代码示例

参数说明：

参数名	说明
clientId	企业内部应用 AppKey/第三方企业应用 SuiteKey。
clientSecret	企业内部应用AppSecret/第三方企业应用 SuiteSecret。

3. 验证连接通道

后端服务启动验证通道连通性

点击保存，设置需要监听的事件。

回调事件说明

点击查看详细说明

数据说明

Stream模式推送数据分为两个部分，一个部分为事件的基础信息，另一个部分为事件业务数据信息。以通讯录用户更改事件为例：

说明：
Stream模式推送格式是以小驼峰的命名方式对数据进行推送的。

  "eventBornTime": 1684467623381,
  "eventCorpId": "ding9f5*******41",
  "eventId": "e7ee3e9beeb54704bdaf34db6edfc79d",
  "eventType": "user_modify_org",
  "eventUnifiedAppId": "unifiedAppId1"
  "data": { //事件业务信息部分
    "timeStamp": "168****362",
    "diffInfo": [
      {
        "prev": {
          "extFields": "{}",
          "name": "小钉",
          "telephone": "1135",
          "remark": "",
          "workPlace": "",
          "jobNumber": "01053590",
          "email": ""
        },
        "curr": {
          "extFields": "{}",
          "name": "小钉",
          "telephone": "1135",
          "remark": "",
          "workPlace": "",
          "jobNumber": "",
          "email": ""
        },
        "userid": "014728xxx40768602"
      }
    ],
    "optStaffId": "45252xxxx39877041",
    "userId": [
      "014728xxx8602"
    ]
  }
}

钉钉Stream回调

配置Stream推送#

使用场景#

准备工作#

订阅流程#

2.1 JAVA语言#

代码示例#

2.2 Golang语言#

代码示例#

3. 验证连接通道#

回调事件说明#

数据说明#

配置Stream推送

使用场景

准备工作

订阅流程

2.1 JAVA语言

代码示例

2.2 Golang语言

代码示例

3. 验证连接通道

回调事件说明

数据说明