Send OTP SMS

Caution

For security reasons, please contact your Account Manager to provide you with an API host.

The host https://api.example.com not is a real endpoint.

GET

/v2/otp/send

• Production

Sends an OTP SMS using query string parameters.

Note: This endpoint generates an OTP code and sends it via SMS. It is not an OTP verification route — use /v2/otp/verify for that.

Suitable for quick tests via browser or Postman.

Authorizations

BasicAuth

Use HTTP Basic Authentication to authorize requests.

The password is your API key, not your web portal password.

Example: Authorization: Basic WU9VUl9VU0VSTkFNRV9IRVJFOllPVVJfQVBJX1RPS0VOX0hFUkU=

(Where “YOUR_USERNAME_HERE:YOUR_API_TOKEN_HERE” is Base64-encoded)

Parameters

Query Parameters

msg

required

string

>= 3 characters <= 160 characters

GSM-encoded message (max 160 characters).

Note: If the [code] tag is omitted, it will be appended to the end of the message.

Example

Your otp code is [code], please don't share it with anyone.

phone

required

string

/^\d{10}$/

10-digit destination phone number (Mexico, without country code)

Example

8100001234

sender

string

Sender ID authorized by carrier (optional)

Example

AWESOMEINC

id

string

External reference ID for your own tracking (optional)

Example

external-id-relation

Responses

200

OTP SMS sent successfully

object

status

boolean

true

error

boolean

description

object

added_on

string format: date-time

2023-09-20 16:47:15

charge

number format: float

0.99

country

object

country

string

MEXICO

iso_code

string

MX

type

string

MOVIL

encoding

string

Allowed values: gsm unicode

gsm

id

integer

199999

job_id

string

199999

length

integer

12

message

string

Your otp code is 0000, please don't share it with anyone.

number

string

segments

integer

1

sender

string

AWESOMEINC

Example

{
  "status": true,
  "error": false,
  "description": {
    "added_on": "2023-09-20 16:47:15",
    "charge": 0.99,
    "country": {
      "country": "MEXICO",
      "iso_code": "MX",
      "type": "MOVIL"
    },
    "encoding": "gsm",
    "id": 199999,
    "job_id": "199999",
    "length": 12,
    "message": "Your otp code is 0000, please don't share it with anyone.",
    "number": "8100001234",
    "segments": 1,
    "sender": "AWESOMEINC"
  }
}

400

Missing required parameters

Example

{
  "status": false,
  "error": true,
  "description": "Missing params, please verify or contact to support"
}

401

Your key auth is not valid

Example

{
  "status": false,
  "error": true,
  "description": "Your key auth is not valid, please check with your administrator to get the new key"
}

402

Your account doesn’t have credits available for sending

Example

{
  "status": false,
  "error": true,
  "description": "Your account doesn't have credits available for this, please contact your administrator"
}

406

Country or carrier not reachable or assigned to your account

Example

{
  "status": false,
  "error": true,
  "description": "Country or carrier not reachable or assigned to your account, please contact an administrator or support"
}

410

Failed to append to the queue, no need to resend

Example

{
  "status": false,
  "error": true,
  "description": "Failed to append to the queue, no need to resend"
}

411

Your account doesn’t have multi-message sending enabled

Example

{
  "status": false,
  "error": true,
  "description": "Your account doesn't have multi-message sending enabled, please contact your administrator"
}

Examples

Useful for guiding users to view code examples in different developer languages.

Bash

developer@developer:~#

curl -X GET "https://api.example.com/v2/otp/send?msg=Your+otp+code+is+%5Bcode%5D%2C+please+don%27t+share+it+with+anyone.&phone=8100001234&sender=AWESOMEINC&id=external-id-relation" \
    -H "Accept: application/json" \
  -H "Connection: keep-alive" \
  -H "Authorization: Basic <base64-encoded-credentials>"

Node.js

example.js

  const fetch = require('node-fetch');

  fetch("https://api.example.com/v2/otp/send?msg=Your+otp+code+is+%5Bcode%5D%2C+please+don%27t+share+it+with+anyone.&phone=8100001234&sender=AWESOMEINC&id=external-id-relation", {
    method: "GET",
    headers: {
  "Accept": "application/json",
  "Connection": "keep-alive",
  "Authorization": "Basic <base64-encoded-credentials>"
}
  })
    .then(res => res.json())
    .then(console.log)
    .catch(console.error);

PHP

example.php

  <?php
  $curl = curl_init();

  curl_setopt_array($curl, [
    CURLOPT_URL => "https://api.example.com/v2/otp/send?msg=Your+otp+code+is+%5Bcode%5D%2C+please+don%27t+share+it+with+anyone.&phone=8100001234&sender=AWESOMEINC&id=external-id-relation",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Connection: keep-alive",
    "Authorization: Basic <base64-encoded-credentials>"
    ]
  ]);

  $response = curl_exec($curl);
  curl_close($curl);
  echo $response;
  ?>

C-Sharp

example.cs

  using System.Net.Http;
  using System.Text;
  using System.Threading.Tasks;

  var client = new HttpClient();
  var request = new HttpRequestMessage(HttpMethod.GET, "https://api.example.com/v2/otp/send?msg=Your+otp+code+is+%5Bcode%5D%2C+please+don%27t+share+it+with+anyone.&phone=8100001234&sender=AWESOMEINC&id=external-id-relation");
  request.Headers.Add("Accept", "application/json");
request.Headers.Add("Connection", "keep-alive");
request.Headers.Add("Authorization", "Basic <base64-encoded-credentials>");
  var response = await client.SendAsync(request);
  var responseBody = await response.Content.ReadAsStringAsync();
  Console.WriteLine(responseBody);

Python

example.py

  import requests
  import json

  url = "https://api.example.com/v2/otp/send?msg=Your+otp+code+is+%5Bcode%5D%2C+please+don%27t+share+it+with+anyone.&phone=8100001234&sender=AWESOMEINC&id=external-id-relation"
  headers = {
    "Accept": "application/json",
  "Connection": "keep-alive",
  "Authorization": "Basic <base64-encoded-credentials>"
  }

  response = requests.get(url, headers=headers)
  print(response.text)

Java

example.java

  import java.io.OutputStream;
  import java.net.HttpURLConnection;
  import java.net.URL;
  import java.nio.charset.StandardCharsets;

  public class ApiExample {
    public static void main(String[] args) throws Exception {
      URL url = new URL("https://api.example.com/v2/otp/send?msg=Your+otp+code+is+%5Bcode%5D%2C+please+don%27t+share+it+with+anyone.&phone=8100001234&sender=AWESOMEINC&id=external-id-relation");
      HttpURLConnection conn = (HttpURLConnection) url.openConnection();
      conn.setRequestMethod("GET");

      conn.setRequestProperty("Accept", "application/json");
    conn.setRequestProperty("Connection", "keep-alive");
    conn.setRequestProperty("Authorization", "Basic <base64-encoded-credentials>");

      int code = conn.getResponseCode();
      System.out.println("Response code: " + code);
    }
  }