Get PBX Extensions

This API endpoint will allow you to pull a list of extensions from your PBX along with any associated information.

Base URL

POST https://portal.vevzo.com/api/v1/get/extensions

Example JSON to Get Extensions List

{
    "authId": "YOUR_API_ID",
    "authKey": "YOUR_API_KEY",
    "module": "pbx",
    "pbxId": "1234"
}

POST Parameters

Parameter	Required	Description	Expected Value
authId	yes	Your portal authentication ID	string(24)
authKey	yes	Your portal authentication key	string(24)
module	yes	The api module you are accessing	pbx
pbxId	yes	The ID of your PBX in the portal.	numeric

Example JSON Response

{
    "message":"2 total extensions found",
    "count":2,
    "result":[
       {
          "number":"1000"
          "status":"1",
          "firstName":"Jane",
          "lastName":"Doe",
          "email":"jane.doe@pointvoip.com",
          "callerId":"+15169005353",
          "e911":{
             "subscriber":"PointVoIP",
             "address1":"329 S. OYSTER BAY RD",
             "address2":"STE 329",
             "city":"PLAINVIEW",
             "zip":"11803",
             "state": "NEW YORK",
             "psapName":"PROVISIONED"
          },
          "lastUpdate":"2020-03-01 12:19:01"
       },
       {
          "number":"1001"
          "status":"1",
          "firstName":"John",
          "lastName":"Doe",
          "email":"john.doe@pointvoip.com",
          "callerId":"+15169005353",
          "e911":[],
          "lastUpdate":"2020-03-01 12:19:01"
       }
 ],
    "status":true,
    "node":"VE-NY-02",
    "executionTime":"0.7100"
 }

JSON Response Parameters

Parameter	Type	Description
message	string	General response message.
count	int	Total number of extensions returned.
status	boolean	The status if the request was successful.
node	string	The ID of the cloud node this was executed on.
executionTime	float	The time in seconds it took to execute the API request.
result	array	Contains an array of the returned extensions
result[number]	int	The PBX extension number.
result[status]	boolean	Returns true if the extension is registered and false if it is not.
result[firstName]	string	Extension first name
result[lastName]	string	Extension last name
result[email]	string	Extension email address
result[callerId]	string	Extension’s set outbound caller ID
result[e911]	array	Returns an array of E911 parameters, this will return a blank array if none set.
result[e911][subscriber]	string	The E911 subscriber name
result[e911][address1]	string	The E911 registered address line 1.
result[e911][address2]	string	The E911 registered address line 2.
result[e911][city]	string	The E911 registered city.
result[e911][state]	string	The E911 registered state.
result[e911][zip]	string	The E911 registered ZIP code.
result[e911][psapName]	string	The E911 associated PSAP name.
result[lastUpdate]	DATETIME	The last time the record was automatically updated.