Skip to navigation
Management APIReferencePSTN Blacklist

GetPstnBlackList

View as Markdown

Get the whole PSTN blacklist.

Allowed roles: Owner, Admin.

Authentication

AuthorizationBearer

Voximplant Management API uses signed JWT tokens generated from your service-account private key. Pass the token in the Authorization header as a Bearer value:

Authorization: Bearer $VOXIMPLANT_TOKEN

See Authorization for ready-to-copy snippets in bash, Python, Node.js and Go that turn your credentials.json into a token.

Query parameters

pstn_blacklist_idintegerOptional
The PSTN black list item ID for filter
pstn_blacklist_phonestringOptional
The phone number in format e164 for filter
countintegerOptionalDefaults to 20
The max returning record count
offsetintegerOptionalDefaults to 0

The first N records are skipped in the output

Response

Successful response
resultlist of objectsOptional
total_countintegerOptional
The total found phone numbers count
countintegerOptional
The returned phone numbers count