Returns the information for all your created SMS campaigns

GET

https://api.brevo.com/v3/smsCampaigns

GET

/v3/smsCampaigns

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

{
  "campaigns": [
    {
      "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": [
          13
        ],
        "lists": [
          21
        ]
      },
      "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."
    },
    {
      "content": "Summer Sale is starting tomorrow. Get extra 10% with this code:SUM17",
      "createdAt": "2017-06-01T12:30:00Z",
      "id": 10,
      "modifiedAt": "2017-05-01T12:30:00Z",
      "name": "SUMMER SALE",
      "sender": "MyCompany",
      "status": "draft",
      "recipients": {
        "exclusionLists": [
          13
        ],
        "lists": [
          21
        ]
      },
      "statistics": {
        "answered": 2,
        "delivered": 2987,
        "hardBounces": 1,
        "processing": 0,
        "sent": 3000,
        "softBounces": 3,
        "unsubscriptions": 3
      },
      "organisationPrefix": "",
      "scheduledAt": "2017-08-04T12:30:00Z",
      "unsubscribeInstruction": ""
    }
  ],
  "count": 12
}

Retrieve a paginated list of all your SMS campaigns with their statistics and recipient information. Results can be filtered by status and date range, with a default limit of 500 and maximum of 1000 per page. The sort order defaults to descending by creation date; date filters are only available when status is not passed or is set to sent.

Authentication

api-keystring

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

AuthorizationBearer

OAuth 2.0 client_credentials (machine-to-machine) grant. Exchange your app’s client_id/client_secret for a short-lived Bearer token.

Query parameters

statusenumOptional

Status of campaign.

startDatestringOptional

Mandatory if endDate is used. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent SMS campaigns. Prefer to pass your timezone in date-time format for accurate result. Only available if status is not passed or is set to sent. startDate must not be in the future.

endDatestringOptional

Mandatory if startDate is used. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent SMS campaigns. Prefer to pass your timezone in date-time format for accurate result. Only available if status is not passed or is set to sent. endDate must not be in the future.

limitlongOptional1-1000Defaults to 500

Number of documents per page

offsetlongOptionalDefaults to 0

Beginning point in the list to retrieve from.

sortenumOptionalDefaults to desc

Sort the results in the ascending/descending order of record creation. Default order is descending if sort is not passed

Allowed values:

Response

SMS campaigns information

campaignslist of objectsOptional

countlongOptional

Number of SMS campaigns retrieved

Errors

400

Bad Request Error