# Wazapin API Documentation

> Integrate WhatsApp — send messages, receive webhooks, and automate with Wazapin.

## Get started
- [Introduction](https://docs.wazapin.id/introduction.md): Send notifications, reply to customers, and automate WhatsApp from your app — Wazapin integration guide.
- [Quickstart](https://docs.wazapin.id/getting-started/quickstart.md): Send your first WhatsApp message in a few minutes.
- [Connect your number](https://docs.wazapin.id/getting-started/connect-channel.md): Link WhatsApp in the dashboard and get a channel_id for your integration.
- [API keys](https://docs.wazapin.id/api/authentication.md): Create API keys and authenticate your integration with X-Api-Key.
- [API overview](https://docs.wazapin.id/api/overview.md): Base URL, headers, and request conventions for the Wazapin API.

## WhatsApp concepts
- [WhatsApp concepts overview](https://docs.wazapin.id/whatsapp-basics/overview.md): Understand WhatsApp platform concepts including session windows, channel types, and message lifecycles.
- [Customer service window](https://docs.wazapin.id/whatsapp-basics/session-window.md): Learn how the 24-hour customer service window works and the difference between session and template messages.
- [Channel types](https://docs.wazapin.id/whatsapp-basics/channel-types.md): Understand the differences between official WhatsApp Business Cloud API channels and unofficial channels.
- [Message lifecycle](https://docs.wazapin.id/whatsapp-basics/message-lifecycle.md): Learn how messages transition through queued, sent, delivered, and read states, and how to use idempotency.

## Send messages
- [Sending overview](https://docs.wazapin.id/getting-started/sending-overview.md): Learn how to choose between session and template messages and find the right message type.
- [Message types](https://docs.wazapin.id/getting-started/send-messages.md): Pick a message type — text, media, buttons, templates, and more.
- [Send text](https://docs.wazapin.id/getting-started/send-text.md): Send plain text messages and replies on WhatsApp.
- [Send buttons](https://docs.wazapin.id/getting-started/send-buttons.md): Send interactive button messages on WhatsApp.
- [Send list](https://docs.wazapin.id/getting-started/send-list.md): Send interactive list messages on WhatsApp.
- [Send image](https://docs.wazapin.id/getting-started/send-image.md): Send image messages with an optional caption.
- [Send video](https://docs.wazapin.id/getting-started/send-video.md): Send video messages with an optional caption.
- [Send audio](https://docs.wazapin.id/getting-started/send-audio.md): Send audio and voice messages on WhatsApp.
- [Send document](https://docs.wazapin.id/getting-started/send-document.md): Send PDF and document files on WhatsApp.
- [Send sticker](https://docs.wazapin.id/getting-started/send-sticker.md): Send sticker messages on WhatsApp.
- [Send location](https://docs.wazapin.id/getting-started/send-location.md): Send a location pin on WhatsApp.
- [Request location](https://docs.wazapin.id/getting-started/request-user-location.md): Ask a customer to share their location.
- [Send contact](https://docs.wazapin.id/getting-started/send-contact.md): Share a contact card in WhatsApp.
- [Send reaction](https://docs.wazapin.id/getting-started/send-reaction.md): React to a message with an emoji.
- [Mark read](https://docs.wazapin.id/getting-started/mark-messages-read.md): Mark inbound messages as read.

## Receive messages
- [Receive overview](https://docs.wazapin.id/receive-messages/overview.md): Configure HTTPS endpoints to receive real-time messages, delivery receipts, and template status updates from Wazapin.
- [Handle inbound text](https://docs.wazapin.id/guides/handle-inbound-text.md): Learn how to receive, verify, and extract content from customer-initiated text messages in WhatsApp.
- [Handle inbound media](https://docs.wazapin.id/guides/handle-inbound-media.md): Learn how to detect, fetch, and download photos, videos, documents, and stickers sent by WhatsApp users.
- [Handle interactive replies](https://docs.wazapin.id/guides/handle-interactive-replies.md): Learn how to parse quick-replies and list selections sent by WhatsApp users.
- [Handle delivery status](https://docs.wazapin.id/guides/handle-delivery-status.md): Learn how to track message delivery receipts (sent, delivered, read, failed).
- [Webhooks reference](https://docs.wazapin.id/api/webhooks.md): Receive Wazapin events on your HTTPS endpoint using the developer webhooks API.
- [Event catalog](https://docs.wazapin.id/api/webhook-event-catalog.md): Subscribable webhook event types, when they fire, and sample JSON bodies.
- [Payload examples](https://docs.wazapin.id/api/inbound-webhook-examples.md): Example JSON bodies Wazapin POSTs to your webhook URL.
- [Signature examples](https://docs.wazapin.id/api/webhook-signature-examples.md): Verify Wazapin webhook deliveries on your server using the endpoint signing secret.
- [Lifecycle & idempotency](https://docs.wazapin.id/api/message-lifecycle-idempotency.md): Delivery status lifecycle, retry boundaries, and idempotency patterns for reliable messaging.
- [Webhook recipe](https://docs.wazapin.id/recipes/handle-webhook-events.md): Verify signatures, deduplicate deliveries, and process events without dropping messages.

## Templates
- [Templates overview](https://docs.wazapin.id/templates/overview.md): Understand WhatsApp message template categories, approval flows, variables, and sending rules.
- [Authentication & OTP templates](https://docs.wazapin.id/templates/authentication-otp.md): Learn how to build and send secure One-Time Password (OTP) messages with copy-code buttons.
- [Send templates](https://docs.wazapin.id/getting-started/send-template.md): Send approved template notifications (order updates, reminders).

## SDKs
- [TypeScript SDK](https://docs.wazapin.id/sdk/typescript.md): Official @wazapin/sdk client — typed builders, automatic retries, pagination, and webhook verification.
- [SDK quickstart](https://docs.wazapin.id/sdk/quickstart.md): Install @wazapin/sdk, find your channel id, and send your first WhatsApp message.
- [SDK messages](https://docs.wazapin.id/sdk/messages.md): Send, read, and manage WhatsApp messages — text, buttons, lists, and catalog — with @wazapin/sdk.
- [SDK templates](https://docs.wazapin.id/sdk/templates.md): List, inspect, sync, and send WhatsApp templates with @wazapin/sdk.
- [SDK webhooks](https://docs.wazapin.id/sdk/webhooks.md): Manage webhook endpoints and verify signed webhook deliveries with @wazapin/sdk.
- [SDK utilities](https://docs.wazapin.id/sdk/utilities.md): Use message builders, pagination helpers, errors, and the low-level typed API client.
- [SDK contacts](https://docs.wazapin.id/sdk/contacts.md): Create, list, and look up contacts with @wazapin/sdk.
- [SDK channels](https://docs.wazapin.id/sdk/channels-phone-numbers.md): List connected channels and inspect phone number status with @wazapin/sdk.
- [SDK conversations](https://docs.wazapin.id/sdk/conversations.md): List and manage conversations with @wazapin/sdk.
- [SDK media](https://docs.wazapin.id/sdk/media-upload.md): Upload media assets and send media messages with @wazapin/sdk.
- [SDK flows](https://docs.wazapin.id/sdk/flows.md): Send WhatsApp Flow messages with @wazapin/sdk.
- [Direct language integration](https://docs.wazapin.id/api/sdks.md): Call the Wazapin HTTP API directly from Python, Go, PHP, or any language with fetch/cURL.

## Platform
- [Playground guide](https://docs.wazapin.id/api/playground-guide.md): Test Wazapin endpoints in your browser with your API key — no dashboard login required.
- [Postman collection](https://docs.wazapin.id/integrations/postman.md): Import and run requests quickly using the Wazapin Postman collection.
- [Errors reference](https://docs.wazapin.id/api/errors.md): Error handling guidelines, HTTP status codes, and common error shapes.
- [Error codes](https://docs.wazapin.id/api/error-codes.md): Complete list of Wazapin error codes, descriptions, and troubleshooting steps.
- [Rate limits](https://docs.wazapin.id/api/rate-limits.md): Request limits, throttling signals, and how to retry without overwhelming the API.
- [Security practices](https://docs.wazapin.id/api/security-best-practices.md): Credential, transport, and webhook security recommendations for API integrations.
- [Permissions matrix](https://docs.wazapin.id/api/permissions-matrix.md): Which API key permissions each integration needs — messages, channels, webhooks, and more.
- [Channel support](https://docs.wazapin.id/api/channel-support.md): Which message types and setup flows work on official Meta channels vs gateway channels.

## API reference
- [API reference overview](https://docs.wazapin.id/api-reference/overview.md): Overview of the Wazapin REST API and interactive playground.
- [Reference: send message](https://docs.wazapin.id/api/reference-send-message.md): Example requests and parameters for sending WhatsApp messages.
- [Reference: get message](https://docs.wazapin.id/api/reference-get-message.md): Example request and response for GET /v1/messages/{messageID}.
- [Reference: login](https://docs.wazapin.id/api/reference-auth-login.md): Example request and response for POST /v1/auth/login.
- [Reference: contacts](https://docs.wazapin.id/api/reference-contacts.md): Example requests and parameter references for CRM contacts.

## Examples
- [Recipe: send text message](https://docs.wazapin.id/recipes/send-text-message.md): Notify a customer with a plain text WhatsApp message, end to end.
- [Recipe: send template message](https://docs.wazapin.id/recipes/send-template-message.md): Send an order update template with body variables.