Twilio

What you can do

Available commands: 48 (23 read, 25 write). Enable only the commands your application needs.

Run Send a message with Twilio. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Full JSON Schema

Full JSON Schema

Example input

{
  "to": "+15005550006",
  "message": "Your workflow finished.",
  "sender": {
    "phoneNumber": "+15005550001"
  }
}

At most 1 provider requests per invocation; timeout: 60 seconds.

Run Read usage records with Twilio. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Full JSON Schema

Full JSON Schema

Example input

{
  "scope": "communications",
  "periodStart": "2026-08-01",
  "periodEnd": "2026-08-31"
}

At most 10 provider requests per invocation; timeout: 120 seconds.

Run Redirect a live call with Twilio. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Full JSON Schema

Full JSON Schema

Example input

{
  "callReference": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "callbackUrl": "https://www.tooluse.net/voice/twiml"
}

At most 1 provider requests per invocation; timeout: 60 seconds.

Run Issue a voice network token with Twilio. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Full JSON Schema

Full JSON Schema

Example input

{
  "ttlSeconds": 3600
}

At most 1 provider requests per invocation; timeout: 60 seconds.

Run Download a call recording with Twilio. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Full JSON Schema

Full JSON Schema

Example input

{
  "recordingId": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "format": "mp3"
}

At most 1 provider requests per invocation; timeout: 120 seconds.

Run Read or change a core REST resource with Twilio. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Full JSON Schema

Full JSON Schema

Example input

{
  "resource": "Messages",
  "action": "read",
  "phoneNumber": "+15005550006",
  "dateSentAfter": "2026-08-01"
}

At most 1 provider requests per invocation; timeout: 60 seconds.

Run Read a messaging resource with Twilio. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Full JSON Schema

Full JSON Schema

Example input

{
  "resourceType": "services",
  "action": "read"
}

At most 1 provider requests per invocation; timeout: 60 seconds.

Run Change a messaging compliance resource with Twilio. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Full JSON Schema

Full JSON Schema

Example input

{
  "resourceType": "tollfree",
  "action": "create",
  "fields": {
    "BusinessName": "Gridheap"
  }
}

At most 1 provider requests per invocation; timeout: 60 seconds.

Run Read message content templates with Twilio. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Full JSON Schema

Full JSON Schema

Example input

{
  "resourceType": "content",
  "action": "read"
}

At most 1 provider requests per invocation; timeout: 60 seconds.

Run Change a message content template with Twilio. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Full JSON Schema

Full JSON Schema

Example input

{
  "resourceType": "content",
  "action": "create",
  "fields": {
    "FriendlyName": "order-update"
  }
}

At most 1 provider requests per invocation; timeout: 60 seconds.

Run Read a numbers resource with Twilio. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Full JSON Schema

Full JSON Schema

Example input

{
  "resourceType": "regulatory-compliance",
  "action": "read"
}

At most 1 provider requests per invocation; timeout: 60 seconds.

Run Change a numbers resource with Twilio. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Full JSON Schema

Full JSON Schema

Example input

{
  "resourceType": "regulatory-compliance",
  "action": "create",
  "fields": {
    "FriendlyName": "primary-bundle"
  }
}

At most 1 provider requests per invocation; timeout: 60 seconds.

Run Read a WhatsApp-capable number with Twilio. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Full JSON Schema

Full JSON Schema

Example input

{
  "incomingNumberReference": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}

At most 1 provider requests per invocation; timeout: 60 seconds.

Run Release a number with Twilio. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Full JSON Schema

Full JSON Schema

Example input

{
  "incomingNumberReference": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}

At most 1 provider requests per invocation; timeout: 60 seconds.

Run Search available local numbers with Twilio. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Full JSON Schema

Full JSON Schema

Example input

{
  "country": "US",
  "areaCode": "415"
}

At most 1 provider requests per invocation; timeout: 60 seconds.

Run Buy a number with Twilio. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Full JSON Schema

Full JSON Schema

Example input

{
  "phoneNumber": "+15005550006",
  "label": "support-line",
  "smsCallbackUrl": "https://www.tooluse.net/sms",
  "voiceCallbackUrl": "https://www.tooluse.net/voice"
}

At most 1 provider requests per invocation; timeout: 60 seconds.

Run List owned numbers with Twilio. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Full JSON Schema

Full JSON Schema

Example input

{
  "label": "support-line",
  "limit": 50
}

At most 1 provider requests per invocation; timeout: 60 seconds.

Run Download message media with Twilio. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Full JSON Schema

Full JSON Schema

Example input

{
  "messageReference": "SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "mediaReference": "MEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}

At most 2 provider requests per invocation; timeout: 60 seconds.

Run Register a WhatsApp sender with Twilio. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Full JSON Schema

Full JSON Schema

Example input

{
  "phoneNumber": "+15005550006",
  "businessAccountReference": "109876543210987",
  "displayName": "Gridheap",
  "callbackUrl": "https://www.tooluse.net/whatsapp",
  "statusCallbackUrl": "https://www.tooluse.net/whatsapp/status"
}

At most 1 provider requests per invocation; timeout: 60 seconds.

Run Read a sender with Twilio. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Full JSON Schema

Full JSON Schema

Example input

{
  "senderReference": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}

At most 1 provider requests per invocation; timeout: 60 seconds.

Run List senders with Twilio. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Full JSON Schema

Full JSON Schema

Example input

{
  "phoneNumber": "+15005550006",
  "limit": 50
}

At most 1 provider requests per invocation; timeout: 60 seconds.

Run Update a sender with Twilio. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Full JSON Schema

Full JSON Schema

Example input

{
  "senderReference": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "profile": {
    "name": "Gridheap"
  }
}

At most 1 provider requests per invocation; timeout: 60 seconds.

Run Remove a sender with Twilio. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Full JSON Schema

Full JSON Schema

Example input

{
  "senderReference": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}

At most 1 provider requests per invocation; timeout: 60 seconds.

Run Send a WhatsApp message with Twilio. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Full JSON Schema

Full JSON Schema

Example input

{
  "from": "whatsapp:+15005550001",
  "to": "whatsapp:+15005550006",
  "message": "Your workflow finished.",
  "statusCallbackUrl": "https://www.tooluse.net/whatsapp/status"
}

At most 1 provider requests per invocation; timeout: 60 seconds.

Run Create a content template with Twilio. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Full JSON Schema

Full JSON Schema

Example input

{
  "friendlyName": "order_update",
  "language": "en_US",
  "variables": {
    "1": "order id"
  },
  "types": {
    "twilio/text": {
      "body": "Order {{1}} shipped."
    }
  }
}

At most 1 provider requests per invocation; timeout: 60 seconds.

Run Update a content template with Twilio. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Full JSON Schema

Full JSON Schema

Example input

{
  "contentReference": "HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "friendlyName": "order_update",
  "variables": {
    "1": "order id"
  },
  "types": {
    "twilio/text": {
      "body": "Order {{1}} delivered."
    }
  }
}

At most 1 provider requests per invocation; timeout: 60 seconds.

Run Read a content template with Twilio. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Full JSON Schema

Full JSON Schema

Example input

{
  "contentReference": "HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}

At most 1 provider requests per invocation; timeout: 60 seconds.

Run List content templates and approvals with Twilio. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Full JSON Schema

Full JSON Schema

Example input

{
  "limit": 50
}

At most 1 provider requests per invocation; timeout: 60 seconds.

Run Submit a template for approval with Twilio. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Full JSON Schema

Full JSON Schema

Example input

{
  "contentReference": "HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "name": "order_update",
  "category": "UTILITY"
}

At most 1 provider requests per invocation; timeout: 60 seconds.

Run Read approval status with Twilio. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Full JSON Schema

Full JSON Schema

Example input

{
  "contentReference": "HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}

At most 1 provider requests per invocation; timeout: 60 seconds.

Run Delete a content template with Twilio. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Full JSON Schema

Full JSON Schema

Example input

{
  "contentReference": "HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}

At most 1 provider requests per invocation; timeout: 60 seconds.

Run Find an owned number by its digits with Twilio. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Full JSON Schema

Full JSON Schema

Example input

{
  "phoneNumber": "+15005550006"
}

At most 1 provider requests per invocation; timeout: 60 seconds.

Run Attach a number to a messaging service with Twilio. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Full JSON Schema

Full JSON Schema

Example input

{
  "messagingServiceId": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "phoneNumberId": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}

At most 1 provider requests per invocation; timeout: 60 seconds.

Run Register a US A2P 10DLC campaign with Twilio. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Full JSON Schema

Full JSON Schema

Example input

{
  "messagingServiceId": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "brandRegistrationId": "BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "campaign": {
    "useCase": "CUSTOMER_CARE",
    "description": "Workflow run notifications for Gridheap customers.",
    "messageFlow": "Customers opt in from the Gridheap dashboard when enabling notifications.",
    "sampleMessages": [
      "Your workflow finished."
    ],
    "optInKeywords": [
      "START"
    ],
    "optOutKeywords": [
      "STOP"
    ],
    "helpKeywords": [
      "HELP"
    ],
    "subscriberOptIn": true
  }
}

At most 1 provider requests per invocation; timeout: 60 seconds.

Run Read a US A2P 10DLC campaign with Twilio. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Full JSON Schema

Full JSON Schema

Example input

{
  "messagingServiceId": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "campaignId": "QEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}

At most 1 provider requests per invocation; timeout: 60 seconds.

Run Submit or edit a toll-free verification with Twilio. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Full JSON Schema

Full JSON Schema

Example input

{
  "phoneNumberId": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "business": {
    "legalName": "Gridheap Inc",
    "websiteUrl": "https://www.tooluse.net",
    "notificationEmail": "[email protected]",
    "type": "Private Company",
    "address": {
      "line1": "1 Market St",
      "city": "San Francisco",
      "region": "CA",
      "postalCode": "94105",
      "country": "US"
    },
    "contact": {
      "firstName": "Ops",
      "lastName": "Team",
      "email": "[email protected]"
    }
  },
  "campaign": {
    "description": "Workflow run notifications.",
    "sampleMessage": "Your workflow finished.",
    "optInType": "WEB_FORM",
    "messageVolume": "1,000",
    "additionalInformation": "Notifications only.",
    "useCaseCategory": "Customer Care",
    "optInKeywords": [
      "START"
    ],
    "optInImageUrls": [
      "https://www.tooluse.net/opt-in.png"
    ]
  }
}

At most 1 provider requests per invocation; timeout: 60 seconds.

Run Read a toll-free verification with Twilio. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Full JSON Schema

Full JSON Schema

Example input

{
  "verificationId": "HHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}

At most 1 provider requests per invocation; timeout: 60 seconds.

Run Check whether a number can be ported in with Twilio. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Full JSON Schema

Full JSON Schema

Example input

{
  "phoneNumber": "+15005550006"
}

At most 1 provider requests per invocation; timeout: 60 seconds.

Run Read the porting webhook configuration with Twilio. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 1 provider requests per invocation; timeout: 60 seconds.

Run Set the porting webhook configuration with Twilio. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Full JSON Schema

Full JSON Schema

Example input

{
  "portInTargetUrl": "https://www.tooluse.net/porting/in",
  "portOutTargetUrl": "https://www.tooluse.net/porting/out",
  "eventTypes": [
    "PortInRequestStatusChanged"
  ]
}

At most 1 provider requests per invocation; timeout: 60 seconds.

Run Open a port-in request with Twilio. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Full JSON Schema

Full JSON Schema

Example input

{
  "phoneNumber": "+15005550006",
  "targetDate": "2026-10-01",
  "notificationEmails": [
    "[email protected]"
  ],
  "customer": {
    "type": "Business",
    "name": "Gridheap Inc",
    "authorizedRepresentative": "Ops Team",
    "authorizedRepresentativeEmail": "[email protected]"
  },
  "transferCredentials": {
    "accountNumber": "123456789",
    "pin": "4321"
  },
  "serviceAddress": {
    "street": "1 Market St",
    "city": "San Francisco",
    "state": "CA",
    "postalCode": "94105",
    "country": "US"
  },
  "documentReferences": []
}

At most 1 provider requests per invocation; timeout: 60 seconds.

Run Read a port-in request with Twilio. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Full JSON Schema

Full JSON Schema

Example input

{
  "portInRequestId": "KWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}

At most 1 provider requests per invocation; timeout: 60 seconds.

Run Create a bounded owned conference participant with Twilio. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Full JSON Schema

Full JSON Schema

Example input

{
  "conferenceReference": "tidyanswer_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "to": "client:voice_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "from": "+15005550001",
  "participantLabel": "synthetic-participant",
  "statusCallbackUrl": "https://api.tidyanswer.com/v1/twilio/voice-status?workspaceID=workspace_fixture&tidyanswerCallID=call_bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
  "timeoutSeconds": 20,
  "timeLimitSeconds": 7200
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Run Hold or resume an existing conference participant with Twilio. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Full JSON Schema

Full JSON Schema

Example input

{
  "conferenceReference": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "callReference": "CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
  "hold": true
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Run Read an existing conference participant with Twilio. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Full JSON Schema

Full JSON Schema

Example input

{
  "conferenceReference": "CFaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "callReference": "CAbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Run Read the current owned call with Twilio. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Full JSON Schema

Full JSON Schema

Example input

{
  "callReference": "CAcccccccccccccccccccccccccccccccc"
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Run Create one registered native client with an owned answer gate with Twilio. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Full JSON Schema

Full JSON Schema

Example input

{
  "to": "client:voice_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "from": "+12025550111",
  "answerUrl": "https://api.tidyanswer.com/v1/twilio/voice-incoming-answer?workspaceID=workspace_fixture&tidyanswerCallID=call_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&candidateID=candidate_cccccccccccccccccccccccccccccccc&generation=bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
  "statusCallbackUrl": "https://api.tidyanswer.com/v1/twilio/voice-incoming-status?workspaceID=workspace_fixture&tidyanswerCallID=call_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&candidateID=candidate_cccccccccccccccccccccccccccccccc&generation=bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
  "timeoutSeconds": 20,
  "timeLimitSeconds": 7200
}

At most 1 provider requests per invocation; timeout: 30 seconds.

Run Terminate one observed owned call with Twilio. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Full JSON Schema

Full JSON Schema

Example input

{
  "callReference": "CAcccccccccccccccccccccccccccccccc",
  "expectedStatus": "ringing"
}

At most 1 provider requests per invocation; timeout: 30 seconds.