Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

blacklist module APIs are useful to create, delete and fetch the values of existing configured blacklist. 

Add Blacklist Number 

Adding a blacklist number to Freepbx/PBXact system.

...

Code Block
2.Api to add Blacklist number
  
GQLAPI:  /admin/api/api/gql
  
{
    "data": {
        "addBlacklist": {
            "clientMutationId": "12432"
        }
    }
}

Remove Blacklist Number

Removing a blacklist number from Freepbx/PBXact system.

...

Code Block
API to remove blacklist number
 
 
GQLAPI:  /admin/api/api/gql
 
 
 
 
{
    "data": {
        "removeBlacklist": {
            "clientMutationId": "12432"
        }
    }
}

Fetch All Blacklist Numbers

Fetch all black list numbers from Freepbx/PBXact system

...

Code Block
API to fetch all blacklist numbers
 
 
GQLAPI:  /admin/api/api/gql
 
 
 
 
{
    "data": {
        "allBlacklists": {
            "blacklists": [
                {
                    "id": "YmxhY2tsaXN0OjMyNDMyNDMyNDIzNA==",
                    "description": "dsfsfds",
                    "number": "324324324234"
                },
                {
                    "id": "YmxhY2tsaXN0OjM0NTQ2NDM=",
                    "description": "cxvfbgdhgfh",
                    "number": "3454643"
                }
            ]
        }
    }
}

Fetch Particular Blacklist Number

Fetch particular blacklist number from Freepbx/PBXact system.

...

Code Block
API to particular blacklist number
 
 
GQLAPI:  /admin/api/api/gql
 
 
 
 
{
    "data": {
        "blacklist": {
            "description": "dsfsfds",
            "number": "324324324234"
        }
    }
}

Fetch Blacklist Settings

To fetch blacklist settings into Freepbx/PBXact system.

...

Code Block
{
    "data": {
        "blacklistSettings": {
            "blockUnknown": true,
            "destination": "Extensions: 101 101"
        }
    }
}

Update Blacklist Settings

Add or update blacklist settings

...