Docs menu

Calls

A call is one request to call one person from your own number. It follows every rule that calls follow in the dashboard: calling hours, do-not-call, consent and credit.

POST /calls

Place one call. Needs a full-access key.

Send either leadId or phone (a lead is made if there is none). purpose is reminder, followup, feedback or information. script is what the employee should say or ask. Add dryRun: true to see what would happen without calling anyone, making a lead or using credit.

Request body

leadId
text
A lead you already have.
phone
text
Or the number to call.
purpose
text
reminder, followup, feedback or information. Default followup.
script
text
What to say or ask, up to 1,500 characters.
consent
true or false
True only if this person agreed to be contacted or is your customer.
dryRun
true or false
Check everything, change nothing.

Request

curl -X POST https://navaprastha.in/api/v1/calls \
  -H "Authorization: Bearer $NAVAPRASTHA_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: unique-text-from-your-system" \
  -d '{"phone":"98480 12345","purpose":"reminder","script":"Remind about tomorrow at 11 am.","consent":true}'

Response

{
  "data": {
    "id": "51d8c2e07a9b4f63",
    "status": "queued",
    "leadId": "9f3c0a1b2c3d4e5f"
  }
}

A dry run: request

curl -X POST https://navaprastha.in/api/v1/calls \
  -H "Authorization: Bearer $NAVAPRASTHA_KEY" \
  -H "Content-Type: application/json" \
  -d '{"phone":"98480 12345","consent":true,"dryRun":true}'

A dry run: response

{
  "data": {
    "dryRun": true,
    "wouldPlace": true,
    "status": "queued",
    "leadExists": false,
    "checks": [
      {
        "name": "phone",
        "passed": true,
        "detail": "+919848012345"
      },
      {
        "name": "do_not_call",
        "passed": true,
        "detail": "The person must not be on your do-not-call list."
      },
      {
        "name": "consent",
        "passed": true,
        "detail": "Send consent: true when the person asked to be contacted or is your customer."
      },
      {
        "name": "calling_hours",
        "passed": true,
        "detail": "Calls go out between 9 am and 9 pm India time."
      },
      {
        "name": "credits_and_plan",
        "passed": true,
        "detail": "You have a plan with calls and enough credit."
      },
      {
        "name": "phone_number",
        "passed": true,
        "detail": "Calls go out from your own active number."
      },
      {
        "name": "per_person_limit",
        "passed": true,
        "detail": "At most 3 calls to the same person in 24 hours."
      },
      {
        "name": "daily_limit",
        "passed": true,
        "detail": "At most 1000 calls a day."
      }
    ]
  }
}

GET /calls

The latest calls. Any key, including a read-only key.

Query parameters

limit
integer
How many, 1 to 100. Default 50.

Request

curl https://navaprastha.in/api/v1/calls \
  -H "Authorization: Bearer $NAVAPRASTHA_KEY"

Response

{
  "data": [
    {
      "id": "51d8c2e07a9b4f63",
      "direction": "out",
      "phone": "+919848012345",
      "status": "ended",
      "answered": true,
      "startedAt": 1794135600,
      "seconds": 84,
      "outcome": "completed",
      "campaignId": null
    }
  ]
}

GET /calls/{id}

One call, with its transcript and outcome. Any key, including a read-only key.

Request

curl https://navaprastha.in/api/v1/calls/ID \
  -H "Authorization: Bearer $NAVAPRASTHA_KEY"

Response

{
  "data": {
    "id": "51d8c2e07a9b4f63",
    "direction": "out",
    "phone": "+919848012345",
    "answered": true,
    "startedAt": 1794135600,
    "endedAt": 1794135684,
    "seconds": 84,
    "billedSeconds": 90,
    "outcome": "completed",
    "campaignId": null,
    "leadId": "9f3c0a1b2c3d4e5f",
    "transcript": [
      {
        "speaker": "agent",
        "text": "Hello Ravi, this is a reminder for tomorrow at 11 am.",
        "at": 1794135603
      },
      {
        "speaker": "person",
        "text": "Yes, I will come.",
        "at": 1794135611
      }
    ],
    "status": "ended"
  }
}

Last updated 13 November 2026. Found something wrong on this page? Email bodavulasiddardha@navaprastha.in and we will correct it.