View as Markdown
CommPeak icon

CommPeak ACTION

Request Bulk Number Lookup

Perform a bulk number lookup, to later fetch the results when the operation is finished. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's CommPeak account once, then configure and run Request Bulk Number Lookup 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: "commpeak-request-bulk-number-lookup",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    commpeak: { authProvisionId: "apn_xxxxxxx" },
    keys: [10],
    requestType: "Request Type",
  },
})

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.

Request Bulk Number Lookup inputs
Property Type Description
keys Numbers integer[]
The numbers to perform the lookup on. Up to 200 phone numbers are supported per a single request.
Required
requestType Request Type string
The lookup type.
Required
respondUrl Respond URL string
The URL to which results will be sent as a callback once they're ready. This can be the URL of an HTTP source. Alternatively, you can use the Get Bulk Lookup Results action to fetch the results manually.
Optional

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
commpeak-request-bulk-number-lookup
Version
0.0.3
App
CommPeak
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes