ChatmaidChatmaid DevelopersChatmaid Dev
Docs
DashboardStart Building
Get Started

Overview

Introduction to the Chatmaid Developers platform and API contract.

Platform

Chatmaid Developers provides a WhatsApp messaging API plus a dashboard for key management, billing, phone connections, and delivery observability.

This documentation focuses on the integration contract used by API consumers. Public APIs are versioned and stable under /v1.

Base URL:

  • https://developers-api.chatmaid.net

Integration host: https://developers-api.chatmaid.net.

Public vs Internal
Integrators should only call documented message endpoints. Dashboard setup actions (billing, phone setup, webhook configuration) happen in the UI. This docs site focuses on API-key authenticated endpoints for runtime integrations.

API Contract

Integration endpoints for API consumers:

  • POST /v1/messages/send
  • GET /v1/messages
  • GET /v1/messages/:messageId
  • GET /v1/phone-numbers
  • GET /v1/phone-numbers/:id
  • GET /v1/phone-numbers/:id/status
  • GET /v1/account
  • GET /v1/account/usage

Integration Flow

  1. Create account and complete setup in dashboard.
  2. Develop and validate first with sk_test_* keys.
  3. Generate API key in dashboard.
  4. Discover phone IDs via GET /v1/phone-numbers.
  5. Send messages via POST /v1/messages/send.
  6. Track status via polling or webhooks.
  7. Promote by using sk_live_* keys in production systems.

Next Steps

On This Page