不使用IBM Cloud Function时如何在IBM Watson Webhook中调用自定义REST API

基础可行性说明 #

完全可以不使用IBM Cloud Function，直接对接自行开发部署的Node.js REST API作为IBM Assistant的webhook地址，只要你的服务符合IBM Assistant的webhook调用规范即可。

服务必须满足的核心要求 #

大部分迁移后调用失败的问题都是未满足以下要求导致的：

• 必须为公网可访问的HTTPS地址，不支持HTTP协议，也不支持自签名SSL证书
• 必须支持POST请求，且能正确解析application/json格式的请求体
• 接口响应耗时必须控制在8秒以内，超出会被IBM Assistant判定为超时失败
• 响应内容必须为标准JSON格式，禁止返回非JSON结构的文本

Node.js 实现示例 #

我们以Express框架为例给出可直接运行的代码：

安装依赖 #

npm install express cors

服务代码 #

const express = require('express');
const cors = require('cors');
const app = express();
const servicePort = 3000;

// 配置必须的中间件
app.use(cors()); // 处理跨域请求
app.use(express.json()); // 解析JSON格式的请求体

// Webhook接口，路径可根据需求自定义
app.post('/watson-webhook', (req, res) => {
  // 读取IBM Assistant传入的参数，和你在Assistant后台配置的发送参数一一对应
  const { query, user_id, custom_param } = req.body;

  // 这里替换为你原来在Cloud Function中运行的业务逻辑即可
  let responseData = {};
  try {
    // 示例业务逻辑
    responseData = {
      status: 'success',
      result: `已处理用户${user_id}的请求：${query}`,
      extra: custom_param
    };
  } catch (err) {
    responseData = {
      status: 'error',
      message: err.message
    };
  }

  // 返回JSON格式响应
  res.json(responseData);
});

app.listen(servicePort, () => {
  console.log(`Webhook服务已启动，监听端口${servicePort}`);
});

调试验证步骤 #

1. 本地运行服务后，可使用内网穿透工具将本地端口映射为可公网访问的HTTPS地址用于测试
2. 先用Postman或ApiPost模拟POST请求调用你的接口，传入你配置的请求参数，确认接口能正常返回JSON格式数据
3. 到IBM Assistant后台的webhook配置页填入你的接口地址，点击测试按钮验证连通性
4. 若测试失败，可查看IBM Assistant的webhook错误日志，定位具体错误类型（超时/证书错误/返回格式错误等）

内容的提问来源于stack exchange，提问作者vivasola