PBX GUI - SIPSettings Module GQL APIs
- Nathaniel Halbrooks
- Merry Arpaia
- 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
status
message |
API Request
GQL API: /admin/api/api/gql
parameters:
mutation {
updateSipNatExternalIp(input:{ net: "100.100.3.100"})
{
status
message
}
} |
API Response
{
"data": {
"updateSipNatExternalIp": {
"status": true,
"message": "External IP has been updated successfully"
}
}
} |
Fetch SIP NAT Network Settings
Fetch Sipsettings configuration from Freepbx/PBXact system.
API: fetchSipNatNetworkSettings
API Parameters -none
Query Parameters
status
message
externIP
localIP{
net
mask
}
routes{
net
mask
} |
API Request
GQLAPI: /admin/api/api/gql
{
fetchSipNatNetworkSettings{
status
message
externIP
localIP{
net
mask
}
routes{
net
mask
}
}
} |
API Response
{
"data": {
"fetchSipNatNetworkSettings": {
"status": true,
"message": "List of External and Local IPs",
"externIP": "100.100.3.100",
"localIP": [
{
"net": "192.168.8.80",
"mask": "21"
}
],
"routes": [
{
"net": "101.101.8.100",
"mask": "21"
}
]
}
}
} |
Fetch Web Socket Settings
Fetch Web Socket configuration from Freepbx/PBXact system.
API: fetchWSSettings
API Parameters -none
Query Parameters
status
message
ws {
interface
state
}
wss {
interface
state
} |
API Request
GQLAPI: /admin/api/api/gql
fetchWSSettings {
status
message
ws {
interface
state
}
wss {
interface
state
}
} |
API Response
{
"data": {
"fetchWSSettings": {
"status": true,
"message": "Web Socket Settings",
"ws": [
{
"interface": "0.0.0.0",
"state": "off"
},
{
"interface": "192.168.1.9",
"state": "on"
}
],
"wss": [
{
"interface": "0.0.0.0",
"state": "on"
},
{
"interface": "192.168.1.9",
"state": "off"
}
]
}
}
} |
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
status
message |
API Request
GQL API: /admin/api/api/gql
parameters:
mutation {
updateWSSettings(input: {
ws: "{'0.0.0.0': 'off','192.168.1.9':'on'}"
wss: "{'0.0.0.0': 'on','192.168.1.9':'off'}"
}) {
status
message
}
} |
API Response
{
"data": {
"updateWSSettings": {
"status": true,
"message": "Web Socket settings updated successfully"
}
}
} |