EndPoint Module GraphQL APIs

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

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 

 

API Request 

 

API Response 

Update EPM Global Settings

 

Update ( configure )  IP into Freepbx/PBXact system.

API: updateEndpointManagerGlobalSettings

API Parameters -

Name

Required

Type

Default

Description

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 

 

API Request 

 

API Response 


Fetch EPM Global Settings

Fetch EPM global settings configuration from  Freepbx/PBXact system.

API: fetchEndpointManagerGlobalSettings

API Parameters -none

Query Parameters 

 

API Request 

 

API Response 


Fetch Internal External IPs

Fetch Internal External IPs from  Freepbx/PBXact system.

API: fetchInternalExternalIPs

API Parameters -none

Query Parameters 

 

API Request 

 

API Response 

Update Internal External IPs

Update ( configure )  Internal External IP into Freepbx/PBXact system.

API: updateEndpointGlobalSettings

API Parameters -

Name

Required

Type

Default

Description

Name

Required

Type

Default

Description

externalAddress

Mandatory

String

 

Enter the Public IP.

internalAddress

Mandatory

String

 

Enter the Internal IP.

 

Query Parameters 

 

API Request 

 

API Response 

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

Name

Required

Type

Description

 

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)
Template Name: Rebuild the configs of all phones and send an update command to each phone that is related to that particular template.
all: Rebuild the configs of all phones and send update commands to each phone.

 

Query Parameters 

API Request 

API Response 

Return to Documentation Home I Return to Sangoma Support