Skip to content

Reach Messaging API

Sending SMS messages and accessing meta-data, such as delivery status, are both made simple via Reach Messaging API.

From now on, the Reach Messaging API from TalkyLabs allows you to integrate robust messaging capabilities in your application.

Information Circle

Using the Reach Messaging API, you can

  • send SMS messages

  • track the delivery of sent messages

  • schedule SMS messages to send at a later time

  • retrieve and modify message history

Base URLs

The Reach Messaging API from TalkyLabs are served over HTTPS using the following base URL:

https://api.reach.talkylabs.com/rest/messaging/v1

Authentication

The Reach Messaging API from TalkyLabs uses the API key as the authentication mechanism.

Use your API User and API Key (both information can be be found in the console) simultaneously in order to authenticate when sending requests to the Reach platform.

The API User acts as an identifer of your Applet while the API Key, in addition to act as a password, allows to determine the setting in which your requests are operating.

The Reach platform defines two operational settings and enables you to switch from one to the other as seamlessly as possible:

  • Sandbox mode
  • Production mode

Sandbox mode

The sandbox mode enables you to easily test the integration of your application with the Reach platform at no cost.

To operate in that mode, simply use the Test API Key in conjuction with the API User when sending request to the Reach platform.

Production mode

Once you are satisfied with your integration and you want to go live, you can easily switch to the production mode by simply using the Live API Key instead of the Test API Key.

Again, the API User, Test API Key, and Live API Key can be be found in the console.

The code samples in the API documentation highlight how to provide your credentials when using curl or a client library to interact with the Reach platform. In the snippet below, we show an example of how this is done using curl.

curl -X GET https://api.reach.talkylabs.com/rest/messaging/v1/list -H "ApiUser: <API_USER>" -H "ApiKey: <API_KEY>"

Send messages

To send a message, simply call the send request from the TalkyLabs Reach Messaging API.

This call could be customized using the scheduledTime parameter in such a way that the message is scheduled to be sent at the specified time.

Other operations

It is possible to easily track the delivery status of a given message by simply fetch it from the Reach platform.

More generally, it is possible for you to retrieve, or delete all your messages from the Reach platform.

Moreover, if you change your mind, you can easily unschedule a previously scheduled message.

Finally, it is possible to update the content of your messages.

Get Started

Get started with the Reach Messaging API from TalkyLabs is very easy. Simply select your favourite programming language and code. We have multiple client libraries and quickstarts to facilitate your debut.


curl -X POST https://api.reach.talkylabs.com/rest/messaging/v1/create --data-urlencode "dest=+237671234567" --data-urlencode "src=+237691234567" --data-urlencode "body=Hello World! This is a sms message." -H "ApiUser: $REACH_TALKYLABS_API_USER" -H "ApiKey: $REACH_TALKYLABS_API_KEY"

Client libraries

You can interact with the Reach Messaging API from TalkyLabs using your favorite programming language.

For a step-by-step guideline of how to start with a client library, select one of the links below:

Information Circle