Skip to main content

Overview

The SMS Sends API lets you send transactional or marketing SMS messages to one or many recipients in a single request. You can use a global message and personalization tags for all recipients, or specify per-recipient content for fully customized batch sends. Base URL: https://api.effilink.co
Endpoint: POST /v5/sms/sends
Authentication via ApiKey or OAuth header is required.
SMS content must match a pre-approved template registered with the relevant carrier or regulatory authority. Messages that do not comply with the approved template may be rejected. Maximum 100 recipients per request.

Content Priority

When multiple content sources are provided, EffiLink resolves the final message for each recipient using the following priority order (highest to lowest):

Request Parameters

Global Parameters

string
The SMS message body, including your brand signature, applied to all recipients. Supports personalization tags (e.g., {{code}}, {{name}}). Required unless templateName is provided.Example: [YourBrand] Your verification code is {{code}}. Valid for 5 minutes.
string
The name of a globally registered SMS template to use as the message body for all recipients. Takes priority over the global content field when both are provided.
object
A key-value map of personalization tag values applied to all recipients. Overridden by per-recipient params when both are present.
array[object]
required
An array of recipient objects. Maximum 100 entries per request.
boolean
Set to true to run in sandbox mode. The request is processed and validated, but no SMS messages are actually delivered.

Response

integer
HTTP-style status code. 200 on success.
string
A human-readable status message. Empty string on success.

Example: Simple Bulk Send

Send the same message to multiple recipients using a global template and a shared personalization value.
Both recipients will receive:
[YourBrand] Your verification code is 123456. Valid for 5 minutes.

Example: Personalized Batch Send

Send a unique message to each recipient by providing per-recipient params.
Each recipient receives a personalized message:
  • 18800006666: [YourBrand] Hi Alice, your order ORD-001 has shipped.
  • 18800008888: [YourBrand] Hi Bob, your order ORD-002 has shipped.

Example Response