View as Markdown
Yay.com icon

Yay.com ACTION

Create Outbound Call

Initiates an outbound call to a specified number. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Yay.com account once, then configure and run Create Outbound Call 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: "yay_com-create-outbound-call",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    yay_com: { authProvisionId: "apn_xxxxxxx" },
    userUuid: "SIP User ID",
    destination: "Destination",
  },
})

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.

Create Outbound Call inputs
Property Type Description
userUuid SIP User ID string
The SIP user to make the outbound call for
Required Dynamic
destination Destination string
The destination phone number to call (in E164 format for outbound calls). You may also provide extension numbers of your hunt groups, users and call routes.
Required
displayName Display Name string
What display name should be sent to the user, this will show as the name on their phone (where supported)
Optional
sipUsers Target SIP Users string[]
One or more SIP users who will receive the outbound call request
Optional Dynamic
huntGroups Target Hunt Groups string[]
One or more hunt groups who will receive the outbound call request
Optional Dynamic

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
yay_com-create-outbound-call
Version
0.0.2
App
Yay.com
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes