---
canonical_url: "https://docs.composio.dev/toolkits/callonthego"
markdown_url: "https://docs.composio.dev/toolkits/callonthego.md"
product: "platform"
version: null
last_updated: null
---

# CallOnTheGo

CallOnTheGo provides APIs for managing phone numbers, caller IDs, suppression lists, audio assets, contact lists, and Voice AI campaigns.

- **Category:** call tracking
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 29
- **Triggers:** 0
- **Slug:** `CALLONTHEGO`
- **Version:** 00000000_00

## Tools

### Add Suppression Entry

**Slug:** `CALLONTHEGO_ADD_SUPPRESSION_ENTRY`

Idempotently add one phone number to the Do-Not-Call list. This change persists indefinitely because the API provides no removal route.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `reason` | string | No | Optional reason recorded with the persistent suppression entry. |
| `source` | string | No | Short source label recording where the suppression request originated. |
| `phone_number` | string | Yes | Phone number to persist on the Do-Not-Call list, in E.164 format or as a 10-digit US number. The API provides no removal route. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Cancel Campaign

**Slug:** `CALLONTHEGO_CANCEL_CAMPAIGN`

Irreversibly cancel a campaign and mark its queued or pending recipients cancelled. This changes the campaign to a terminal state but does not delete its record.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaign_id` | string | Yes | ID of the campaign to irreversibly cancel without deleting its record. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Caller ID

**Slug:** `CALLONTHEGO_CREATE_CALLER_ID`

Add a caller ID and initiate a telecom-provider verification call to confirm ownership. Returns the caller-ID resource ID and verification code needed to complete verification; this does not launch a campaign.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `label` | string | No | Optional human-readable label for the caller ID. |
| `phone_number` | string | Yes | Caller-ID phone number in E.164 format (a leading '+' and up to 15 digits) or as exactly 10 US digits, without spaces or punctuation. A telecom-provider verification call is initiated for this number. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Campaign

**Slug:** `CALLONTHEGO_CREATE_CAMPAIGN`

Create a draft Voice AI campaign from explicit caller ID, contact list, and audio resources. This only saves a draft: it does not launch the campaign, place or queue calls, or incur call charges. Use the separate launch action when calling should begin.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Non-empty name for the draft campaign. |
| `start_at` | string | No | Optional ISO 8601 time at which the campaign becomes eligible to start. |
| `opt_out_key` | string | No | Single keypad key recipients press to opt out. |
| `caller_id_id` | string | Yes | Owned, verified caller-ID resource ID. |
| `transfer_key` | string | No | Single keypad key recipients press to request a transfer. |
| `timezone_mode` | string ("recipient" | "fixed" | "campaign") | No | Timezone basis for the calling window: recipient uses each recipient's timezone, fixed uses one fixed timezone, and campaign uses the campaign timezone. |
| `estimated_cost` | number | No | Optional non-negative campaign cost estimate recorded on the draft. |
| `contact_list_id` | string | Yes | Contact-list resource ID containing the campaign recipients. |
| `allowed_end_time` | string | No | Latest local recipient time at which calls may be placed, in 24-hour HH:MM format. Must be later than allowed_start_time. |
| `allowed_start_time` | string | No | Earliest local recipient time at which calls may be placed, in 24-hour HH:MM format. Must be earlier than allowed_end_time. |
| `live_answer_audio_id` | string | Yes | Audio-asset ID to play when a person answers. |
| `max_calls_per_minute` | integer | No | Maximum campaign call attempts per minute; must be positive. |
| `transfer_phone_number` | string | No | Optional destination phone number for recipient-requested transfers. |
| `machine_answer_audio_id` | string | No | Optional audio-asset ID to play when an answering machine is detected. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Caller ID

**Slug:** `CALLONTHEGO_DELETE_CALLER_ID`

Permanently remove an owned caller ID configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `caller_id` | string | Yes | ID of the caller ID to permanently remove. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Phone Number

**Slug:** `CALLONTHEGO_DELETE_PHONE_NUMBER`

Permanently remove an owned phone-number configuration by ID; deleting a missing ID also reports success.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `number_id` | string | Yes | ID of the owned phone number to permanently remove. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Campaign

**Slug:** `CALLONTHEGO_GET_CAMPAIGN`

Get one campaign's configuration, lifecycle state, resource names, delivery metrics, and cost metrics.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaign_id` | string | Yes | ID of the campaign to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Dashboard Stats

**Slug:** `CALLONTHEGO_GET_DASHBOARD_STATS`

Return account-level call, contact, group, list, success-rate, and recent-activity summary metrics.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Voice Readiness

**Slug:** `CALLONTHEGO_GET_VOICE_READINESS`

Return runtime readiness, telecom provider assignment, and supported capabilities for diagnosing whether voice campaigns can run.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Launch Campaign

**Slug:** `CALLONTHEGO_LAUNCH_CAMPAIGN`

Validate compliance, provision telecom isolation if needed, and launch a campaign. Launching immediately queues eligible recipients for calls and may incur call charges.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaign_id` | string | Yes | ID of the fully configured draft campaign to launch. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Audio Assets

**Slug:** `CALLONTHEGO_LIST_AUDIO_ASSETS`

List campaign audio assets with playback, duration, transcript, and compliance details.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Caller IDs

**Slug:** `CALLONTHEGO_LIST_CALLER_IDS`

List owned caller IDs with ownership-verification status and inbound-campaign assignment.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Calls

**Slug:** `CALLONTHEGO_LIST_CALLS`

Return one page of account call records for outcome and duration review, with an opaque cursor for the next page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum call records to return in this page, at least 1. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call; omit it for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Campaign Events

**Slug:** `CALLONTHEGO_LIST_CAMPAIGN_EVENTS`

List only the newest 100 delivery events for a campaign, ordered newest first. CallOnTheGo provides no cursor or continuation mechanism, so events older than this fixed window cannot be retrieved with this tool.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaign_id` | string | Yes | ID of the campaign whose newest delivery events to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Campaign Recipients

**Slug:** `CALLONTHEGO_LIST_CAMPAIGN_RECIPIENTS`

List all recipients for a campaign with call status, attempts, machine detection, and cost estimates. CallOnTheGo does not paginate this endpoint, so campaigns with many recipients can return a large response.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaign_id` | string | Yes | ID of the campaign whose recipients to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Campaigns

**Slug:** `CALLONTHEGO_LIST_CAMPAIGNS`

List Voice AI campaigns with lifecycle state, linked resources, calling window, rate, estimated cost, compliance state, and timestamps.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Contact Lists

**Slug:** `CALLONTHEGO_LIST_CONTACT_LISTS`

List campaign contact lists with valid, invalid, suppressed, and total recipient counts.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Contacts

**Slug:** `CALLONTHEGO_LIST_CONTACTS`

Return one page of contacts from the connected CallOnTheGo account for CRM lookup, with an opaque cursor for the next page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum contacts to return in this page. The provider does not publish a maximum. |
| `next_cursor` | string | No | Opaque continuation cursor from a previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Phone Numbers

**Slug:** `CALLONTHEGO_LIST_PHONE_NUMBERS`

List phone numbers owned by the connected CallOnTheGo account, including the resource records needed to identify numbers for later management.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Suppression Entries

**Slug:** `CALLONTHEGO_LIST_SUPPRESSION_ENTRIES`

List Do-Not-Call suppression entries for the connected account.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Pause Campaign

**Slug:** `CALLONTHEGO_PAUSE_CAMPAIGN`

Pause a running campaign while retaining its pending recipients for a later resume. The campaign must currently be running.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaign_id` | string | Yes | ID of the running campaign to pause. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Queue Campaign Lead

**Slug:** `CALLONTHEGO_QUEUE_CAMPAIGN_LEAD`

Queue one phone-number lead for dialing by a running campaign. This can place a call and incur charges; suppressed or already-active leads may return without a new dial.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Optional full name for the lead. |
| `source` | string | No | Short source label associated with the lead. |
| `metadata` | object | No | Optional JSON metadata to associate with the lead. |
| `last_name` | string | No | Optional lead last name. |
| `first_name` | string | No | Optional lead first name. |
| `campaign_id` | string | Yes | ID of the running campaign that will dial the lead. |
| `phone_number` | string | Yes | Required non-empty lead phone number to queue, preferably in E.164 format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Resume Campaign

**Slug:** `CALLONTHEGO_RESUME_CAMPAIGN`

Resume a paused campaign and immediately requeue its pending recipients for calls. Resuming can place calls and incur call charges.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaign_id` | string | Yes | ID of the paused campaign to resume. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Set Caller ID Inbound Campaign

**Slug:** `CALLONTHEGO_SET_CALLER_ID_INBOUND_CAMPAIGN`

Set or clear the preferred inbound campaign assigned to an owned caller ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `caller_id` | string | Yes | ID of the caller ID whose inbound assignment will change. |
| `inbound_campaign_id` | string | Yes | Campaign ID to assign, or null to clear the current inbound campaign. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Campaign

**Slug:** `CALLONTHEGO_UPDATE_CAMPAIGN`

Update selected configuration fields on a draft or paused campaign. Running, completed, cancelled, and failed campaigns reject updates. Only explicitly supplied fields are changed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New non-empty campaign name. Omit to leave the name unchanged. |
| `campaign_id` | string | Yes | ID of the draft or paused campaign to update. |
| `caller_id_id` | string | No | New owned, verified caller-ID resource ID. Omit to leave it unchanged; null is not accepted. |
| `contact_list_id` | string | No | New contact-list resource ID. Omit to leave it unchanged; null is not accepted. |
| `live_answer_audio_id` | string | No | New live-answer audio-asset ID. Omit to leave it unchanged; null is not accepted. |
| `max_calls_per_minute` | integer | No | New positive call-attempt rate per minute. Omit to leave it unchanged; null is not accepted. |
| `transfer_phone_number` | string | No | New transfer destination. Omit to leave it unchanged; null is not accepted. |
| `machine_answer_audio_id` | string | No | New machine-answer audio-asset ID. Omit to leave it unchanged; null is not accepted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload Audio Asset

**Slug:** `CALLONTHEGO_UPLOAD_AUDIO_ASSET`

Upload an MP3 or WAV file as a reusable campaign audio asset. This creates stored account data but does not place calls; the API provides no route to delete the stored asset.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | MP3 or WAV audio file to store as a reusable campaign asset. The API provides no route to delete the stored asset. |
| `name` | string | No | Optional display name for the audio asset. The filename is used when omitted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload Contact List

**Slug:** `CALLONTHEGO_UPLOAD_CONTACT_LIST`

Create a campaign contact list from a CSV file. CallOnTheGo normalizes phone numbers, removes duplicates, filters suppressed recipients, and persists the resulting contacts without placing calls. The API provides no route to delete the resulting contact list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | CSV file with a phone column and optional firstName, lastName, company, timezone, and consentSource columns. The API provides no route to delete the resulting contact list. |
| `name` | string | No | Optional contact-list name; the filename is used when omitted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upload Suppression CSV

**Slug:** `CALLONTHEGO_UPLOAD_SUPPRESSION_CSV`

Persistently add many phone numbers to the Do-Not-Call list from a CSV file. Duplicate entries are skipped. This bulk change cannot be undone through the API because no suppression-removal route is available.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | CSV file containing a phone or phoneNumber column. Every valid number is persistently added to the Do-Not-Call list, and the API provides no removal route. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Verify Caller ID

**Slug:** `CALLONTHEGO_VERIFY_CALLER_ID`

Submit an ownership-verification code for an existing caller ID and return whether it became verified or remains pending.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `caller_id` | string | Yes | ID of the caller ID being verified. |
| `verification_code` | string | Yes | Ownership-verification code issued when the caller ID was created. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |