# 接收 Webhook 事件 (/zh-CN/realtime-media/cloud-recording/build/monitor-events/enable-ncs)

> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).

Webhook 是一种基于 HTTP 协议的回调机制，允许服务端主动推送数据。

声网的消息通知服务使用 Webhook 向你推送特定事件的通知，当你订阅的事件发生时，声网业务服务器会将事件消息发送给声网消息通知服务器，然后声网消息通知服务器会通过 HTTPS POST 请求将事件通知投递给你的服务器。消息通知服务已集成旁路推流、输入在线媒体流、云端录制、云端转码等业务下的一些事件。你可以向声网提供相关的配置信息来开通该服务。

<DocsImage alt="消息通知服务" src="https://web-cdn.agora.io/doc-cms/uploads/1727074548122-Webhook.png" displayWidth="80%" />

## 前提条件 [#前提条件]

如果你的网络环境部署了防火墙，请将声网消息通知服务器的 IP 地址添加到白名单，以正常使用声网消息通知服务。详见[查询消息通知服务器的 IP 地址](/zh-CN/api-reference/api-ref/cloud-recording/get-ncs-ip)。

## 开通消息通知服务 [#开通消息通知服务]

本节介绍如何在声网控制台开通消息通知服务并完成健康检查。

### 1. 开通并配置服务 [#1-开通并配置服务]

参考以下步骤开通并配置消息通知服务：

1. 登录[声网控制台](https://console.shengwang.cn/)，点击左侧导航栏的**全部产品** > **拓展能力** > **媒体服务**，选择**云端录制**。

2. 在**云端录制**页面，点击进入**功能配置**子页面，再切换到 **Webhook** 页签。

3. 在配置区域点击**新增事件**，然后在**新建 Webhook** 弹出框中填入以下信息，最后点击**保存**。
   - **消息接收区域**：你的消息通知接收服务器所在的区域。声网会根据你提供的区域就近接入声网节点服务器。
   - **消息接收 URL**：接收消息通知的 HTTPS 服务器地址。
   - **订阅事件**：需要订阅的频道事件。详见[消息通知事件类型](/zh-CN/realtime-media/cloud-recording/reference/ncs-events)。建议一次选择所有需要订阅的事件，以避免多次配置和健康检查。
   - **IP 白名单**：如果你的消息接收服务器受防火墙限制，请勾选该选项，并按照以下步骤将声网消息通知服务器的 IP 地址全部添加到防火墙白名单。

<Accordions type="multiple">
<Accordion title="获取 IP 地址并添加到防火墙白名单">

如果你的服务器受防火墙限制，你需要调用 RESTful API [查询消息通知服务器 IP 地址](/zh-CN/api-reference/api-ref/cloud-recording/get-ncs-ip)，将获取到的所有 IP 地址都添加到防火墙白名单。

声网可能会调整消息通知服务器的 IP 地址，因此强烈推荐你至少每 24 小时进行一次查询并自动更新防火墙配置，否则可能会影响你接收通知。

```java
import java.io.IOException;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.util.Base64;
import java.util.concurrent.Executors;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.TimeUnit;
public class Base64Encoding {
    public static void main(String[] args) throws IOException {
         	// 客户 ID
         	// 需要设置环境变量 AGORA_CUSTOMER_KEY
         	final String customerKey = System.getenv("AGORA_CUSTOMER_KEY");
         	// 客户密钥
         	// 需要设置环境变量 AGORA_CUSTOMER_SECRET
         	final String customerSecret = System.getenv("AGORA_CUSTOMER_SECRET");
        ScheduledExecutorService executor = Executors.newSingleThreadScheduledExecutor();
        // 拼接客户 ID 和客户密钥并使用 base64 编码
        String plainCredentials = customerKey + ":" + customerSecret;
        String base64Credentials = new String(Base64.getEncoder().encode(plainCredentials.getBytes()));
        // 创建 authorization header
        String authorizationHeader = "Basic " + base64Credentials;
        // 创建 HTTP 请求对象
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.agora.io/v2/ncs/ip"))
            .GET()
            .header("Authorization", authorizationHeader)
            .header("Content-Type", "application/json")
            .build();
        // [!code highlight:11]
        // 使用 executor 安排任务，每 24 小时运行一次
        executor.scheduleAtFixedRate(() -> {
            try {
                HttpClient client = HttpClient.newHttpClient();
                // 发送 HTTP 请求
                HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
                System.out.println(response.body());
        } catch (IOException | InterruptedException e) {
                e.printStackTrace();
        }
    }, 0, 24, TimeUnit.HOURS);
}
}
```

</Accordion>
</Accordions>


点击**保存**后，声网会对你的配置进行健康检查。

### 2. 完成健康检查 [#2-完成健康检查]

:::warning[注意]
健康检查为开通消息通知服务必需步骤，只有通过检查才算开通成功。
:::

参考如下步骤完成健康检查：

1. 声网会根据你订阅的事件生成对应的测试事件，并向你的服务器发送事件回调。在测试事件回调中，`channelName` 为 `test_webhook`，`uid` 为 `12121212`。

2. 接收到每个测试事件回调后，你的服务器需要在 10 秒内对声网消息服务器作出响应，响应状态码必须为 200，响应包体格式为 JSON，包体内容不作要求。示例代码如下：

    ```javascript
    const express = require('express');
    const app = express();
    const bodyParser = require('body-parser');

    // 使用 body-parser 中间件解析请求体
    app.use(bodyParser.json());

    // 处理接收到的 POST 请求
    app.post('/', express.json({ type: 'application/json' }), (req, res) => {
        const event = request.body;
        // 5 秒后发送响应
        setTimeout(() => {
            res.status(200).json({message: 'Success'});
        }, 5000);
        // 发送响应后，再执行耗时较长的任务
    });
    ```

3. 如果健康检查失败，请根据控制台的提示进行错误排查。常见的错误包括：

    - 请求超时：你的服务器没有在 10 秒内返回 200。请检查你的服务器是否及时对事件回调作出正确的响应。如果响应正确，请联系[技术支持](https://ticket.shengwang.cn/)确认声网消息通知服务器到你的服务器之间的网络连接是否正常。
    - 证书错误：HTTPS 证书错误。请检查证书是否正确。如果你的服务器受防火墙限制，请检查是否已将声网消息通知服务器的 IP 地址全部添加到防火墙白名单。
    - 域名不可达：域名不合法，无法解析到目标 IP 地址。请检查你的服务器部署是否正确。
    - 响应错误：你的服务器返回的响应状态码不为 200，具体的状态码和描述详见控制台提示。

4. 健康检查成功后，点击**保存配置**。

### 注意事项 [#注意事项]

开通服务并完成健康检查后，你需要注意以下事项：

- 5 分钟后，该服务即会生效。你的服务器需要尽快响应消息通知服务器，响应的 Body 格式必须为 JSON。
- 控制台会自动生成**密钥**，你需要复制并保存这个密钥以备后续验签，详见[验证签名](#验证签名)。

## 消息通知回调格式 [#消息通知回调格式]

消息通知回调以 HTTPS POST 请求发送给你的服务器，请求的 Body 格式为 JSON。字符编码为 UTF-8。

消息通知回调的 Header 中包含以下字段：

| 字段名            | 值                 |
| ----------------- | ------------------ |
| `Content-Type`    | `application/json` |
| `Agora-Signature` |声网用密钥（`secret`）和 HMAC/SHA1 算法生成的签名值。你需要使用密钥（`secret`）和 HMAC/SHA1 算法来验证该签名值。详见[验证签名](#验证签名)。          |
| `Agora-Signature-V2` |声网用密钥（`secret`）和 HMAC/SHA256 算法生成的签名值。你需要使用密钥（`secret`）和 HMAC/SHA256 算法来验证该签名值。 详见[验证签名](#验证签名)。            |

消息通知回调的 Body 中包含以下字段：

| 字段名      | 类型   | 含义                                                         |
| ----------- | ------ | ------------------------------------------------------------ |
| `noticeId`  | String | 通知 ID，标识来自业务服务器的一次事件通知。            |
| `productId` | Number | 业务 ID：`3(Cloud Recording and Extension Service)`，代表云端录制或云端转码服务。|
| `eventType` | Number | 通知的事件类型。|
| `notifyMs`  | Number | 消息通知服务器向你的服务器发出回调请求的 Unix 时间戳，单位为毫秒。通知重试时会更新该时间。|
| `payload`   | JSON Object | 事件内容。`payload` 字段是一个 JSON Object，包含事件的具体内容。详细字段见 [Payload 说明](/zh-CN/realtime-media/cloud-recording/reference/ncs-events)。|

## 验证签名 [#验证签名]

为提高声网消息服务器和你的服务器之间的通信安全，你可以通过签名机制进行身份验证，确保接收到的请求来自声网。

当声网向你的服务器发送消息通知回调时，会使用密钥通过 HMAC/SHA1 和 HMAC/SHA256 算法生成签名值，并分别添加在 HTTPS 请求 Header 的 `Agora-Signature` 和 `Agora-Signature-V2` 字段中。

参考以下步骤进行签名验证：

1. 获取密钥：配置声网消息通知服务时，声网会生成一个密钥。在控制台左侧导航栏的**全部产品** > **拓展能力** > **媒体服务**下，选择**云端录制**，进入**功能配置**子页面，然后在 **Webhook** 页签点击复制按钮即可获取该密钥。

   ![复制密钥](https://web-cdn.agora.io/doc-cms/uploads/1730109572286-other-secret.png)

2. 收到回调后，使用密钥和请求 Body 中的参数，选用 HMAC/SHA1 或 HMAC/SHA256 算法计算签名值。

3. 将你计算出的签名与请求 Header 中对应的字段进行对比：

   - 如果你选用 HMAC/SHA1 算法：将计算值与 `Agora-Signature` 字段对比。二者完全相同则说明该请求是由声网发送的。
   - 如果你选用 HMAC/SHA256 算法：将计算值与 `Agora-Signature-V2` 字段对比。二者完全相同则说明该请求是由声网发送的。

声网提供多种语言的验证签名示例代码供你参考。

<Accordions>
<Accordion title="Python 示例">

<Tabs defaultValue="1" groupId="signature" persist>
<TabsList>
  <TabsTrigger value="1">HMAC/SHA1</TabsTrigger>
  <TabsTrigger value="256">HMAC/SHA256</TabsTrigger>
</TabsList>

<TabsContent value="1">

:::warning[注意]
如下代码中的 `request_body` 是反序列化之前的 binary byte array，不是反序列化之后的 Dictionary。
:::

```python
#!/usr/bin/env python2
# !-*- coding: utf-8 -*-
import hashlib
import hmac
# 拿到消息通知的 raw request body 并对其计算签名
request_body = '{"eventMs":1560408533119,"eventType":10,"noticeId":"4eb720f0-8da7-11e9-a43e-53f411c2761f","notifyMs":1560408533119,"payload":{"a":"1","b":2},"productId":1}'
secret = 'secret'
signature = hmac.new(secret, request_body, hashlib.sha1).hexdigest()
print(signature) # 033c62f40f687675f17f0f41f91a40c71c0f134c
```

</TabsContent>

<TabsContent value="256">

:::warning[注意]
如下代码中的 `request_body` 是反序列化之前的 binary byte array，不是反序列化之后的 Dictionary。
:::

```python
#!/usr/bin/env python2
# !-*- coding: utf-8 -*-
import hashlib
import hmac
# 拿到消息通知的 raw request body 并对其计算签名
request_body = '{"eventMs":1560408533119,"eventType":10,"noticeId":"4eb720f0-8da7-11e9-a43e-53f411c2761f","notifyMs":1560408533119,"payload":{"a":"1","b":2},"productId":1}'
secret = 'secret'
signature2 = hmac.new(secret, request_body, hashlib.sha256).hexdigest()
print(signature2) # 6d3320c60b11101395b7fc8f9068748808a0aa1bfa064438e39d1bc2c7d74d99
```

</TabsContent>
</Tabs>

</Accordion>

<Accordion title="Node.js 示例">

<Tabs defaultValue="1" groupId="signature" persist>
<TabsList>
  <TabsTrigger value="1">HMAC/SHA1</TabsTrigger>
  <TabsTrigger value="256">HMAC/SHA256</TabsTrigger>
</TabsList>

<TabsContent value="1">

```javascript
const crypto = require('crypto')
// 拿到消息通知的 raw request body 并对其计算签名，也就是说下面代码中的 requestBody 是反序列化之前的 binary byte array，不是反序列化之后的 object
const requestBody = '{"eventMs":1560408533119,"eventType":10,"noticeId":"4eb720f0-8da7-11e9-a43e-53f411c2761f","notifyMs":1560408533119,"payload":{"a":"1","b":2},"productId":1}'
const secret = 'secret'
const signature = crypto.createHmac('sha1', secret).update(requestBody, 'utf8').digest('hex')
console.log(signature) // 033c62f40f687675f17f0f41f91a40c71c0f134c
```

</TabsContent>

<TabsContent value="256">

```javascript
const crypto = require('crypto')
// 拿到消息通知的 raw request body 并对其计算签名，也就是说下面代码中的 requestBody 是反序列化之前的 binary byte array，不是反序列化之后的 object
const requestBody = '{"eventMs":1560408533119,"eventType":10,"noticeId":"4eb720f0-8da7-11e9-a43e-53f411c2761f","notifyMs":1560408533119,"payload":{"a":"1","b":2},"productId":1}'
const secret = 'secret'
const signature2 = crypto.createHmac('sha256', secret).update(requestBody, 'utf8').digest('hex')
console.log(signature2) // 6d3320c60b11101395b7fc8f9068748808a0aa1bfa064438e39d1bc2c7d74d99
```

</TabsContent>
</Tabs>

</Accordion>

<Accordion title="Java 示例">

<Tabs defaultValue="1" groupId="signature" persist>
<TabsList>
  <TabsTrigger value="1">HMAC/SHA1</TabsTrigger>
  <TabsTrigger value="256">HMAC/SHA256</TabsTrigger>
</TabsList>

<TabsContent value="1">

:::warning[注意]
如下代码中的 `request_body` 是反序列化之前的 binary byte array，不是反序列化之后的 Object。
:::

```java
import javax.crypto.Mac;
import javax.crypto.SecretKey;
import javax.crypto.spec.SecretKeySpec;

public class HmacSha {
    // 将加密后的字节数组转换成字符串
    public static String bytesToHex(byte[] bytes) {
        StringBuffer sb = new StringBuffer();
        for (int i = 0; i < bytes.length; i++) {
            String hex = Integer.toHexString(bytes[i] & 0xFF);
            if (hex.length() < 2) {
                sb.append(0);
            }
            sb.append(hex);
        }
        return sb.toString();
    }
    // HMAC/SHA1 加密，返回加密后的字符串
    public static String hmacSha1(String message, String secret) {
        try {
            SecretKeySpec signingKey = new SecretKeySpec(secret.getBytes(
                        "utf-8"), "HmacSHA1");
            Mac mac = Mac.getInstance("HmacSHA1");
            mac.init(signingKey);
            byte[] rawHmac = mac.doFinal(message.getBytes("utf-8"));
            return bytesToHex(rawHmac);
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }
    public static void main(String[] args) {
        // 拿到消息通知的 raw request body 并对其计算签名
        String request_body = "{\"eventMs\":1560408533119,\"eventType\":10,\"noticeId\":\"4eb720f0-8da7-11e9-a43e-53f411c2761f\",\"notifyMs\":1560408533119,\"payload\":{\"a\":\"1\",\"b\":2},\"productId\":1}";
        String secret = "secret";
        System.out.println(hmacSha1(request_body, secret)); //033c62f40f687675f17f0f41f91a40c71c0f134c
    }
}
```

</TabsContent>

<TabsContent value="256">

:::warning[注意]
如下代码中的 `request_body` 是反序列化之前的 binary byte array，不是反序列化之后的 Object。
:::

```java
import javax.crypto.Mac;
import javax.crypto.SecretKey;
import javax.crypto.spec.SecretKeySpec;

public class HmacSha {
    // 将加密后的字节数组转换成字符串
    public static String bytesToHex(byte[] bytes) {
        StringBuffer sb = new StringBuffer();
        for (int i = 0; i < bytes.length; i++) {
            String hex = Integer.toHexString(bytes[i] & 0xFF);
            if (hex.length() < 2) {
                sb.append(0);
            }
            sb.append(hex);
        }
        return sb.toString();
    }
    // HMAC/SHA256 加密，返回加密后的字符串
    public static String hmacSha256(String message, String secret) {
        try {
            SecretKeySpec signingKey = new SecretKeySpec(secret.getBytes(
                        "utf-8"), "HmacSHA256");
            Mac mac = Mac.getInstance("HmacSHA256");
            mac.init(signingKey);
            byte[] rawHmac = mac.doFinal(message.getBytes("utf-8"));
            return bytesToHex(rawHmac);
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }
    public static void main(String[] args) {
        // 拿到消息通知的 raw request body 并对其计算签名
        String request_body = "{\"eventMs\":1560408533119,\"eventType\":10,\"noticeId\":\"4eb720f0-8da7-11e9-a43e-53f411c2761f\",\"notifyMs\":1560408533119,\"payload\":{\"a\":\"1\",\"b\":2},\"productId\":1}";
        String secret = "secret";
        System.out.println(hmacSha256(request_body, secret)); //033c62f40f687675f17f0f41f91a40c71c0f134c
    }
}
```

</TabsContent>
</Tabs>

</Accordion>

<Accordion title="PHP 示例">

<Tabs defaultValue="1" groupId="signature" persist>
<TabsList>
  <TabsTrigger value="1">HMAC/SHA1</TabsTrigger>
  <TabsTrigger value="256">HMAC/SHA256</TabsTrigger>
</TabsList>

<TabsContent value="1">

```php
<?php
function assertEqual($expect, $actual)
{
    if ($expect != $actual) {
        echo("\n assert failed");
        echo("\n  expect:\n    " . $expect);
        echo("\n  actual:\n    " . $actual);
        echo("\n");
    } else {
        echo("assert ok\n");
        echo("\n");
    }
}
// 拿到消息通知的 raw request body 并对其计算签名，也就是说下面代码中的 requestBody 是反序列化之前的 binary byte array，不是反序列化之后的 object
$request_body = '{"eventMs":1560408533119,"eventType":10,"noticeId":"4eb720f0-8da7-11e9-a43e-53f411c2761f","notifyMs":1560408533119,"payload":{"a":"1","b":2},"productId":1}';
$secret = 'secret';
// 请求 header 中 Agora-Signature 的值
$sha1 = '033c62f40f687675f17f0f41f91a40c71c0f134c';
$res1 = (hash_hmac('sha1', $request_body, $secret));
assertEqual($res1, $sha1);
?>
```

</TabsContent>

<TabsContent value="256">

```php
<?php
function assertEqual($expect, $actual)
{
    if ($expect != $actual) {
        echo("\n assert failed");
        echo("\n  expect:\n    " . $expect);
        echo("\n  actual:\n    " . $actual);
        echo("\n");
    } else {
        echo("assert ok\n");
        echo("\n");
    }
}
// 拿到消息通知的 raw request body 并对其计算签名，也就是说下面代码中的 requestBody 是反序列化之前的 binary byte array，不是反序列化之后的 object
$request_body = '{"eventMs":1560408533119,"eventType":10,"noticeId":"4eb720f0-8da7-11e9-a43e-53f411c2761f","notifyMs":1560408533119,"payload":{"a":"1","b":2},"productId":1}';
$secret = 'secret';
// 请求 header 中 Agora-Signature-V2 的值
$sha256 = '6d3320c60b11101395b7fc8f9068748808a0aa1bfa064438e39d1bc2c7d74d99';
$res2 = (hash_hmac('sha256', $request_body, $secret));
assertEqual($res2, $sha256);
?>
```

</TabsContent>
</Tabs>

</Accordion>
</Accordions>

## 注意事项 [#注意事项-1]

- 你的服务器收到的通知顺序和事件发生的顺序不一定完全一致。
- 为确保消息通知的可靠性，每次事件可能会有不止一次消息通知，你的服务器需要能处理重复消息。

## 常见问题 [#常见问题]

- [消息通知服务和 query 方法有什么区别？](/zh-CN/reference/faq/integration/ncs_vs_query)