GET /sms/lines/{line}/blocked/{number}
Check whether a number is blocked
| Scope | sms:read |
| Role permission | Phone numbers — line must be one of theirs |
| Cost | Free |
404 when the number is not blocked — a distinct answer rather than an
empty body, because "is this blocked" is the question, and a caller
distinguishing null-from-error will eventually get it backwards.
Path parameters
| Name | Type | Required | Example | Description |
|---|---|---|---|---|
line | string | yes | 12125550188 | One of your account's numbers. Digits. |
number | string | yes | 13475550123 | The other party's number. Digits. |
Responses
200
The blocked sender.
| 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: |
404 | not_found — no such object, or it is not this account's. The two are deliberately indistinguishable. |
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/13475550123' \
-H "Authorization: Bearer $TB_KEY"