简体中文 | English
This documentation describes the 1.0.0-beta.1 public beta. Start with the quick start, then use the topic guides according to the part of the channel you are integrating.
- Quick start: build, configure, connect, receive, and reply
- Configuration: credentials, transport, domain, client assertion, safety, and outbound options
- Examples: runnable consumer-shaped projects
- Events: normalized event names, message fields, subscriptions, and raw-event opt-in
- Webhook: create and host the SDK dispatcher securely
- Policy and safety: allowlists, mention rules, deduplication, ordering, and batching
- Sending messages: targets, content kinds, replies, mentions, retry, and errors
- Streaming: Markdown and card streaming controllers
- Media: URLs, local files, byte arrays, streams, duration handling, and SSRF controls
- API reference: public facade, model, and low-level method map
- Migration from
oapi-sdk-java: package and dependency migration checklist - Compatibility: Java, Maven, main SDK, and package guarantees
- Troubleshooting: common connection, policy, send, and media failures
- Testing: local verification and opt-in integration tests
- First bot: Quick start → Events → Sending messages → Policy and safety
- Existing HTTP service: Quick start → Webhook → Policy and safety → Testing
- AI/Agent response: Quick start → Streaming → Media → Sending messages
- Main-SDK migration: Migration → Compatibility → Troubleshooting → Testing
Each topic links to its Simplified Chinese counterpart. Release artifacts include sources and Javadoc JARs.