{"templateId":"openapi_docs","sharedDataIds":{"openAPIDocsStore":"oas-apis/conversations.yaml","sidebar":"sidebar-sidebar.yaml__apis_conversations"},"props":{"definitionId":"apis/conversations.yaml","dynamicMarkdocComponents":[],"baseSlug":"/apis/conversations","seo":{"title":"eCommunicate Conversations API","siteUrl":"https://docs.ecommunicate.co.za","keywords":["eCommunicate API","WhatsApp Business API","SMS API","omnichannel messaging","WhatsApp templates","messaging platform","South Africa messaging API"],"llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"itemId":"","disableAutoScroll":true,"metadata":{"type":"openapi","title":"eCommunicate Conversations API","description":"# Overview\nThe eCommunicate Conversations API enables you to create, manage, and send messages within\n**long-lived WhatsApp conversation sessions**. Unlike standard WhatsApp messaging, where a\nbusiness-initiated session automatically expires after 24 hours, eCommunicate Conversations\nremain open **until explicitly closed** by either the business or the recipient, allowing\nongoing dialogue that can span days, weeks, or even months.\n\n## What are Conversations?\nA conversation is a persistent, bi-directional communication channel between a WhatsApp\nBusiness number and a customer. These conversations are **not** governed by the\n[WhatsApp 24-hour session window](https://developers.facebook.com/docs/whatsapp/pricing)\nthat applies to standard notification and session messages.\n\nConversations are ideal for use cases where an extended dialogue is required, such as:\n- **Sales and lead nurturing** — a salesperson opens a conversation with a prospect and\n  follows up over several weeks until a deal is closed.\n- **Customer onboarding** — guide a customer through multi-step onboarding processes at\n  their own pace.\n- **After-sales support** — keep a support thread open for the duration of a service case\n  or warranty claim.\n- **Appointment management** — maintain an open channel for scheduling, rescheduling, and\n  confirming appointments.\n\nEach conversation is assigned a unique `conversationId` (UUID) upon creation. This identifier\nis used across all subsequent API calls to send messages, check status, and close the session.\n\n## Authentication\nEvery request requires a Developer API Key in the `Authorization` header. This key authenticates\nyour application and associates requests with your eCommunicate account. Contact the eCommunicate\nteam to obtain your key, along with approved template IDs and template names.\n\n## How It Works\n1. **Create** a conversation between your WhatsApp Business number and a recipient using the\n   [Create a conversation](#tag/Manage-Conversations/operation/createConversation) endpoint.\n   You will receive a `conversationId` to reference in all future operations.\n2. **Send** text, media, call-to-action, card, or quick-reply messages within the conversation\n   using the [Send a conversation message](#tag/Send-Messages/operation/sendConversationMessage)\n   endpoint. All messages are delivered through pre-approved WhatsApp templates.\n3. **Monitor** the conversation at any time: check the\n   [remaining time](#tag/Manage-Conversations/operation/getRemainingTime) before expiry, or\n   [list all conversations](#tag/Manage-Conversations/operation/getMyConversations) to review\n   their status.\n4. **Close** the conversation when the interaction is complete using the\n   [Close a conversation](#tag/Manage-Conversations/operation/closeConversation) endpoint.\n   Once closed, no further messages can be sent within that session.\n\n## Message Types\nThe API supports five template-based message types, each suited to different communication needs:\n\n| Type | Description |\n|---|---|\n| Text Only | A template populated with body text parameters only. Use for simple informational messages. |\n| Text + Media | A template combining body text with a media attachment such as a PDF, image, or video. Ideal for sending invoices, brochures, or product images. |\n| Call to Action | A template with body text and one or more CTA buttons (e.g., \"Visit Website\" or \"Call Now\"). Use to drive specific customer actions. |\n| Card | A rich template combining media, body text, and recipient tracking. Suited for product showcases or interactive catalogues. |\n| Quick Reply | A template with body text and interactive quick-reply buttons that can control conversation flow (start or end a conversation branch). Use for guided decision trees or surveys. |\n"},"compilationErrors":[],"markdown":{"partials":{},"variables":{"rbac":{"teams":["anonymous"]},"user":{},"remoteAddr":{"hostname":"docs.ecommunicate.co.za","port":4000,"ipAddress":"216.73.217.36"},"lang":"default_locale","env":{"PUBLIC_REDOCLY_BRANCH_NAME":"main"}}},"pagePropGetterError":{"message":"","name":""}},"slug":"/apis/conversations","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}