> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.hams.ai/omni-channel/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.hams.ai/_mcp/server. # Omni Channel ## Docs - [Overview](https://docs.hams.ai/omni-channel/overview.md): Learn what Omni Channel does, the main terms of the product, and the first steps to set up your account. - [Inboxes and channels](https://docs.hams.ai/omni-channel/inboxes.md): Connect a channel to your account as an inbox, and see what each channel needs. - [WhatsApp](https://docs.hams.ai/omni-channel/whatsapp.md): Connect a WhatsApp Business number as an inbox, reply in the 24-hour window, and send approved templates outside it. - [Voice](https://docs.hams.ai/omni-channel/voice.md): Link Cloud Call Center numbers to inboxes, and see each call as a call card in the conversation of the customer. - [Live chat](https://docs.hams.ai/omni-channel/live-chat.md): Add the live chat widget to your website and answer visitors in Omni Channel. - [Facebook](https://docs.hams.ai/omni-channel/facebook.md): Connect a Facebook Page as an inbox, get its Messenger messages as conversations, and reply within the message window. - [Telegram](https://docs.hams.ai/omni-channel/telegram.md): Connect a Telegram bot as an inbox and reply to the messages that people send to the bot. - [X](https://docs.hams.ai/omni-channel/x.md): Connect 1 X account as an inbox, turn on direct messages and mentions, and keep the connection active. - [X Mentions](https://docs.hams.ai/omni-channel/x-mentions.md): Read X mentions as threads, reply to each post on X, and track the posts that need a reply. - [Conversation cycles](https://docs.hams.ai/omni-channel/conversation-cycles.md): Learn how a conversation cycle starts and ends, and where you see the cycles of a conversation. - [Companies](https://docs.hams.ai/omni-channel/companies.md): Group the contacts who work for the same organization, and see their conversations and notes on one page. - [Teams](https://docs.hams.ai/omni-channel/teams.md): Group agents into teams, set how each team receives conversations, and learn how conversations get a team. - [WhatsApp campaigns](https://docs.hams.ai/omni-channel/whatsapp-campaigns.md): Send one approved WhatsApp template to a group of contacts, and see who read it and who replied. - [Workflows](https://docs.hams.ai/omni-channel/workflows.md): Automate a conversation with a graph of nodes that ask questions, wait, tag, call APIs, and assign. - [Conversation log](https://docs.hams.ai/omni-channel/reports/conversation-log.md): Use the conversation log report to count, filter, and read the conversation cycles of your account. - [Post-chat analysis](https://docs.hams.ai/omni-channel/reports/post-chat-analysis.md): Set up analysis profiles and read the outcome, sentiment, summary, and labels that post-chat analysis gives each closed conversation cycle. - [WhatsApp campaign reports](https://docs.hams.ai/omni-channel/reports/whatsapp-campaign-reports.md): Use the WhatsApp Campaigns report to compare the results of all WhatsApp campaigns of a period. - [Assistants](https://docs.hams.ai/omni-channel/ai-agent/assistants.md): Create an AI agent, set its instructions and behavior, and assign it to conversations. - [Knowledge and documents](https://docs.hams.ai/omni-channel/ai-agent/knowledge.md): Add web pages and PDF files that an AI agent uses to answer customers. - [FAQ and responses](https://docs.hams.ai/omni-channel/ai-agent/faq.md): Review, add, and edit the question and answer pairs that an AI agent searches. - [Scenarios](https://docs.hams.ai/omni-channel/ai-agent/scenarios.md): Send a specific type of request to a sub-agent that has its own instructions. - [Tools](https://docs.hams.ai/omni-channel/ai-agent/tools.md): Give an AI agent actions that it can do in a conversation, and connect it to your own API. - [Playground](https://docs.hams.ai/omni-channel/ai-agent/playground.md): Test an AI agent in a chat or on a call before it answers customers. - [AI agent reports](https://docs.hams.ai/omni-channel/ai-agent/reports.md): Read the AI agent report, see the CSAT of your AI agents, and find the cause of a bad answer. - [Quickstart](https://docs.hams.ai/omni-channel/api/quickstart.md): Create an API key and send your first WhatsApp template from your own system in 3 steps. - [Messages](https://docs.hams.ai/omni-channel/api/messages.md): How to address a message, and how the service window controls whether the API accepts it. - [Templates](https://docs.hams.ai/omni-channel/api/templates.md): How to send an approved WhatsApp template, and what to put in processed_params. - [Conversations](https://docs.hams.ai/omni-channel/api/conversations.md): Read, create, label, assign, and change the status of the conversations of your integration. - [Contacts](https://docs.hams.ai/omni-channel/api/contacts.md): Find, read, create, and update the contacts behind your conversations, also by phone number. - [Pre-call context](https://docs.hams.ai/omni-channel/api/precall-context.md): The pre-call context endpoint returns the contact, the conversation, and the recent messages of a customer as a flat map. - [Errors](https://docs.hams.ai/omni-channel/api/errors.md): The error codes of the developer API, the body of each error, and what to do about it. ## API Docs - API Reference > Messaging [Send a message](https://docs.hams.ai/omni-channel/reference/messaging/send-message.md) - API Reference > Conversations [Create a conversation](https://docs.hams.ai/omni-channel/reference/conversations/create-conversation.md) - API Reference > Conversations [Get a conversation](https://docs.hams.ai/omni-channel/reference/conversations/get-conversation.md) - API Reference > Conversations [Update a conversation](https://docs.hams.ai/omni-channel/reference/conversations/update-conversation.md) - API Reference > Conversations [Reply in a conversation](https://docs.hams.ai/omni-channel/reference/conversations/create-conversation-message.md) - API Reference > Conversations [Change conversation status](https://docs.hams.ai/omni-channel/reference/conversations/toggle-conversation-status.md) - API Reference > Conversations [Set conversation priority](https://docs.hams.ai/omni-channel/reference/conversations/toggle-conversation-priority.md) - API Reference > Conversations [Set conversation custom attributes](https://docs.hams.ai/omni-channel/reference/conversations/set-conversation-custom-attributes.md) - API Reference > Conversations [List conversation labels](https://docs.hams.ai/omni-channel/reference/conversations/list-conversation-labels.md) - API Reference > Conversations [Replace conversation labels](https://docs.hams.ai/omni-channel/reference/conversations/set-conversation-labels.md) - API Reference > Conversations [Assign a conversation](https://docs.hams.ai/omni-channel/reference/conversations/assign-conversation.md) - API Reference > Contacts [List contacts](https://docs.hams.ai/omni-channel/reference/contacts/list-contacts.md) - API Reference > Contacts [Create a contact](https://docs.hams.ai/omni-channel/reference/contacts/create-contact.md) - API Reference > Contacts [Get a contact by phone number](https://docs.hams.ai/omni-channel/reference/contacts/get-contact-by-phone.md) - API Reference > Contacts [Create or update a contact by phone number](https://docs.hams.ai/omni-channel/reference/contacts/create-or-update-contact-by-phone.md) - API Reference > Contacts [Get a contact](https://docs.hams.ai/omni-channel/reference/contacts/get-contact.md) - API Reference > Contacts [Update a contact](https://docs.hams.ai/omni-channel/reference/contacts/update-contact.md) - API Reference > Contacts [Filter contacts](https://docs.hams.ai/omni-channel/reference/contacts/filter-contacts.md) - API Reference > Pre Call Context [Get pre-call context](https://docs.hams.ai/omni-channel/reference/pre-call-context/get-precall-context.md) ## OpenAPI Specification The raw OpenAPI 3.1 specification for this API is available at: - [OpenAPI JSON](https://docs.hams.ai/openapi.json) - [OpenAPI YAML](https://docs.hams.ai/openapi.yaml)