SIPSettings Module GQL APIs
- Nathaniel Halbrooks
- Kelli Higdon
Add SIP NAT Local IP
Add ( configure ) Sipsettings configuration to into Freepbx/PBXact system.
API: addSipNatLocalIp
API Parameters -
Name | Required | Type | Default | Description |
|---|---|---|---|---|
net | Mandatory | String |
| Network IP to save |
mask | Mandatory | String |
| Mask for the network IP |
Query Parameters
status
message |
API Request
GQLAPI: /admin/api/api/gql
parameters:
mutation {
addSipNatLocalIp(input:{ net: "192.168.8.80", mask : "22" })
{
status
message
}
} |
API Response
{
"data": {
"addSipNatLocalIp": {
"status": true,
"message": "Local IP has been added successfully"
}
}
} |
Update SIP NAT External IP
Add ( configure ) Sipsettings configuration to into Freepbx/PBXact system.
API: updateSipNatExternalIp
API Parameters -
Name | Required | Type | Default | Description |
|---|---|---|---|---|
net | Mandatory | String |
| External network IP to save |
Query Parameters
API Request
API Response
Fetch SIP NAT Network Settings
Fetch Sipsettings configuration from Freepbx/PBXact system.
API: fetchSipNatNetworkSettings
API Parameters -none
Query Parameters
API Request
API Response
Fetch Web Socket Settings
Fetch Web Socket configuration from Freepbx/PBXact system.
API: fetchWSSettings
API Parameters -none
Query Parameters
API Request
API Response
Update Web Socket Settings
Update Web Socket configuration into Freepbx/PBXact system.
API: updateWSSettings
API Parameters -
Name | Required | Type | Default | Description |
|---|---|---|---|---|
ws | Mandatory | String |
| WS Interface IPs and their states |
wss | Mandatory | String |
| WSS Interface IPs and their states |
Query Parameters
API Request
API Response