SMS

Index

• GET /api/v1/sms/{id} - Get SMS information

Note

For sending an SMS for a pass, see the Pass Delivery documentation.

Get SMS information

Get information about an SMS delivery by its ID.

Will return the phone number, message length, number of message parts, and delivery status of the SMS.

Request

GET https://smartpages-api.smartsolutions.is/api/v1/sms/{id}

Response

Example

{ "id": "19700910-7195-4d57-b402-886ff7439e44", "sender": "MyCompany", "recipient": "+3541234567", "messageParts": 1, "messageLength": 75, "whenCreated": "2025-07-15T12:00:00.000Z", "passId": "21ba9a96-fb86-4e56-a390-3c8df69903f7", "delivered": true, "statuses": [ { "status": "CREATED", "timestamp": "2026-06-11T12:00:00.000Z" }, { "status": "PENDING", "timestamp": "2026-06-11T12:00:01.000Z" }, { "status": "SENT", "timestamp": "2026-06-11T12:00:01.200Z" }, { "status": "DELIVERED", "timestamp": "2026-06-11T12:00:03.000Z" } ] }

Fields details

id UUID

ID of the SMS

sender string

The Sender Identity

recipient string

The Phone Number the SMS was sent to.

passId UUID Optional

The Pass the SMS was sent for, if any.

messageParts integer

How many parts the message was split into, as per carrier requirements.

messageLength integer

How long the message is in characters.

whenCreated timestampz

When the SMS message was queued for delivery.

delivered boolean

Whether the SMS message has been delivered to the recipient. This is a terminal state, once this is true, the message will not be routed anymore.

statuses array

Delivery statuses for the message

status enum

Possible values:
- "CREATED": SMS Record was created
- "PENDING": SMS has been queued for delivery
- "SENT": SMS has been sent
- "SCHEDULED": SMS was scheduled for later delivery
- "DELIVERED": SMS has been delivered - Terminal state
- "EXPIRED": SMS message expires (routed too many times without resolution) - Terminal state
- "ACCEPTED": The network carrier accepted the message, but won't give more information on delivery - Terminal state
- "REJECTED": The network carrier rejected the message - Terminal state
- "FAILED": Delivery failed. - Terminal state

timestamp timestampz

When this delivery state was entered.

Code example

Node.js (fetch)

const myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Authorization", "Bearer <base64(KEY_ID:KEY_TOKEN)>");

const requestOptions = {
    method: "GET",
    headers: myHeaders,
    redirect: "follow"
};

try {
    const response = await fetch("https://smartpages-api.smartsolutions.is/api/v1/sms/{id}", requestOptions);
    const result = await response.text();
    console.log(result)
} catch (error) {
    console.error(error);
};

Node.js (axios)

const axios = require('axios');

let config = {
    method: 'get',
    maxBodyLength: Infinity,
    url: 'https://smartpages-api.smartsolutions.is/api/v1/sms/{id}',
    headers: {
        'Content-Type': 'application/json',
        'Authorization': 'Bearer <base64(KEY_ID:KEY_TOKEN)>'
    }
};

async function makeRequest() {
    try {
        const response = await axios.request(config);
        console.log(JSON.stringify(response.data));
    }
    catch (error) {
        console.log(error);
    }
}

makeRequest();

Python

import requests
import json

url = "https://smartpages-api.smartsolutions.is/api/v1/sms/{id}"

payload = {}
headers = {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer <base64(KEY_ID:KEY_TOKEN)>'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

Kotlin

val client = OkHttpClient()
val request = Request.Builder()
    .url("https://smartpages-api.smartsolutions.is/api/v1/sms/{id}")
    .addHeader("Content-Type", "application/json")
    .addHeader("Authorization", "Bearer <base64(KEY_ID:KEY_TOKEN)>")
    .build()
val response = client.newCall(request).execute()

C#

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://smartpages-api.smartsolutions.is/api/v1/sms/{id}");
request.Headers.Add("Authorization", "Bearer <base64(KEY_ID:KEY_TOKEN)>");
var content = new StringContent(string.Empty);
content.Headers.ContentType = new MediaTypeHeaderValue("application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Rust

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = reqwest::Client::builder()
        .build()?;

    let mut headers = reqwest::header::HeaderMap::new();
    headers.insert("Content-Type", "application/json".parse()?);
    headers.insert("Authorization", "Bearer <base64(KEY_ID:KEY_TOKEN)>".parse()?);

    let request = client.request(reqwest::Method::GET, "https://smartpages-api.smartsolutions.is/api/v1/sms/{id}")
        .headers(headers);

    let response = request.send().await?;
    let body = response.text().await?;

    println!("{}", body);

    Ok(())
}