Get an SMS campaign | Brevo API Documentation

import { BrevoClient } from "@getbrevo/brevo";
async function main() {
    const client = new BrevoClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.smsCampaigns.getSmsCampaign(1);
}
main();

{
  "content": "Visit our Store and get some discount !",
  "createdAt": "2017-06-01T12:30:00Z",
  "id": 2,
  "modifiedAt": "2017-05-01T12:30:00Z",
  "name": "PROMO CODE",
  "sender": "MyCompany",
  "status": "sent",
  "recipients": {
    "exclusionLists": [
      {
        "id": 13,
        "name": "Exclusion List"
      }
    ],
    "lists": [
      {
        "id": 21,
        "name": "Main List"
      }
    ]
  },
  "statistics": {
    "answered": 2,
    "delivered": 2987,
    "hardBounces": 1,
    "processing": 0,
    "sent": 3000,
    "softBounces": 3,
    "unsubscriptions": 3
  },
  "organisationPrefix": "MyCompany",
  "scheduledAt": "2017-06-01T12:30:00Z",
  "sentDate": "2017-06-01T12:30:00Z",
  "unsubscribeInstruction": "send Stop if you want to unsubscribe.",
  "tags": []
}

Retrieve detailed information about a specific SMS campaign by its ID, including campaign content, sender, recipients with list names, statistics (delivered, sent, bounces, unsubscriptions, answered), and tags. Unlike the list endpoint, recipients are returned as objects with id and name fields rather than plain IDs.

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Path parameters

campaignIdlongRequired

id of the SMS campaign

Response

SMS campaign information

contentstring

Content of the SMS Campaign

createdAtstring

Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)

idlong

ID of the SMS Campaign

modifiedAtstring

UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)

namestring

Name of the SMS Campaign

senderstring

Sender of the SMS Campaign

statusenum

Status of the SMS Campaign

recipientsobject

Recipients of the SMS campaign. For a single campaign, lists and exclusion lists are returned as objects with id and name.

statisticsobject

organisationPrefixstring

A recognizable prefix added as the Brand Name before the message content. Empty string if not set.

scheduledAtstring

UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format. Empty string if not scheduled.

sentDatestring

UTC date-time on which the SMS campaign was sent (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if the campaign status is ‘sent’.

unsubscribeInstructionstring

Instructions to unsubscribe from future communications. Empty string if not set.

tagslist of strings

Tags (labels) associated with the SMS campaign. Only available when retrieving a single campaign.

Errors

400

Bad Request Error

404

Not Found Error