Generate a Rust client for Twilio's API
The Twilio OpenAPI Spec is currently in BETA. The spec is expected to be accurate, but is currently in active development and is unsupported. If you've identified a mismatch between Twilio's API behavior and the specification, please open an issue.
With the rollout of Twilio’s OpenAPI specification, it is now possible to auto-generate your own Twilio client in your preferred programming language.
One language that Twilio currently does not have an official SDK for is Rust. By using the Twilio OpenAPI specification with open source tools such as OpenAPI Generator, you can now generate a strongly-typed Rust client for Twilio’s API methods.
Setup
To begin, install OpenAPI Generator. If you are on a Mac, we recommend installing using Homebrew for ease of use as below:
brew install openapi-generator
Once OpenAPI Generator is installed, the next step is to generate your very first Twilio client in Rust. Paste the following code snippet into your terminal to pull in the Twilio OpenAPI spec from GitHub, generate a client, and save the resulting client code to a directory named twilio-rust.
openapi-generator generate -g rust \
-i https://raw.githubusercontent.com/twilio/twilio-oai/main/spec/json/twilio_api_v2010.json \
-o twilio-rust \
--additional-properties=useSingleRequestParameter=true
Refer to the configuration documentation for the Rust generator to see other ways you can customize the generated library to your needs.
Use the auto-generated Twilio Rust client
Create a Rust project
Now that the client has been generated, it’s time to create some code that will enable you to interact with Twilio’s API in Rust. If you don’t already have Rust installed, you can install Rust by following the instructions as described in their documentation.
With Rust installed, create a new Rust project. We suggest that you use cargo to simplify this process and run the following command from the same directory where you executed the codegen process:
cargo new twilio-rust-example
This will scaffold out a Rust project for you, with the necessary main.rs file and a Cargo.toml file for managing dependencies.
.
├── src
│ └── main.rs
└── Cargo.tomlAdd dependencies
In order to make use of the generated Twilio client, it must be added to the project's Cargo.toml. More specifically, it should be added as a path dependency, since it is a crate currently residing on your local file system instead of crates.io or a similar repository.
Let's add two more dependencies as well:
dotenvto enable easy access to environment variables from a local.envfiletokiowhich provides an asynchronous runtime environment so that your code can useasync/await
You can manually edit Cargo.toml to include these dependencies, but we suggest leveraging a tool such as cargo-edit to manage dependencies. Once you have installed cargo-edit, run the following commands:
cargo add openapi --path=../twilio-rust
cargo add dotenv
cargo add tokio --features rt,rt-multi-thread,macros
Once cargo-edit has completed (or you skipped that step and did things manually), Cargo.toml will reflect the following contents:
[package]
name = "twilio-rust-example"
version = "0.1.0"
edition = "2021"
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
[dependencies]
dotenv = "0.15.0"
openapi = { path = "../twilio-rust" }
tokio = { version = "1.21.1", features = ["rt", "rt-multi-thread", "macros"] }
The specific versions of dotenv and tokio may vary from this example depending on when you are coming across this tutorial. Using cargo-edit as shown above will ensure you're on the latest version of each.
Once you’ve saved those changes to Cargo.toml, run the following command to install all of the above dependencies.
cargo build
Send an SMS using Twilio and Rust
Now that our dependencies are in order, it’s time to create a program in Rust.
We will leverage environment variables in order to securely access your Twilio credentials, so the next step is to create a .env file at the root of your Rust project and provide the necessary values. Be sure to replace the placeholder values here with your own credentials and a non-Twilio phone number such as your own as TO_NUMBER. Ensure that your phone numbers are declared in the E.164 format (+1234567890).
TWILIO_API_KEY=SKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
TWILIO_API_KEY_SECRET=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
TWILIO_ACCOUNT_SID=ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
TWILIO_PHONE_NUMBER=+1098765432
TO_NUMBER=+1234567890
Note that we’re using best practices here, and creating the Twilio client using an API Key and Secret instead of directly using and potentially exposing your account’s auth token. If you’d like to learn more about API Keys and how to create one, please refer to the API Keys documentation!
With the environment variables in place, it's time to open src/main.rs and replace the boilerplate code there with the following sample:
Execute cargo run in your terminal, and you will see a log output of the message’s SID as well as an SMS appear on your intended phone shortly after.
$ cargo run
Finished dev [unoptimized + debuginfo] target(s) in 0.15s
Running `target/debug/twilio-rust-example`
Message sent with SID "SMXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.
