SIPStation Module GraphQL APIs

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

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 

 

API Request 

 

API Response 

Fetch Sipstation Status

Fetch Sipstation status into Freepbx/PBXact system.

API:  fetchSipStationStatus

 

API Parameters -none

 

Query Parameters 

 

API Request 

 

API Response 

Remove Sipstation Key

Remove Sipstation key to into Freepbx/PBXact system.

API: 

removeSipStationKey

API Parameters - none

 

Query Parameters 

 

API Request 

 

API Response 

Remove Sipstation Key and Delete Trunk

Remove Sipstation key and delete trunk to into Freepbx/PBXact system.

API: removeSipStationKeyAndDeleteTrunk

API Parameters - none

Query Parameters 

 

API Request 

 

API Response 

Return to Documentation Home I Return to Sangoma Support