...
Create Extension
Creating an extension into Freepbx/PBXact system.
...
| Code Block |
|---|
{
"data": {
"addExtension": {
"status": true,
"message": "Extension has been created Successfully"
}
}
} |
|
Update Extension
Update extension in FreePBX/PBXACT to do any modification of an existing extension parameters.
...
| Code Block |
|---|
{
"data": {
"updateExtension": {
"status": true,
"message": "Extension has been updated",
"clientMutationId": "test1231"
}
}
} |
|
Delete Extension
Delete an Extension from Freepbx/PBXACT
...
| Code Block |
|---|
{
"data": {
"deleteExtension": {
"status": true,
"message": "Extension has been deleted"
}
}
} |
|
Create Range of Extensions
Create a Rage of extensions starting from given extension number.
...
| Code Block |
|---|
{
"data": {
"createRangeofExtension": {
"message": "Extension's has been created Successfully",
"status": "true"
}
}
} |
|
Fetch a particular extension detail
API Name : fetchExtension
...
| Code Block |
|---|
{
"data": {
"fetchExtension": {
"status": true,
"message": "Extension found successfully",
"id": "ZXh0ZW5zaW9uOjkwOTAwOTAxMTA=",
"extensionId": "9090090110",
"user": {
"name": "APi Test2",
"outboundCid": "12345678901",
"voicemail": "default",
"ringtimer": 0,
"noanswer": "",
"noanswerDestination": "",
"noanswerCid": "",
"busyCid": "",
"sipname": "",
"password" : "password",
"extPassword": "ecc6de2001ceb217a04d5d9ac90f3e1123444c"
},
"coreDevice": {
"deviceId": "9090090110",
"dial": "PJSIP/9090090110",
"devicetype": "fixed",
"description": "APi Test2",
"emergencyCid": "",
}
}
}
} |
|
Fetch all Extensions Details
API Name : fetchAllExtensions
...
| Code Block |
|---|
{
"data": {
"fetchAllExtensions": {
"status": true,
"message": "Extension's found successfully",
"totalCount": 4,
"extension": [
{
"id": "ZXh0ZW5zaW9uOg==",
"extensionId": "100",
"user": {
"name": "100",
"outboundCid": "",
"ringtimer": 0,
"noanswer": "",
"sipname": "",
"password" : "password",
"extPassword": "ecc6de2001ceb217a04d5d9ac90f3e1123444c"
},
"coreDevice": {
"deviceId": "100",
"dial": "PJSIP/100",
"devicetype": "fixed",
"description": "100",
"emergencyCid": ""
}
},
{
"id": "ZXh0ZW5zaW9uOg==",
"extensionId": "101",
"user": {
"name": "101",
"password": "",
"outboundCid": "",
"ringtimer": 0,
"noanswer": "",
"sipname": "",
"password": "password",
"extPassword": "ecc6de2001ceb217a04d5d9ac90f3e1123444c"
},
"coreDevice": {
"deviceId": "101",
"dial": "PJSIP/101",
"devicetype": "fixed",
"description": "101",
"emergencyCid": ""
}
}]
}
} |
|
Fetch all valid extensions
API Name : fetchAllValidExtensions
...
| Code Block |
|---|
{
"data": {
"fetchAllValidExtensions": {
"status": true,
"message": "Valid core extensions",
"count": 2,
"extension": [
{
"id": "ZXh0ZW5zaW9uOg==",
"extensionId": "100",
"user": {
"name": "100",
"password": "",
"outboundCid": "",
"ringtimer": 0,
"noanswer": "",
"sipname": "",
"password" : "password",
"extPassword": "ecc6de2001ceb217a04d5d9ac90f3e1123444c"
},
"coreDevice": {
"deviceId": "100",
"dial": "PJSIP/100",
"devicetype": "fixed",
"description": "100",
"emergencyCid": ""
}
},
{
"id": "ZXh0ZW5zaW9uOg==",
"extensionId": "101",
"user": {
"name": "101",
"password": "",
"outboundCid": "",
"ringtimer": 0,
"noanswer": "",
"sipname": "",
"password": "password",
"extPassword": "ecc6de2001ceb217a04d5d9ac90f3e1123444c"
},
"coreDevice": {
"deviceId": "101",
"dial": "PJSIP/101",
"devicetype": "fixed",
"description": "101",
"emergencyCid": ""
}
}]
}
} |
|
Add Inbound Route
Creating inbound route into Freepbx/PBXact system.
...
| Code Block |
|---|
1. Api to add inbound route
GQLAPI: /admin/api/api/gql
parameters:
mutation {
addInboundRoute(input: {
extension:"71667"
cidnum:"1232abc1232"
description:"Lorem Ipsum"
privacyman:false
alertinfo:"Lorem Ipsum"
ringing:true
mohclass:"Lorem Ipsum"
grppre:"ABC"
delay_answer:12
pricid:false
pmmaxretries:"123"
pmminlength:"12"
reversal:true
rvolume:"12"
fanswer:true
destination:"1233"
}) {
inboundRoute {
id
}
status
message
}
} |
|
...
| Code Block |
|---|
{
"data": {
"addInboundRoute": {
"inboundRoute": {
"id": "71667/1232abc1232"
}
"status": true,
"message": "Inbound Route created successfully"
}
}
} |
|
Update Inbound Route
Updating inbound route into Freepbx/PBXact system.
...
Name | Required | Type | Default | Description |
|---|
oldExtension | Optional | string | | Old Extension. Used to change the current extension |
oldCidnum | Optional | string | | Old CID Num. Used to change the current cid number |
extension | Mandatory | string | | Define the expected DID Number if your trunk passes DID on incoming calls. |
cidnum | Mandatory | string | | Define the CallerID Number to be matched on incoming calls. Can only be numbers, A-D, * and #. DID may also start with a +. Patterns must begin with an _ DID may also start with a +. |
description | Optional | String | | Provide a meaningful description of what this incoming route is |
privacyman | Optional | Boolean | | If no CallerID has been received, Privacy Manager will ask the caller to enter their phone number. If an user/extension has Call Screening enabled, the incoming caller will be prompted to say their name when the call reaches the user/extension. |
alertinfo | Optional | String | | ALERT_INFO can be used for distinctive ring with SIP devices. |
ringing | Optional | Boolean | | Some devices or providers require RINGING to be sent before ANSWER. You'll notice this happening if you can send calls directly to a phone, but if you send it to an IVR, it won't connect the call. |
mohclass | Optional | String | | Set the MoH class that will be used for calls that come in on this route. For example, choose a type appropriate for routes coming in from a country which may have announcements in their language. |
grppre | Optional | String | | CID name prefix |
delay_answer | Optional | Integer | | An optional delay to wait before processing this route. Setting this value will delay the channel from answering the call. This may be handy if external fax equipment or security systems are installed in parallel and you would like them to be able to seize the line. |
pricid | Optional | Boolean | | This effects CID ONLY routes where no DID is specified. If checked, calls with this CID will be routed to this route, even if there is a route to the DID that was called.
Normal behavior is for the DID route to take the calls. If there is a specific DID/CID route for this CID, that route will still take the call when that DID is called |
pmmaxretries | Optional | String | | Number of attempts the caller has to enter a valid CallerID. Default value is 3 |
pmminlength | Optional | String | | Minimum amount of digits CallerID needs to contain in order to be considered valid. Default value is 10 |
reversal | Optional | Boolean | | On PRI channels the carrier will send a signal if the caller indicates a billing reversal.
When checked this route will reject calls that indicate a billing reversal if supported |
rvolume | Optional | String | | Override the ringer volume. Note: This is only valid for Sangoma phones at this time. Default value is 0 |
fanswer | Optional | Boolean | | Set to Yes to force the call to be answered at this time |
destination | Mandatory | String | | Destination for route |
...
| Code Block |
|---|
{
"data": {
"updateInboundRoute": {
"inboundRoute": {
"id": "71667/1232lorem"
}
"status": true,
"message": "Inbound Route updated successfully"
}
}
} |
|
Remove Inbound Route
Remove inbound route from Freepbx/PBXact system.
...
| Code Block |
|---|
{
"data": {
"removeInboundRoute": {
"status": true,
"message": "Inbound Route deleted successfully",
"deletedId": "71667/1232lorem"
}
}
} |
|
Fetch All Inbound Routes
API Name : allInboundRoutes
...
| Code Block |
|---|
{
"data": {
"allInboundRoutes": {
"inboundRoutes": [
{
"id": "71667/1232dsds",
"extension": "71667",
"cidnum": "1232dsds",
"description": "Lorem Ipsum",
"privacyman": false,
"alertinfo": "Lorem Ipsum",
"ringing": true,
"mohclass": "Lorem Ipsum",
"grppre": "ABC",
"delay_answer": 12,
"pricid": false,
"pmmaxretries": 12,
"pmminlength": 12,
"reversal": false,
"rvolume": 12,
"fanswer": false,
"destinationConnection": "Extensions: 4001 Extension 4001"
}
]
}
}
} |
|
Fetch Inbound Route
API Name : inboundRoute
API Parameters to query
...
| Code Block |
|---|
{
"data": {
"inboundRoute": {
"id": "71667/1232dsds",
"extension": "71667",
"cidnum": "1232dsds",
"description": "Lorem Ipsum",
"privacyman": false,
"alertinfo": "Lorem Ipsum",
"ringing": true,
"mohclass": "Lorem Ipsum",
"grppre": "ABC",
"delay_answer": 12,
"pricid": false,
"pmmaxretries": 12,
"pmminlength": 12,
"reversal": false,
"rvolume": 12,
"fanswer": false,
"destinationConnection": "Extensions: 4001 Extension 4001"
}
}
} |
|
Create Core Device
Creating an core device into Freepbx/PBXact system.
...
| Code Block |
|---|
{
"data": {
"addCoreDevice": {
"message": "Core device has been created successfully",
"status": true
}
}
} |
|
Update Core Device
Updating an core device into Freepbx/PBXact system.
...
| Code Block |
|---|
{
"data": {
"updateCoreDevice": {
"message": "Core device has been updated successfully",
"status": true
}
}
} |
|
Fetch a particular core device details
API Name : fetchCoreDevice
...
| Code Block |
|---|
{
"data": {
"fetchCoreDevice": {
"deviceId": "111223345",
"tech": "pjsip",
"dial": "PJSIP/111223345",
"devicetype": "fixed",
"user": {
"id": "Y29yZXVzZXI6"
},
"description": "Lorem Ipsum updated",
"emergencyCid": ""
}
}
} |
|
Fetch all Core Device Details
API Name : fetchAllCoreDevices
...
| Code Block |
|---|
{
"data": {
"fetchAllCoreDevices": {
"coreDevice": [
{
"deviceId": "10007",
"tech": "pjsip",
"dial": "PJSIP/10007",
"devicetype": "fixed",
"user": {
"id": "Y29yZXVzZXI6MTAwMDc="
},
"description": "Test",
"emergencyCid": ""
},
{
"deviceId": "1002",
"tech": "pjsip",
"dial": "PJSIP/1002",
"devicetype": "fixed",
"user": {
"id": "Y29yZXVzZXI6"
},
"description": "Testing-ABC",
"emergencyCid": ""
}
],
"totalCount": 134,
"status": true,
"message": "Core Device's found successfully"
}
}
} |
|
Delete Core Device
Delete an Core Device from Freepbx/PBXACT
...
| Code Block |
|---|
{
"data": {
"deleteCoreDevice": {
"deletedId": "1114334",
"message": "Core device has been deleted successfully",
"status": true
}
}
} |
|
Update Advance Setting's
API Name updateAdvanceSettings API.
...
| Code Block |
|---|
{
"data": {
"updateAdvanceSettings": {
"message": "Setting's updated successfully",
"status": true
}
}
} |
|
Fetch a particular advance settings details
API Name : fetchAdvanceSetting
...
| Code Block |
|---|
{
"data": {
"fetchAdvanceSetting": {
"keyword": "HTTPENABLED",
"value": "0",
"name": "Enable the mini-HTTP Server",
"category": "Asterisk Builtin mini-HTTP server",
"description": "Whether the Asterisk HTTP interface is enabled or not. This is for Asterisk, it is not directly related for FreePBX usage and the value of this setting is irrelevant for accessing core FreePBX settings. Default is no.",
"status": true,
"message": "Setting's found successfully"
}
}
} |
|
Fetch all Advance Settings Details
API Name : fetchAllAdvanceSettings
...