How to get started with the CallMePing developer API

Before you start

• You need an active plan or free trial. Without one, every call returns 402 with: The developer API needs an active plan.
• Only the account owner can create API keys and set up the webhook. Team members given the Developer API menu can read the reference but cannot create keys.
• Your WhatsApp number must be connected. Check that GET /me returns status working before sending.

Base URL and conventions

The base URL is your app domain followed by /api/v1, for example https://callmeping.com/api/v1. The Developer API page shows the exact base URL under Quick start.

• Send your key as Authorization: Bearer YOUR_API_KEY (or in an X-Api-Key header).
• Bodies are JSON. Send Content-Type: application/json.
• Phone numbers are digits with the country code and no plus sign, for example 919876543210.
• Timestamps are ISO 8601 in UTC, except scheduledAt on posts, which is local time in your profile timezone.
• Group ids look like [email protected]. Get them from GET /groups.

Make your first call

1. Open Developer API in the Account section of the sidebar.
2. Type a label in the API keys card and press Create key.
3. Press Copy key and store it somewhere safe.
4. Call GET /me with the key to check it works.

curl -X GET "https://callmeping.com/api/v1/me" \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "id": "7c2e5a90-...",
  "phoneNumber": "919000000000",
  "name": "Asha Traders",
  "status": "working",
  "timezone": "Asia/Kolkata",
  "aiGloballyEnabled": true
}

status is one of pending, working, failed or logged_out. Only send messages when it is working.

Send messages

You can only reply to people who messaged you first. The API cannot cold-message new numbers, which protects your number from bans. Groups your number is in can be messaged directly.

curl -X POST "https://callmeping.com/api/v1/messages/send" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"to":"919876543210","text":"Your order has shipped."}'

curl -X POST "https://callmeping.com/api/v1/groups/[email protected]/messages" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text":"Hello everyone"}'

curl -X POST "https://callmeping.com/api/v1/groups/[email protected]/messages" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text":"New offers","media":{"url":"https://example.com/poster.jpg","mimetype":"image/jpeg","filename":"poster.jpg"}}'

Give media as exactly one of url (a public http or https link) or base64, with a mimetype. Sending to a number that has never messaged you returns 403.

Reply inside a chat where the AI is on

To reply with POST /chats/{chatId}/messages, first turn the AI off for that chat. If the AI is still replying there, the call returns 409 asking you to take over the conversation. Get the chat id from GET /chats.

curl -X POST "https://callmeping.com/api/v1/chats/CHAT_ID/ai" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"enabled":false}'

curl -X POST "https://callmeping.com/api/v1/chats/CHAT_ID/messages" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"body":"Thanks, we will deliver today."}'

What else the API covers

Every endpoint, with a ready to copy curl command and example response, is listed on the Developer API page. Click an endpoint to open it.

• Groups: list, details, rename, add or remove members (your number must be a group admin), leave, read and send messages.
• Chats and labels: list chats, read and send messages, turn the AI on or off per chat, create labels and put them on chats.
• AI settings: read and change tone, unknown question handling, reply delay and auto resume.
• Train AI: knowledge cards, files (CSV or PDF under 5 MB), images (under 8 MB) and importing a web page.
• AI Automations and leads: create and edit automations, and read captured leads with GET /automations/{automationId}/collected.
• Scheduled posts and Summaries: schedule posts to groups and numbers, create and run group summaries.