# Cogfy Messenger

## Docs

- [Introduction](https://docs.cogfy.com/index.md): Welcome to Cogfy Messenger documentation
- [Quickstart](https://docs.cogfy.com/quickstart.md): Create your first WhatsApp AI Agent in a few minutes
- [Overview](https://docs.cogfy.com/guide/fundamentals/overview.md): Manage your Cogfy Messenger workspaces
- [Members](https://docs.cogfy.com/guide/fundamentals/members.md): Manage your Cogfy Messenger workspaces members
- [Tags](https://docs.cogfy.com/guide/fundamentals/tags.md): Manage your Cogfy Messenger workspaces tags
- [API Keys](https://docs.cogfy.com/guide/fundamentals/api-keys.md): Manage your Cogfy Messenger workspaces API keys
- [Contacts](https://docs.cogfy.com/guide/fundamentals/contacts.md): Manage contacts in Cogfy Messenger
- [Analytics](https://docs.cogfy.com/guide/fundamentals/analytics.md): Monitor and analyze your Cogfy Messenger workspace performance
- [Connect Phone Number](https://docs.cogfy.com/guide/phone-numbers/connect-phone-number.md): Link your phone number to your Cogfy Messenger account
- [Phone number conversations](https://docs.cogfy.com/guide/phone-numbers/phone-number-conversations.md): Manage conversations linked to your phone number in Cogfy Messenger
- [WhatsApp phone number profile settings](https://docs.cogfy.com/guide/phone-numbers/whatsapp-phone-profile-settings.md): Update and manage your WhatsApp phone number profile settings in Cogfy Messenger
- [Overview](https://docs.cogfy.com/guide/workflows/overview.md): Learn about Cogfy Workflows and how to manage them in Cogfy Messenger
- [Create Your First Workflow](https://docs.cogfy.com/guide/workflows/tutorial-first-workflow.md): In this tutorial you will quickly learn how to create a new workflow and publish it in a phone number.
- [Message Received](https://docs.cogfy.com/guide/workflows/nodes/triggers/message-received-node.md): Triggers the workflow on receiving a message on the published phone number.
- [JavaScript Code](https://docs.cogfy.com/guide/workflows/nodes/core/java-script-code-node.md): Execute arbitrary Javascript code
- [OpenAI Assistant](https://docs.cogfy.com/guide/workflows/nodes/core/assistant/openai-assistant-node.md): Chat completion models by OpenAI
- [WhatsApp Text Message](https://docs.cogfy.com/guide/workflows/nodes/core/send-message/send-whatsapp-text-message.md): Text messaging using Meta's WhatsApp
- [If Node](https://docs.cogfy.com/guide/workflows/nodes/logic/if-node.md): Conditional routing
- [Introduction](https://docs.cogfy.com/api-reference/introduction.md): Cogfy messenger provides an HTTP API that can be used to perform actions on your workspace. The API is available at https://messenger-public-api.cogfy.com
- [Authentication](https://docs.cogfy.com/api-reference/authentication.md): All requests made to the Cogfy API must be authenticated. This is done by providing an API key in the header `Api-Key` of each request:
- [Create a new broadcast](https://docs.cogfy.com/api-reference/endpoint/broadcasts/create.md): Creates a broadcast for a phone number of the workspace.
- [List all broadcasts](https://docs.cogfy.com/api-reference/endpoint/broadcasts/list.md)
- [Get a broadcast by ID](https://docs.cogfy.com/api-reference/endpoint/broadcasts/get-by-id.md)
- [Send a broadcast by ID](https://docs.cogfy.com/api-reference/endpoint/broadcasts/send.md)
- [Pause a sending broadcast](https://docs.cogfy.com/api-reference/endpoint/broadcasts/pause.md)
- [Resume a paused broadcast](https://docs.cogfy.com/api-reference/endpoint/broadcasts/resume.md)
- [List messages of a broadcast](https://docs.cogfy.com/api-reference/endpoint/broadcasts/get-messages.md): Returns a paginated list of messages for a specific broadcast. Use the `status` query parameter to filter by message status.
- [Get all conversations](https://docs.cogfy.com/api-reference/endpoint/conversations/get.md)
- [Get a conversation by ID](https://docs.cogfy.com/api-reference/endpoint/conversations/get-by-id.md)
- [Send a message to a conversation](https://docs.cogfy.com/api-reference/endpoint/conversations/send-message.md)
- [Get all conversation messages by ID](https://docs.cogfy.com/api-reference/endpoint/conversations/get-messages.md)
- [Enqueue a conversation session](https://docs.cogfy.com/api-reference/endpoint/conversation-sessions/enqueue.md): Enqueues the open conversation session for a contact into a queue and persists the observation as transfer_observation.
- [Create a contact](https://docs.cogfy.com/api-reference/endpoint/contacts/create.md): Creates a contact in the workspace.
- [Delete a contact](https://docs.cogfy.com/api-reference/endpoint/contacts/delete.md)
- [Get a contact by ID](https://docs.cogfy.com/api-reference/endpoint/contacts/get-by-id.md)
- [Update a contact by ID](https://docs.cogfy.com/api-reference/endpoint/contacts/update-by-id.md): Updates the given fields of a contact. Omitted fields are left untouched; sending `null` clears the field.
- [Update the tags of a contact](https://docs.cogfy.com/api-reference/endpoint/contacts/update-tags.md): Links and unlinks tags of a contact. Each tag is referenced by `id` or by `name`.
- [Get a contact page](https://docs.cogfy.com/api-reference/endpoint/contacts/get.md): Lists the contacts of the workspace, 25 per page.
- [Send an audio message](https://docs.cogfy.com/api-reference/endpoint/messages/send-audio.md): Provide either `id`, for a media previously uploaded through `POST /messages/upload-media`, or `link`, a public URL WhatsApp can download from.
- [Send contacts message](https://docs.cogfy.com/api-reference/endpoint/messages/send-contacts.md): Sends one or more contact cards.
- [Send document message](https://docs.cogfy.com/api-reference/endpoint/messages/send-document.md): Provide either `id`, for a media previously uploaded through `POST /messages/upload-media`, or `link`, a public URL WhatsApp can download from.
- [Send image message](https://docs.cogfy.com/api-reference/endpoint/messages/send-image.md): Provide either `id`, for a media previously uploaded through `POST /messages/upload-media`, or `link`, a public URL WhatsApp can download from.
- [Send interactive button message](https://docs.cogfy.com/api-reference/endpoint/messages/send-interactive-button.md): Sends up to 3 reply buttons.
- [Send interactive CTA URL message](https://docs.cogfy.com/api-reference/endpoint/messages/send-interactive-cta-url.md): Sends a message with a button that opens a URL.
- [Send interactive flow message](https://docs.cogfy.com/api-reference/endpoint/messages/send-interactive-flow.md): Sends a message with a button that opens a published WhatsApp flow.
- [Send interactive list message](https://docs.cogfy.com/api-reference/endpoint/messages/send-interactive-list.md): Sends a message with a list of selectable options.
- [Send interactive order details message](https://docs.cogfy.com/api-reference/endpoint/messages/send-interactive-order-details.md): Sends an order summary with payment instructions. Amounts are integers scaled by `offset` — `{ value: 1050, offset: 100 }` means 10.50.
- [Send interactive carousel message](https://docs.cogfy.com/api-reference/endpoint/messages/send-interactive-carousel.md): Sends up to 10 cards, each with its own header and action.
- [Send interactive order status message](https://docs.cogfy.com/api-reference/endpoint/messages/send-interactive-order-status.md): Updates the status of an order previously sent through `POST /messages/interactive/order_details`, matched by `reference_id`.
- [Send location message](https://docs.cogfy.com/api-reference/endpoint/messages/send-location.md): Requires an open service window: the recipient must have messaged the business in the last 24 hours. Use `POST /messages/template` to reach recipients outside that window.
- [Send reaction message](https://docs.cogfy.com/api-reference/endpoint/messages/send-reaction.md): Reacts to a message previously exchanged in the conversation. `reaction.message_id` is the WhatsApp id of the message being reacted to, and must belong to the workspace. Send an empty `emoji` to remove a reaction.
- [Send sticker message](https://docs.cogfy.com/api-reference/endpoint/messages/send-sticker.md): Provide either `id`, for a media previously uploaded through `POST /messages/upload-media`, or `link`, a public URL WhatsApp can download from.
- [Send template message](https://docs.cogfy.com/api-reference/endpoint/messages/send-template.md): Sends an approved WhatsApp template message. This is the only message type that reaches recipients that never messaged the business or whose service window is closed.
- [Send text message](https://docs.cogfy.com/api-reference/endpoint/messages/send-text.md): Requires an open service window: the recipient must have messaged the business in the last 24 hours. Use `POST /messages/template` to reach recipients outside that window.
- [Send video message](https://docs.cogfy.com/api-reference/endpoint/messages/send-video.md): Provide either `id`, for a media previously uploaded through `POST /messages/upload-media`, or `link`, a public URL WhatsApp can download from.
- [Get a message by id](https://docs.cogfy.com/api-reference/endpoint/messages/get-by-id.md)
- [Upload media to WhatsApp](https://docs.cogfy.com/api-reference/endpoint/messages/upload-media.md): Uploads a file to WhatsApp Cloud API. Use the returned id as document.id when calling POST /messages/document.
- [Create a tag](https://docs.cogfy.com/api-reference/endpoint/tags/create.md): Creates a tag in the workspace.
- [Get a tag page](https://docs.cogfy.com/api-reference/endpoint/tags/get.md): Lists every tag of the workspace, ordered by name.
- [Delete a tag by ID](https://docs.cogfy.com/api-reference/endpoint/tags/delete.md): Deletes a tag from the workspace. Returns the tag that was deleted.
- [Update a tag by ID](https://docs.cogfy.com/api-reference/endpoint/tags/update-by-id.md): Updates the name of a tag. Contacts and conversations linked to the tag keep their link.
- [Get a tag by ID](https://docs.cogfy.com/api-reference/endpoint/tags/get-by-id.md)

## OpenAPI Specs

- [openapi](https://docs.cogfy.com/api-reference/openapi.json)

## Optional

- [Cogfy Messenger](https://messenger.cogfy.com)