CallMissed

https://github.com/callmissed/callmissed-docs
Admin
OpenAI-compatible APIs for WhatsApp chatbots and AI voice agents: chat completion, speech-to-text,...
Tokens:870,405
Snippets:4,240
Trust Score:1
Update:3 days ago
Show doc for...
Tokens:
Raw
================
LIBRARY RULES
================
- Base URL is https://api.callmissed.com
- Endpoints are OpenAI-compatible: use the OpenAI SDK and set base_url to https://api.callmissed.com/v1
- API keys are prefixed with cm_ and sent as the header Authorization: Bearer cm_your_key
- Use sarvam-30b or sarvam-105b for Indic-language LLM tasks
- Use saaras:v3 for Indian-language speech-to-text across 22 Indic languages
- Use bulbul:v3 for Indian-language text-to-speech (39 voices across 11 languages)
- The Anthropic Messages API is available at /v1/messages using the Anthropic SDK
- Free-tier models include kimi-k2.5, sarvam-30b, sarvam-105b, saaras:v3, and bulbul:v3

================
CODE SNIPPETS
================
### Install OpenAI SDK (Python, JavaScript/TypeScript, Go, PHP, Ruby, Java)

Source: https://github.com/callmissed/callmissed-docs/blob/main/docs/quickstart.md

Install the OpenAI SDK for your preferred language. The Java example is a comment placeholder; use OkHttp or any HTTP client.

```bash
pip install openai
```

```bash
npm install openai
```

```bash
go get github.com/openai/openai-go
```

```bash
composer require openai-php/client
```

```bash
gem install ruby-openai
```

```bash
# Add to pom.xml or build.gradle — use OkHttp or any HTTP client
```

--------------------------------

### Quickstart: JSON response from embeddings request

Source: https://github.com/callmissed/callmissed-docs/blob/main/docs/embeddings.md

Example response object returned by the embeddings endpoint. Contains the embedding vector, model name, and token usage.

```json
{
  "object": "list",
  "data": [
    {
      "object": "embedding",
      "index": 0,
      "embedding": [0.0023064255, -0.009327292, 0.015797347]
    }
  ],
  "model": "text-embedding-3-small",
  "usage": {
    "prompt_tokens": 5,
    "total_tokens": 5
  }
}
```

--------------------------------

### GET /api/v1/integrations curl example

Source: https://github.com/callmissed/callmissed-docs/blob/main/docs/integrations.md

Curl command to list integrations with a limit parameter. Requires an API key in the Authorization header.

```bash
curl "https://api.callmissed.com/api/v1/integrations?limit=50" \
  -H "Authorization: Bearer cm_your_api_key"
```

--------------------------------

### List sends and get usage (cURL, Python, JavaScript)

Source: https://github.com/callmissed/callmissed-docs/blob/main/docs/email-logs.md

These examples show how to list the newest 50 sends and retrieve account usage. The cURL example uses two commands; the Python and JavaScript examples use the httpx and fetch libraries respectively. Both endpoints are reads, so a read-only key works.

```bash
# Newest 50 sends
curl "https://api.callmissed.com/api/v1/email/sends?limit=50&offset=0" \
  -H "Authorization: Bearer cm_your_key"

# Spend
curl https://api.callmissed.com/api/v1/email/usage \
  -H "Authorization: Bearer cm_your_key"
```

```python
import httpx

BASE = "https://api.callmissed.com/api/v1/email"
h = {"Authorization": "Bearer cm_your_key"}

sends = httpx.get(f"{BASE}/sends", headers=h, params={"limit": 50, "offset": 0}).json()
usage = httpx.get(f"{BASE}/usage", headers=h).json()

for row in sends:
    print(row["id"], row["status"], row["subject"])
```

```javascript
const BASE = "https://api.callmissed.com/api/v1/email";
const headers = { Authorization: "Bearer cm_your_key" };

const sends = await fetch(`${BASE}/sends?limit=50&offset=0`, { headers }).then((r) =>
  r.json(),
);
const usage = await fetch(`${BASE}/usage`, { headers }).then((r) => r.json());

for (const row of sends) console.log(row.id, row.status, row.subject);
```

--------------------------------

### Install livekit-client

Source: https://github.com/callmissed/callmissed-docs/blob/main/docs/voice-sessions-api.md

Install the livekit-client SDK before connecting to the WebSocket. Use npm.

```bash
npm install livekit-client
```

--------------------------------

### Response for GET conversational automation

Source: https://github.com/callmissed/callmissed-docs/blob/main/docs/whatsapp-api.md

Example JSON response for the GET conversational automation endpoint, showing enabled welcome message, commands, and prompts.

```json
{
  "enable_welcome_message": true,
  "commands": [
    { "command_name": "track", "command_description": "Track your latest order" },
    { "command_name": "invoice", "command_description": "Get an invoice by order id" }
  ],
  "prompts": ["Track my order", "Talk to a human", "Store timings"]
}
```

--------------------------------

### Account health response JSON

Source: https://github.com/callmissed/callmissed-docs/blob/main/docs/whatsapp-numbers.md

Example 200 OK response for the GET health endpoint. Shows the account_id, waba_id, health_status with per-entity breakdown, health_checked_at, business verification, review status, account status, restriction reason, and payment setup flag.

```json
{
  "account_id": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
  "waba_id": "102290129340398",
  "health_status": {
    "can_send_message": "AVAILABLE",
    "entities": [
      { "entity_type": "BUSINESS", "id": "441329482726", "can_send_message": "AVAILABLE" },
      { "entity_type": "WABA", "id": "102290129340398", "can_send_message": "AVAILABLE" }
    ]
  },
  "health_checked_at": "2026-09-30T08:15:00Z",
  "business_verification_status": "verified",
  "account_review_status": "APPROVED",
  "account_status": "ACTIVE",
  "account_restriction_reason": null,
  "payment_setup_complete": true
}
```

--------------------------------

### Business profile response example

Source: https://github.com/callmissed/callmissed-docs/blob/main/docs/whatsapp-numbers.md

Example JSON response for a successful GET business profile request. Shows the profile fields returned by the API.

```json
{
  "phone_id": "9c2b7e30-1d8a-4c5f-9b3d-2f4a6e8b1c2d",
  "phone_number_id": "1234567890",
  "about": "Fresh coffee, delivered.",
  "address": "12 MG Road, Bengaluru 560001",
  "description": "Specialty coffee roasted in small batches and shipped across India.",
  "email": "support@acme.example",
  "vertical": "RETAIL",
  "websites": ["https://acme.example"],
  "profile_picture_url": "https://pps.whatsapp.net/v/t61.24694-24/...",
  "last_synced_at": "2026-09-30T08:20:00Z",
  "stale": false
}
```

--------------------------------

### Quickstart: Python client for embeddings

Source: https://github.com/callmissed/callmissed-docs/blob/main/docs/embeddings.md

Uses the OpenAI Python client to create embeddings for multiple inputs. Requires the openai package and an API key.

```python
from openai import OpenAI

client = OpenAI(
    api_key="cm_your_api_key",
    base_url="https://api.callmissed.com/v1",
)

resp = client.embeddings.create(
    model="text-embedding-3-small",
    input=["Where is my order?", "How do I return this?"],
)
vectors = [row.embedding for row in resp.data]
```

--------------------------------

### Search numbers response (JSON)

Source: https://github.com/callmissed/callmissed-docs/blob/main/docs/telephony-api.md

Example 200 OK response from the search endpoint. compliance_required indicates if documents are needed; setup_credits is a one-time fee added to the first payment.

```json
[
  {
    "number": "+919309963483",
    "number_type": "local",
    "country": "IN",
    "region": "Mumbai",
    "monthly_rental_rate_usd": 2.5,
    "rental_base_credits": 250,
    "rental_gst_credits": 45,
    "gst_rate": 0.18,
    "rental_credits": 295,
    "voice_enabled": true,
    "sms_enabled": false,
    "compliance_required": true,
    "setup_credits": 0
  }
]
```

--------------------------------

### SLA status response example

Source: https://github.com/callmissed/callmissed-docs/blob/main/docs/support-sla.md

Example JSON response from the GET status endpoint. Shows due dates, breach flags, and minutes remaining.

```json
{
  "ticket_id": "e5d4…",
  "policy_id": "d1c2…",
  "policy_name": "Urgent — 15 min first response",
  "first_response_due_at": "2026-08-17T06:25:00Z",
  "first_response_breached": true,
  "resolution_due_at": "2026-08-17T10:10:00Z",
  "resolution_breached": false,
  "minutes_remaining": 84
}
```

--------------------------------

### GET /api/v1/crm/tasks - curl example

Source: https://github.com/callmissed/callmissed-docs/blob/main/docs/crm-notes-tasks.md

Lists tasks, ordered by due_at ascending with undated tasks last. This example filters by status=open and overdue=true. Requires an API key with the crm_tasks:* scope.

```bash
curl "https://api.callmissed.com/api/v1/crm/tasks?status=open&overdue=true" \
  -H "Authorization: Bearer cm_your_api_key"
```

--------------------------------

### Response 200 OK for build_system_prompt

Source: https://github.com/callmissed/callmissed-docs/blob/main/docs/whatsapp-setup.md

Example JSON response containing the generated system_prompt field. The prompt is markdown text that you review and save on the agent yourself.

```json
{
  "system_prompt": "## Role\nYou are the support agent for Acme Coffee...\n\n## Rules\n- Answer in under 60 words..."
}
```

--------------------------------

### GET /api/v1/gateway/provider-keys response

Source: https://github.com/callmissed/callmissed-docs/blob/main/docs/provider-keys.md

Example JSON array returned by the GET endpoint. Shows a record with id, provider, label, key_last4, is_active, last_verified_at, created_at, and updated_at fields. Newest first.

```json
[
  {
    "id": "1a2b…",
    "provider": "google",
    "label": "eu",
    "key_last4": "9f3a",
    "is_active": true,
    "last_verified_at": "2026-08-17T09:12:00Z",
    "created_at": "2026-08-02T11:00:00Z",
    "updated_at": "2026-08-17T09:12:00Z"
  }
]
```

--------------------------------

### Install OpenAI and Anthropic SDKs

Source: https://github.com/callmissed/callmissed-docs/blob/main/docs/sdks.md

Install the OpenAI SDK for Python, JavaScript/TypeScript, Go, PHP, and Ruby, or the Anthropic SDK for Python and JavaScript/TypeScript.

```bash
pip install openai
```

```bash
npm install openai
```

```bash
go get github.com/openai/openai-go/v3
```

```bash
composer require openai-php/client
```

```bash
gem install ruby-openai
```

```bash
pip install anthropic
```

```bash
npm install @anthropic-ai/sdk
```

--------------------------------

### Example response from Agent Assist

Source: https://github.com/callmissed/callmissed-docs/blob/main/docs/agent-assist.md

Shows the JSON response containing up to three suggestions, knowledge-base snippets, the model used, and remaining calls in the window. The kb_snippets array is empty when nothing relevant is found.

```json
{
  "suggestions": [
    "Sorry about the delay! Could you share your order number so I can check it right away?",
    "Your order left our warehouse yesterday and should arrive within 2 business days.",
    "I'm escalating this to our delivery team now and will update you within the hour."
  ],
  "kb_snippets": [
    {
      "source_id": "b3e1…",
      "chunk_index": 4,
      "score": 0.81,
      "content": "Standard delivery takes 3–5 business days after dispatch…"
    }
  ],
  "model": "gpt-oss-120b",
  "remaining_in_window": 29
}
```

--------------------------------

### GET Shopify OAuth status response

Source: https://github.com/callmissed/callmissed-docs/blob/main/docs/integrations.md

Example JSON response indicating that Shopify sign-in is configured.

```json
{ "configured": true }
```

--------------------------------

### Create payment configuration with curl (UPI VPA and Gateway)

Source: https://github.com/callmissed/callmissed-docs/blob/main/docs/whatsapp-payments.md

Create a payment configuration for a UPI VPA or a gateway provider. The UPI VPA example uses `merchant_vpa`; the gateway example uses `redirect_url` and returns an `oauth_url` that the merchant must visit before payments can be taken.

```bash
curl -X POST https://api.callmissed.com/api/v1/whatsapp/payment_configurations \
  -H "Authorization: Bearer cm_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "waba_id": "102290129340398",
    "configuration_name": "acme-upi",
    "provider_name": "upi_vpa",
    "merchant_vpa": "acmecoffee@okhdfcbank"
  }'
```

```bash
curl -X POST https://api.callmissed.com/api/v1/whatsapp/payment_configurations \
  -H "Authorization: Bearer cm_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "waba_id": "102290129340398",
    "configuration_name": "acme-razorpay",
    "provider_name": "razorpay",
    "redirect_url": "https://acme.example.com/payments/linked"
  }'
```

--------------------------------

### Example response for list orders

Source: https://github.com/callmissed/callmissed-docs/blob/main/docs/integrations.md

Example JSON response from the GET orders endpoint. Shows the structure with total and items, including fields like order_key, segment, phone_e164, whatsapp_status, call_status, outcome, and sheet_status.

```json
{
  "total": 1,
  "items": [
    {
      "id": "0d1e…",
      "order_key": "#1042",
      "segment": "cod",
      "phone_e164": "+919812345678",
      "whatsapp_status": "sent",
      "whatsapp_error": null,
      "call_status": "done",
      "call_attempts": 1,
      "call_error": null,
      "outcome": "confirmed",
      "note": "Customer confirmed delivery address.",
      "sheet_status": "Confirmed",
      "sheet_error": null,
      "created_at": "2026-09-25T08:03:00Z",
      "updated_at": "2026-09-25T08:09:00Z"
    }
  ]
}
```

--------------------------------

### POST /api/v1/gateway/prompts/presets

Source: https://github.com/callmissed/callmissed-docs/blob/main/docs/gateway-prompts.md

Creates a new preset. Requires `prompts:write` scope.

```APIDOC
## POST /api/v1/gateway/prompts/presets

### Description
Creates a new preset. Requires `prompts:write` scope.

### Method
POST

### Endpoint
/api/v1/gateway/prompts/presets

### Parameters
#### Request Body
- **name** (string) - Required - 1–255 characters, unique per tenant.
- **model** (string) - Required - 1–128 characters.
- **params** (object) - Optional - Defaults to `{}`. Allowlisted keys only.
- **prompt_version_id** (UUID) - Optional - Must be a version in your tenant.

### Request Example
{
  "name": "production",
  "model": "kimi-k2.6",
  "params": {
    "temperature": 0.3
  }
}

### Response
#### Success Response (200)
- **PresetOut** (object) - Contains `id`, `tenant_id`, `name`, `model`, `params`, `prompt_version_id`, `created_at`, `updated_at`.
```

--------------------------------

### GET /api/v1/sheet-automations/columns - JSON response

Source: https://github.com/callmissed/callmissed-docs/blob/main/docs/integrations.md

Example response from the columns endpoint, showing the header row index and column names.

```json
{ "header_row": 2, "columns": ["Order ID", "Customer", "Phone", "Payment", "Total"] }
```

--------------------------------

### Bootstrap response (200 OK)

Source: https://github.com/callmissed/callmissed-docs/blob/main/docs/whatsapp-setup.md

Example JSON response from the bootstrap endpoint when mode is 'suggest'. Shows the generated plan with system_prompt, persona, welcome_message, and templates. The applied field is false and bootstrap_id is null because nothing was applied.

```json
{
  "bootstrap_id": null,
  "mode": "suggest",
  "applied": false,
  "system_prompt": "You are the support agent for Acme Coffee, an Indian D2C roastery...",
  "persona": {
    "name": "Acme Coffee Support",
    "tone": "warm and concise",
    "signature": "Acme Coffee"
  },
  "welcome_message": "Hi, this is Acme Coffee. Ask me about an order, a roast date, or a return.",
  "templates": [
    {
      "name": "order_shipped",
      "category": "UTILITY",
      "body": "Hi {{1}}, order {{2}} shipped today and should arrive in 2 to 3 days.",
      "applied": false,
      "template_id": null
    }
  ]
}
```

--------------------------------

### Python example using httpx to call POST /api/v1/knowledge/search

Source: https://github.com/callmissed/callmissed-docs/blob/main/docs/knowledge.md

Uses the httpx library to POST a search request and prints each chunk's score and first 80 characters of content. Requires an API key.

```python
import httpx

resp = httpx.post(
    "https://api.callmissed.com/api/v1/knowledge/search",
    headers={"Authorization": "Bearer cm_your_key"},
    json={"query": "how long does delivery take?", "k": 4, "min_score": 0.6},
)
for chunk in resp.json()["chunks"]:
    print(round(chunk["score"], 3), chunk["content"][:80])
```

--------------------------------

### JSON: Container status check response

Source: https://github.com/callmissed/callmissed-docs/blob/main/docs/social-publish.md

Example response from GET /api/v1/instagram/posts/{container_id} when the container is finished processing. status_code is FINISHED.

```json
{ "container_id": "17889455560051444", "status_code": "FINISHED" }
```

--------------------------------

### Manage senders with Python (httpx)

Source: https://github.com/callmissed/callmissed-docs/blob/main/docs/email-domains.md

Python example using httpx to list, register, and remove a sender. Requires the domain to be verified; otherwise returns 400. Registration is idempotent and eventually consistent.

```python
import httpx

BASE = "https://api.callmissed.com/api/v1/email"
h = {"Authorization": "Bearer cm_your_key"}
domain_id = "9d0f8b3a-1c2e-4a5b-8f7d-6e2a1b0c9d4e"

httpx.get(f"{BASE}/domains/{domain_id}/senders", headers=h).json()
httpx.post(f"{BASE}/domains/{domain_id}/senders", headers=h, json={"username": "hello"}).json()
httpx.delete(f"{BASE}/domains/{domain_id}/senders/hello", headers=h)
```

--------------------------------

### List Flows - curl request

Source: https://github.com/callmissed/callmissed-docs/blob/main/docs/whatsapp-flows.md

Example curl command to list WhatsApp Flows using GET /api/v1/whatsapp/flows with a waba_id and limit parameter.

```bash
curl "https://api.callmissed.com/api/v1/whatsapp/flows?waba_id=102290129340398&limit=50" \
  -H "Authorization: Bearer cm_your_api_key"
```

--------------------------------

### Catalog response example

Source: https://github.com/callmissed/callmissed-docs/blob/main/docs/integrations.md

Example JSON response from the catalog endpoint. Shows a single item with provider details, auth kind, tool names, and connection status.

```json
{
  "items": [
    {
      "provider": "calcom",
      "label": "Cal.com",
      "category": "scheduling",
      "auth_kind": "apikey",
      "logo_key": "calcom",
      "tool_names": ["calcom_list_slots", "calcom_book"],
      "enabled": true,
      "aggregator": false,
      "description": "Check availability and book appointments on the call.",
      "connected": true,
      "account": "dr-mehta"
    }
  ]
}
```

--------------------------------

### JavaScript/TypeScript: Get model access and check free plan

Source: https://github.com/callmissed/callmissed-docs/blob/main/docs/model-access.md

JavaScript/TypeScript example using fetch to get model access, list free LLM models, and check if a model is on the free plan. The output for 'gpt-6-luna' is false.

```typescript
const resp = await fetch("https://api.callmissed.com/api/v1/models/access");
const data = await resp.json();

// List free LLM models
const freeLLMs = data.plans.free.by_category.llm;
console.log("Free LLM models:", freeLLMs);

// Check if a model is available on free plan
const model = "gpt-6-luna";
const isFree = data.plans.free.models.includes(model);
console.log(model, "on free plan:", isFree); // false
```

--------------------------------

### Library response (200 OK)

Source: https://github.com/callmissed/callmissed-docs/blob/main/docs/whatsapp-templates.md

Example JSON response from the library endpoint. Contains an array of template objects with fields like name, language, category, topic, usecase, body, body_params, and buttons.

```json
{
  "data": [
    {
      "name": "order_confirmation_1",
      "language": "en_US",
      "category": "UTILITY",
      "topic": "ORDER_MANAGEMENT",
      "usecase": "ORDER_CONFIRMATION",
      "body": "Hi {{1}}, your order {{2}} is confirmed. We will let you know when it ships.",
      "body_params": ["Priya", "AC-10294"],
      "buttons": [{ "type": "URL", "text": "View order" }]
    }
  ],
  "paging": null
}
```

--------------------------------

### Response for provider connection (201 Created)

Source: https://github.com/callmissed/callmissed-docs/blob/main/docs/bring-your-own-telephony.md

Example response from the connect provider endpoint. Contains internal routing identifiers; treat any field not shown as opaque. Credentials are never returned.

```json
{
  "id": "4b8d2f10-6c3e-4a1b-9f2d-7e8a9b0c1d2e",
  "tenant_id": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
  "provider": "twilio",
  "label": "Twilio, prod account",
  "status": "active",
  "external_account_id": "ACxxxxxxxx...",
  "provider_trunk_id": "TKxxxxxxxx...",
  "config": {"outbound_address": "example.pstn.twilio.com", "transport": "tcp"},
  "last_error": null,
  "has_credentials": true,
  "created_at": "2026-09-20T09:00:00Z",
  "updated_at": "2026-09-20T09:00:00Z"
}
```

--------------------------------

### GET /api/v1/status/incidents

Source: https://github.com/callmissed/callmissed-docs/blob/main/docs/status-api.md

Retrieves incidents overlapping the requested window, newest first. An incident is included when it started before now and either has not ended or ended inside the window.

```APIDOC
## GET /api/v1/status/incidents

### Description
Retrieves incidents overlapping the requested window, newest first. An incident is included when it started before now and either has not ended or ended inside the window.

### Method
GET

### Endpoint
/api/v1/status/incidents

### Parameters
#### Query Parameters
- **days** (integer) - Optional - Number of days to look back. Constraints: 1 <= days <= 90, default 7.

### Request Example
```bash
curl "https://api.callmissed.com/api/v1/status/incidents?days=7"
```

### Response
#### Success Response (200)
- **days** (integer) - The requested window in days.
- **incidents** (array) - List of incidents. Empty array when the window is clean.
  - **id** (string) - UUID of the incident.
  - **service_name** (string) - Matches a `services[].name` from `/status`.
  - **severity** (string) - `degraded` or `down`.
  - **title** (string) - Generated from service and severity when no custom title was written.
  - **summary** (string | null) - Optional detail.
  - **started_at** (string) - ISO-8601 UTC.
  - **ended_at** (string | null) - `null` while the incident is ongoing.
  - **resolved** (boolean) - Whether the incident is closed.

#### Response Example
```json
{
  "days": 7,
  "incidents": [
    {
      "id": "b7c8d9e0-f1a2-4b3c-8d4e-5f6a7b8c9d0e",
      "service_name": "CallMissed API",
      "severity": "degraded",
      "title": "Elevated latency on the CallMissed API",
      "summary": "Requests were slower than normal for roughly 20 minutes.",
      "started_at": "2026-08-01T04:12:00+00:00",
      "ended_at": "2026-08-01T04:33:00+00:00",
      "resolved": true
    }
  ]
}
```

### Error Handling
- **422** - When `days` is outside `1 .. 90`.
```

--------------------------------

### GET /api/v1/sheet-automations/{automation_id}/orders

Source: https://github.com/callmissed/callmissed-docs/blob/main/docs/integrations.md

Retrieves the orders that the specified automation has acted on, newest first. Rows that were already in the tab when the automation started are not included.

```APIDOC
## GET /api/v1/sheet-automations/{automation_id}/orders

### Description
Retrieves the orders that the specified automation has acted on, newest first. Rows that were already in the tab when the automation started are not included.

### Method
GET

### Endpoint
/api/v1/sheet-automations/{automation_id}/orders

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Number of orders to return. Constraints: 1 <= limit <= 200, default 50.
- **offset** (integer) - Optional - Number of orders to skip. Constraints: 0 <= offset <= 100000, default 0.

### Request Example
```bash
curl "https://api.callmissed.com/api/v1/sheet-automations/{automation_id}/orders?limit=50" \
  -H "Authorization: Bearer cm_your_api_key"
```

### Response
#### Success Response (200)
- **total** (integer) - Total number of orders.
- **items** (array) - List of order objects.
  - **id** (string) - Order ID.
  - **order_key** (string) - Order key, e.g. "#1042".
  - **segment** (string) - Order segment: `cod` or `prepaid`.
  - **phone_e164** (string) - Phone number in E.164 format.
  - **whatsapp_status** (string) - WhatsApp status: `null` (not wanted), `pending`, `sending`, `sent`, `failed`, `skipped`.
  - **whatsapp_error** (string) - Error message if WhatsApp sending failed, otherwise null.
  - **call_status** (string) - Call status: `null` (not wanted), `pending`, `calling`, `answered`, `done`, `failed`.
  - **call_attempts** (integer) - Number of call attempts.
  - **call_error** (string) - Error message if call failed, otherwise null.
  - **outcome** (string) - Outcome: `confirmed`, `cancelled`, `reschedule`, `unclear`, `no_answer` or `null`.
  - **note** (string) - Note about the order.
  - **sheet_status** (string) - The text last written to the status column, e.g. `Confirmed`, `No answer`, `Call scheduled`.
  - **sheet_error** (string) - Why the last write-back failed, if it did.
  - **created_at** (string) - Creation timestamp in ISO 8601 format.
  - **updated_at** (string) - Last update timestamp in ISO 8601 format.

#### Response Example
```json
{
  "total": 1,
  "items": [
    {
      "id": "0d1e…",
      "order_key": "#1042",
      "segment": "cod",
      "phone_e164": "+919812345678",
      "whatsapp_status": "sent",
      "whatsapp_error": null,
      "call_status": "done",
      "call_attempts": 1,
      "call_error": null,
      "outcome": "confirmed",
      "note": "Customer confirmed delivery address.",
      "sheet_status": "Confirmed",
      "sheet_error": null,
      "created_at": "2026-09-25T08:03:00Z",
      "updated_at": "2026-09-25T08:09:00Z"
    }
  ]
}
```

### Error Handling
- **404** - Automation not found.
```

--------------------------------

### Manage senders with JavaScript (fetch)

Source: https://github.com/callmissed/callmissed-docs/blob/main/docs/email-domains.md

JavaScript example using fetch to list, register, and remove a sender. Requires the domain to be verified; otherwise returns 400. Registration is idempotent and eventually consistent.

```javascript
const BASE = "https://api.callmissed.com/api/v1/email";
const domainId = "9d0f8b3a-1c2e-4a5b-8f7d-6e2a1b0c9d4e";
const headers = {
  Authorization: "Bearer cm_your_key",
  "Content-Type": "application/json",
};

await fetch(`${BASE}/domains/${domainId}/senders`, { headers }).then((r) => r.json());

await fetch(`${BASE}/domains/${domainId}/senders`, {
  method: "POST",
  headers,
  body: JSON.stringify({ username: "hello" }),
}).then((r) => r.json());

await fetch(`${BASE}/domains/${domainId}/senders/hello`, {
  method: "DELETE",
  headers: { Authorization: "Bearer cm_your_key" },
});
```

--------------------------------

### GET /v1/usage/summary - JSON response

Source: https://github.com/callmissed/callmissed-docs/blob/main/docs/usage-api.md

Example response for the summary endpoint. Includes totals, per-service and per-model breakdowns, and a daily series.

```json
{
  "period_days": 7,
  "totals": {
    "total_requests": 18422,
    "success": 18310,
    "errors": 112,
    "success_rate": 0.9939,
    "total_cost_usd": 41.87,
    "total_input_tokens": 9120334,
    "total_output_tokens": 1844920,
    "total_cache_read_tokens": 4210000,
    "total_cache_creation_tokens": 120500,
    "total_audio_seconds": 6120.5,
    "avg_latency_ms": 812.4
  },
  "by_service": [
    { "service": "llm", "requests": 15980, "cost_usd": 38.11, "input_tokens": 9120334, "output_tokens": 1844920, "cache_read_tokens": 4210000, "cache_creation_tokens": 120500 },
    { "service": "tts", "requests": 1422, "cost_usd": 2.44, "input_tokens": 0, "output_tokens": 0, "cache_read_tokens": 0, "cache_creation_tokens": 0 }
  ],
  "by_model": [
    { "model": "kimi-k2.6", "requests": 9120, "cost_usd": 12.30 }
  ],
  "series": [
    { "date": "2026-08-11", "requests": 2610, "cost_usd": 5.98 }
  ]
}
```

--------------------------------

### Order detail with line items

Source: https://github.com/callmissed/callmissed-docs/blob/main/docs/whatsapp-orders.md

Example JSON response from GET /api/v1/commerce/orders/{order_id} showing the order plus its line items, oldest first. product_retailer_id is your own SKU.

```json
{
  "id": "o1a2…",
  "status": "pending",
  "currency": "INR",
  "subtotal": 2499.0,
  "items": [
    {
      "id": "i9b8…",
      "product_retailer_id": "SKU-114",
      "quantity": 2,
      "item_price": 999.0,
      "currency": "INR",
      "created_at": "2026-08-17T07:20:00Z"
    },
    {
      "id": "i7c6…",
      "product_retailer_id": "SKU-220",
      "quantity": 1,
      "item_price": 501.0,
      "currency": "INR",
      "created_at": "2026-08-17T07:20:00Z"
    }
  ]
}
```

--------------------------------

### Install globally with npm

Source: https://github.com/callmissed/callmissed-docs/blob/main/docs/mcp-server.md

Install the MCP server globally using npm, allowing it to be run without npx.

```bash
npm install -g callmissed-docs-mcp
```

--------------------------------

### GET delivery inspector JSON response

Source: https://github.com/callmissed/callmissed-docs/blob/main/docs/webhooks.md

Example response for the delivery inspector endpoint. Shows a failed delivery with status_code 500, attempts 3, and the stored payload.

```json
{
  "id": "d5e6f708-1920-4a3b-8c4d-5e6f708192a3",
  "webhook_id": "w1a2b3c4-d5e6-4f70-8192-a3b4c5d6e7f8",
  "event": "message.received",
  "status_code": 500,
  "attempts": 3,
  "success": false,
  "error": "HTTP 500",
  "payload": {
    "event": "message.received",
    "data": { "conversation_id": "c0ffee00-1111-2222-3333-444455556666", "role": "user" }
  },
  "created_at": "2026-08-04T09:12:00+00:00",
  "delivered_at": null
}
```

--------------------------------

### Create AUTHENTICATION template with add_security_recommendation

Source: https://github.com/callmissed/callmissed-docs/blob/main/docs/whatsapp-templates.md

Creates a one-time-code authentication template. The body must not include `BODY` text; only the boolean `add_security_recommendation` is allowed. Sending `BODY` text or a non-boolean value returns a `400` error.

```bash
curl -X POST https://api.callmissed.com/api/v1/whatsapp/templates \
  -H "Authorization: Bearer cm_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "waba_id": "102290129340398",
    "name": "acme_login_code",
    "category": "AUTHENTICATION",
    "language": "en_US",
    "components": [
      { "type": "BODY", "add_security_recommendation": true }
    ]
  }'
```

--------------------------------

### 503 relay_failed error shape: flat with id

Source: https://github.com/callmissed/callmissed-docs/blob/main/docs/email-limits.md

Example of the error body for a 'relay_failed' error. This shape is not wrapped in 'detail' and includes an 'id' for looking up the send with GET /api/v1/email/sends.

```json
{
  "error": "The message could not be accepted for delivery",
  "reason": "relay_failed",
  "id": "9d0f8b3a-1c2e-4a5b-8f7d-6e2a1b0c9d4e"
}
```

--------------------------------

### GET /api/v1/call-flows curl example

Source: https://github.com/callmissed/callmissed-docs/blob/main/docs/call-handling-api.md

Lists your call flows, newest first. Requires the telephony:read scope. The limit parameter defaults to 50 and offset to 0.

```bash
curl https://api.callmissed.com/api/v1/call-flows \
  -H "Authorization: Bearer cm_your_api_key"
```

--------------------------------

### Create AUTHENTICATION template with zero_tap OTP button

Source: https://github.com/callmissed/callmissed-docs/blob/main/docs/whatsapp-templates.md

Creates an authentication template with a zero-tap OTP button. Requires `zero_tap_terms_accepted` to be `true` and `supported_apps` with `package_name` and `signature_hash`. The `message_send_ttl_seconds` and `code_expiration_minutes` are optional. Invalid configurations return `400`.

```bash
curl -X POST https://api.callmissed.com/api/v1/whatsapp/templates \
  -H "Authorization: Bearer cm_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "waba_id": "102290129340398",
    "name": "acme_app_login",
    "category": "AUTHENTICATION",
    "language": "en_US",
    "message_send_ttl_seconds": 600,
    "components": [
      { "type": "BODY", "add_security_recommendation": true },
      { "type": "FOOTER", "code_expiration_minutes": 10 },
      {
        "type": "BUTTONS",
        "buttons": [
          {
            "type": "OTP",
            "otp_type": "zero_tap",
            "text": "Copy code",
            "autofill_text": "Autofill",
            "zero_tap_terms_accepted": true,
            "supported_apps": [
              { "package_name": "com.acme.app", "signature_hash": "K8a/AINcGX7" }
            ]
          }
        ]
      }
    ]
  }'
```

--------------------------------

### Get one call response (200 OK)

Source: https://github.com/callmissed/callmissed-docs/blob/main/docs/whatsapp-calling.md

Example JSON response for the get one call endpoint. Includes all list fields plus a transcript array with turn_index, user_transcript, agent_response, and interrupted. The transcript is empty until the agent has persisted turns, so it is normally empty during a live call. Returns 404 if the call is not on your workspace.

```json
{
  "id": "c4a7f210-3b8e-4d1f-9a2c-5e6b7d8f9012",
  "call_id": "wacid.HBgMOTE5MDAwMDAwMDAwFQIAERgSQTBGOEQ3MTJGM0EyRDFDNQA=",
  "direction": "BUSINESS_INITIATED",
  "status": "COMPLETED",
  "from_wa_id": "1234567890",
  "to_number": "919000000000",
  "duration_seconds": 96,
  "cost_credits": 4.8,
  "voice_session_id": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b",
  "permission_status": "permanent",
  "created_at": "2026-04-19T12:31:08Z",
  "ai_cost_credits": 2.1374,
  "transcript": [
    {
      "turn_index": 0,
      "user_transcript": null,
      "agent_response": "Hi, this is Acme Coffee calling about order AC-10294.",
      "interrupted": false
    },
    {
      "turn_index": 1,
      "user_transcript": "Yes, go ahead.",
      "agent_response": "We could not verify the delivery address. Is flat 4B still correct?",
      "interrupted": false
    }
  ]
}
```

--------------------------------

### curl POST /api/v1/whatsapp/ai/build_system_prompt

Source: https://github.com/callmissed/callmissed-docs/blob/main/docs/whatsapp-setup.md

Sends a request to generate a system prompt. Requires the whatsapp:write scope and an API key. The intent field is required (10-8000 chars); tone and language are optional. Returns markdown that you review and save yourself.

```bash
curl -X POST https://api.callmissed.com/api/v1/whatsapp/ai/build_system_prompt \
  -H "Authorization: Bearer cm_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "intent": "Support agent for Acme Coffee. Handle order status, roast dates and returns. Escalate anything about a refund over 5000 rupees to a human.",
    "tone": "warm and concise"
  }'
```

--------------------------------

### Response for creating a knowledge entry

Source: https://github.com/callmissed/callmissed-docs/blob/main/docs/knowledge.md

Example JSON response for a successful creation (201 Created). Shows the entry fields including id, bot_id, name, content, metadata, file_url, file_size_bytes, format, status, error_message, and created_at.

```json
{
  "id": "7c1d2e3f-4a5b-6c7d-8e9f-0a1b2c3d4e5f",
  "bot_id": "b1f2c3d4-5678-90ab-cdef-1234567890ab",
  "name": "Refund policy",
  "content": "Refunds are issued within 7 days of purchase.",
  "metadata": null,
  "file_url": null,
  "file_size_bytes": null,
  "format": null,
  "status": "indexed",
  "error_message": null,
  "created_at": "2026-07-20T09:15:00Z"
}
```

--------------------------------

### List webhooks response

Source: https://github.com/callmissed/callmissed-docs/blob/main/docs/webhooks.md

Example JSON response for the GET /api/v1/webhooks endpoint. Shows a subscription object with id, tenant_id, url, secret (masked), events, is_active, bot_id, and created_at.

```json
[
  {
    "id": "w1a2b3c4-d5e6-4f70-8192-a3b4c5d6e7f8",
    "tenant_id": "a0b1c2d3-4455-6677-8899-aabbccddeeff",
    "url": "https://hooks.acme.com/callmissed",
    "secret": "Xk4p****9dQz",
    "events": ["conversation.started", "message.received"],
    "is_active": true,
    "bot_id": null,
    "created_at": "2026-07-19T08:00:00Z"
  }
]
```

--------------------------------

### GET /api/v1/status - JSON response

Source: https://github.com/callmissed/callmissed-docs/blob/main/docs/status-api.md

Example response from the status endpoint. Shows the overall status, checked_at timestamp, services array with status and optional latency, self_heal array, and interval_seconds.

```json
{
  "overall": "operational",
  "checked_at": "2026-08-04T10:31:07.512004+00:00",
  "services": [
    {
      "name": "CallMissed API",
      "group": "infrastructure",
      "status": "operational",
      "description": "REST API, dashboard, webhooks, and API keys",
      "latency_ms": 4
    },
    {
      "name": "AI, speech & language",
      "group": "ai",
      "status": "operational",
      "description": "Chat, speech-to-text, text-to-speech, and embeddings-compatible routes"
    },
    {
      "name": "Billing & checkout",
      "group": "payments",
      "status": "operational",
      "description": "Subscriptions and one-time payments"
    },
    {
      "name": "WhatsApp Business",
      "group": "channels",
      "status": "operational",
      "description": "Meta WhatsApp Cloud API"
    },
    {
      "name": "Voice & SMS",
      "group": "channels",
      "status": "operational",
      "description": "PSTN voice and SMS"
    },
    {
      "name": "Transactional email",
      "group": "notifications",
      "status": "operational",
      "description": "Account notifications and receipts"
    }
  ],
  "self_heal": [],
  "interval_seconds": 30
}
```

--------------------------------

### Create a coupon code template with curl

Source: https://github.com/callmissed/callmissed-docs/blob/main/docs/whatsapp-templates.md

POST to /api/v1/whatsapp/templates to create a MARKETING template with a COPY_CODE button. The button shape is { "type": "COPY_CODE", "example": "<CODE>" } with a required example coupon code (max 20 chars). At most one COPY_CODE button per template, and a QUICK_REPLY button may accompany it. The example is for review only; the real code is passed per send as a coupon_code button parameter.

```bash
curl -X POST https://api.callmissed.com/api/v1/whatsapp/templates \
  -H "Authorization: Bearer cm_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "waba_id": "102290129340398",
    "name": "welcome_coupon",
    "category": "MARKETING",
    "language": "en_US",
    "components": [
      {
        "type": "BODY",
        "text": "Welcome to Acme, {{1}}. Here is 15% off your first order.",
        "example": { "body_text": [["Priya"]] }
      },
      {
        "type": "BUTTONS",
        "buttons": [
          { "type": "COPY_CODE", "example": "WELCOME15" },
          { "type": "QUICK_REPLY", "text": "Browse blends" }
        ]
      }
    ]
  }'
```

--------------------------------

### POST /api/v1/gateway/provider-keys curl example

Source: https://github.com/callmissed/callmissed-docs/blob/main/docs/provider-keys.md

Example curl command to create a new provider key. Uses an Authorization header with a bearer token and sends a JSON body with provider, key, and label. Returns 201 with the record, but the response has no key field.

```bash
curl -X POST https://api.callmissed.com/api/v1/gateway/provider-keys \
  -H "Authorization: Bearer cm_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{ "provider": "google", "key": "AIza…", "label": "eu" }'
```
Tokens:
Raw