Skip to main content

GET /sms/lines/{line}/blocked/{number}

Check whether a number is blocked

Scopesms:read
Role permissionPhone numbers — line must be one of theirs
CostFree

Answers "is this number blocked?" If it is, you get a 200 with the block details; if not, a 404 (a clear "no"). It returns 404 rather than a 200 with an empty body, which your code could easily confuse with an error.

Path parameters​

NameTypeRequiredExampleDescription
linestringyes12125550188One of your account's numbers. Digits.
numberstringyes13475550123The other party's number. Digits.

Responses​

200​

The blocked sender.

FieldTypeDescription
linestringYour account number (the line) the sender is blocked on.
numberstringThe blocked sender's phone number.
reasonstringFree text for your own records. Never shown to the blocked party.
blockedAtstring (RFC 3339)When the block was added, RFC 3339 UTC.

Errors​

StatusMeaning
400invalid_request — a missing or malformed field, an unknown enum value, or an unknown field in the body. Nothing was charged.
401unauthenticated — no credential, or one that is invalid, revoked or expired. The WWW-Authenticate header names the scope the endpoint wanted.
403Two different failures share this status; the type field tells them apart — insufficient_scope (the credential lacks the scope) or permission_denied (the scope is fine, but the user's role lacks the permission).
404not_found — no such object, or it is not this account's. The two are deliberately indistinguishable.
500internal_error — something failed on our side, not with your request. Safe to retry.

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"

Try it in the playground →