List opted-out numbers (suppression list)

GET/v1/consent

Query Parameters

Results are paged. When has_more is true, pass next_cursor from the response as cursor to fetch the next page.

limitinteger
Default 25. Maximum 100.
cursorstring

Responses

200Page of Consent
Suppressions in numeric order
401Error
Missing, malformed, or revoked API key
402Error
Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged
429Error
Rate limit or quota exceeded

Response Fields

The body is a page: data (the array), has_more, and next_cursor (null on the last page). Each item in data:

objectconsent
phonestring
Example: +14155550132.
statusopted_out, opted_in, no_record
updated_atstring (date-time)
viastring
Example: sms_phrase.
methodkeyword, phrase, ai, api, import, hosted_page
detectedstring
The keyword or phrase that triggered detection
confidencenumber
Intent-tier detections only, 0 to 1
campaign_idstring
On the response to an opt-in recorded for one registration
proofOptInProof
Opt-in evidence (Messaging Policy 1.4). Accepted only with status opted_in.

Errors

Every error has the same JSON shape, and request_id matches the X-Request-Id response header. Errors lists every code and what to do about it.

401
Missing, malformed, or revoked API key
402
Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged
429
Rate limit or quota exceeded

import { TextKit } from 'jointextkit'; // npm install jointextkit

const sms = new TextKit(process.env.TEXTKIT_API_KEY);

const optedOut = await sms.consent.list({ limit: 10 });

console.log(optedOut.data.map((c) => c.phone));

Response 200

{
  "data": [
    {
      "object": "consent",
      "phone": "+14155550132",
      "status": "opted_out",
      "via": "sms_phrase",
      "method": "keyword"
    }
  ],
  "has_more": true,
  "next_cursor": null
}