PSTNBlacklist
Methods
AddPstnBlackListItem
Add a new phone number to the PSTN blacklist. Blacklist is used to block incoming calls from specified phone numbers to numbers purchased from Voximplant. Since we have no control over exact phone number format for calls from SIP integrations, blacklisting such numbers should be done via JavaScript scenarios.
To call this method, make sure your service account has one of the following roles:
Parameters
pstn_blacklist_phone:
string
The phone number in format e164 or regex pattern
Returns
result:
number
1
pstn_blacklist_id:
number
The PSTN black list item ID
SetPstnBlackListItem
Update the PSTN blacklist item. BlackList works for numbers that are purchased from Voximplant only. Since we have no control over exact phone number format for calls from SIP integrations, blacklisting such numbers should be done via JavaScript scenarios.
To call this method, make sure your service account has one of the following roles:
Parameters
pstn_blacklist_id:
number
The PSTN black list item ID
pstn_blacklist_phone:
string
The new phone number in format e164
Returns
result:
number
1
DelPstnBlackListItem
Remove phone number from the PSTN blacklist.
To call this method, make sure your service account has one of the following roles:
Parameters
pstn_blacklist_id:
number
The PSTN black list item ID
Returns
result:
number
1
GetPstnBlackList
Get the whole PSTN blacklist.
To call this method, make sure your service account has one of the following roles:
Parameters
pstn_blacklist_id:
number
OptionalThe PSTN black list item ID for filter
pstn_blacklist_phone:
string
OptionalThe phone number in format e164 for filter
count:
number
OptionalDefaults on: 20The max returning record count
offset:
number
OptionalDefaults on: 0The first N records will be skipped in the output
Returns
result:
total_count:
number
The total found phone numbers count
count:
number
The returned phone numbers count