Open API
Use REST APIs to integrate deeply with TWT Chat, manage chat sessions, send messages, and synchronize customer data.
What You Can Do
- Create one-to-one chats or group chats from your server, including batch operations
- Delete or dissolve chats and clean up data from business workflows
- Manage FAQ and web/article knowledge entries in the knowledge base
- Protect every API request with HMAC-SHA256 request signing
How To
- Authentication and Signature - Generate request signatures before calling any API
- Live chat APIs - Create Session, Batch Create Sessions, Create Group, and deletion / dissolve APIs
- Live session APIs - Create Agent Session, Create Robot Session, and Add Agents
- Knowledge Base APIs - Create, edit, and delete FAQ entries; create and delete web entries; create, edit, and delete article entries
- Error Code Reference - Understand the unified error response format
Base URL: https://apichat.twt.com, over HTTPS, with JSON request and response bodies.
API Overview
| API | Method | Module | Description |
|---|---|---|---|
| Authentication and Signature | — | Authentication | HMAC-SHA256 request signing, required for every API |
| Create Session | POST | Live Chat | Create a single one-to-one chat session |
| Batch Create Sessions | POST | Live Chat | Create one-to-one chat sessions in batch |
| Create Group | POST | Live Chat | Create group chats in batch |
| Delete Session | POST | Live Chat | Delete a single chat session |
| Dissolve Group | POST | Live Chat | Dissolve a single group chat |
| Batch Dissolve Groups | POST | Live Chat | Dissolve group chats in batch |
| Create Agent Session | POST | Live Session | Create a session and assign the responsible agent plus participants |
| Create Robot Session | POST | Live Session | Create a session handled by Autopilot |
| Add Agents | POST | Live Session | Add agents to an existing ticket session |
| Knowledge Base APIs | POST | Knowledge Base | Manage FAQ entries and web/article knowledge entries (article editing supported) |
| Error Code Reference | — | Common | Unified error response format |
What You Get
- Connect TWT Chat to your own business workflows for automated chat operations
- Start chats proactively from the server side without manual agent actions
- Integrate with CRM, ticketing, and internal systems
Need an account?
Create a free TWT Chat account to get your API credentials.