Phone

Use Phone endpoints for telephony resource management.

Authentication & scope

Header: X-API-Key: YOUR_API_KEY
Read operations: phone:read
Write operations: phone:write
Use API Reference for Try-it on each phone endpoint.

`GET /v1/phone/purchases`

Lists purchased numbers for your organization.

curl -X GET "https://api.indigenius.ai/v1/phone/purchases" \
  -H "X-API-Key: YOUR_API_KEY"

const response = await fetch('https://api.indigenius.ai/v1/phone/purchases', {
  headers: { 'X-API-Key': process.env.INDIGENIUS_API_KEY },
});
console.log(await response.json());

import requests
response = requests.get(
    "https://api.indigenius.ai/v1/phone/purchases",
    headers={"X-API-Key": "YOUR_API_KEY"},
    timeout=30,
)
print(response.status_code)
print(response.json())

Common status codes

200 success
403 missing phone:read
500 server error

`GET /v1/phone/contacts/{id}`

Lists contacts for a purchased number.

curl -X GET "https://api.indigenius.ai/v1/phone/contacts/665e4a34c65bb95f2f2d72e4?page=1&pageSize=10" \
  -H "X-API-Key: YOUR_API_KEY"

const phonePurchaseId = '665e4a34c65bb95f2f2d72e4';
const response = await fetch(
  `https://api.indigenius.ai/v1/phone/contacts/${phonePurchaseId}?page=1&pageSize=10`,
  { headers: { 'X-API-Key': process.env.INDIGENIUS_API_KEY } },
);
console.log(await response.json());

import requests
phone_purchase_id = "665e4a34c65bb95f2f2d72e4"
response = requests.get(
    f"https://api.indigenius.ai/v1/phone/contacts/{phone_purchase_id}?page=1&pageSize=10",
    headers={"X-API-Key": "YOUR_API_KEY"},
    timeout=30,
)
print(response.status_code)
print(response.json())

Common status codes

200 success
403 missing phone:read
404 purchase not found
500 server error

`POST /v1/phone/allocate-assistant`

Assigns which agent answers inbound calls and which one places outbound calls on a purchased number. Optionally turns on call forwarding for the number in the same request.

An announcer agent can only be allocated as outboundAssistantId, never inboundAssistantId — it’s rejected with a 400 there since announcer agents can’t handle inbound calls. inboundAssistantId is still a required field on every call to this endpoint, even for a number that only ever places announcer calls; use any conversational agent you aren’t otherwise routing inbound calls to.

Request body

Field	Type	Required	Description
`id`	string	yes	Purchased phone number id to configure.
`inboundAssistantId`	string	yes	Agent that answers inbound calls on this number.
`outboundAssistantId`	string	yes	Agent used when placing outbound calls from this number.
`callForwardingEnabled`	boolean	no	Turns call forwarding on or off for this number.
`callForwardingNumber`	string (E.164)	only if `callForwardingEnabled` is `true`	Number to forward calls to. Must be in the same country as the purchased number, or the request is rejected with a `400`.
`callForwardingWhen`	string (`always` \| `no_answer` \| `busy` \| `unavailable`)	only if `callForwardingEnabled` is `true`	Condition under which calls are forwarded — see `PATCH /v1/phone/{id}/call-forwarding` below for what each value means.

curl -X POST "https://api.indigenius.ai/v1/phone/allocate-assistant" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "inboundAssistantId": "665e4a34c65bb95f2f2d72e2",
    "outboundAssistantId": "665e4a34c65bb95f2f2d72e3",
    "id": "665e4a34c65bb95f2f2d72e4",
    "message": "Hello, this call may be recorded."
  }'

const response = await fetch(
  'https://api.indigenius.ai/v1/phone/allocate-assistant',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'X-API-Key': process.env.INDIGENIUS_API_KEY,
    },
    body: JSON.stringify({
      inboundAssistantId: '665e4a34c65bb95f2f2d72e2',
      outboundAssistantId: '665e4a34c65bb95f2f2d72e3',
      id: '665e4a34c65bb95f2f2d72e4',
      message: 'Hello, this call may be recorded.',
    }),
  },
);
console.log(await response.json());

import requests
payload = {
    "inboundAssistantId": "665e4a34c65bb95f2f2d72e2",
    "outboundAssistantId": "665e4a34c65bb95f2f2d72e3",
    "id": "665e4a34c65bb95f2f2d72e4",
    "message": "Hello, this call may be recorded.",
}
response = requests.post(
    "https://api.indigenius.ai/v1/phone/allocate-assistant",
    headers={"X-API-Key": "YOUR_API_KEY", "Content-Type": "application/json"},
    json=payload,
    timeout=30,
)
print(response.status_code)
print(response.json())

Common status codes

200 success
400 validation error; inboundAssistantId is an announcer agent; or callForwardingNumber is not in the same country as the purchased number
403 missing phone:write
404 resource not found
500 server error

`PATCH /v1/phone/{id}/call-forwarding`

Turns call forwarding on or off for a purchased number, and configures when calls get forwarded.

Request body

Field	Type	Required	Description
`callForwardingEnabled`	boolean	yes	Turns forwarding on or off. When `false`, `callForwardingNumber` and `callForwardingWhen` are ignored.
`callForwardingNumber`	string (E.164)	only if `callForwardingEnabled` is `true`	Number to forward calls to. Must be in the same country as the purchased number, or the request is rejected with a `400`.
`callForwardingWhen`	string	only if `callForwardingEnabled` is `true`	One of the conditions below.

callForwardingWhen accepts:

always — every inbound call is forwarded immediately, without connecting to the assistant.
unavailable — forwarded only if the number has no inbound assistant assigned.
no_answer — forwarded if the assistant doesn’t pick up within the connect timeout.
busy — accepted by the API but not yet enforced.

curl -X PATCH "https://api.indigenius.ai/v1/phone/665e4a34c65bb95f2f2d72e4/call-forwarding" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "callForwardingEnabled": true,
    "callForwardingNumber": "+14155559999",
    "callForwardingWhen": "unavailable"
  }'

const phonePurchaseId = '665e4a34c65bb95f2f2d72e4';
const response = await fetch(
  `https://api.indigenius.ai/v1/phone/${phonePurchaseId}/call-forwarding`,
  {
    method: 'PATCH',
    headers: {
      'Content-Type': 'application/json',
      'X-API-Key': process.env.INDIGENIUS_API_KEY,
    },
    body: JSON.stringify({
      callForwardingEnabled: true,
      callForwardingNumber: '+14155559999',
      callForwardingWhen: 'unavailable',
    }),
  },
);
console.log(await response.json());

import requests
phone_purchase_id = "665e4a34c65bb95f2f2d72e4"
payload = {
    "callForwardingEnabled": True,
    "callForwardingNumber": "+14155559999",
    "callForwardingWhen": "unavailable",
}
response = requests.patch(
    f"https://api.indigenius.ai/v1/phone/{phone_purchase_id}/call-forwarding",
    headers={"X-API-Key": "YOUR_API_KEY", "Content-Type": "application/json"},
    json=payload,
    timeout=30,
)
print(response.status_code)
print(response.json())

Common status codes

200 success
400 validation error (e.g. callForwardingNumber missing or not E.164 when enabled); or not in the same country as the purchased number
403 missing phone:write
404 phone purchase not found
500 server error

`GET /v1/phone/{id}/call-forwarding/history`

Lists forwarding events for a purchased number, most recent first.

curl -X GET "https://api.indigenius.ai/v1/phone/665e4a34c65bb95f2f2d72e4/call-forwarding/history?page=1&pageSize=10" \
  -H "X-API-Key: YOUR_API_KEY"

const phonePurchaseId = '665e4a34c65bb95f2f2d72e4';
const response = await fetch(
  `https://api.indigenius.ai/v1/phone/${phonePurchaseId}/call-forwarding/history?page=1&pageSize=10`,
  { headers: { 'X-API-Key': process.env.INDIGENIUS_API_KEY } },
);
console.log(await response.json());

import requests
phone_purchase_id = "665e4a34c65bb95f2f2d72e4"
response = requests.get(
    f"https://api.indigenius.ai/v1/phone/{phone_purchase_id}/call-forwarding/history?page=1&pageSize=10",
    headers={"X-API-Key": "YOUR_API_KEY"},
    timeout=30,
)
print(response.status_code)
print(response.json())

Common status codes

200 success
403 missing phone:read
404 phone purchase not found
500 server error

`POST /v1/phone/schedule-call`

Schedules a batch of outbound calls to a list of contacts, all using the same message and outbound number, at one or more future dates. Use this for a standard conversational-agent campaign; for a personalized one-way announcer campaign, use POST /v1/phone/schedule-announcer-campaign instead.

Request body

Field	Type	Required	Description
`name`	string	yes	Campaign name, shown when listing schedules.
`phone_id`	string	yes	Purchased number to place the calls from.
`contacts_id`	string[]	yes	Ids of the contacts to call — see `POST /v1/phone/contacts` and `POST /v1/phone/contacts/upload`.
`message`	string	yes	Message the assistant opens the call with.
`dates`	string[] (ISO 8601 datetime)	yes	One or more dates to run this campaign on. Each date creates a separate call schedule with the same contacts, phone number, message, and timezone.
`timezone`	string	yes	Timezone `dates` are interpreted in. One of `GMT_plus_1`, `UTC_minus_4`, `UTC_minus_5`, `UTC_minus_6`, `UTC_minus_7`, `UTC_minus_8`.

curl -X POST "https://api.indigenius.ai/v1/phone/schedule-call" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Morning outreach",
    "contacts_id": ["665e4a34c65bb95f2f2d72e5", "665e4a34c65bb95f2f2d72e6"],
    "phone_id": "665e4a34c65bb95f2f2d72e4",
    "message": "Hi, just checking in on your request.",
    "dates": ["2026-06-15T09:00:00.000Z"],
    "timezone": "GMT_plus_1"
  }'

const response = await fetch(
  'https://api.indigenius.ai/v1/phone/schedule-call',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'X-API-Key': process.env.INDIGENIUS_API_KEY,
    },
    body: JSON.stringify({
      name: 'Morning outreach',
      contacts_id: ['665e4a34c65bb95f2f2d72e5', '665e4a34c65bb95f2f2d72e6'],
      phone_id: '665e4a34c65bb95f2f2d72e4',
      message: 'Hi, just checking in on your request.',
      dates: ['2026-06-15T09:00:00.000Z'],
      timezone: 'GMT_plus_1',
    }),
  },
);
console.log(await response.json());

import requests
payload = {
    "name": "Morning outreach",
    "contacts_id": ["665e4a34c65bb95f2f2d72e5", "665e4a34c65bb95f2f2d72e6"],
    "phone_id": "665e4a34c65bb95f2f2d72e4",
    "message": "Hi, just checking in on your request.",
    "dates": ["2026-06-15T09:00:00.000Z"],
    "timezone": "GMT_plus_1",
}
response = requests.post(
    "https://api.indigenius.ai/v1/phone/schedule-call",
    headers={"X-API-Key": "YOUR_API_KEY", "Content-Type": "application/json"},
    json=payload,
    timeout=30,
)
print(response.status_code)
print(response.json())

`201 Created`

{
  "success": true,
  "message": "Call scheduled successfully",
  "data": null,
  "meta": {
    "requestId": "f3c9b29a-9f4d-4b71-8b3b-2cb77f4e9cf1",
    "timestamp": "2026-06-02T10:30:45.123Z",
    "version": "v1"
  }
}

No id is returned — dates can create more than one call schedule in a single request (one per unique date), so there’s no single id to hand back. Look the schedule up afterwards via its campaign name.

Common status codes

201 scheduled
400 validation error
403 missing phone:write
404 resource not found
500 server error

`POST /v1/phone/contacts`

Adds a single contact to a purchased phone number. Use this for one-off additions; for bulk import, use POST /v1/phone/contacts/upload instead.

Request body

Field	Type	Required	Description
`phone_id`	string	yes	Purchased number this contact belongs to.
`name`	string	yes	Contact’s display name.
`contact`	string	yes	Contact’s phone number, including country code. Rejected with `400` if it can’t be parsed as a valid number, or if it’s already a contact on this phone number.

curl -X POST "https://api.indigenius.ai/v1/phone/contacts" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "phone_id": "665e4a34c65bb95f2f2d72e4",
    "name": "John Doe",
    "contact": "+14155552671"
  }'

const response = await fetch('https://api.indigenius.ai/v1/phone/contacts', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'X-API-Key': process.env.INDIGENIUS_API_KEY,
  },
  body: JSON.stringify({
    phone_id: '665e4a34c65bb95f2f2d72e4',
    name: 'John Doe',
    contact: '+14155552671',
  }),
});
console.log(await response.json());

import requests
payload = {
    "phone_id": "665e4a34c65bb95f2f2d72e4",
    "name": "John Doe",
    "contact": "+14155552671",
}
response = requests.post(
    "https://api.indigenius.ai/v1/phone/contacts",
    headers={"X-API-Key": "YOUR_API_KEY", "Content-Type": "application/json"},
    json=payload,
    timeout=30,
)
print(response.status_code)
print(response.json())

Common status codes

200 success
400 validation error, or contact already exists
403 missing phone:write
404 phone number not found
500 server error

`POST /v1/phone/contacts/upload`

Uploads a contact list file (.xlsx, .vcf, or .csv) for a purchased phone number. Each phone number in the file must include a country code (start with +).

curl -X POST "https://api.indigenius.ai/v1/phone/contacts/upload" \
  -H "X-API-Key: YOUR_API_KEY" \
  -F "phone_id=665e4a34c65bb95f2f2d72e4" \
  -F "file=@contacts.csv"

const form = new FormData();
form.append('phone_id', '665e4a34c65bb95f2f2d72e4');
form.append('file', fileBlob, 'contacts.csv');

const response = await fetch(
  'https://api.indigenius.ai/v1/phone/contacts/upload',
  {
    method: 'POST',
    headers: { 'X-API-Key': process.env.INDIGENIUS_API_KEY },
    body: form,
  },
);
console.log(await response.json());

import requests
files = {"file": open("contacts.csv", "rb")}
data = {"phone_id": "665e4a34c65bb95f2f2d72e4"}
response = requests.post(
    "https://api.indigenius.ai/v1/phone/contacts/upload",
    headers={"X-API-Key": "YOUR_API_KEY"},
    data=data,
    files=files,
    timeout=30,
)
print(response.status_code)
print(response.json())

`200 OK`

{
  "success": true,
  "message": "Contact list uploaded successfully. 42 contacts processed.",
  "data": {
    "totalProcessed": 42,
    "invalidContacts": 0
  },
  "meta": {
    "requestId": "f3c9b29a-9f4d-4b71-8b3b-2cb77f4e9cf1",
    "timestamp": "2026-06-02T10:30:45.123Z",
    "version": "v1"
  }
}

Common status codes

200 success
400 unsupported file type, or numbers missing country code
403 missing phone:write
404 phone number not found
500 server error

`POST /v1/phone/announce`

Places an outbound announcer call: the system dials the destination number and, once the call connects, speaks a one-way message — either synthesized from text or played back from an audio source — using the voice configured on the assistant allocated to the purchased number, then automatically hangs up. The call never listens for or accepts caller audio; nothing the recipient says is transcribed or acted on. This is useful for reminders, alerts, one-time codes, or any broadcast-style message that doesn’t need a two-way conversation.

This endpoint dials out with an announcer agent that’s already been created and allocated to the number. To create and configure the agent itself (message, voice, personalization), see Agents → Announcer agents.

Provide exactly one of text, audioUrl, or the audioFile upload. Sending zero, or more than one, returns a 400.

How it’s routed

The underlying telephony carrier for the purchased number is resolved automatically — you don’t choose it.
The assistant used is the number’s outboundAssistantId if set, otherwise its inboundAssistantId. That assistant must be configured with a voice provider that supports announcer calls; assistants configured to rely on a full conversational voice engine are rejected, since announcer calls are one-way only (no conversation, no listening).
The call is placed first (a Calls record is created and the number is dialed), and once it connects, the announcement is streamed into the live call audio.
At the end of the call: the transcript, call analysis, and call tag are generated as with any other assistant call, and credit is deducted from your organization’s balance for call duration exactly as with /v1/calls/phone/initiate.

Request body

Field	Type	Required	Description
`phone_purchase_id`	string	yes	The purchased number to call out from.
`phoneNumber`	string	yes	Destination number, E.164 format.
`text`	string	one of `text` / `audioUrl` / `audioFile`	Text to synthesize and speak.
`audioUrl`	string (URL)	one of `text` / `audioUrl` / `audioFile`	Publicly reachable URL of an audio file to fetch and play.
`audioFile`	file	one of `text` / `audioUrl` / `audioFile`	Audio file upload (`multipart/form-data`). Accepted types: `mp3`, `mp4`/`m4a`, `wav`, `ogg`.

curl -X POST "https://api.indigenius.ai/v1/phone/announce" \
  -H "X-API-Key: YOUR_API_KEY" \
  -F "phone_purchase_id=665e4a34c65bb95f2f2d72e1" \
  -F "phoneNumber=+14155552671" \
  -F "text=Hello, this is a courtesy reminder about your appointment tomorrow at 10am."

curl -X POST "https://api.indigenius.ai/v1/phone/announce" \
  -H "X-API-Key: YOUR_API_KEY" \
  -F "phone_purchase_id=665e4a34c65bb95f2f2d72e1" \
  -F "phoneNumber=+14155552671" \
  -F "audioUrl=https://example.com/announcement.mp3"

curl -X POST "https://api.indigenius.ai/v1/phone/announce" \
  -H "X-API-Key: YOUR_API_KEY" \
  -F "phone_purchase_id=665e4a34c65bb95f2f2d72e1" \
  -F "phoneNumber=+14155552671" \
  -F "audioFile=@announcement.mp3"

const form = new FormData();
form.append('phone_purchase_id', '665e4a34c65bb95f2f2d72e1');
form.append('phoneNumber', '+14155552671');
form.append(
  'text',
  'Hello, this is a courtesy reminder about your appointment tomorrow at 10am.',
);

const response = await fetch('https://api.indigenius.ai/v1/phone/announce', {
  method: 'POST',
  headers: { 'X-API-Key': process.env.INDIGENIUS_API_KEY },
  body: form,
});
console.log(await response.json());

const form = new FormData();
form.append('phone_purchase_id', '665e4a34c65bb95f2f2d72e1');
form.append('phoneNumber', '+14155552671');
form.append('audioFile', audioBlob, 'announcement.mp3');

const response = await fetch('https://api.indigenius.ai/v1/phone/announce', {
  method: 'POST',
  headers: { 'X-API-Key': process.env.INDIGENIUS_API_KEY },
  body: form,
});
console.log(await response.json());

import requests
data = {
    "phone_purchase_id": "665e4a34c65bb95f2f2d72e1",
    "phoneNumber": "+14155552671",
    "text": "Hello, this is a courtesy reminder about your appointment tomorrow at 10am.",
}
response = requests.post(
    "https://api.indigenius.ai/v1/phone/announce",
    headers={"X-API-Key": "YOUR_API_KEY"},
    data=data,
    timeout=30,
)
print(response.status_code)
print(response.json())

import requests
data = {
    "phone_purchase_id": "665e4a34c65bb95f2f2d72e1",
    "phoneNumber": "+14155552671",
}
files = {"audioFile": open("announcement.mp3", "rb")}
response = requests.post(
    "https://api.indigenius.ai/v1/phone/announce",
    headers={"X-API-Key": "YOUR_API_KEY"},
    data=data,
    files=files,
    timeout=30,
)
print(response.status_code)
print(response.json())

`201 Created`

{
  "success": true,
  "data": {
    "id": "665e4a34c65bb95f2f2d72e1",
    "type": "phone",
    "phone": "+14155552671",
    "callMode": "outbound",
    "status": 0
  },
  "meta": {
    "requestId": "f3c9b29a-9f4d-4b71-8b3b-2cb77f4e9cf1",
    "timestamp": "2026-06-02T10:30:45.123Z",
    "version": "v1"
  }
}

Use the returned id with the Calls endpoints — GET /v1/calls/{id}, GET /v1/calls/{id}/transcripts, GET /v1/calls/{id}/analysis, and GET /v1/calls/{id}/recording — to check on the announcement call afterwards.

Common status codes

201 announcer call initiated
400 validation error; zero or more than one of text/audioUrl/audioFile provided; the audio couldn’t be fetched or processed; the allocated assistant isn’t configured for announcer calls; the number’s carrier doesn’t support announcer calls; or the phone number is no longer active
403 missing phone:write
404 phone purchase or assistant not found
500 server error

`GET /v1/phone/announcer/{phoneId}/campaign-template`

Downloads an .xlsx contact sheet template for a personalized Announcer agent. The outbound assistant is resolved from the purchased phone number itself (its outboundAssistantId), not passed separately. The template has a phone_number column plus one column per personalization parameter the agent’s message uses (e.g. {first_name}, {amount} — these are extracted automatically from the message, never declared by the caller). Non-personalized announcer agents (a single TTS or uploaded-audio message with no {placeholders}) don’t use this campaign flow at all — schedule them the same way as conversational agents, via POST /v1/phone/schedule-call.

To make an agent personalized — so it has parameter columns to download here — set its message with personalized: true via PUT /v1/agents/{id}/announcer-message. See Agents → Personalized campaign flow for the full sequence.

curl -X GET "https://api.indigenius.ai/v1/phone/announcer/665e4a34c65bb95f2f2d72e4/campaign-template" \
  -H "X-API-Key: YOUR_API_KEY" \
  -o campaign_template.xlsx

Common status codes

200 success (binary .xlsx response)
400 this phone number does not have a personalized announcer agent allocated as its outbound assistant, or that agent has no message configured
403 missing phone:read
404 phone number not found
500 server error

`POST /v1/phone/schedule-announcer-campaign`

Schedules a personalized Announcer campaign: uploads a filled-in contact sheet (from the template above) and schedules a one-way, personalized announcer call to every row. Every parameter the agent’s message uses must be present as a column in the sheet, alongside a mandatory phone_number column.

Request body

Field	Type	Required	Description
`name`	string	yes	Campaign name, shown when listing schedules.
`phone_id`	string	yes	Purchased number to place the calls from. The outbound announcer agent is resolved from this number, not passed separately.
`dates`	string[] (ISO 8601 datetime)	yes	One or more dates to run this campaign on.
`timezone`	string	yes	Timezone `dates` are interpreted in. One of `GMT_plus_1`, `UTC_minus_4`, `UTC_minus_5`, `UTC_minus_6`, `UTC_minus_7`, `UTC_minus_8`.
`file`	file (`multipart/form-data`)	yes	The filled-in `.xlsx` contact sheet downloaded from the campaign template endpoint above.

curl -X POST "https://api.indigenius.ai/v1/phone/schedule-announcer-campaign" \
  -H "X-API-Key: YOUR_API_KEY" \
  -F "name=Repayment reminders" \
  -F "phone_id=665e4a34c65bb95f2f2d72e4" \
  -F "dates=2026-06-15T09:00:00.000Z" \
  -F "timezone=GMT_plus_1" \
  -F "file=@campaign_contacts.xlsx"

`201 Created`

{
  "success": true,
  "message": "Announcer campaign scheduled successfully",
  "data": {
    "schedules": [
      "665e4a34c65bb95f2f2d72e8"
    ],
    "totalContacts": 42
  },
  "meta": {
    "requestId": "f3c9b29a-9f4d-4b71-8b3b-2cb77f4e9cf1",
    "timestamp": "2026-06-02T10:30:45.123Z",
    "version": "v1"
  }
}

Common status codes

201 scheduled
400 validation error; this phone number does not have a personalized announcer agent allocated as its outbound assistant; contact sheet is missing the phone_number column or a required personalization column; or a row has an invalid phone number
403 missing phone:write
404 phone number not found
500 server error

`GET /v1/phone/get-schedules/{id}`

Lists the call schedules (campaigns) created for a purchased number, most recently created first. Use this to find a campaign’s id before calling POST /v1/phone/duplicate-call-schedule/{id} or GET /v1/phone/bulk-call-summary/{id} below, or to check a campaign’s progress.

Path parameters

Parameter	Type	Description
`id`	string	Purchased phone number id whose campaigns to list.

Query parameters

Parameter	Type	Required	Description
`page`	integer	no	Page number, defaults to `1`.
`pageSize`	integer	no	Results per page, defaults to `10`.
`campaign`	string	no	Case-insensitive substring search on campaign name.
`status`	string (`pending` \| `scheduled`)	no	Filter by whether the campaign has finished dialing every contact.
`startDate`	string (ISO 8601 datetime)	no	Only include campaigns scheduled on or after this time.
`endDate`	string (ISO 8601 datetime)	no	Only include campaigns scheduled on or before this time.
`timeZone`	string	no	Filter by the campaign’s timezone. One of `GMT_plus_1`, `UTC_minus_4`, `UTC_minus_5`, `UTC_minus_6`, `UTC_minus_7`, `UTC_minus_8`.

curl -X GET "https://api.indigenius.ai/v1/phone/get-schedules/665e4a34c65bb95f2f2d72e4?campaign=Spring&status=pending&page=1&pageSize=10" \
  -H "X-API-Key: YOUR_API_KEY"

const phonePurchaseId = '665e4a34c65bb95f2f2d72e4';
const params = new URLSearchParams({
  campaign: 'Spring',
  status: 'pending',
  page: '1',
  pageSize: '10',
});
const response = await fetch(
  `https://api.indigenius.ai/v1/phone/get-schedules/${phonePurchaseId}?${params}`,
  { headers: { 'X-API-Key': process.env.INDIGENIUS_API_KEY } },
);
console.log(await response.json());

import requests
phone_purchase_id = "665e4a34c65bb95f2f2d72e4"
response = requests.get(
    f"https://api.indigenius.ai/v1/phone/get-schedules/{phone_purchase_id}",
    headers={"X-API-Key": "YOUR_API_KEY"},
    params={"campaign": "Spring", "status": "pending", "page": 1, "pageSize": 10},
    timeout=30,
)
print(response.status_code)
print(response.json())

`200 OK`

{
  "success": true,
  "message": "Call schedules fetched successfully",
  "data": {
    "currentPage": 1,
    "totalPages": 1,
    "hasNextPage": false,
    "hasPrevPage": false,
    "nextPage": null,
    "prevPage": null,
    "record": [
      {
        "id": "665e4a34c65bb95f2f2d72e7",
        "name": "Spring Promo",
        "date": "2026-06-15T09:00:00.000Z",
        "status": 0,
        "contacts": 42
      }
    ]
  },
  "meta": {
    "requestId": "f3c9b29a-9f4d-4b71-8b3b-2cb77f4e9cf1",
    "timestamp": "2026-06-02T10:30:45.123Z",
    "version": "v1"
  }
}

status on each item is 0 (pending — not yet handed off for dialing), 1 (scheduled — already queued to dial; this does not mean every contact has been reached yet), or 2 (failed at the schedule level, e.g. the outbound number became unavailable). The status filter groups 1 and 2 together as scheduled — to know whether every contact has actually been dialed, check GET /v1/phone/bulk-call-summary/{id} below, which returns a 400 until the campaign has finished. contacts is the count of contacts on the schedule that still exist as active phone contacts, not necessarily how many were actually called.

Common status codes

200 success
403 missing phone:read
404 phone purchase not found
500 server error

`POST /v1/phone/duplicate-call-schedule/{id}`

Relaunches a campaign without re-uploading anything: creates a new call schedule that reuses the source campaign’s contact list, phone number, message, and timezone, and queues it to run on a new date you provide. Use this instead of POST /v1/phone/schedule-call when you’re re-running the same audience and message — for example, sending last week’s promo to the same list again next month. The copy is independent of the source once created — deleting or editing the original afterwards has no effect on it. It always starts fresh in the pending state, so it will be picked up and dialed out on schedule even if the source campaign is still running or has already finished.

Path parameters

Parameter	Type	Description
`id`	string	The id of the call schedule to duplicate.

Request body

Field	Type	Required	Description
`date`	string (ISO 8601 datetime)	yes	When the duplicated campaign should run. Interpreted in the timezone stored on the source campaign, not UTC.

curl -X POST "https://api.indigenius.ai/v1/phone/duplicate-call-schedule/665e4a34c65bb95f2f2d72e7" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "date": "2026-08-01T00:00:00.000Z"
  }'

const response = await fetch(
  'https://api.indigenius.ai/v1/phone/duplicate-call-schedule/665e4a34c65bb95f2f2d72e7',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'X-API-Key': process.env.INDIGENIUS_API_KEY,
    },
    body: JSON.stringify({ date: '2026-08-01T00:00:00.000Z' }),
  },
);
console.log(await response.json());

import requests
response = requests.post(
    "https://api.indigenius.ai/v1/phone/duplicate-call-schedule/665e4a34c65bb95f2f2d72e7",
    headers={"X-API-Key": "YOUR_API_KEY", "Content-Type": "application/json"},
    json={"date": "2026-08-01T00:00:00.000Z"},
    timeout=30,
)
print(response.status_code)
print(response.json())

`201 Created`

{
  "success": true,
  "message": "Call schedule duplicated successfully",
  "data": {
    "id": "665e4a34c65bb95f2f2d72e8",
    "name": "Spring Promo (copy)",
    "date": "2026-08-01T00:00:00.000Z"
  },
  "meta": {
    "requestId": "f3c9b29a-9f4d-4b71-8b3b-2cb77f4e9cf1",
    "timestamp": "2026-06-02T10:30:45.123Z",
    "version": "v1"
  }
}

Common status codes

201 duplicated
400 date missing or not a valid ISO datetime
403 missing phone:write
404 call schedule not found
500 server error

`GET /v1/phone/bulk-call-summary/{id}`

Downloads a one-page report for a finished campaign: how many calls succeeded, failed, or are still pending, plus a short list of contacts that need a follow-up action (e.g. calls that failed to connect). Useful for closing out a campaign — attach it to an internal report or share it with whoever requested the outreach, without having to pull the raw call list and tally it yourself. This only becomes available once every contact in the schedule has been dialed at least once. Calling it while the campaign is still in progress returns a 400 telling you it hasn’t finished yet.

Path parameters

Parameter	Type	Description
`id`	string	The id of the call schedule to summarize.

Query parameters

Parameter	Type	Required	Description
`format`	string (`pdf` \| `docx`)	yes	File format of the downloaded report.

curl -X GET "https://api.indigenius.ai/v1/phone/bulk-call-summary/665e4a34c65bb95f2f2d72e7?format=pdf" \
  -H "X-API-Key: YOUR_API_KEY" \
  -o bulk_call_summary.pdf

Common status codes

200 success (binary pdf or docx file)
400 format missing or not one of pdf/docx; campaign still has contacts left to dial
403 missing phone:read
404 call schedule not found
500 server error

​Phone

​Authentication & scope

​GET /v1/phone/purchases

​Common status codes

​GET /v1/phone/contacts/{id}

​Common status codes

​POST /v1/phone/allocate-assistant

​Request body

​Common status codes

​PATCH /v1/phone/{id}/call-forwarding

​Request body

​Common status codes

​GET /v1/phone/{id}/call-forwarding/history

​Common status codes

​POST /v1/phone/schedule-call

​Request body

​201 Created

​Common status codes

​POST /v1/phone/contacts

​Request body

​Common status codes

​POST /v1/phone/contacts/upload

​200 OK

​Common status codes

​POST /v1/phone/announce

​How it’s routed

​Request body

​201 Created

​Common status codes

​GET /v1/phone/announcer/{phoneId}/campaign-template

​Common status codes

​POST /v1/phone/schedule-announcer-campaign

​Request body

​201 Created

​Common status codes

​GET /v1/phone/get-schedules/{id}

​Path parameters

​Query parameters

​200 OK

​Common status codes

​POST /v1/phone/duplicate-call-schedule/{id}

​Path parameters

​Request body

​201 Created

​Common status codes

​GET /v1/phone/bulk-call-summary/{id}

​Path parameters

​Query parameters

​Common status codes

Phone

Authentication & scope

`GET /v1/phone/purchases`

Common status codes

`GET /v1/phone/contacts/{id}`

Common status codes

`POST /v1/phone/allocate-assistant`

Request body

Common status codes

`PATCH /v1/phone/{id}/call-forwarding`

Request body

Common status codes

`GET /v1/phone/{id}/call-forwarding/history`

Common status codes

`POST /v1/phone/schedule-call`

Request body

`201 Created`

Common status codes

`POST /v1/phone/contacts`

Request body

Common status codes

`POST /v1/phone/contacts/upload`

`200 OK`

Common status codes

`POST /v1/phone/announce`

How it’s routed

Request body

`201 Created`

Common status codes

`GET /v1/phone/announcer/{phoneId}/campaign-template`

Common status codes

`POST /v1/phone/schedule-announcer-campaign`

Request body

`201 Created`

Common status codes

`GET /v1/phone/get-schedules/{id}`

Path parameters

Query parameters

`200 OK`

Common status codes

`POST /v1/phone/duplicate-call-schedule/{id}`

Path parameters

Request body

`201 Created`

Common status codes

`GET /v1/phone/bulk-call-summary/{id}`

Path parameters

Query parameters

Common status codes