API

TextLink API enables developers to send SMS in a very straightforward and user-friendly way.

Getting an API key

To be able to use TextLink for sending an SMS or user verification, you first have to register an account, after that you are going to get 300 free messages, which you can use to test our API.

After you have registered an account, your API key will be available in the API console.

Sending an SMS

To send an SMS, you can send the following POST request with tool of your choice (like Postman), or use any of the programming languages that support REST API calls.

Using API

POST https://textlinksms.com/api/send-sms

Headers

Name	Type	Description
Content-Type*		The value should be "application/json"
Authorization*		The value should be "Bearer API_KEY", where API_KEY is the API key that you have registered in the API Console

Request Body

Name	Type	Description
phone_number*	String	Recipient phone number, with country prefix. E.g. [phone]
text*	String	Message body
sim_card_id	Number	(Optional) Id of the SIM card that you want to send the message from. Can be found in the Devices Console, by clicking on the device having the SIM card you need
custom_id	String	(Optional) Custom id that you want us to send to you in our failed message webhook

200: OK Message successfully sent

{
  ok: true
}

200: OK Message sending failed

{
  ok: false,
  message: "Reason string"
}

200: OK Message queued (all senders busy, should be sent soon)

{
  ok: true,
  queued: true
}

Using our official packages

Node.js

// Firstly, install the helper library using  or 

const textlink = require("textlink-sms");
textlink.useKey("YOUR_API_KEY"); // Replace with your API key

textlink.sendSMS("[phone]", "Dummy message text...");

TypeScript

// Firstly, install the helper library using  or 

import TextLink from "textlink-sms";
TextLink.useKey("YOUR_API_KEY"); // Replace with your API key

TextLink.sendSMS("[phone]", "Dummy message text...");

Python

# Firstly, install the helper library using 

import textlink as tl

tl.useKey("YOUR_API_KEY") # Replace with your API key

result = tl.sendSMS("[phone]", "Your message text...")
print(result)

OTP / Phone verification

Besides sending SMS, TextLink API can automate one-time-password (OTP) verification for phone numbers. The pricing for OTP verification is the same as sending a normal SMS, but we give OTP messages higher priority and faster delivery times.

The main perk of using our solution for verifying phone number is the removal of need to store the valid codes in your database, since we can verify codes for you.

To send a verification SMS, you can send the following POST request with tool of your choice (like Postman), or use any of the programming languages that support REST API calls.

Using API

POST https://textlinksms.com/api/send-code

Headers

Name	Type	Description
Content-Type*		The value should be "application/json"
Authorization*		The value should be "Bearer API_KEY", where API_KEY is the API key that you have registered on the API Console

Request Body

Name	Type	Description
phone_number*	String	Recipient phone number, with country prefix. E.g. [phone]
service_name	String	Your name to be shown in the message
sim_card_id	Number	(Optional) Id of the SIM card that you want to send the message from. Can be found in the Devices Console, by clicking on the device having the SIM card you need
custom_id	String	(Optional) Custom id that you want us to send to you in our failed message webhook

200: OK Message successfully sent

{
  ok: true,
  code: "123456" // The code sent
}

200: OK Message sending failed

{
  ok: false,
  message: "Reason string"
}

Using our official packages

Node.js

// Firstly, install the helper library using  or 

const textlink = require("textlink-sms");
textlink.useKey("YOUR_API_KEY"); // Replace with your API key

const verificationOptions = {
    service_name: "Tribal"
}; // This is optional

await textlink.sendVerificationSMS("[phone]", verificationOptions);

TypeScript

// Firstly, install the helper library using  or 

import TextLink from "textlink-sms";
TextLink.useKey("YOUR_API_KEY");

const verificationOptions = {
    service_name: "Tribal"
}; // This is optional

await TextLink.sendVerificationSMS("[phone]", verificationOptions);

Python

# Firstly, install the helper library using 

import textlink as tl

tl.useKey("YOUR_API_KEY") # Replace with your API key

result = tl.sendVerificationSMS("[phone]", service_name="Tribal")
print(result)

Check if the code is valid

After you have sent the one-time-password to your user, you can prompt him to enter the code in your website or application. After he has entered the code, you can use the /verify-code endpoint, to check if it is valid, without having to store the code locally.

Using API

POST https://textlinksms.com/api/verify-code

Headers

Name	Type	Description
Content-Type*		The value should be "application/json"
Authorization*		The value should be "Bearer API_KEY", where API_KEY is the API key that you have registered on the API Console

Request Body

Name	Type	Description
phone_number*	String	The phone number that you would like to verify
code	String	The OTP code to verify

200: OK Code verified successfully

{
  ok: true
}

200: OK Verification failed

{
  ok: false,
  message: "Reason string"
}

Using our official packages

Node.js

const result = await textlink.verifyCode("[phone]", "USER_ENTERED_CODE"); 
//if `result.ok` is true, then the phone number is verified. 

TypeScript

const result = await TextLink.verifyCode("[phone]", "USER_ENTERED_CODE"); 
//if `result.ok` is true, then the phone number is verified. 

Python

result = tl.verifyCode("[phone]", "USER_ENTERED_CODE")
# if `result.ok` is true, then the phone number is verified.

Update contact tag

You can use TextLink API to update contact tags. Contact tags allows you to track status of communication with them (e.g. cold/warm), and can be shown in the Chat app. Besides the chat app, they are also received as a part of Received Message Webhook, and each change of tag triggers the Tag Update Webhook.

This contact has "VIP" tag

Using API

POST https://textlinksms.com/api/update-contect-tag

Headers

Name	Type	Description
Content-Type*		The value should be "application/json"
Authorization*		The value should be "Bearer API_KEY", where API_KEY is the API key that you have registered on the API Console

Request Body

Name	Type	Description
phone_number*	String	The phone number that you would like to update the tag for
tag	String	Tag to set for your contact

200: OK Code verified successfully

{
  ok: true
}