PBX GUI - EndPoint Module GraphQL APIs
- Nathaniel Halbrooks
- Merry Arpaia
To capture the GraphQL APIs provided by Endpoint module.
Enable DPMA
Enable DPMA into Freepbx/PBXact system.
API: enableDPMA
API Parameters -
Name | Required | Type | Default | Description |
|---|---|---|---|---|
restartAsterisk | Optional | Boolean | True | Allow to restart Asterisk or not |
Query Parameters
status
message
transaction_id |
API Request
GQL API: /admin/api/api/gql
mutation{
enableDPMA(input : {
restartAsterisk : true
}){
status message transaction_id
}
} |
API Response
{
"data":{
"enableDPMA":{
"status":true,
"message":"Enable DPMA has been initiated. Kindly check the fetchApiStatus api with the transaction id."
"transaction_id" : 100
}
}
} |
Disable DPMA
Diable DPMA into Freepbx/PBXact system.
API: disableDPMA
API Parameters : none
Query Parameters
status
message |
API Request
GQL API: /admin/api/api/gql
mutation{
disableDPMA(input: {}){
status
message
}
} |
API Response
{
"data":{
"disableDPMA":{
"status":true,
"message":"Disable DPMA is done succesfully"
}
}
} |
Update EPM Global Settings
Update ( configure ) IP into Freepbx/PBXact system.
API: updateEndpointManagerGlobalSettings
API Parameters -
Name | Required | Type | Default | Description |
|---|---|---|---|---|
internalAddress | Optional | String |
| Enter the Internal Address of the PBX. This is the address (or hostname) that is reachable from devices that are not going through any NAT. Enter "auto" to automatically detect this address (once only). Use the word "none" to disable this field on endpoints. |
externalAddress | Optional | String |
| Enter the External Address of the PBX. This is the address (or hostname) that is reachable from devices that are on a public, or not directly connected, network. Enter "auto" to automatically detect this address (once only). Use the word "none" to disable this field on endpoints. |
Query Parameters
status
message |
API Request
GQL API: /admin/api/api/gql
mutation{
updateEndpointManagerGlobalSettings(input : {
internalAddress: "100.100.100.100"
externalAddress: "100.100.100.101"
}){
status message
}
} |
API Response
{
"data": {
"updateEndpointManagerGlobalSettings":{
"status":true,
"message":"Golbal settings have been updated successfully"
}
}
} |
Fetch EPM Global Settings
Fetch EPM global settings configuration from Freepbx/PBXact system.
API: fetchEndpointManagerGlobalSettings
API Parameters -none
Query Parameters
status
message
internalAddress
externalAddress |
API Request
GQLAPI: /admin/api/api/gql
query{
fetchEndpointManagerGlobalSettings{
status
message
internalAddress
externalAddress
}
} |
API Response
{
"data": {
"fetchEndpointManagerGlobalSettings": {
"status":true,
"message":"List of External and Internal IP address",
"internalAddress":"100.100.100.100",
"externalAddress":"100.100.100.101"
}
}
} |
Fetch Internal External IPs
Fetch Internal External IPs from Freepbx/PBXact system.
API: fetchInternalExternalIPs
API Parameters -none
Query Parameters
status
message
publicIP
fqdn |
API Request
GQLAPI: /admin/api/api/gql
query{
fetchInternalExternalIPs{
status
message
publicIP
fqdn
}
} |
API Response
{
"data": {
"fetchInternalExternalIPs": {
"status": true,
"message": "List of External and Internal IP address",
"publicIP": "111.102.102.99",
"fqdn": "120.101.120.99"
}
}
} |
Update Internal External IPs
Update ( configure ) Internal External IP into Freepbx/PBXact system.
API: updateEndpointGlobalSettings
API Parameters -
Name | Required | Type | Default | Description |
|---|---|---|---|---|
externalAddress | Mandatory | String |
| Enter the Public IP. |
internalAddress | Mandatory | String |
| Enter the Internal IP. |
Query Parameters
status
message |
API Request
GQL API: /admin/api/api/gql
mutation{
updateEndpointGlobalSettings(input : {
externalAddress : "100.100.100.100"
internalAddress: "100.100.100.101"
}){
status message
}
} |
API Response
{
"data": {
"updateEndpointGlobalSettings": {
"status": true,
"message": "Internal and External IPs have been Updated"
}
}
} |
Rebuild Config(s) and Update Phones
Rebuild Config (s) of Phones and Send Update Command to Phone to fetch the newly build Config(s).
API: rebuildConfigUpdatePhones
API Parameters -
Name | Required | Type | Description |
|---|---|---|---|
getExtTemplateAll
| Mandatory | String | In this API Parameter, we can pass three values to Rebuild Config (s) and update phones i.e Extension/templateName/all. Extension: Rebuild the configs of that user ( Particular Extension) and send an update command to that particular Phone. Here Full extension number should be given like 333-1 (PJSIP) or 333 (Chan_SIP) |
Query Parameters
status
message
transaction_id |
API Request
GQL API: /admin/api/api/gql
mutation{
rebuildConfigUpdatePhones(input : {
getExtTemplateAll : "333-1"
}){
status message transaction_id
}
} |
API Response
{
"data":{
"rebuildConfigUpdatePhones":{
"status":true,
"message":"Rebuild Config(s) and Update Phones has been initiated. Kindly check the fetchApiStatus api with the transaction id."
"transaction_id" : 100
}
}
} |