# CEQUENS Developer Hub Documentation

> Everything you need to know about CEQUENS Communication APIs.

## Guides: Meta Channels Configuration
- [Meta Channels with Cequens: Transforming Communication](https://developer.cequens.com/docs/channels-onboarding-steps.md): Discover how Cequens, as a Meta Solution Provider, revolutionizes business communication through WhatsApp Business, Facebook Messenger, and Instagram.
  - [WhatsApp Business Onboarding Guide](https://developer.cequens.com/docs/whatsapp-channel.md): Connect your phone number to the WhatsApp Business Platform quickly and easily by following these steps.
  - [Facebook Messenger Onboarding Guide](https://developer.cequens.com/docs/messenger-page-onboarding.md): Connect your Facebook Messenger channel to start receiving and sending messages from our platform.
  - [Instagram Onboarding Guide](https://developer.cequens.com/docs/instagram-page.md): Connect your Instagram Business account to manage conversations, automate replies, and use bots through Instagram Messaging.
- [WhatsApp Business Templates Guide](https://developer.cequens.com/docs/whatsapp-templates-1.md): Learn how to create and manage WhatsApp message templates, including Marketing, Utility, and Authentication types, and set up interactive WhatsApp Flows with best practices and submission tips.
  - [Create a Template](https://developer.cequens.com/docs/create-a-template.md): This guide explains how to create, manage, and troubleshoot WhatsApp message templates—including Marketing, Utility, and Authentication types—using your company’s business console. Learn best…
  - [Create a WhatsApp Flow](https://developer.cequens.com/docs/create-a-whatsapp-flow.md): WhatsApp Flows allow you to collect information from customers directly within a WhatsApp conversation using interactive forms. These forms can span multiple screens (pages) and include various input…

## Guides: omni channel chat
- [Introduction](https://developer.cequens.com/docs/occ-introduction.md): Discover CEQUENS Chat - a powerful live agent chat application designed to optimize customer interactions across multiple channels and enhance service efficiency.
  - [Getting Started](https://developer.cequens.com/docs/getting-started-1.md): > Welcome to the Omni-Channels Chat (OCC) platform. This guide will help you quickly learn how to use OCC to manage your customer communications effectively.
- [Inbox & Conversations](https://developer.cequens.com/docs/unified-inbox.md)
  - [Managing Conversations](https://developer.cequens.com/docs/managing-conversations.md)
  - [Conversation Tools](https://developer.cequens.com/docs/conversation-tools.md)
  - [Widget Setup](https://developer.cequens.com/docs/widget-setup.md)
- [Bot Studio Builder](https://developer.cequens.com/docs/bot-studio-builder.md)
  - Bot Studio: Pre-Get Started
    - [Create Blocks In The Bot Studio](https://developer.cequens.com/docs/create-blocks-in-the-bot-studio.md): CEQUENS makes it easy to create no-code chatbots in just a few minutes. One of the essential aspects of designing your chatbot's conversation flow is understanding how to use blocks. Blocks are the…
    - [Link The Blocks](https://developer.cequens.com/docs/link-the-blocks.md): CEQUENS allows you to create no-code chatbots quickly. One of the key aspects of designing your chatbot's conversation flow is understanding how to use blocks and connect them together. In this…
    - [Scroll, zoom, move Blocks & Actions](https://developer.cequens.com/docs/scroll-zoom-move-blocks-actions.md)
    - [Flow's Attributes](https://developer.cequens.com/docs/flows-attributes.md)
    - [Copy and Paste Blocks and Actions for faster conversation design](https://developer.cequens.com/docs/copy-and-paste-blocks-and-actions-for-faster-conversation-design.md)
    - [Avoid dead loops](https://developer.cequens.com/docs/avoid-dead-loops.md)
  - Bot Studio: Get Started
    - [Create a chatbot from scratch](https://developer.cequens.com/docs/create-a-chatbot-from-scratch.md)
    - [Create a chatbot from Template or Import from a file](https://developer.cequens.com/docs/create-a-chatbot-from-template-or-import-from-a-file.md)
    - [Transfer my chatbot to a live agent](https://developer.cequens.com/docs/transfer-my-chatbot-to-a-live-agent.md)
  - Actions explained
    - [Reply Action](https://developer.cequens.com/docs/screen-video-reply-action.md)
    - [Advanced Reply - Manage an inactive chat](https://developer.cequens.com/docs/screenshot-how-to-manage-an-inactive-chat.md)
    - [Random Reply action](https://developer.cequens.com/docs/screenshot-how-to-use-the-random-reply-action-in-design-studio.md)
    - [Questions Feature in Bot Studio](https://developer.cequens.com/docs/questions-feature-in-bot-studio.md)
    - [Form Feature to Collect User Information](https://developer.cequens.com/docs/form-feature-to-collect-user-information.md)
    - [Web Request Action](https://developer.cequens.com/docs/screenshot-web-request-action.md)
    - [Send Email action](https://developer.cequens.com/docs/screenshot-how-the-send-email-action-works.md)
    - [Code Node](https://developer.cequens.com/docs/screenshot-code-node.md)
    - [Capture User Reply Action](https://developer.cequens.com/docs/screenshot-capture-user-reply-action.md)
    - [Wait Action](https://developer.cequens.com/docs/screenshot-wait-action.md)
    - [Replace Bot action](https://developer.cequens.com/docs/screenshot-replace-bot-action.md)
    - [Add Label Action](https://developer.cequens.com/docs/screenshot-add-label-action.md)
    - [Transfer to a Human Action](https://developer.cequens.com/docs/transfer-to-a-human-action.md)
    - [The If Online Agent action and its role in conversation design](https://developer.cequens.com/docs/screenshot-the-if-online-agent-action-and-its-role-in-conversation-design.md)
    - [Use the Close action](https://developer.cequens.com/docs/screenshot-how-to-use-the-close-action.md)
    - [Use Change Inboxes](https://developer.cequens.com/docs/screenshot-how-to-use-change-inboxes-in-design-studio.md)
    - [Move to Unassigned Action](https://developer.cequens.com/docs/check-screenshot-move-to-unassigned-action.md)
- [Surveys Management](https://developer.cequens.com/docs/survey.md): Surveys allow you to collect customer feedback after conversations. Create custom surveys, send them to customers via a shortened URL, and analyze responses to improve your support quality.
- Analytics
  - Inbox Analytics
    - [Requests and Labels](https://developer.cequens.com/docs/requests-and-labels.md)
    - [Conversations Analytics](https://developer.cequens.com/docs/conversations-analytics.md)
  - [Agents Performance Analytics](https://developer.cequens.com/docs/agents-performance-analytics.md)
- [Setup & Configuration](https://developer.cequens.com/docs/getting-started.md)
  - [Inbox Management](https://developer.cequens.com/docs/inbox-management.md)
    - [Routing Configuration](https://developer.cequens.com/docs/routing-configuration.md)
    - [Bots in Inbox Settings](https://developer.cequens.com/docs/bot-management.md)
    - [Media Settings](https://developer.cequens.com/docs/media-settings.md)
    - [SLA Configuration](https://developer.cequens.com/docs/sla-configuration.md)
  - [Users & Groups](https://developer.cequens.com/docs/users-groups.md)
  - [Contacts](https://developer.cequens.com/docs/contacts-1.md)
  - [Labels](https://developer.cequens.com/docs/labels-1.md)
  - [Canned Responses](https://developer.cequens.com/docs/canned-responses-1.md)
  - [Automations (Triggers)](https://developer.cequens.com/docs/automations-triggers.md)
    - [Meta Conversion Events](https://developer.cequens.com/docs/copy-of-meta-conversion-events.md): Linking Labels with Meta Conversion Events in Automations
  - [Integrations](https://developer.cequens.com/docs/integrations-1.md)
  - [CEQUENS Bots](https://developer.cequens.com/docs/cequens-bots.md): Integrate and manage CEQUENS AI Agent bots, Rule-Based bots, and External bots with your OCC inboxes

## Guides: omni-link Studio
- [Concepts](https://developer.cequens.com/docs/concepts.md): Basic concepts about CEQUENS Omni-Link Studio

## Guides: GenAI Agent
- [Introduction](https://developer.cequens.com/docs/introduction-2.md): This page will introduce you to CEQUENS GenAI agent and how it works.
  - [Concepts](https://developer.cequens.com/docs/concepts-1.md): Basic concepts about CEQUENS GenAI agent
- [Setup overview](https://developer.cequens.com/docs/bot-setup.md): This page will help you to setup your GenAI agent on console
  - [Upload Documents Setup](https://developer.cequens.com/docs/upload-documents-setup.md): Enhance your GenAI agents' capabilities by uploading and incorporating your documents as a rich knowledge source. To do this, follow these steps.
  - [GenAI Agent Setup](https://developer.cequens.com/docs/genai-agent-setup.md): Build your GenAI agent by setting its personality, style, and knowledge base, then launch it for your users. This guide provides the steps to achieve this.
- [Prompt & Knowledge Center](https://developer.cequens.com/docs/prompt-knowledge-center.md)
  - [Prompt Best Practices](https://developer.cequens.com/docs/prompt-best-practices.md): The purpose of this guide is to provide comprehensive insights and practical recommendations for crafting effective prompts when interacting with AI agents. By understanding the significance of…
  - [Examples of Effective Prompts](https://developer.cequens.com/docs/examples-of-effective-prompts.md)
  - [Knowledge Documents Best Practices](https://developer.cequens.com/docs/knowledge-documents-best-practices.md): Provide the AI agent with access to structured datasets/folders uploaded. These folders, once indexed, allow the AI agent to generate more precise and contextually relevant responses.
  - [Knowledge Managing and Updating](https://developer.cequens.com/docs/knowledge-managing-and-updating.md): Maintaining and updating your uploaded documents is crucial for ensuring your AI model delivers accurate and relevant information. This section outlines essential practices for managing your document…

## Guides: Cequens Campaign
- [Quick Start](https://developer.cequens.com/docs/quick-start-1.md)
- [Quick Start](https://developer.cequens.com/docs/quick-start-2.md)
- [Email Campaign](https://developer.cequens.com/docs/email-campaign.md)
  - [Quick Start](https://developer.cequens.com/docs/quick-start-3.md)

## Guides: Cequens Conosle
- [Account Management](https://developer.cequens.com/docs/account-and-user-management.md)
  - [Account Registeration](https://developer.cequens.com/docs/account-registeration.md)
  - [Create Sub-Account](https://developer.cequens.com/docs/create-sub-account-1.md)
- [User Managmanet](https://developer.cequens.com/docs/user-managmanet.md)
  - [Invite User](https://developer.cequens.com/docs/invite-user.md)
- [Credit Management](https://developer.cequens.com/docs/credit-management.md)
  - [Top-up Account](https://developer.cequens.com/docs/top-up-account.md)
- [Security Measures](https://developer.cequens.com/docs/security-measures.md)
- [Contacts Management](https://developer.cequens.com/docs/contacts-management.md)

## Guides: CEQUENS MFA
- [Introduction](https://developer.cequens.com/docs/introduction-5.md): This page will introduce you to CEQUENS MFA and how it works.
  - [Product Utility](https://developer.cequens.com/docs/products-purpose.md): Highlight of product's purpose
  - [Unleash the power of CEQUENS MFA](https://developer.cequens.com/docs/sub-1.md): Overview of product’s functionalities
- [Setup Steps](https://developer.cequens.com/docs/page-2.md): This page will help you to setup CEQUENS MFA on console.
  - [Account Defaults](https://developer.cequens.com/docs/sub-2.md): Default variable to be used in the CEQUENS MFA APIs
  - [Sender ID](https://developer.cequens.com/docs/sender-id.md)
- [Templates](https://developer.cequens.com/docs/templates.md)
  - [System Templates](https://developer.cequens.com/docs/system-templates.md)
  - [Default Templates](https://developer.cequens.com/docs/default-templates.md)
  - [SMS Templates](https://developer.cequens.com/docs/sms-template.md)
  - [Email Templates](https://developer.cequens.com/docs/email-templates.md)
  - [Voice Templates](https://developer.cequens.com/docs/voice-templates.md)
  - [WhatsApp Templates](https://developer.cequens.com/docs/whatsapp-templates.md)
- [Push Authentication](https://developer.cequens.com/docs/push-authentication-1.md)

## API Reference: Authentication
- [Signing In](https://developer.cequens.com/reference/signin.md): To sign-in using the TOKEN API, first submit an HTTP Request with your Service Username and API Key, then receive a Response that includes your JWT access-token, which you will then provide in the…

## API Reference: SMS
- [DLR Webhook](https://developer.cequens.com/reference/dlr-webhook-1.md): With Push DLR you will receive DLR updates for SMS messages sent through your account. Each time CEQUENS receives an update for a sent message, we check if the user has setup Push DLR. If it is setup…

## API Reference: Conversation
- [WhatsApp Messaging APIs](https://developer.cequens.com/reference/whatsapp-messaging-apis.md): Explore the CEQUENS WhatsApp Business API for secure, flexible messaging solutions with proactive support and monitoring features.
  - [Send Text Messages](https://developer.cequens.com/reference/sending-text-message-1.md): Send text messages to your customers using the Cequens WhatsApp API. Learn about message limits, timing restrictions, and when to use template messages.
  - [Sending Image Messages](https://developer.cequens.com/reference/sending-media-message-image.md): Learn how to send image messages to customers via WhatsApp Business API. Includes format requirements, size limits, code examples, and best practices for delivering visual content.
  - [Sending Document Messages](https://developer.cequens.com/reference/sending-media-message-document.md): Learn how to send document files (PDF, Word, Excel, PowerPoint) to your customers via WhatsApp using the CEQUENS API. Includes supported formats, best practices, and examples.
  - [Sending Audio Messages](https://developer.cequens.com/reference/sending-media-message-audio.md): Send audio files to your customers including voice messages and audio recordings.
  - [Sending Video Message](https://developer.cequens.com/reference/sending-media-message-video.md): Send video files to your customers for product demonstrations, tutorials, or promotional content.
  - [Sending Template Message](https://developer.cequens.com/reference/sending-template-message.md): Send pre-approved message templates to your customers. Template messages can be sent outside the 24-hour customer care window and are ideal for notifications, reminders, and promotional messages.
  - [Sending Carousel Template](https://developer.cequens.com/reference/sending-carousel-template.md): Use this API to send templates messages to your customers.
  - [Sending Flow Template](https://developer.cequens.com/reference/sending-flow-template.md): Use this API to send flow templates messages to your customers.
  - Media Management
    - [Uploading Media](https://developer.cequens.com/reference/uploading-media.md): Use this API to upload, retrieve, or delete media.
  - WhatsApp Inbound/Notifications
    - [Inbound Replies to Sent Messages](https://developer.cequens.com/reference/inbound-replies-to-sent-messages.md): Users can respond to a specific message on WhatsApp.
    - [Message Status Notifications](https://developer.cequens.com/reference/message-status-notifications.md): Message status notifications provided information about the status of your messages.
- [Facebook Messenger API](https://developer.cequens.com/reference/facebook-messenger.md): To try out our Facebook Messenger APIs, start by asking your assigned Account Manager for access token or use **pre-generated** one on CEQUENS Communication Platform.

## API Reference: Voice
- [Call with User input](https://developer.cequens.com/reference/simple-call-voice-sms.md): This API endpoint allows users to initiate a voice call to a mobile number, during which a voice message will be played. Users can specify the voice message using either the Text-to-Speech (TTS) or…
- [Call with Advanced Call Control](https://developer.cequens.com/reference/call-with-advanced-call-control.md): Allowing you to create interactive voice experiences for your users. With this endpoint, you can send a call execution plan, which is an XML document containing instructions for the call,  such as…
- [Upload an Audio File](https://developer.cequens.com/reference/upload-an-audio-file.md): https://apis.cequens.com/voice/v1/voice/file
- [Retrieve an Audio File](https://developer.cequens.com/reference/retrieve-an-audio-file.md): https://apis.cequens.com/voice/v1/voice/file/{fileId}

## API Reference: E-Mail APIs
- [Send E-Mail request](https://developer.cequens.com/reference/send-email-request.md): Use E-Mail endpoint to send single E-Mail . When you send a request using this API, the API will return to you the sent request’ ID to track it later using our platform.

## API Reference: Omni-Link API
- Events
  - [Trigger event](https://developer.cequens.com/reference/eventscontroller_trackevent.md): Trigger event is the main (and only) way to send notifications to subscribers.      The trigger identifier is used to match the particular workflow associated with it.      Additional information can…
  - [Bulk trigger event](https://developer.cequens.com/reference/eventscontroller_triggerbulkevents.md): Using this endpoint you can trigger multiple events at once, to avoid multiple calls to the API.       The bulk API is limited to 100 events per request.
  - [Broadcast event to all](https://developer.cequens.com/reference/eventscontroller_trackeventtoall.md): Trigger a broadcast event to all existing subscribers, could be used to send announcements, etc.       In the future could be used to trigger events to a subset of subscribers based on defined…
  - [Cancel triggered event](https://developer.cequens.com/reference/eventscontroller_canceldelayed.md): Using a previously generated transactionId during the event trigger,      will cancel any active or pending workflows. This is useful to cancel active digests, delays etc...
- Subscribers
  - [Get subscribers](https://developer.cequens.com/reference/subscriberscontroller_getsubscribers.md): Returns a list of subscribers, could paginated using the `page` and `limit` query parameter
  - [Create subscriber](https://developer.cequens.com/reference/subscriberscontroller_createsubscriber.md): Creates a subscriber entity, in the Omni-Link platform. The subscriber will be later used to receive notifications, and access notification feeds. Communication credentials such as email, phone…
  - [Get subscriber](https://developer.cequens.com/reference/subscriberscontroller_getsubscriber.md): Get subscriber by your internal id used to identify the subscriber
  - [Update subscriber](https://developer.cequens.com/reference/subscriberscontroller_updatesubscriber.md): Used to update the subscriber entity with new information
  - [Delete subscriber](https://developer.cequens.com/reference/subscriberscontroller_removesubscriber.md): Deletes a subscriber entity from the Omni-Link platform
  - [Create subscriber](https://developer.cequens.com/reference/subscriberscontroller_insertsubscribersbulk.md): Bulk creates a subscribers entities, in the Omni-Link platform. The subscribers will be later used to receive notifications, and access notification feeds. Communication credentials such as email,…
  - [Verify subscribers](https://developer.cequens.com/reference/subscriberscontroller_verifysubscribers.md): Verify subscribers entities, in the Omni-Link platform. The subscribers will be later used to receive notifications, and access notification feeds. Communication credentials such as email, phone…
  - [Update subscriber online status](https://developer.cequens.com/reference/subscriberscontroller_updatesubscriberonlineflag.md): Used to update the subscriber isOnline flag.
  - [Get subscriber preferences](https://developer.cequens.com/reference/subscriberscontroller_getsubscriberpreference.md)
  - [Update subscriber global preferences](https://developer.cequens.com/reference/subscriberscontroller_updatesubscriberglobalpreferences.md)
  - [Get subscriber preferences by level](https://developer.cequens.com/reference/subscriberscontroller_getsubscriberpreferencebylevel.md)
  - [Update subscriber preference](https://developer.cequens.com/reference/subscriberscontroller_updatesubscriberpreference.md)
- Topics
  - [Topic creation](https://developer.cequens.com/reference/topicscontroller_createtopic.md): Create a topic
  - [Filter topics](https://developer.cequens.com/reference/topicscontroller_filtertopics.md): Returns a list of topics that can be paginated using the `page` query parameter       and filtered by the topic key with the `key` query parameter
  - [Subscribers addition](https://developer.cequens.com/reference/topicscontroller_addsubscribers.md): Add subscribers to a topic by key
  - [Check topic subscriber](https://developer.cequens.com/reference/topicscontroller_gettopicsubscriber.md): Check if a subscriber belongs to a certain topic
  - [Subscribers removal](https://developer.cequens.com/reference/topicscontroller_removesubscribers.md): Remove subscribers from a topic
  - [Delete topic](https://developer.cequens.com/reference/topicscontroller_deletetopic.md): Delete a topic by its topic key if it has no subscribers
  - [Get topic](https://developer.cequens.com/reference/topicscontroller_gettopic.md): Get a topic by its topic key
  - [Rename a topic](https://developer.cequens.com/reference/topicscontroller_renametopic.md): Rename a topic by providing a new name

## API Reference: Mo webhook
- [MO Forwarding Through HTTP](https://developer.cequens.com/reference/mo-forwarding-through-http.md): CEQUENS can provide the customers with Short/Long codes, where the clients can Send and Receive SMS from users. With MO (Mobile Originated) forwarding the customer will receive MO messages sent…

## API Reference: Knowledge Base
- [Create an empty Knowledge](https://developer.cequens.com/reference/create-an-empty-knowledge.md): This API allows users to initialize a new knowledge base with a specified name. The created knowledge base will be empty, ready for adding files.
- [Knowledge list](https://developer.cequens.com/reference/knowledge-list.md): This API retrieves a list of all existing knowledge bases, including their details such as names, IDs, and creation dates, to help you manage and organize their data sources.
- [Knowledge document list](https://developer.cequens.com/reference/knowledge-document-list.md): This API fetches a list of all documents within a specified knowledge base, providing details such as document names, IDs, upload dates, and statuses for easy management and reference.
- [Create a document from text](https://developer.cequens.com/reference/create-a-document-from-text.md): This api is based on an existing Knowledge and creates a new document through text based on this Knowledge.
- [Delete knowledge](https://developer.cequens.com/reference/delete-knowledge.md): This API allows users to remove a specified knowledge base permanently. It ensures that all associated data within the knowledge base is deleted, streamlining data management and maintaining a clean…
- [Delete document](https://developer.cequens.com/reference/delete-document.md): This API enables users to delete a specific document from a knowledge base. It ensures precise control over data management by removing unwanted or outdated files while keeping the rest of the…

## Pages
- [How we handle feature requests and suggestions ?](https://developer.cequens.com/page/how-we-handle-feature-requests-and-suggestions.md)
- [Number Lookup Application](https://developer.cequens.com/page/number-lookup-application.md)