Getting started
Getting Started
API BasicsAPIs
Authentication
Blocklists
Call Channels
Call Center
Call Recordings
Devices
Pivot
Quickcall
WebhooksBusiness SMS
VirtualTextAutomation
ZapierUse cases
Create Trello Card for Voicemails Received 
Send Call Data to Google Sheets
Slack Notifications from Call Events
SMS Airtable Template
Trigger SMS Messages from Your CRM
Zapier Webinar RecordingBlocklists
A blocklist is a map of caller id numbers that can be then apply to the account to block these callers to call the system. You may also configure a blocklist to block callers that block or restrict their caller id.
Create List
You may create a blocklist before you add numbers to the list or you can include an initial list with the payload shown below.
API
Method: PUT
https://public-api.virtualpbx.com:8443/v2/accounts/{{account_id}}/blacklistsPayload
{
"data": {
"name": "Main Blacklist",
"numbers": {
"+14154846048": {}
}
}
}CURL Example
curl --location -g --request PUT 'https://public-api.virtualpbx.com:8443/v2/accounts/{ACCOUNT_ID}/blacklists' \
--header 'X-Auth-Token: {AUTH_TOKEN}' \
--header 'Content-Type: application/json' \
--data-raw '{
"data": {
"name": "Main Blacklist",
"numbers": {
"+14154846048": {
}
}
}
}'List Lists
You may create a blocklist before you add numbers to the list or you can include an initial list with the payload shown below.
API
Method: GET
https://public-api.virtualpbx.com:8443/v2/accounts/{{account_id}}/blacklistsGet List
You may create a blocklist before you add numbers to the list or you can include an initial list with the payload shown below.
API
Method: GET
https://public-api.virtualpbx.com:8443/v2/accounts/{{account_id}}/blacklists/{{blacklist_id}}Update List
You may create a blocklist before you add numbers to the list or you can include an initial list with the payload shown below.
API
Method: POST
https://public-api.virtualpbx.com:8443/v2/accounts/{{account_id}}/blacklistsPayload
{
"data": {
"name": "Main Blacklist",
"numbers": {
"+12109077509": {},
"+13152151224": {},
"+18322413415": {}
}
}
}Delete List
You may create a blocklist before you add numbers to the list or you can include an initial list with the payload shown below.
API
Method: DELETE
https://public-api.virtualpbx.com:8443/v2/accounts/{{account_id}}/blacklists/{{blacklist_id}}Payload
{
"data": {
"name": "Main Blacklist",
"numbers": {
"+14154846048": {}
}
}
}← Previous
Add link here
Next →
Add link here