--- title: "Twilio" description: "Send messages, redirect calls, read usage and reach Twilio's messaging, content and numbers APIs." --- > Documentation Index > Fetch the complete documentation index at: https://help.tooluse.net/llms.txt > Use this file to discover all available pages before exploring further. # Twilio

Send messages, redirect calls, read usage and reach Twilio's messaging, content and numbers APIs.

What you can do (48)

What you can do

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

Command Effect
Send a message — twilio.messaging.send Write
Read usage records — twilio.usage.read Read
Redirect a live call — twilio.voice.call.redirect Write
Issue a voice network token — twilio.voice.network-token.create Write
Download a call recording — twilio.voice.recording-media.read Read
Read or change a core REST resource — twilio.rest.resource Read
Read a messaging resource — twilio.messaging.read Read
Change a messaging compliance resource — twilio.messaging.compliance-mutation Write
Read message content templates — twilio.content.read Read
Change a message content template — twilio.content.mutation Write
Read a numbers resource — twilio.numbers.read Read
Change a numbers resource — twilio.numbers.mutation Write
Read a WhatsApp-capable number — twilio.whatsapp.incoming-number.read Read
Release a number — twilio.whatsapp.incoming-number.release Write
Search available local numbers — twilio.whatsapp.number.search Read
Buy a number — twilio.whatsapp.number.purchase Write
List owned numbers — twilio.whatsapp.number.list Read
Download message media — twilio.whatsapp.media.download Read
Register a WhatsApp sender — twilio.whatsapp.sender.create Write
Read a sender — twilio.whatsapp.sender.read Read
List senders — twilio.whatsapp.sender.list Read
Update a sender — twilio.whatsapp.sender.update Write
Remove a sender — twilio.whatsapp.sender.delete Write
Send a WhatsApp message — twilio.whatsapp.message.send Write
Create a content template — twilio.whatsapp.content.create Write
Update a content template — twilio.whatsapp.content.update Write
Read a content template — twilio.whatsapp.content.read Read
List content templates and approvals — twilio.whatsapp.content.list Read
Submit a template for approval — twilio.whatsapp.content.approval.submit Write
Read approval status — twilio.whatsapp.content.approval.read Read
Delete a content template — twilio.whatsapp.content.delete Write
Find an owned number by its digits — twilio.messaging.phone-number.lookup Read
Attach a number to a messaging service — twilio.messaging.service-sender.attach Write
Register a US A2P 10DLC campaign — twilio.messaging.a2p-campaign.create Write
Read a US A2P 10DLC campaign — twilio.messaging.a2p-campaign.read Read
Submit or edit a toll-free verification — twilio.messaging.tollfree-verification.upsert Write
Read a toll-free verification — twilio.messaging.tollfree-verification.read Read
Check whether a number can be ported in — twilio.porting.portability.check Read
Read the porting webhook configuration — twilio.porting.webhook.read Read
Set the porting webhook configuration — twilio.porting.webhook.upsert Write
Open a port-in request — twilio.porting.port-in.create Write
Read a port-in request — twilio.porting.port-in.read Read
Create a bounded owned conference participant — twilio.voice.conference.participant.create Write
Hold or resume an existing conference participant — twilio.voice.conference.participant.hold Write
Read an existing conference participant — twilio.voice.conference.participant.read Read
Read the current owned call — twilio.voice.call.read Read
Create one registered native client with an owned answer gate — twilio.voice.call.create Write
Terminate one observed owned call — twilio.voice.call.end Write

Connect and use

Connect and use

Open the integration's connection form to check the available credential source. The source has not been resolved for this documentation export. The instructions below apply when using your own provider account.

Get your provider credentials

Follow these steps for Twilio, then enter the issued values in the connection form below.

  1. Open the Twilio Console's account information and obtain the Account SID and Auth Token for the intended account or subaccount. These are the fields required by this integration.

Official credential setup

Where to enter credentials

In the integration page, sign in, choose your workspace and open Connect. If a Credentials choice is shown, select Use my credentials. Fill the following connection fields and save. Provider credentials belong in this form, never in an MCP configuration or tool input.

Connection field Requirement
Account SID Required
Auth Token Required

Open API keys and create a Tooluse.net key for the enabled commands.

Set TOOLUSE_API_KEY in your client and use the shared MCP configuration.

Configure Claude Code, Codex or Cursor once

Permissions and results

If you have more than one workspace, check the selected workspace in the connection or API-key dialog before saving. Roles, enabled commands, expiry and revocation use Tooluse.net's existing permissions. Disabling a connection or revoking a key immediately prevents new calls.

Send one Claude tool_use block per request. Keep the same Idempotency-Key when retrying the same request; use a new key for a new call. The response includes the shared Tooluse.net receipt and Claude tool_result. Check both HTTP status and the returned tool result before treating a call as successful.

Your connection's daily allowance and key permissions also apply. Adding a connection does not make a provider request.

Calls return the shared execution receipt and a Claude tool_result. Provider output varies by operation; consult the provider documentation for its response fields. Unconfirmed calls should be checked before retrying.

Call from your client

Use the shared MCP configuration. Refresh your client's tool list after saving the connection or changing key permissions, then call the returned tool name with the example input below.

Configure Claude Code, Codex or Cursor once

Discover your enabled tools

List permitted tools in Claude format. Read every page using page and size (maximum 100) until all results have been received. Use the returned name, not a catalog capability identifier, in the tool_use block.

curl 'https://api.tooluse.net/v1/tools' \
  -H "Authorization: Bearer $TOOLUSE_API_KEY"

Find this command in the tool list permitted by your key. Replace svc_FROM_YOUR_TOOL_LIST with its returned name. Use a new Idempotency-Key for each new call and retain it when retrying that same call.

HTTP call

curl 'https://api.tooluse.net/v1/tool-calls' \
  -H "Authorization: Bearer $TOOLUSE_API_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: replace-with-a-new-call-id' \
  --data '{
  "type": "tool_use",
  "id": "toolu_example",
  "name": "svc_FROM_YOUR_TOOL_LIST",
  "input": {
    "scope": "communications",
    "periodStart": "2026-08-01",
    "periodEnd": "2026-08-31"
  }
}'

Send one Claude tool_use block per request. Keep the same Idempotency-Key when retrying the same request; use a new key for a new call. The response includes the shared Tooluse.net receipt and Claude tool_result. Check both HTTP status and the returned tool result before treating a call as successful.

Commands

Send a message — twilio.messaging.send

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.

Parameter Type Required in parent Description Constraints
to string Required Phone number in E.164 pattern: "^\\+[1-9]\\d{7,14}$"
message string Optional Message body minLength: 1; maxLength: 16000
sender object Required Sender (a number or a messaging service, not both) minProperties: 1; maxProperties: 1; additionalProperties: false
sender.phoneNumber string Optional Phone number in E.164 pattern: "^\\+[1-9]\\d{7,14}$"
sender.messagingServiceReference string Optional Messaging Service SID pattern: "^MG[0-9a-fA-F]{32}$"
mediaUrls array Optional Media URLs maxItems: 10
mediaUrls[] string Optional maxLength: 4096; format: "uri"
scheduledAt string Optional Send at (messaging service only) format: "date-time"
shortenUrls boolean Optional Shorten links (messaging service only)
statusCallbackUrl string Optional Status callback URL maxLength: 4096; format: "uri"
accountReference string Optional Subaccount SID pattern: "^AC[0-9a-fA-F]{32}$"

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.

Read usage records — twilio.usage.read

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.

Parameter Type Required in parent Description Constraints
scope string Required Usage scope enum: ["communications","whatsapp"]
periodStart string Required Period start format: "date"
periodEnd string Required Period end format: "date"
accountReference string Optional Subaccount SID pattern: "^AC[0-9a-fA-F]{32}$"
maxPages integer Optional Maximum usage pages minimum: 1; maximum: 10

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.

Redirect a live call — twilio.voice.call.redirect

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.

Parameter Type Required in parent Description Constraints
callReference string Required Call SID pattern: "^CA[0-9a-fA-F]{32}$"
callbackUrl string Required TwiML URL maxLength: 4096; format: "uri"
accountReference string Optional Subaccount SID pattern: "^AC[0-9a-fA-F]{32}$"

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.

Issue a voice network token — twilio.voice.network-token.create

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.

Parameter Type Required in parent Description Constraints
ttlSeconds integer Required Lifetime in seconds minimum: 60; maximum: 86400
accountReference string Optional Subaccount SID pattern: "^AC[0-9a-fA-F]{32}$"

Full JSON Schema

Full JSON Schema

Example input

{
  "ttlSeconds": 3600
}

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

Download a call recording — twilio.voice.recording-media.read

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.

Parameter Type Required in parent Description Constraints
recordingId string Required Recording SID pattern: "^RE[0-9a-fA-F]{32}$"
format string Optional Audio format enum: ["wav","mp3"]

Full JSON Schema

Full JSON Schema

Example input

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

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

Read or change a core REST resource — twilio.rest.resource

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.

Parameter Type Required in parent Description Constraints
resource string Optional Resource enum: ["Messages","Calls","IncomingPhoneNumbers","Applications","Recordings"]
resourceId string Optional Resource SID minLength: 1; maxLength: 80
action string Optional Action enum: ["read","create","update","delete"]
phoneNumber string Optional Phone number in E.164 pattern: "^\\+[1-9]\\d{7,14}$"
dateSentAfter string Optional Sent on or after (message audit) format: "date"
query object Optional Query parameters maxProperties: 40; additionalProperties: {"anyOf":[{"type":"string","maxLength":4096},{"type":"number"},{"type":"boolean"}]}
fields object Optional Request fields maxProperties: 40; additionalProperties: {"anyOf":[{"anyOf":[{"type":"string","maxLength":4096},{"type":"number"},{"type":"boolean"}]},{"type":"array","items":{"anyOf":[{"type":"string","maxLength":4096},{"type":"number"},{"type":"boolean"}]},"maxItems":40}]}
accountReference string Optional Subaccount SID pattern: "^AC[0-9a-fA-F]{32}$"

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.

Read a messaging resource — twilio.messaging.read

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.

Parameter Type Required in parent Description Constraints
resourceType string Optional Sub-API enum: ["services","tollfree","senders"]
resource string Optional Resource path or id minLength: 1; maxLength: 240
action string Optional Action enum: ["read","create","update","delete"]
query object Optional Query parameters maxProperties: 40; additionalProperties: {"anyOf":[{"type":"string","maxLength":4096},{"type":"number"},{"type":"boolean"}]}
fields object Optional Request fields maxProperties: 40; additionalProperties: {"anyOf":[{"anyOf":[{"type":"string","maxLength":4096},{"type":"number"},{"type":"boolean"}]},{"type":"array","items":{"anyOf":[{"type":"string","maxLength":4096},{"type":"number"},{"type":"boolean"}]},"maxItems":40}]}

Full JSON Schema

Full JSON Schema

Example input

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

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

Change a messaging compliance resource — twilio.messaging.compliance-mutation

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.

Parameter Type Required in parent Description Constraints
resourceType string Optional Sub-API enum: ["services","tollfree","senders"]
resource string Optional Resource path or id minLength: 1; maxLength: 240
action string Optional Action enum: ["read","create","update","delete"]
query object Optional Query parameters maxProperties: 40; additionalProperties: {"anyOf":[{"type":"string","maxLength":4096},{"type":"number"},{"type":"boolean"}]}
fields object Optional Request fields maxProperties: 40; additionalProperties: {"anyOf":[{"anyOf":[{"type":"string","maxLength":4096},{"type":"number"},{"type":"boolean"}]},{"type":"array","items":{"anyOf":[{"type":"string","maxLength":4096},{"type":"number"},{"type":"boolean"}]},"maxItems":40}]}

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.

Read message content templates — twilio.content.read

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.

Parameter Type Required in parent Description Constraints
resourceType string Optional Sub-API enum: ["content","content-and-approvals"]
resource string Optional Resource path or id minLength: 1; maxLength: 240
action string Optional Action enum: ["read","create","update","delete"]
query object Optional Query parameters maxProperties: 40; additionalProperties: {"anyOf":[{"type":"string","maxLength":4096},{"type":"number"},{"type":"boolean"}]}
fields object Optional Request fields maxProperties: 40; additionalProperties: {"anyOf":[{"anyOf":[{"type":"string","maxLength":4096},{"type":"number"},{"type":"boolean"}]},{"type":"array","items":{"anyOf":[{"type":"string","maxLength":4096},{"type":"number"},{"type":"boolean"}]},"maxItems":40}]}

Full JSON Schema

Full JSON Schema

Example input

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

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

Change a message content template — twilio.content.mutation

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.

Parameter Type Required in parent Description Constraints
resourceType string Optional Sub-API enum: ["content","content-and-approvals"]
resource string Optional Resource path or id minLength: 1; maxLength: 240
action string Optional Action enum: ["read","create","update","delete"]
query object Optional Query parameters maxProperties: 40; additionalProperties: {"anyOf":[{"type":"string","maxLength":4096},{"type":"number"},{"type":"boolean"}]}
fields object Optional Request fields maxProperties: 40; additionalProperties: {"anyOf":[{"anyOf":[{"type":"string","maxLength":4096},{"type":"number"},{"type":"boolean"}]},{"type":"array","items":{"anyOf":[{"type":"string","maxLength":4096},{"type":"number"},{"type":"boolean"}]},"maxItems":40}]}

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.

Read a numbers resource — twilio.numbers.read

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.

Parameter Type Required in parent Description Constraints
resourceType string Optional Sub-API enum: ["regulatory-compliance","hosted-number","porting"]
resource string Optional Resource path or id minLength: 1; maxLength: 240
action string Optional Action enum: ["read","create","update","delete"]
query object Optional Query parameters maxProperties: 40; additionalProperties: {"anyOf":[{"type":"string","maxLength":4096},{"type":"number"},{"type":"boolean"}]}
fields object Optional Request fields maxProperties: 40; additionalProperties: {"anyOf":[{"anyOf":[{"type":"string","maxLength":4096},{"type":"number"},{"type":"boolean"}]},{"type":"array","items":{"anyOf":[{"type":"string","maxLength":4096},{"type":"number"},{"type":"boolean"}]},"maxItems":40}]}

Full JSON Schema

Full JSON Schema

Example input

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

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

Change a numbers resource — twilio.numbers.mutation

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.

Parameter Type Required in parent Description Constraints
resourceType string Optional Sub-API enum: ["regulatory-compliance","hosted-number","porting"]
resource string Optional Resource path or id minLength: 1; maxLength: 240
action string Optional Action enum: ["read","create","update","delete"]
query object Optional Query parameters maxProperties: 40; additionalProperties: {"anyOf":[{"type":"string","maxLength":4096},{"type":"number"},{"type":"boolean"}]}
fields object Optional Request fields maxProperties: 40; additionalProperties: {"anyOf":[{"anyOf":[{"type":"string","maxLength":4096},{"type":"number"},{"type":"boolean"}]},{"type":"array","items":{"anyOf":[{"type":"string","maxLength":4096},{"type":"number"},{"type":"boolean"}]},"maxItems":40}]}

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.

Read a WhatsApp-capable number — twilio.whatsapp.incoming-number.read

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.

Parameter Type Required in parent Description Constraints
incomingNumberReference string Required Incoming number SID pattern: "^PN[0-9a-fA-F]{32}$"
accountReference string Optional Subaccount SID pattern: "^AC[0-9a-fA-F]{32}$"

Full JSON Schema

Full JSON Schema

Example input

{
  "incomingNumberReference": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}

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

Release a number — twilio.whatsapp.incoming-number.release

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.

Parameter Type Required in parent Description Constraints
incomingNumberReference string Required Incoming number SID pattern: "^PN[0-9a-fA-F]{32}$"
accountReference string Optional Subaccount SID pattern: "^AC[0-9a-fA-F]{32}$"

Full JSON Schema

Full JSON Schema

Example input

{
  "incomingNumberReference": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}

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

Buy a number — twilio.whatsapp.number.purchase

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.

Parameter Type Required in parent Description Constraints
phoneNumber string Required Phone number in E.164 pattern: "^\\+[1-9]\\d{7,14}$"
label string Required Label maxLength: 64; pattern: "^\\S(?:.*\\S)?$"
smsCallbackUrl string Required HTTPS callback URL maxLength: 2048; format: "uri"
voiceCallbackUrl string Required HTTPS callback URL maxLength: 2048; format: "uri"
accountReference string Optional Subaccount SID pattern: "^AC[0-9a-fA-F]{32}$"

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.

List owned numbers — twilio.whatsapp.number.list

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.

Parameter Type Required in parent Description Constraints
label string Optional Label maxLength: 64; pattern: "^\\S(?:.*\\S)?$"
limit integer Optional Page size minimum: 1; maximum: 200
cursor string Optional Page token maxLength: 2048; pattern: "^[A-Za-z0-9._~+/=-]+$"
accountReference string Optional Subaccount SID pattern: "^AC[0-9a-fA-F]{32}$"
mode string Optional Explicit bounded discovery enum: ["discovery"]
limit integer Required oneOf[2]; maximum: 10

Full JSON Schema

Full JSON Schema

Example input

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

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

Download message media — twilio.whatsapp.media.download

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.

Parameter Type Required in parent Description Constraints
messageReference string Required Message SID pattern: "^SM[0-9a-fA-F]{32}$"
mediaReference string Required Media SID pattern: "^ME[0-9a-fA-F]{32}$"
accountReference string Optional Subaccount SID pattern: "^AC[0-9a-fA-F]{32}$"

Full JSON Schema

Full JSON Schema

Example input

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

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

Register a WhatsApp sender — twilio.whatsapp.sender.create

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.

Parameter Type Required in parent Description Constraints
phoneNumber string Required Phone number in E.164 pattern: "^\\+[1-9]\\d{7,14}$"
businessAccountReference string Required WhatsApp Business Account id pattern: "^\\d{1,40}$"
displayName string Required Display name minLength: 1; maxLength: 80
callbackUrl string Required HTTPS callback URL maxLength: 2048; format: "uri"
statusCallbackUrl string Required HTTPS callback URL maxLength: 2048; format: "uri"
accountReference string Optional Subaccount SID pattern: "^AC[0-9a-fA-F]{32}$"

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.

Read a sender — twilio.whatsapp.sender.read

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.

Parameter Type Required in parent Description Constraints
senderReference string Required Sender SID pattern: "^XE[0-9a-fA-F]{32}$"
accountReference string Optional Subaccount SID pattern: "^AC[0-9a-fA-F]{32}$"

Full JSON Schema

Full JSON Schema

Example input

{
  "senderReference": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}

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

List senders — twilio.whatsapp.sender.list

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.

Parameter Type Required in parent Description Constraints
phoneNumber string Required Phone number in E.164 pattern: "^\\+[1-9]\\d{7,14}$"
limit integer Optional Page size minimum: 1; maximum: 1000
cursor string Optional Page token maxLength: 2048; pattern: "^[A-Za-z0-9._~+/=-]+$"
accountReference string Optional Subaccount SID pattern: "^AC[0-9a-fA-F]{32}$"

Full JSON Schema

Full JSON Schema

Example input

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

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

Update a sender — twilio.whatsapp.sender.update

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.

Parameter Type Required in parent Description Constraints
senderReference string Required Sender SID pattern: "^XE[0-9a-fA-F]{32}$"
profile object Optional Business profile minProperties: 1; additionalProperties: false
profile.name string Optional Display name minLength: 1; maxLength: 80
profile.about string Optional About maxLength: 139
profile.address string Optional Address maxLength: 256
profile.description string Optional Description maxLength: 512
profile.emails array Optional Emails maxItems: 2
profile.emails[] string Optional maxLength: 320; format: "email"
profile.websites array Optional Websites maxItems: 2
profile.websites[] string Optional HTTPS callback URL maxLength: 2048; format: "uri"
profile.vertical string Optional Business vertical maxLength: 80
profile.logo_url string Optional HTTPS callback URL maxLength: 2048; format: "uri"
callbackUrl string Optional HTTPS callback URL maxLength: 2048; format: "uri"
statusCallbackUrl string Optional HTTPS callback URL maxLength: 2048; format: "uri"
accountReference string Optional Subaccount SID pattern: "^AC[0-9a-fA-F]{32}$"

Full JSON Schema

Full JSON Schema

Example input

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

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

Remove a sender — twilio.whatsapp.sender.delete

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.

Parameter Type Required in parent Description Constraints
senderReference string Required Sender SID pattern: "^XE[0-9a-fA-F]{32}$"
accountReference string Optional Subaccount SID pattern: "^AC[0-9a-fA-F]{32}$"

Full JSON Schema

Full JSON Schema

Example input

{
  "senderReference": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}

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

Send a WhatsApp message — twilio.whatsapp.message.send

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.

Parameter Type Required in parent Description Constraints
from string Required whatsapp:+E.164 address pattern: "^whatsapp:\\+[1-9]\\d{7,14}$"
to string Required whatsapp:+E.164 address pattern: "^whatsapp:\\+[1-9]\\d{7,14}$"
message string Optional Free-form body minLength: 1; maxLength: 1600
mediaUrl string Optional HTTPS callback URL maxLength: 2048; format: "uri"
contentReference string Optional Content SID pattern: "^HX[0-9a-fA-F]{32}$"
contentVariables object Optional Template variables keyed by position maxProperties: 100; additionalProperties: {"type":"string","maxLength":1000}; propertyNames: {"pattern":"^[1-9]\\d{0,2}$"}
statusCallbackUrl string Required HTTPS callback URL maxLength: 2048; format: "uri"
accountReference string Optional Subaccount SID pattern: "^AC[0-9a-fA-F]{32}$"

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.

Create a content template — twilio.whatsapp.content.create

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.

Parameter Type Required in parent Description Constraints
friendlyName string Required Template name pattern: "^[a-z0-9][a-z0-9_]{0,511}$"
language string Required Language, such as en_US pattern: "^[a-z]{2,3}(?:_[A-Z]{2})?$"
variables object Required Template variables keyed by position maxProperties: 100; additionalProperties: {"type":"string","maxLength":1000}; propertyNames: {"pattern":"^[1-9]\\d{0,2}$"}
types object Required Content bodies keyed by Twilio content type minProperties: 1; maxProperties: 8; additionalProperties: {"type":"object"}; propertyNames: {"pattern":"^(?:twilio|whatsapp)/[a-z][a-z0-9-]{1,63}$"}
accountReference string Optional Subaccount SID pattern: "^AC[0-9a-fA-F]{32}$"

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.

Update a content template — twilio.whatsapp.content.update

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.

Parameter Type Required in parent Description Constraints
contentReference string Required Content SID pattern: "^HX[0-9a-fA-F]{32}$"
friendlyName string Required Template name pattern: "^[a-z0-9][a-z0-9_]{0,511}$"
variables object Required Template variables keyed by position maxProperties: 100; additionalProperties: {"type":"string","maxLength":1000}; propertyNames: {"pattern":"^[1-9]\\d{0,2}$"}
types object Required Content bodies keyed by Twilio content type minProperties: 1; maxProperties: 8; additionalProperties: {"type":"object"}; propertyNames: {"pattern":"^(?:twilio|whatsapp)/[a-z][a-z0-9-]{1,63}$"}
accountReference string Optional Subaccount SID pattern: "^AC[0-9a-fA-F]{32}$"

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.

Read a content template — twilio.whatsapp.content.read

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.

Parameter Type Required in parent Description Constraints
contentReference string Required Content SID pattern: "^HX[0-9a-fA-F]{32}$"
accountReference string Optional Subaccount SID pattern: "^AC[0-9a-fA-F]{32}$"

Full JSON Schema

Full JSON Schema

Example input

{
  "contentReference": "HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}

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

List content templates and approvals — twilio.whatsapp.content.list

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.

Parameter Type Required in parent Description Constraints
limit integer Optional Page size minimum: 1; maximum: 500
cursor string Optional Page token maxLength: 2048; pattern: "^[A-Za-z0-9._~+/=-]+$"
accountReference string Optional Subaccount SID pattern: "^AC[0-9a-fA-F]{32}$"

Full JSON Schema

Full JSON Schema

Example input

{
  "limit": 50
}

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

Submit a template for approval — twilio.whatsapp.content.approval.submit

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.

Parameter Type Required in parent Description Constraints
contentReference string Required Content SID pattern: "^HX[0-9a-fA-F]{32}$"
name string Required Template name pattern: "^[a-z0-9][a-z0-9_]{0,511}$"
category string Required Category enum: ["AUTHENTICATION","MARKETING","UTILITY"]
accountReference string Optional Subaccount SID pattern: "^AC[0-9a-fA-F]{32}$"

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.

Read approval status — twilio.whatsapp.content.approval.read

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.

Parameter Type Required in parent Description Constraints
contentReference string Required Content SID pattern: "^HX[0-9a-fA-F]{32}$"
accountReference string Optional Subaccount SID pattern: "^AC[0-9a-fA-F]{32}$"

Full JSON Schema

Full JSON Schema

Example input

{
  "contentReference": "HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}

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

Delete a content template — twilio.whatsapp.content.delete

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.

Parameter Type Required in parent Description Constraints
contentReference string Required Content SID pattern: "^HX[0-9a-fA-F]{32}$"
accountReference string Optional Subaccount SID pattern: "^AC[0-9a-fA-F]{32}$"

Full JSON Schema

Full JSON Schema

Example input

{
  "contentReference": "HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}

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

Find an owned number by its digits — twilio.messaging.phone-number.lookup

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.

Parameter Type Required in parent Description Constraints
phoneNumber string Required Phone number in E.164 pattern: "^\\+[1-9]\\d{7,14}$"

Full JSON Schema

Full JSON Schema

Example input

{
  "phoneNumber": "+15005550006"
}

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

Attach a number to a messaging service — twilio.messaging.service-sender.attach

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.

Parameter Type Required in parent Description Constraints
messagingServiceId string Required Messaging Service SID pattern: "^MG[0-9a-fA-F]{32}$"
phoneNumberId string Required Incoming number SID pattern: "^PN[0-9a-fA-F]{32}$"

Full JSON Schema

Full JSON Schema

Example input

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

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

Register a US A2P 10DLC campaign — twilio.messaging.a2p-campaign.create

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.

Parameter Type Required in parent Description Constraints
messagingServiceId string Required Messaging Service SID pattern: "^MG[0-9a-fA-F]{32}$"
brandRegistrationId string Required Brand Registration SID pattern: "^BN[0-9a-fA-F]{32}$"
campaign object Required Campaign additionalProperties: false
campaign.useCase string Required Use case minLength: 1; maxLength: 120
campaign.description string Required Description minLength: 1; maxLength: 4000
campaign.messageFlow string Required Opt-in message flow minLength: 1; maxLength: 4000
campaign.sampleMessages array Required Sample messages minItems: 1; maxItems: 10
campaign.sampleMessages[] string Optional minLength: 1; maxLength: 2000
campaign.optInKeywords array Required Opt-in keywords maxItems: 20
campaign.optInKeywords[] string Optional minLength: 1; maxLength: 80
campaign.optOutKeywords array Required Opt-out keywords maxItems: 20
campaign.optOutKeywords[] string Optional minLength: 1; maxLength: 80
campaign.helpKeywords array Required Help keywords maxItems: 20
campaign.helpKeywords[] string Optional minLength: 1; maxLength: 80
campaign.optInMessage string Optional Opt-in reply maxLength: 2000
campaign.optOutMessage string Optional Opt-out reply maxLength: 2000
campaign.helpMessage string Optional Help reply maxLength: 2000
campaign.privacyPolicyUrl string Optional HTTPS callback URL maxLength: 2048; format: "uri"
campaign.termsAndConditionsUrl string Optional HTTPS callback URL maxLength: 2048; format: "uri"
campaign.subscriberOptIn boolean Optional Subscribers opt in
campaign.ageGated boolean Optional Age gated
campaign.hasEmbeddedLinks boolean Optional Messages contain links
campaign.hasEmbeddedPhone boolean Optional Messages contain phone numbers

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.

Read a US A2P 10DLC campaign — twilio.messaging.a2p-campaign.read

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.

Parameter Type Required in parent Description Constraints
messagingServiceId string Required Messaging Service SID pattern: "^MG[0-9a-fA-F]{32}$"
campaignId string Required Campaign id pattern: "^[A-Za-z0-9][A-Za-z0-9._:-]{0,159}$"

Full JSON Schema

Full JSON Schema

Example input

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

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

Submit or edit a toll-free verification — twilio.messaging.tollfree-verification.upsert

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.

Parameter Type Required in parent Description Constraints
phoneNumberId string Required Incoming number SID pattern: "^PN[0-9a-fA-F]{32}$"
business object Required Business additionalProperties: false
business.legalName string Required minLength: 1; maxLength: 240
business.doingBusinessAs string Optional maxLength: 240
business.websiteUrl string Required HTTPS callback URL maxLength: 2048; format: "uri"
business.notificationEmail string Required maxLength: 320; format: "email"
business.type string Required Business type minLength: 1; maxLength: 80
business.address object Optional Registered address additionalProperties: false
business.address.line1 string Required minLength: 1; maxLength: 240
business.address.line2 string Optional maxLength: 240
business.address.city string Required minLength: 1; maxLength: 120
business.address.region string Required minLength: 1; maxLength: 40
business.address.postalCode string Required minLength: 1; maxLength: 32
business.address.country string Required pattern: "^[A-Za-z]{2}$"
business.contact object Optional Contact additionalProperties: false
business.contact.firstName string Required minLength: 1; maxLength: 120
business.contact.lastName string Required minLength: 1; maxLength: 120
business.contact.email string Required maxLength: 320; format: "email"
business.contact.phone string Optional maxLength: 40
business.registration object Optional Registration additionalProperties: false
business.registration.number string Optional maxLength: 240
business.registration.authority string Optional maxLength: 120
business.registration.country string Optional pattern: "^[A-Za-z]{2}$"
business.registration.phoneNumber string Optional maxLength: 40
campaign object Required Campaign additionalProperties: false
campaign.description string Required minLength: 1; maxLength: 4000
campaign.sampleMessage string Required minLength: 1; maxLength: 2000
campaign.optInType string Required minLength: 1; maxLength: 80
campaign.messageVolume string Required minLength: 1; maxLength: 80
campaign.additionalInformation string Required minLength: 1; maxLength: 4000
campaign.useCaseCategory string Required minLength: 1; maxLength: 120
campaign.ageGated boolean Optional
campaign.helpMessage string Optional maxLength: 2000
campaign.optInMessage string Optional maxLength: 2000
campaign.optInKeywords array Required Opt-in keywords maxItems: 20
campaign.optInKeywords[] string Optional minLength: 1; maxLength: 80
campaign.optInImageUrls array Required maxItems: 20
campaign.optInImageUrls[] string Optional HTTPS callback URL maxLength: 2048; format: "uri"
campaign.privacyPolicyUrl string Optional HTTPS callback URL maxLength: 2048; format: "uri"
campaign.termsAndConditionsUrl string Optional HTTPS callback URL maxLength: 2048; format: "uri"
customerProfileId string Optional maxLength: 120
verificationId string Optional Verification id (edit only) pattern: "^[A-Za-z0-9][A-Za-z0-9._:-]{0,159}$"
editReason string Optional maxLength: 1000
lockedProfile boolean Optional Business profile is already locked

Full JSON Schema

Full JSON Schema

Example input

{
  "phoneNumberId": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "business": {
    "legalName": "Gridheap Inc",
    "websiteUrl": "https://www.tooluse.net",
    "notificationEmail": "ops@gridheap.com",
    "type": "Private Company",
    "address": {
      "line1": "1 Market St",
      "city": "San Francisco",
      "region": "CA",
      "postalCode": "94105",
      "country": "US"
    },
    "contact": {
      "firstName": "Ops",
      "lastName": "Team",
      "email": "ops@gridheap.com"
    }
  },
  "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.

Read a toll-free verification — twilio.messaging.tollfree-verification.read

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.

Parameter Type Required in parent Description Constraints
verificationId string Required Verification id pattern: "^[A-Za-z0-9][A-Za-z0-9._:-]{0,159}$"

Full JSON Schema

Full JSON Schema

Example input

{
  "verificationId": "HHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}

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

Check whether a number can be ported in — twilio.porting.portability.check

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.

Parameter Type Required in parent Description Constraints
phoneNumber string Required Phone number in E.164 pattern: "^\\+[1-9]\\d{7,14}$"
serviceAddressReference string Optional Address SID pattern: "^AD[0-9a-fA-F]{32}$"
targetAccountReference string Optional Subaccount SID pattern: "^AC[0-9a-fA-F]{32}$"

Full JSON Schema

Full JSON Schema

Example input

{
  "phoneNumber": "+15005550006"
}

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

Read the porting webhook configuration — twilio.porting.webhook.read

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.

Set the porting webhook configuration — twilio.porting.webhook.upsert

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.

Parameter Type Required in parent Description Constraints
portInTargetUrl string Required HTTPS callback URL maxLength: 2048; format: "uri"
portOutTargetUrl string Required HTTPS callback URL maxLength: 2048; format: "uri"
eventTypes array Required Event types minItems: 1; maxItems: 40
eventTypes[] string Optional pattern: "^[A-Za-z][A-Za-z0-9]{1,119}$"

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.

Open a port-in request — twilio.porting.port-in.create

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.

Parameter Type Required in parent Description Constraints
phoneNumber string Required Phone number in E.164 pattern: "^\\+[1-9]\\d{7,14}$"
targetDate string Required Requested port date format: "date"
targetTimeRangeStart string Optional Window start maxLength: 80
targetTimeRangeEnd string Optional Window end maxLength: 80
notificationEmails array Required Notification emails minItems: 1; maxItems: 20
notificationEmails[] string Optional maxLength: 320; format: "email"
customer object Required Losing carrier account holder additionalProperties: false
customer.type string Required enum: ["Business","Individual"]
customer.name string Required minLength: 1; maxLength: 240
customer.authorizedRepresentative string Required minLength: 1; maxLength: 240
customer.authorizedRepresentativeEmail string Required maxLength: 320; format: "email"
transferCredentials object Required Losing carrier credentials additionalProperties: false
transferCredentials.accountNumber string Required minLength: 1; maxLength: 240
transferCredentials.pin string Required minLength: 1; maxLength: 120
serviceAddress object Optional Service address (omit when using a stored address) additionalProperties: false
serviceAddress.street string Required minLength: 1; maxLength: 240
serviceAddress.street2 string Optional maxLength: 240
serviceAddress.city string Required minLength: 1; maxLength: 120
serviceAddress.state string Required minLength: 1; maxLength: 80
serviceAddress.postalCode string Required minLength: 1; maxLength: 40
serviceAddress.country string Required pattern: "^[A-Za-z]{2}$"
serviceAddressReference string Optional Stored address SID pattern: "^AD[0-9a-fA-F]{32}$"
targetAccountReference string Optional Subaccount SID pattern: "^AC[0-9a-fA-F]{32}$"
documentReferences array Optional Uploaded document references maxItems: 40
documentReferences[] string Optional pattern: "^[A-Za-z0-9][A-Za-z0-9._:-]{0,159}$"

Full JSON Schema

Full JSON Schema

Example input

{
  "phoneNumber": "+15005550006",
  "targetDate": "2026-10-01",
  "notificationEmails": [
    "ops@gridheap.com"
  ],
  "customer": {
    "type": "Business",
    "name": "Gridheap Inc",
    "authorizedRepresentative": "Ops Team",
    "authorizedRepresentativeEmail": "ops@gridheap.com"
  },
  "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.

Read a port-in request — twilio.porting.port-in.read

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.

Parameter Type Required in parent Description Constraints
portInRequestId string Required Port-in request SID pattern: "^KW[0-9a-fA-F]{32}$"

Full JSON Schema

Full JSON Schema

Example input

{
  "portInRequestId": "KWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}

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

Create a bounded owned conference participant — twilio.voice.conference.participant.create

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.

Parameter Type Required in parent Description Constraints
conferenceReference string Required pattern: "^(CF[0-9a-fA-F]{32}|tidyanswer_[a-f0-9]{64})$"
to string Required maxLength: 160; pattern: "^(\\+[1-9][0-9]{7,14}|client:[A-Za-z0-9_-]{1,128})$"
from string Required pattern: "^\\+[1-9][0-9]{7,14}$"
participantLabel string Required maxLength: 128; pattern: "^[A-Za-z0-9_-]{1,128}$"
statusCallbackUrl string Required maxLength: 4096; format: "uri"
timeoutSeconds integer Required minimum: 5; maximum: 120
timeLimitSeconds integer Required minimum: 60; maximum: 7200

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.

Hold or resume an existing conference participant — twilio.voice.conference.participant.hold

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.

Parameter Type Required in parent Description Constraints
conferenceReference string Required pattern: "^CF[0-9a-fA-F]{32}$"
callReference string Required pattern: "^CA[0-9a-fA-F]{32}$"
hold boolean Required

Full JSON Schema

Full JSON Schema

Example input

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

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

Read an existing conference participant — twilio.voice.conference.participant.read

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.

Parameter Type Required in parent Description Constraints
conferenceReference string Required pattern: "^CF[0-9a-fA-F]{32}$"
callReference string Required pattern: "^CA[0-9a-fA-F]{32}$"
observationID string Optional pattern: "^observation_[a-f0-9]{64}$"

Full JSON Schema

Full JSON Schema

Example input

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

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

Read the current owned call — twilio.voice.call.read

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.

Parameter Type Required in parent Description Constraints
callReference string Required pattern: "^CA[0-9a-fA-F]{32}$"
observationID string Optional pattern: "^observation_[a-f0-9]{64}$"

Full JSON Schema

Full JSON Schema

Example input

{
  "callReference": "CAcccccccccccccccccccccccccccccccc"
}

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

Create one registered native client with an owned answer gate — twilio.voice.call.create

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.

Parameter Type Required in parent Description Constraints
to string Required pattern: "^client:voice_[a-f0-9]{48}$"
from string Required pattern: "^\\+[1-9][0-9]{7,14}$"
answerUrl string Required maxLength: 4096; format: "uri"
statusCallbackUrl string Required maxLength: 4096; format: "uri"
timeoutSeconds integer Required minimum: 5; maximum: 120
timeLimitSeconds integer Required minimum: 60; maximum: 7200

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.

Terminate one observed owned call — twilio.voice.call.end

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.

Parameter Type Required in parent Description Constraints
callReference string Required pattern: "^CA[0-9a-fA-F]{32}$"
expectedStatus string Required enum: ["queued","initiated","ringing","in-progress"]

Full JSON Schema

Full JSON Schema

Example input

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

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

Errors

Check the key's expiry, revocation, workspace and allowed operations.

Reuse the same idempotency key only for the same request.

The connection or provider limit has been reached. Check the receipt before retrying.

Test the connection

Open the integration's commands below to inspect parameters and examples. Start with a read command for an account or resource you can access. Refresh your client's tool list, use the returned tool name, and check the execution result and usage. Provider charges and permissions still apply. Never test a write against production data without reviewing it.

Official provider documentation

Source: https://help.tooluse.net/integrations/twilio/index.mdx