Skip to main content
CallOnTheGo logo
  • Category: call tracking
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 29
  • Triggers: 0
  • Slug: CALLONTHEGO
  • Version: 20261101_00

Tools

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

Input Parameters

string
Optional reason recorded with the persistent suppression entry.
string
Short source label recording where the suppression request originated.
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLONTHEGO_CANCEL_CAMPAIGNIrreversibly 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

string
required
ID of the campaign to irreversibly cancel without deleting its record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLONTHEGO_CREATE_CALLER_IDAdd 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

string
Optional human-readable label for the caller ID.
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLONTHEGO_CREATE_CAMPAIGNCreate 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLONTHEGO_DELETE_CALLER_IDPermanently remove an owned caller ID configuration.

Input Parameters

string
required
ID of the caller ID to permanently remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLONTHEGO_DELETE_PHONE_NUMBERPermanently remove an owned phone-number configuration by ID; deleting a missing ID also reports success.

Input Parameters

string
required
ID of the owned phone number to permanently remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLONTHEGO_GET_CAMPAIGNGet one campaign’s configuration, lifecycle state, resource names, delivery metrics, and cost metrics.

Input Parameters

string
required
ID of the campaign to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLONTHEGO_GET_DASHBOARD_STATSReturn account-level call, contact, group, list, success-rate, and recent-activity summary metrics.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLONTHEGO_GET_VOICE_READINESSReturn runtime readiness, telecom provider assignment, and supported capabilities for diagnosing whether voice campaigns can run.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLONTHEGO_LAUNCH_CAMPAIGNValidate compliance, provision telecom isolation if needed, and launch a campaign. Launching immediately queues eligible recipients for calls and may incur call charges.

Input Parameters

string
required
ID of the fully configured draft campaign to launch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLONTHEGO_LIST_AUDIO_ASSETSList campaign audio assets with playback, duration, transcript, and compliance details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLONTHEGO_LIST_CALLER_IDSList owned caller IDs with ownership-verification status and inbound-campaign assignment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLONTHEGO_LIST_CALLSReturn one page of account call records for outcome and duration review, with an opaque cursor for the next page.

Input Parameters

integer
Maximum call records to return in this page, at least 1.
string
Opaque continuation cursor returned by a previous call; omit it for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLONTHEGO_LIST_CAMPAIGN_EVENTSList 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

string
required
ID of the campaign whose newest delivery events to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLONTHEGO_LIST_CAMPAIGN_RECIPIENTSList 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

string
required
ID of the campaign whose recipients to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLONTHEGO_LIST_CAMPAIGNSList Voice AI campaigns with lifecycle state, linked resources, calling window, rate, estimated cost, compliance state, and timestamps.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLONTHEGO_LIST_CONTACT_LISTSList campaign contact lists with valid, invalid, suppressed, and total recipient counts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLONTHEGO_LIST_CONTACTSReturn one page of contacts from the connected CallOnTheGo account for CRM lookup. An opaque continuation cursor is returned only when the page contains at least the requested number of contacts.

Input Parameters

integer
Maximum contacts to return in this page. The provider does not publish a maximum.
string
Opaque continuation cursor from a previous call; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLONTHEGO_LIST_PHONE_NUMBERSList phone numbers owned by the connected CallOnTheGo account, including the resource records needed to identify numbers for later management.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLONTHEGO_LIST_SUPPRESSION_ENTRIESList Do-Not-Call suppression entries for the connected account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLONTHEGO_PAUSE_CAMPAIGNPause a running campaign while retaining its pending recipients for a later resume. The campaign must currently be running.

Input Parameters

string
required
ID of the running campaign to pause.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLONTHEGO_QUEUE_CAMPAIGN_LEADQueue 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

string
Optional full name for the lead.
string
Short source label associated with the lead.
object
Optional JSON metadata to associate with the lead.
string
Optional lead last name.
string
Optional lead first name.
string
required
ID of the running campaign that will dial the lead.
string
required
Required non-empty lead phone number to queue, preferably in E.164 format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLONTHEGO_RESUME_CAMPAIGNResume a paused campaign and immediately requeue its pending recipients for calls. Resuming can place calls and incur call charges.

Input Parameters

string
required
ID of the paused campaign to resume.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLONTHEGO_SET_CALLER_ID_INBOUND_CAMPAIGNSet or clear the preferred inbound campaign assigned to an owned caller ID.

Input Parameters

string
required
ID of the caller ID whose inbound assignment will change.
string
required
Campaign ID to assign, or null to clear the current inbound campaign.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLONTHEGO_UPDATE_CAMPAIGNUpdate 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

string
New non-empty campaign name. Omit to leave the name unchanged.
string
required
ID of the draft or paused campaign to update.
string
New owned, verified caller-ID resource ID. Omit to leave it unchanged; null is not accepted.
string
New contact-list resource ID. Omit to leave it unchanged; null is not accepted.
string
New live-answer audio-asset ID. Omit to leave it unchanged; null is not accepted.
integer
New positive call-attempt rate per minute. Omit to leave it unchanged; null is not accepted.
string
New transfer destination. Omit to leave it unchanged; null is not accepted.
string
New machine-answer audio-asset ID. Omit to leave it unchanged; null is not accepted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLONTHEGO_UPLOAD_AUDIO_ASSETUpload 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

object
required
MP3 or WAV audio file to store as a reusable campaign asset. The API provides no route to delete the stored asset.
string
Optional display name for the audio asset. The filename is used when omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLONTHEGO_UPLOAD_CONTACT_LISTCreate 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

object
required
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.
string
Optional contact-list name; the filename is used when omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLONTHEGO_UPLOAD_SUPPRESSION_CSVPersistently 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

object
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLONTHEGO_VERIFY_CALLER_IDSubmit an ownership-verification code for an existing caller ID and return whether it became verified or remains pending.

Input Parameters

string
required
ID of the caller ID being verified.
string
required
Ownership-verification code issued when the caller ID was created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not