Blacklist Module GraphQL APIs
- Nathaniel Halbrooks
This wiki is to capture the Blacklist module provided GraphQL APIs.
Please find below list of APIs supported by blacklist module.
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.
API Name: addBlacklist
API parameters:
Name | Required | Type | Description |
|---|---|---|---|
number | Mandatory | ID | Number which is to be added to blacklist |
description | Optional | String | description for the blacklist number |
clientMutationId | Optional | ID | Client id for request and response |
Query Parameters
clientMutationId |
API Request
1. Api to add Blacklist number
GQLAPI: /admin/api/api/gql
parameters:
mutation {
addBlacklist(input: {
number: "1324546"
description:"blocklist number"
clientMutationId : "12432"
}) {
clientMutationId
}
} |
API Response
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.
API Name: removeBlacklist
API parameters:
Name | Required | Type | Description |
|---|---|---|---|
number | Mandatory | ID | Number which is to be removed from the blacklist |
clientMutationId | Optional | ID | Client id for request and response |
Query Parameters
API Request
API Response
Fetch All Blacklist Numbers
Fetch all black list numbers from Freepbx/PBXact system
API Name: allBlacklists
API Parameters:
Name | Required | Type | Description |
|---|---|---|---|
id | Optional | ID | Unique string to identify the blacklist number. |
description | Optional | String | Description for the blacklisted number |
number | Optional | ID | Blacklisted Number |
Query Parameters
API Request
API Response
Fetch Particular Blacklist Number
Fetch particular blacklist number from Freepbx/PBXact system.
API Name: blacklist
API Parameters:
Name | Required | Type | Description |
|---|---|---|---|
id | Optional | ID | Blacklisted Number. |
description | Optional | String | Description for the blacklisted number |
number | mandatory | ID | Blacklisted Number |
Query Parameters
API Request
API Response
Fetch Blacklist Settings
To fetch blacklist settings into Freepbx/PBXact system.
API Name: blacklistSettings
API Parameters:
Name | Required | Type | Description |
|---|---|---|---|
mandatory | Boolean | Boolean value used to identify setting is enabled or not | |
optional | string | Destination to which blacklist setting is enabled |
Query Parameters
API Request
API Response
Update Blacklist Settings
Add or update blacklist settings
API Name: setBlacklistSettings
API Parameters:
Name | Required | Type | Description |
|---|---|---|---|
mandatory | Boolean | Boolean value to enable or disable blacklist settings. | |
mandatory | string | Destination to which blacklist setting to be enabled | |
optional | ID | Client id for request and response |
Query Parameters
API Request
API Response