---
title: "Telnyx"
description: "Search and order phone numbers and manage 10DLC messaging registration."
---

> 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.

# Telnyx

<p>Search and order phone numbers and manage 10DLC messaging registration.</p>

<details data-command-index><summary>What you can do (3)</summary>
<h2>What you can do</h2>
<p>Available commands: 3 (2 read, 1 write). Enable only the commands your application needs.</p>
<div class="nb-table-scroll"><table>
<thead>
<tr>
<th>Command</th>
<th>Effect</th>
</tr>
</thead>
<tbody><tr>
<td><a href="https://help.tooluse.net/integrations/telnyx#command-telnyx-telephony">Reach a Telnyx telephony resource</a> — <code>telnyx.telephony</code></td>
<td>Read</td>
</tr>
<tr>
<td><a href="https://help.tooluse.net/integrations/telnyx#command-telnyx-messaging-a2p-campaign-create">Register a 10DLC campaign</a> — <code>telnyx.messaging.a2p-campaign.create</code></td>
<td>Write</td>
</tr>
<tr>
<td><a href="https://help.tooluse.net/integrations/telnyx#command-telnyx-messaging-a2p-campaign-read">Read a 10DLC campaign</a> — <code>telnyx.messaging.a2p-campaign.read</code></td>
<td>Read</td>
</tr>
</tbody></table>
</div>
</details>
<h2>Connect and use</h2>

<p><a href="https://www.tooluse.net/tools/integrations/telnyx">Connect and use</a></p>
<p>Open the integration&#39;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.</p>
<h2>Get your provider credentials</h2>
<p>Follow these steps for Telnyx, then enter the issued values in the connection form below.</p>
<ol>
<li>In Telnyx Mission Control Portal → API Keys, create an account key and enter API Key. Messaging/voice also need the corresponding product permissions, configured profile and number.</li>
</ol>
<p><a href="https://developers.telnyx.com/api">Official credential setup</a></p>
<h2>Where to enter credentials</h2>
<p>In the integration page, sign in, choose your workspace and open Connect. If a <strong>Credentials</strong> choice is shown, select <strong>Use my credentials</strong>. Fill the following connection fields and save. Provider credentials belong in this form, never in an MCP configuration or tool input.</p>
<div class="nb-table-scroll"><table>
<thead>
<tr>
<th>Connection field</th>
<th>Requirement</th>
</tr>
</thead>
<tbody><tr>
<td>API Key</td>
<td>Required</td>
</tr>
</tbody></table>
</div><p>Open API keys and create a Tooluse.net key for the enabled commands.</p>
<p>Set TOOLUSE_API_KEY in your client and use the shared MCP configuration.</p>
<p><a href="https://help.tooluse.net/clients">Configure Claude Code, Codex or Cursor once</a></p>

<h2>Permissions and results</h2>

<p>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&#39;s existing permissions. Disabling a connection or revoking a key immediately prevents new calls.</p>

<p>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.</p>

<p>Your connection&#39;s daily allowance and key permissions also apply. Adding a connection does not make a provider request.</p>

<p>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.</p>

<h2>Call from your client</h2>

<p>Use the shared MCP configuration. Refresh your client&#39;s tool list after saving the connection or changing key permissions, then call the returned tool name with the example input below.</p>

<p><a href="https://help.tooluse.net/clients">Configure Claude Code, Codex or Cursor once</a></p>

<h2>Discover your enabled tools</h2>

<p>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.</p>

<pre><code class="language-bash">curl 'https://api.tooluse.net/v1/tools' \
  -H "Authorization: Bearer $TOOLUSE_API_KEY"
</code></pre>

<p>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.</p>

<h2>HTTP call</h2>

<pre><code class="language-bash">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": {
    "resourceType": "available-phone-numbers",
    "action": "read",
    "query": {
      "filter[country_code]": "US"
    }
  }
}'
</code></pre>

<p>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.</p>

<h2>Commands</h2>

<details id="command-telnyx-telephony">
<summary><span>Reach a Telnyx telephony resource — <code>telnyx.<wbr>telephony</code></span></summary>
<p>Run <strong>Reach a Telnyx telephony resource</strong> with Telnyx. This is a read command; it does not grant access beyond the connected account&#39;s permissions.</p>

<p>This is a read operation. Provider rate limits and data access rules still apply.</p>

<p><a href="https://www.tooluse.net/tools/integrations/telnyx?command=telnyx.telephony">Connect and use</a></p>

<p><strong>Parameters</strong></p>

<p>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.</p>

<div class="nb-table-scroll"><table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Required in parent</th>
<th>Description</th>
<th>Constraints</th>
</tr>
</thead>
<tbody><tr>
<td><code>resourceType</code></td>
<td>string</td>
<td>Optional</td>
<td>Sub-API</td>
<td><code>enum: [&quot;10dlc&quot;,&quot;number-order&quot;,&quot;available-phone-numbers&quot;,&quot;phone-numbers&quot;]</code></td>
</tr>
<tr>
<td><code>resource</code></td>
<td>string</td>
<td>Optional</td>
<td>Resource path or id</td>
<td><code>minLength: 1; maxLength: 240</code></td>
</tr>
<tr>
<td><code>action</code></td>
<td>string</td>
<td>Optional</td>
<td>Action</td>
<td><code>enum: [&quot;read&quot;,&quot;create&quot;,&quot;update&quot;,&quot;delete&quot;]</code></td>
</tr>
<tr>
<td><code>query</code></td>
<td>object</td>
<td>Optional</td>
<td>Query parameters</td>
<td><code>maxProperties: 40; additionalProperties: {&quot;anyOf&quot;:[{&quot;type&quot;:&quot;string&quot;,&quot;maxLength&quot;:4096},{&quot;type&quot;:&quot;number&quot;},{&quot;type&quot;:&quot;boolean&quot;}]}</code></td>
</tr>
<tr>
<td><code>fields</code></td>
<td>object</td>
<td>Optional</td>
<td>Request fields</td>
<td><code>maxProperties: 40; additionalProperties: {&quot;anyOf&quot;:[{&quot;anyOf&quot;:[{&quot;type&quot;:&quot;string&quot;,&quot;maxLength&quot;:4096},{&quot;type&quot;:&quot;number&quot;},{&quot;type&quot;:&quot;boolean&quot;}]},{&quot;type&quot;:&quot;array&quot;,&quot;items&quot;:{&quot;anyOf&quot;:[{&quot;type&quot;:&quot;string&quot;,&quot;maxLength&quot;:4096},{&quot;type&quot;:&quot;number&quot;},{&quot;type&quot;:&quot;boolean&quot;}]},&quot;maxItems&quot;:40}]}</code></td>
</tr>
</tbody></table>
</div>
<p><strong>Full JSON Schema</strong></p>

<p><a href="https://api.tooluse.net/v1/integrations/telnyx/commands/telnyx.telephony">Full JSON Schema</a></p>

<p><strong>Example input</strong></p>

<pre><code class="language-json">{
  "resourceType": "available-phone-numbers",
  "action": "read",
  "query": {
    "filter[country_code]": "US"
  }
}
</code></pre>

<p>At most 1 provider requests per invocation; timeout: 60 seconds.</p>

</details>
<details id="command-telnyx-messaging-a2p-campaign-create">
<summary><span>Register a 10DLC campaign — <code>telnyx.<wbr>messaging.<wbr>a2p-<wbr>campaign.<wbr>create</code></span></summary>
<p>Run <strong>Register a 10DLC campaign</strong> with Telnyx. This command can change provider data. Review the target and input before invoking it.</p>

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

<p><a href="https://www.tooluse.net/tools/integrations/telnyx?command=telnyx.messaging.a2p-campaign.create">Connect and use</a></p>

<p><strong>Parameters</strong></p>

<p>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.</p>

<div class="nb-table-scroll"><table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Required in parent</th>
<th>Description</th>
<th>Constraints</th>
</tr>
</thead>
<tbody><tr>
<td><code>brandId</code></td>
<td>string</td>
<td>Required</td>
<td>Brand id</td>
<td><code>pattern: &quot;^[A-Za-z0-9][A-Za-z0-9._:-]{0,159}$&quot;</code></td>
</tr>
<tr>
<td><code>campaign</code></td>
<td>object</td>
<td>Required</td>
<td>Campaign</td>
<td><code>additionalProperties: false</code></td>
</tr>
<tr>
<td><code>campaign.useCase</code></td>
<td>string</td>
<td>Required</td>
<td>Use case</td>
<td><code>minLength: 1; maxLength: 120</code></td>
</tr>
<tr>
<td><code>campaign.description</code></td>
<td>string</td>
<td>Required</td>
<td>Description</td>
<td><code>minLength: 1; maxLength: 4000</code></td>
</tr>
<tr>
<td><code>campaign.messageFlow</code></td>
<td>string</td>
<td>Required</td>
<td>Opt-in message flow</td>
<td><code>minLength: 1; maxLength: 4000</code></td>
</tr>
<tr>
<td><code>campaign.sampleMessages</code></td>
<td>array</td>
<td>Required</td>
<td>Sample messages</td>
<td><code>minItems: 1; maxItems: 10</code></td>
</tr>
<tr>
<td><code>campaign.sampleMessages[]</code></td>
<td>string</td>
<td>Optional</td>
<td></td>
<td><code>minLength: 1; maxLength: 2000</code></td>
</tr>
<tr>
<td><code>campaign.optInKeywords</code></td>
<td>array</td>
<td>Required</td>
<td>Opt-in keywords</td>
<td><code>maxItems: 20</code></td>
</tr>
<tr>
<td><code>campaign.optInKeywords[]</code></td>
<td>string</td>
<td>Optional</td>
<td></td>
<td><code>minLength: 1; maxLength: 80</code></td>
</tr>
<tr>
<td><code>campaign.optOutKeywords</code></td>
<td>array</td>
<td>Required</td>
<td>Opt-out keywords</td>
<td><code>maxItems: 20</code></td>
</tr>
<tr>
<td><code>campaign.optOutKeywords[]</code></td>
<td>string</td>
<td>Optional</td>
<td></td>
<td><code>minLength: 1; maxLength: 80</code></td>
</tr>
<tr>
<td><code>campaign.helpKeywords</code></td>
<td>array</td>
<td>Required</td>
<td>Help keywords</td>
<td><code>maxItems: 20</code></td>
</tr>
<tr>
<td><code>campaign.helpKeywords[]</code></td>
<td>string</td>
<td>Optional</td>
<td></td>
<td><code>minLength: 1; maxLength: 80</code></td>
</tr>
<tr>
<td><code>campaign.optInMessage</code></td>
<td>string</td>
<td>Optional</td>
<td>Opt-in reply</td>
<td><code>maxLength: 2000</code></td>
</tr>
<tr>
<td><code>campaign.optOutMessage</code></td>
<td>string</td>
<td>Optional</td>
<td>Opt-out reply</td>
<td><code>maxLength: 2000</code></td>
</tr>
<tr>
<td><code>campaign.helpMessage</code></td>
<td>string</td>
<td>Optional</td>
<td>Help reply</td>
<td><code>maxLength: 2000</code></td>
</tr>
<tr>
<td><code>campaign.privacyPolicyUrl</code></td>
<td>string</td>
<td>Optional</td>
<td>HTTPS callback URL</td>
<td><code>maxLength: 2048; format: &quot;uri&quot;</code></td>
</tr>
<tr>
<td><code>campaign.termsAndConditionsUrl</code></td>
<td>string</td>
<td>Optional</td>
<td>HTTPS callback URL</td>
<td><code>maxLength: 2048; format: &quot;uri&quot;</code></td>
</tr>
<tr>
<td><code>campaign.subscriberOptIn</code></td>
<td>boolean</td>
<td>Optional</td>
<td>Subscribers opt in</td>
<td></td>
</tr>
<tr>
<td><code>campaign.ageGated</code></td>
<td>boolean</td>
<td>Optional</td>
<td>Age gated</td>
<td></td>
</tr>
<tr>
<td><code>campaign.hasEmbeddedLinks</code></td>
<td>boolean</td>
<td>Optional</td>
<td>Messages contain links</td>
<td></td>
</tr>
<tr>
<td><code>campaign.hasEmbeddedPhone</code></td>
<td>boolean</td>
<td>Optional</td>
<td>Messages contain phone numbers</td>
<td></td>
</tr>
<tr>
<td><code>phoneNumbers</code></td>
<td>array</td>
<td>Required</td>
<td>Numbers to assign</td>
<td><code>minItems: 1; maxItems: 100</code></td>
</tr>
<tr>
<td><code>phoneNumbers[]</code></td>
<td>string</td>
<td>Optional</td>
<td>Phone number in E.164</td>
<td><code>pattern: &quot;^\\+[1-9]\\d{7,14}$&quot;</code></td>
</tr>
</tbody></table>
</div>
<p><strong>Full JSON Schema</strong></p>

<p><a href="https://api.tooluse.net/v1/integrations/telnyx/commands/telnyx.messaging.a2p-campaign.create">Full JSON Schema</a></p>

<p><strong>Example input</strong></p>

<pre><code class="language-json">{
  "brandId": "4b6d8f2a",
  "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
  },
  "phoneNumbers": [
    "+15005550006"
  ]
}
</code></pre>

<p>At most 1 provider requests per invocation; timeout: 60 seconds.</p>

</details>
<details id="command-telnyx-messaging-a2p-campaign-read">
<summary><span>Read a 10DLC campaign — <code>telnyx.<wbr>messaging.<wbr>a2p-<wbr>campaign.<wbr>read</code></span></summary>
<p>Run <strong>Read a 10DLC campaign</strong> with Telnyx. This is a read command; it does not grant access beyond the connected account&#39;s permissions.</p>

<p>This is a read operation. Provider rate limits and data access rules still apply.</p>

<p><a href="https://www.tooluse.net/tools/integrations/telnyx?command=telnyx.messaging.a2p-campaign.read">Connect and use</a></p>

<p><strong>Parameters</strong></p>

<p>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.</p>

<div class="nb-table-scroll"><table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Required in parent</th>
<th>Description</th>
<th>Constraints</th>
</tr>
</thead>
<tbody><tr>
<td><code>campaignId</code></td>
<td>string</td>
<td>Required</td>
<td>Campaign id</td>
<td><code>pattern: &quot;^[A-Za-z0-9][A-Za-z0-9._:-]{0,159}$&quot;</code></td>
</tr>
</tbody></table>
</div>
<p><strong>Full JSON Schema</strong></p>

<p><a href="https://api.tooluse.net/v1/integrations/telnyx/commands/telnyx.messaging.a2p-campaign.read">Full JSON Schema</a></p>

<p><strong>Example input</strong></p>

<pre><code class="language-json">{
  "campaignId": "4b6d8f2a"
}
</code></pre>

<p>At most 1 provider requests per invocation; timeout: 60 seconds.</p>

</details>
<h2>Errors</h2>

<p>Check the key&#39;s expiry, revocation, workspace and allowed operations.</p>

<p>Reuse the same idempotency key only for the same request.</p>

<p>The connection or provider limit has been reached. Check the receipt before retrying.</p>

<h2>Test the connection</h2>

<p>Open the integration&#39;s commands below to inspect parameters and examples. Start with a read command for an account or resource you can access. Refresh your client&#39;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.</p>

<p><a href="https://developers.telnyx.com/api">Official provider documentation</a></p>

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