Skip to main content

Telnyx SMS Gateway

Purpose​

Telnyx SMS Gateway activates the Telnyx request template already supplied by SMS Gateway & API Routing. It updates that existing gateway record instead of adding a separate sending application. It supplies no standalone menu, provider account, sending credit or inbox.

Before you start​

Install corvus_telnyx_gateway and its eis_sms_apis dependency for the same Odoo major version. The manifests declare no Enterprise-only dependency. Use an existing authorised provider account and sender configuration. This guide is a source review of the 19.0 adapter and routing dependency; no provider request, account creation or runtime delivery test was performed.

Installation data sets the gateway to Active with placeholder credentials. Before allowing any SMS workload, have the administrator put the record in Disabled state and ensure Settings does not select it as the default SMS Gateway until configuration is complete. The configured default is selected without the active-state filtering used for prefix routes, so disabling alone does not exclude that default. Installation or an addon update also writes the template fields; review retained customisations after an update.

Access and setup​

The adapter adds no permission group or ACL. Gateway setup and status records use the base module's Settings administrator (base.group_system) access. Sending from other applications follows the installed modules' access and routing arrangements.

Open SMS Gateways and locate Telnyx. Check these exact source-supplied fields:

FieldSupplied configuration or required value
Base URLhttps://api.telnyx.com/v2/messages
HTTP Method / Request TypePOST / JSON
Authentication TypeToken
TokenTelnyx API key; do not put it in the separate API Key field for this template
HeadersAuthorization: Bearer {token} and Content-Type: application/json
JSON Body{"from":"[approved Telnyx number]","to":"{phone}","text":"{message}"}
Priority370
Success HTTP Codes / Success Substring200,202 / "record_type"
Message ID RegexCaptures an id containing hexadecimal characters and hyphens

Replace placeholder sender/authentication values with the approved configuration. Leave recipient and message placeholders dynamic. Track Status is enabled and Supports Multiple Recipients is disabled in this template. Review existing Country Prefix values and the default gateway selection, because routing is shared with every other configured provider.

Workflow​

  1. Review API Settings, Authentication, and the listed request fields on Telnyx while it is disabled and unselected as the default gateway.
  2. Review Request Preview and the source template against the official Telnyx message API reference. The preview checks configuration visibility; it does not call the provider or establish authentication success.
  3. Confirm Use IAP is not bypassing custom routing. Set the intended prefix/default route and priority, then activate the completed gateway when approved for use.
  4. Prepare a message through the existing Odoo SMS workflow. A live Send uses the external provider and may incur charges; the adapter has no separate safe-send simulator.
  5. Inspect tracked status and the provider message ID. Configure delivery callbacks separately in the base module if asynchronous delivery confirmation is required. This wrapper does not configure inbound parsing, a signature policy or an inbox.

Practice scenario​

In an authorised training database, inspect the template using a fictional recipient +12025550123 and the draft text “Your sample collection is ready.” Identify where the sender, recipient, message and authentication values belong. Keep placeholders non-operational and the record disabled and unselected as the default gateway; do not send. This source-derived exercise has not been executed.

Troubleshooting and limitations​

Selecting Token is not enough by itself: the bearer header is the part that places it on the request. Keep that header and the JSON content-type row. The adapter does not provision a sender or messaging profile; reconcile provider-side requirements with the approved account configuration.

If the wrong gateway is selected, inspect country prefixes, priority and the global default. IAP fallback covers recipients with no selected gateway; it does not retry failures from Telnyx. If a request times out, reconcile its status before retrying to avoid a duplicate. Callback URLs and credentials belong only in the authorised configuration, never in shared screenshots.

Catalogue-qualified packages exist for 17.0–20.0. Comparison found the adapter's gateway data identical across those versions; the reviewed workflow is 19.0, and the underlying Odoo/base module integrations still differ by major version. No cross-version runtime compatibility is claimed.

Choose the exact package and available Live Test selector in the Corvus app catalogue. No demo was launched. For replies, install and configure Two-Way SMS & CRM Inbox; for media, review MMS Media & Attachments.