Sending an SMS

TextLink offers a versatile SMS API, tailor-made for developers who seek straightforwardness in sending and receiving SMS. The act of dispatching an SMS is inherently simple, and we aim to reflect this simplicity in our API. We ensure it's user-friendly, eliminating the need for elaborate account setups, mandatory logins, or additional recurring charges.

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 500 free messages per month, which you can use to send SMS or verify user request anywhere in the world.

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

Sending an HTTP POST request

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.

Send an SMS wih the custom body to the recipient phone number.

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 on 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	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
}

Examples for different programming languages

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)