List SMS opt-outs

The recipients who opted out of SMS (replied STOP) across your numbers, most recent first. Compliance surface: you must be able to see and export your opt-out list. Read-only: a recipient is re-subscribed only by replying START. Pass format=csv to download a CSV instead of JSON.

Authorization

AuthorizationBearer <token>

API key authentication - use your Zernio API key as a Bearer token

In: header

Query Parameters

format?string

Default"json"

Value in"json" | "csv"

limit?integer

Default500

Range1 <= value <= 5000

Response Body

application/json

import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.sms.listSmsOptOuts();console.log(data);

{
  "optOuts": [
    {
      "phoneNumber": "string",
      "optedOutAt": "2019-08-24T14:15:22Z",
      "keyword": "string",
      "from": "string"
    }
  ],
  "count": 0
}

{
  "error": "Unauthorized"
}

Authorization

AuthorizationBearer <token>

API key authentication - use your Zernio API key as a Bearer token

In: header

Query Parameters

format?string

Default"json"

Value in"json" | "csv"

limit?integer

Default500

Range1 <= value <= 5000

Response Body

application/json

import Zernio from '@zernio/node';

const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });

const { data } = await zernio.sms.listSmsOptOuts();
console.log(data);

import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.sms.listSmsOptOuts();console.log(data);

{
  "optOuts": [
    {
      "phoneNumber": "string",
      "optedOutAt": "2019-08-24T14:15:22Z",
      "keyword": "string",
      "from": "string"
    }
  ],
  "count": 0
}

{
  "error": "Unauthorized"
}

List SMS opt-outs

Authorization

Query Parameters

Response Body

200

401application/json

List SMS opt-outs

Authorization

Query Parameters

Response Body

200

401application/json

application/json

application/json