Skip to main content

​
Setup

You will need a Telnyx account with an SMS-capable phone number and an API key. In Courier, navigate to the Telnyx Integration page, enter your API key and originating phone number, then click “Save.”

​
Profile Requirements

To deliver a message to a recipient over Telnyx, Courier must be provided the recipient’s SMS-compatible telephone number. This value should be included in the recipient profile as phone_number. 
{
  "message": {
    "to": {
      "phone_number": "+12025550156"
    }
  }
}

​
Overrides

Overrides can be used to change the request body that Courier uses to send a message. You can override any of the fields supported on the outgoing call to Telnyx: 
{
  "message": {
    "template": "NOTIFICATION_TEMPLATE_ID",
    "to": {
      "phone_number": "+15551734686"
    },
    "data": {
      "name": "Katherine Pryde"
    },
    "providers": {
      "telnyx": {
        "override": {
          "body": {
            "text": "Override message text",
            "to": "+17777777777"
          },
          "config": {
            "apiKey": "<your API Key>",
            "from": "+15555555555",
            "url": "<alternate url>"
          }
        }
      }
    }
  }
}
Everything inside of message.providers.telnyx.override will replace what Courier sends to the Telnyx Messaging API.