Check SMS Status

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/sms/check

• Production

Checks the delivery status of a previously sent SMS by its message ID.

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

token

required

string

Message ID returned when the SMS was sent

Example

199999

Responses

200

SMS status retrieved successfully

object

status

boolean

true

error

boolean

description

object

message

object

carrier

string

ATT COMERCIALIZACION MOVIL S. DE R.L. DE C.V.

control

Internal carrier control reference

string

1006095262300

disposicion

Line type (e.g. MOVIL, FIJO)

string

MOVIL

encoding

string

Allowed values: gsm unicode

gsm

loops

Number of delivery retry loops

string

0

msg

Original message text

string

Tu codigo de verificacion es 1234456

parts

Number of SMS segments

integer

1

phone

Destination phone number

string

8121500346

received_date

Date the message was received by the platform

string format: date-time

2026-06-24 16:16:52

send_date

Date the message was delivered to the carrier (zeros if pending)

string format: date-time

2026-06-24 16:16:53

size

Character count of the message

integer

36

status

Delivery status reported by the carrier

string

ENVIO CONFIRMADO

var_a

Custom variable A (usually set to your external ID)

string

API-8121500346

var_b

Custom variable B

string

nullable

answers

Incoming replies to this message (if two-way SMS is enabled)

Array<object>

object

Example

{
  "status": true,
  "error": false,
  "description": {
    "message": {
      "carrier": "ATT COMERCIALIZACION MOVIL S. DE R.L. DE C.V.",
      "control": "1006095262300",
      "disposicion": "MOVIL",
      "encoding": "gsm",
      "loops": 1,
      "msg": "Tu codigo de verificacion es 1234456",
      "parts": 1,
      "phone": "8100001234",
      "received_date": "2026-06-24 16:16:52",
      "send_date": "2026-06-24 16:16:53",
      "size": 36,
      "status": "ENVIO CONFIRMADO",
      "var_a": "API-8100001234",
      "var_b": null
    },
    "answers": []
  }
}

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

Examples

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

Bash

developer@developer:~#

curl -X GET "https://api.example.com/v2/sms/check?token=199999" \
    -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/sms/check?token=199999", {
    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/sms/check?token=199999",
    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/sms/check?token=199999");
  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/sms/check?token=199999"
  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/sms/check?token=199999");
      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);
    }
  }