PBX GUI - SIPStation Module GraphQL APIs
- Nathaniel Halbrooks
- Merry Arpaia
To capture the GraphQL APIs provided by SIPStation module.
Add Sipstation Key
Add ( configure ) Sipstation configuration to into Freepbx/PBXact system.
API: addSipStationKey
API Parameters -
Name | Required | Type | Default | Description |
|---|---|---|---|---|
key | Mandatory | String |
| key which is generated from http://store.sipstation.com/ |
Query Parameters
status
message |
API Request
1. Api to add Key
GQLAPI: /admin/api/api/gql
parameters:
mutation {
addSipStationKey(input: {
key: "******************"
}) {
status message
}
} |
API Response
{
"data": {
"addSipStationKey": {
"status": true,
"message": "SipStation key has been added successfully"
}
}
} |
Fetch Sipstation Key
Fetch Sipstation key to into Freepbx/PBXact system.
API: fetchSipStationkey
API Parameters -none
Query Parameters
status
message |
API Request
GQLAPI: /admin/api/api/gql
parameters:
query{
fetchSipStationkey {
status message key
}
} |
API Response
{
"data": {
"fetchSipStationkey ": {
"status": true,
"message": "SipStation key found",
"key" : *******************
}
}
} |
Fetch Sipstation Status
Fetch Sipstation status into Freepbx/PBXact system.
API: fetchSipStationStatus
API Parameters -none
Query Parameters
status
message
numberOfTrunks
serverSettings{
sms
fax
international
}
e911Info{
name
number
street1
street2
zip
state
city
}
primarySipServer{
name
registered
userAgent
contactIp
networkIp
ipsMatch
}
secondarySipServer{
name
registered
userAgent
contactIp
networkIp
ipsMatch
} |
API Request
GQLAPI: /admin/api/api/gql
parameters:
query{
fetchSipStationStatus{
status
message
numberOfTrunks
serverSettings{
sms
fax
international
}
e911Info{
name
number
street1
street2
zip
state
city
}
primarySipServer{
name
registered
userAgent
contactIp
networkIp
ipsMatch
}
secondarySipServer{
name
registered
userAgent
contactIp
networkIp
ipsMatch
}
}
} |
API Response
{
"data": {
"fetchSipStationStatus": {
"status": "true",
"message": "Sipstation status found",
"numberOfTrunks": "1",
"serverSettings": {
"sms": true,
"fax": false,
"international": false
},
"e911Info": {
"name": "test",
"number": "1234",
"street1": "test ",
"street2": "",
"zip": "12342",
"state": "test",
"city": "test"
},
"primarySipServer": {
"name": "test1",
"registered": "1",
"userAgent": "test",
"contactIp": "0.0.0.0",
"networkIp": "0.0.0.0",
"ipsMatch": "yes"
},
"secondarySipServer": {
"name": "test2",
"registered": "1",
"userAgent": "test",
"contactIp": "1.0.0.0",
"networkIp": "1.0.0.0",
"ipsMatch": "yes"
}
}
}
} |
Remove Sipstation Key
Remove Sipstation key to into Freepbx/PBXact system.
API:
removeSipStationKey
API Parameters - none
Query Parameters
status
message |
API Request
1. Api to remove Key
GQLAPI: /admin/api/api/gql
parameters:
mutation {
removeSipStationKey(input: {
}) {
status message
}
} |
API Response
{
"data": {
"removeSipStationKey": {
"status": true,
"message": "Sipstation key has been removed"
}
}
} |
Remove Sipstation Key and Delete Trunk
Remove Sipstation key and delete trunk to into Freepbx/PBXact system.
API: removeSipStationKeyAndDeleteTrunk
API Parameters - none
Query Parameters
status
message |
API Request
1. Api to remove Key and delete trunk
GQLAPI: /admin/api/api/gql
parameters:
mutation {
removeSipStationKeyAndDeleteTrunk(input: {
}) {
status message
}
} |
API Response
{
"data": {
"removeSipStationKeyAndDeleteTrunk": {
"status": true,
"message": "Sipstation key has been removed"
}
}
} |