Module twilio

ballerinax/twilio Ballerina library

4.0.0

Overview

Twilio is a cloud communications platform that allows software developers to programmatically make and receive phone calls, send and receive text messages, and perform other communication functions using its web service APIs.

The Ballerina Twilio connector supports the Twilio Basic API version 2010-04-01, enabling users to leverage these communication capabilities within their Ballerina applications.

Set up guide

Before using the ballerinax-twilio connector you must have access to Twilio API, If you do not have access to Twilio API please complete the following steps:

Step 1: Create a Twilio account.

Creating a Twilio account can be done by visiting Twilio and clicking the "Try Twilio for Free" button.

Step 2: Obtain a Twilio phone number.

All trial projects can provision a free trial phone number for testing. Here's how to get started.

Notice: Trial project phone number selection may be limited. You must upgrade your Twilio project to provision more than one phone number, or to provision a number that is not available to trial projects.

  1. Access the Buy a Number page in the Console.

Get Phone Number

  1. Enter the criteria for the phone number you need, and then click Search.

Configure Phone Number

  • Country: Select the desired country from the drop-down menu.
  • Number or Location: Select the desired option to search by digits/phrases, or a specific City or Region.
  • Capabilities: Select your service needs for this number.
  1. Click Buy to purchase a phone number for your current project or sub-account.

Search Results

Notice: Many countries require identity documentation for Phone Number compliance. Requests to provision phone numbers with these regulations will be required to select or add the required documentation after clicking Buy in Console. To see which countries and phone number types are affected by these requirements, please see twilio's Phone Number Regulations site.

Step 3: Obtain a Twilio Account SID with Auth Token.

Twilio uses two credentials to determine which account an API request is coming from: The Account SID, which acts as a username, and the Auth Token which acts as a password. You can find your account SID and auth token in your Twilio console.

Twilio Credentails

Your account's Auth Token is hidden by default. Click show to display the token, and hide to conceal it again. For further information click here

Quick Start

This sample demonstrates a scenario where the Twilio connector is used to send a text message to a phone number.

Step 1 - Import the package

Import the Twilio package into your Ballerina program as shown below:

Copy
import ballerinax/twilio;

Step 2 - Create a new connector instance

To create a new connector instance, add a configuration as follows (You can use configurable variables to provide the necessary credentials):

Copy
configurable string accountSid = ?;
configurable string authToken = ?;

twilio:ConnectionConfig twilioConfig = {
    auth: {
        username: accountSid,
        password: authToken
    }
};

twilio:Client twilio = check new (twilioConfig);

Step 3 - Invoke the connector operation

  1. Invoke the sending SMS operation using the client as shown below:
Copy
public function main() returns error? {
    twilio:CreateMessageRequest messageRequest = {
        To: "+XXXXXXXXXXX", // Phone number that you want to send the message to
        From: "+XXXXXXXXXXX", // Twilio phone number
        Body: "Hello from Ballerina"
    };

    twilio:Message response = check twilio->createMessage(messageRequest);

    // Print the status of the message from the response
    io:println("Message Status: ", response?.status);
}
  1. Use bal run command to compile and run the Ballerina program.

Examples

The Twilio connector comes equipped with examples that demonstrate its usage across various scenarios. These examples are conveniently organized into three distinct groups based on the functionalities they showcase. For a more hands-on experience and a deeper understanding of these capabilities, we encourage you to experiment with the provided examples in your development environment.

  1. Account management
  2. Call management
  3. Message management