GET /sms/lines/{line}/blocked
List blocked senders
| Scope | sms:read |
| Role permission | Phone numbers — line must be one of theirs |
| Cost | Free |
This is not the opt-out list. This is your inbound block list, which
you control. A recipient who texted STOP is on a different list that this
API deliberately cannot edit — you must not be able to delete someone's
opt-out. The only way to observe that one is the skipped: "opted_out"
result of a send.
Path parameters
| Name | Type | Required | Example | Description |
|---|---|---|---|---|
line | string | yes | 12125550188 | One of your account's numbers. Digits. |
Responses
200
The blocked senders on this line.
| Field | Type | Description |
|---|---|---|
[].line | string | |
[].number | string | |
[].reason | string | Free text for your own records. Never shown to the blocked party. |
[].blockedAt | string (RFC 3339) |
Errors
| Status | Meaning |
|---|---|
400 | invalid_request — a missing or malformed field, an unknown enum value, or an unknown field in the body. Nothing was charged. |
401 | unauthenticated — no credential, or one that is invalid, revoked or expired. The WWW-Authenticate header names the scope the endpoint wanted. |
403 | Two different failures share this status, and the type tells them apart: |
500 | internal_error — something failed on our side. For a send, nothing was charged, guaranteed, which is what makes a retry safe. |
See Errors for the full catalog and what to do about each.
Example
curl -X GET 'https://api.account.telebroad.com/api/public/v1/sms/lines/12125550188/blocked' \
-H "Authorization: Bearer $TB_KEY"