View as Markdown
CallerAPI icon

CallerAPI ACTION

Get Phone Number Information

Retrieve detailed information about a specific phone number, including name, location, and carrier. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's CallerAPI account once, then configure and run Get Phone Number Information from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "callerapi-get-phone-number-information",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    callerapi: { authProvisionId: "apn_xxxxxxx" },
    phoneNumber: "Phone Number",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Get Phone Number Information inputs
Property Type Description
phoneNumber Phone Number string
The phone number to retrieve information for (E.164 format, e.g., +18006927753)
Required

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
callerapi-get-phone-number-information
Version
0.0.2
App
CallerAPI
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes