Bottender项目中的MessengerClient API详解

Bottender项目中的MessengerClient API详解

bottender ⚡️ A framework for building conversational user interfaces. 项目地址: https://gitcode.com/gh_mirrors/bo/bottender

概述

在Bottender框架中，MessengerClient是与Messenger Bot API交互的核心组件。它为开发者提供了完整的Messenger机器人功能接口，包括消息发送、接收、群组管理等功能。本文将深入解析MessengerClient的使用方法和API细节。

获取MessengerClient实例

在Bottender中有两种方式获取MessengerClient实例：

1. 直接获取方式

const { getClient } = require('bottender');
const client = getClient('messenger');

2. 从上下文中获取

async function MyAction(context) {
  if (context.platform === 'messenger') {
    const client = context.client;
  }
}

错误处理机制

MessengerClient使用axios作为HTTP客户端，并提供了完善的错误处理机制：

client.getWebhookInfo().catch((error) => {
  console.log(error); // 格式化的错误信息
  console.log(error.stack); // 错误堆栈
  console.log(error.config); // 请求配置
  console.log(error.request); // HTTP请求对象
  console.log(error.response); // HTTP响应对象
});

核心API功能

Webhook相关API

获取Webhook信息

client.getWebhookInfo().then((info) => {
  console.log(info);
});

设置Webhook

client.setWebhook('https://your-webhook-url.com/');

删除Webhook

client.deleteWebhook();

消息发送API

MessengerClient提供了丰富的消息发送功能：

发送文本消息

client.sendMessage(CHAT_ID, 'Hello World!', {
  disableWebPagePreview: true
});

发送多媒体内容

// 发送图片
client.sendPhoto(CHAT_ID, 'https://example.com/image.png');

// 发送音频
client.sendAudio(CHAT_ID, 'https://example.com/audio.mp3');

// 发送视频
client.sendVideo(CHAT_ID, 'https://example.com/video.mp4');

发送位置信息

client.sendLocation(CHAT_ID, {
  latitude: 25.0330,
  longitude: 121.5654
});

发送聊天动作

client.sendChatAction(CHAT_ID, 'typing');

信息获取API

获取机器人信息

client.getMe().then((botInfo) => {
  console.log(botInfo);
});

获取用户头像

client.getUserProfilePhotos(USER_ID);

高级功能

媒体组发送

可以一次性发送多张图片或视频组成的相册：

client.sendMediaGroup(CHAT_ID, [
  { type: 'photo', media: 'photo1_id' },
  { type: 'photo', media: 'photo2_id' }
]);

支付功能

MessengerClient支持Messenger支付功能，可以发送发票和接收支付。

内联模式

支持内联查询和结果返回，让用户在不离开聊天界面的情况下与机器人交互。

调试技巧

1. 使用getWebhookInfo检查webhook状态
2. 捕获并详细打印错误信息
3. 测试各种消息类型时，注意Messenger的文件大小限制

测试建议

1. 为每个API编写单元测试
2. 测试各种边界条件
3. 模拟网络错误测试错误处理机制

总结

Bottender的MessengerClient提供了完整的Messenger Bot API封装，使开发者能够轻松构建功能丰富的Messenger机器人。通过本文的详细解析，开发者可以全面了解各个API的使用方法和注意事项，从而更高效地开发Messenger机器人应用。

bottender ⚡️ A framework for building conversational user interfaces. 项目地址: https://gitcode.com/gh_mirrors/bo/bottender