goim

goim

A platform-agnostic IM gateway library for Go. Connect any AI agent backend to 10+ chat platforms through a single Runtime interface.

中文文档

Features

• Single interface integration — implement Runtime to bridge your agent to all supported platforms
• 10 IM platforms — Telegram, Feishu (Lark), Discord, Slack, DingTalk, WeCom, QQ, QQBot, LINE, WeChat
• Streaming support — real-time text, tool use, and error events via channel-based API
• Multi-channel config — manage multiple platform credentials in a single channels.json
• Session management — per-user sessions with concurrent message handling
• Rotating log — automatic log rotation with size-based pruning

Install

go get github.com/godeps/goim@latest

Quick Start

1. Implement the Runtime interface

package main

import (
    "context"
    "github.com/godeps/goim"
)

type MyRuntime struct{}

func (r *MyRuntime) RunStream(ctx context.Context, req goim.Request) (<-chan goim.StreamEvent, error) {
    ch := make(chan goim.StreamEvent, 16)
    go func() {
        defer close(ch)
        // Process req.Prompt, stream back events
        ch <- goim.StreamEvent{
            Type:  goim.EventContentBlockDelta,
            Delta: &goim.Delta{Text: "Hello from my agent!"},
        }
        ch <- goim.StreamEvent{Type: goim.EventMessageStop}
    }()
    return ch, nil
}

2. Start the gateway

func main() {
    rt := &MyRuntime{}
    cfg := goim.ConfigFromFlags("telegram", "YOUR_BOT_TOKEN", "")

    platforms, _ := goim.CreatePlatforms(cfg)
    agent := goim.NewAgent(rt, "mybot")
    engine := goim.NewEngine(agent, platforms, cfg)

    engine.Start()
    // Block until interrupted...
}

3. Or use the controller for lifecycle management

ctrl := goim.NewIMController("/path/to/channels.json")
err := ctrl.Start(rt, "mybot", "telegram", "YOUR_BOT_TOKEN", "", "")
// ...
ctrl.Stop()

Configuration

channels.json

Manage multiple platforms in a single file:

{
  "channels": {
    "telegram": {
      "token": "123456:ABC-DEF",
      "enabled": true
    },
    "feishu": {
      "app_id": "cli_xxx",
      "app_secret": "secret",
      "enabled": true
    },
    "discord": {
      "token": "discord-bot-token",
      "enabled": false
    }
  },
  "language": "zh"
}

Platform credentials

TOML config (legacy)

[project]
name = "mybot"

[[project.platforms]]
type = "telegram"
[project.platforms.options]
token = "YOUR_BOT_TOKEN"

Stream Events

License

MIT

中文文档

goim 是一个平台无关的 Go 语言 IM 网关库。通过实现一个 Runtime 接口，即可将任意 AI Agent 后端接入 10+ 聊天平台。

特性

• 单接口集成 — 实现 Runtime 接口即可桥接所有支持的平台
• 10 个 IM 平台 — Telegram、飞书、Discord、Slack、钉钉、企业微信、QQ、QQ 机器人、LINE、微信
• 流式支持 — 基于 channel 的实时文本、工具调用和错误事件流
• 多渠道配置 — 通过 channels.json 统一管理多平台凭据
• 会话管理 — 按用户隔离会话，支持并发消息处理
• 日志轮转 — 按大小自动轮转日志文件

安装

go get github.com/godeps/goim@latest

快速开始

1. 实现 Runtime 接口

package main

import (
    "context"
    "github.com/godeps/goim"
)

type MyRuntime struct{}

func (r *MyRuntime) RunStream(ctx context.Context, req goim.Request) (<-chan goim.StreamEvent, error) {
    ch := make(chan goim.StreamEvent, 16)
    go func() {
        defer close(ch)
        // 处理 req.Prompt，流式返回事件
        ch <- goim.StreamEvent{
            Type:  goim.EventContentBlockDelta,
            Delta: &goim.Delta{Text: "你好！"},
        }
        ch <- goim.StreamEvent{Type: goim.EventMessageStop}
    }()
    return ch, nil
}

2. 启动网关

func main() {
    rt := &MyRuntime{}
    cfg := goim.ConfigFromFlags("telegram", "你的机器人Token", "")

    platforms, _ := goim.CreatePlatforms(cfg)
    agent := goim.NewAgent(rt, "mybot")
    engine := goim.NewEngine(agent, platforms, cfg)

    engine.Start()
    // 阻塞等待中断信号...
}

3. 使用 Controller 管理生命周期

ctrl := goim.NewIMController("/path/to/channels.json")
err := ctrl.Start(rt, "mybot", "telegram", "你的Token", "", "")
// ...
ctrl.Stop()

配置

channels.json

通过一个文件管理多个平台：

{
  "channels": {
    "telegram": {
      "token": "123456:ABC-DEF",
      "enabled": true
    },
    "feishu": {
      "app_id": "cli_xxx",
      "app_secret": "secret",
      "enabled": true
    }
  },
  "language": "zh"
}

各平台所需凭据

流式事件类型

许可证

MIT