ballerinax/bulksms Ballerina library

Overview

The BulkSMS API v1 connector(https://www.bulksms.com/developer/) OpenAPI Specification.

BulkSMS API provides capability to access you to submit and receive BulkSMS messages. You can also get access to past messages and see your account profile. Dates are formatted according to ISO-8601, such as 1970-01-01T10:00:00+01:00 for 1st January 1970, 10AM UTC+1. It currently supports operations on messages, numbers, user profile, webhooks, and batch messages.

Key Features

• Programmatic access to create and manage resources via REST API
• Send and publish data through the API
• Manage user accounts and profiles
• Support for webhooks and event-driven workflows

Prerequisites

Before using this connector in your Ballerina application, complete the following:

• Create bulkSMS account
• Obtaining tokens

1. Provide the username and password for the Authentication. Follow this link for more detail

Quickstart

To use the bulkSMS connector in your Ballerina application, update the .bal file as follows:

Step 1 - Import connector

import ballerinax/bulksms;

Step 2 - Create a new connector instance

configurable http:CredentialsConfig & readonly auth = ?;
bulksms:ClientConfig clientConfig = {auth : auth};
bulksms:Client baseClient = check new Client(clientConfig);

Step 3 - Invoke connector operation

1. Invoking connector operations using the client

bulksms:Profile profile = check baseClient->getProfile();

2. Use bal run command to compile and run the Ballerina program.