Bottender项目中的即时通讯客户端API详解

Bottender项目中的即时通讯客户端API详解

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

概述

即时通讯客户端是Bottender框架中用于与即时通讯Bot API交互的核心组件。它为开发者提供了简洁易用的接口，可以轻松实现各种即时通讯机器人功能。本文将详细介绍即时通讯客户端的使用方法、主要API功能以及调试技巧。

获取即时通讯客户端实例

在Bottender中，有两种方式获取即时通讯客户端实例：

1. 通过getClient函数直接获取

const { getClient } = require('bottender');
const client = getClient('instant-messaging');

2. 从上下文中获取

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

错误处理机制

即时通讯客户端使用axios作为HTTP客户端，并提供了完善的错误处理机制。当API调用失败时，错误对象包含以下有用信息：

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信息

const webhookInfo = await client.getWebhookInfo();

设置Webhook

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

删除Webhook

await client.deleteWebhook();

消息发送API

即时通讯客户端支持发送多种类型的消息：

文本消息

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

多媒体消息

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

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

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

位置信息

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

联系人信息

await client.sendContact(chatId, {
  phoneNumber: '123456789',
  firstName: 'John'
});

信息获取API

获取机器人信息

const botInfo = await client.getMe();

获取用户资料照片

const photos = await client.getUserProfilePhotos(userId);

高级功能

发送聊天动作

// 显示"正在输入"状态
await client.sendChatAction(chatId, 'typing');

发送媒体组

await client.sendMediaGroup(chatId, [
  { type: 'photo', media: 'photo1.jpg' },
  { type: 'photo', media: 'photo2.jpg' }
]);

调试技巧

1. 使用try-catch捕获并检查错误对象
2. 打印完整的错误信息以了解问题详情
3. 检查API返回的状态码和响应内容
4. 使用即时通讯Bot API官方文档作为参考

最佳实践

1. 对于频繁发送的消息，考虑使用disableNotification选项避免打扰用户
2. 为多媒体消息添加适当的caption提高用户体验
3. 合理使用sendChatAction让用户知道机器人正在处理请求
4. 对API调用进行适当的错误处理和重试机制

通过即时通讯客户端，开发者可以轻松构建功能丰富的即时通讯机器人，实现各种自动化和交互场景。

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