Telnyx

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": {
    // Recipient Profile
    "to": {
      "phone_number": "+491575556511"
    }
  }
}

Overrides

Overrides can be used to change the request body that Courier uses to send a message. Overrides are useful you would like to override the value that Courier generates. You can override any of the fields supported on the outgoing call to Telnyx.:

{
  "message": {
    "event": "<COURIER_NOTIFICATION_ID>",
    "to": {
      "phone_number": "+15551734686"
    },
    "data": {
      "name": "Katherine Pryde"
    },
    "providers": {
      "telnyx": {
        "override": {
          "body": {
            "text": "text override"
            "to": "+17777777777"
          },
          "config": {
            "apiKey": "<your API Key>",
            "from": "+15555555555",
            "url": "<alternate url>"
          }
        }
      }
    }
  }
}