Get Sms Campaign Batches

Gets sms campaign batches.

The SMS channel delivers text messages — templates, campaigns, and provider integrations — for OTPs, alerts, and bulk sends.

This endpoint returns the sms campaign batches available in your project.

Gets sms campaign batches

get

Authorizations

Bearer

HTTPRequired

JWT Bearer Authorization

Path parameters

versionstring · nullableRequired

The CodeMash API version used to fetch data from the API. If not specified, the last version will be used. E.g.: v3

Query parameters

Idstring · nullableOptional

The campaign id. Get it from get_sms_campaigns.

DatabaseIntegrationIdstring · nullableOptional

Optional. Omit to use the project default database integration (resolved per environment).

startingAfterstring · nullableOptional

Cursor token — fetch the page AFTER this item.

endingBeforestring · nullableOptional

Cursor token — fetch the page BEFORE this item.

pageSizeinteger · int32 · nullableOptional

Amount of records to return.

Header parameters

norbix-project-idstring · nullableRequired

ID of your project. Can be passed in a header as norbix-project-id.

norbix-envstring · nullableOptional

Target environment for this request (e.g. TEST, STAGING). Optional — when omitted the request runs against PROD. Can be passed in a header as norbix-env.

CultureCodestring · nullableOptional

Specify culture code when your response from the API should be localised. E.g.: en

TimeZoneIdstring · nullableOptional

TimeZone

CorrelationIdstring · nullableOptional

CorrelationId for each request

Responses

200

OK

application/json

get/{version}/notifications/sms/campaigns/{id}/batches

HTTPcURLJavaScriptPython

GET /{version}/notifications/sms/campaigns/{id}/batches HTTP/1.1
Host: hub.norbix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
norbix-project-id: text
Accept: */*

200

OK

{
  "responseStatus": {
    "isSuccess": true
  },
  "list": {
    "items": [],
    "hasMore": true,
    "hasPrevious": true,
    "startingAfter": "text",
    "endingBefore": "text"
  }
}

In the dashboard

Manage this visually in Norbix Cloud — see Notifications.

Use it from code

Every Norbix SDK exposes this endpoint as a method — see Get Sms Campaign Batches in the SDK reference, with examples in every language.