• +1 844-778-5060
  • hello@pointvoip.com
  • Customer Portal
  • Knowledge Base
  • SALES: (844) 778-5060
  • SUPPORT: (877) 756-3385
Get Started, Contact Us
  • Home
  • About
    • FAQ
    • Careers
  • Services
    • Cloud PBX
    • Messaging
    • Cloud Fax
    • SIP Trunking

    Unified Communications

    Cloud PBX

    Our system gives you all the features you would get with an on-premise system with many additional benefits. Each instance is redundant and is geographically located within your location.

    Learn More
    Cloud Voice
    Cloud Fax
    Messaging
    SIP Trunking
    Toll Free Routing
    911 Access
  • Products
    • Phone Models
    • 3CX PBX
  • Partners
    • Become a Partner
    • Become a Reseller
Get Started

PBX

  • Get PBX Extensions

API

  • Get PBX Extensions

Web Apps

  • Using the Switchboard
  • Manage Your Status
  • Click to Call Extension
  • Sending a Virtual Fax

Mobile Apps

  • Status & Forwarding Rules
  • 3CX App Install

Phones

  • Create a Conference Call (Yealink)
  • Create a Conference Bridge
  • Set Your Voicemail Greeting
  • Call Parking
  • Transferring a Call (Yealink)
  • Home
  • Docs
  • API
  • Get PBX Extensions

Get PBX Extensions

Table of Contents
  • Base URL
    • Example JSON to Get Extensions List
  • POST Parameters
  • Example JSON Response
  • JSON Response Parameters

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 #

ParameterRequiredDescriptionExpected Value
authIdyesYour portal authentication IDstring(24)
authKeyyesYour portal authentication keystring(24)
moduleyesThe api module you are accessingpbx
pbxIdyesThe 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 #

ParameterTypeDescription
messagestringGeneral response message.
countintTotal number of extensions returned.
statusbooleanThe status if the request was successful.
nodestringThe ID of the cloud node this was executed on.
executionTimefloatThe time in seconds it took to execute the API request.
resultarrayContains an array of the returned extensions
result[number]intThe PBX extension number.
result[status]booleanReturns true if the extension is registered and false if it is not.
result[firstName]stringExtension first name
result[lastName]stringExtension last name
result[email]stringExtension email address
result[callerId]stringExtension’s set outbound caller ID
result[e911]arrayReturns an array of E911 parameters, this will return a blank array if none set.
result[e911][subscriber]stringThe E911 subscriber name
result[e911][address1]stringThe E911 registered address line 1.
result[e911][address2]stringThe E911 registered address line 2.
result[e911][city]stringThe E911 registered city.
result[e911][state]stringThe E911 registered state.
result[e911][zip]stringThe E911 registered ZIP code.
result[e911][psapName]stringThe E911 associated PSAP name.
result[lastUpdate]DATETIMEThe last time the record was automatically updated.
Did this document help?
Did this document help?
Share This Article :
  • Facebook
  • Twitter
  • LinkedIn
Still stuck? How can we help?

How can we help?

Updated on November 20, 2020
Table of Contents
  • Base URL
    • Example JSON to Get Extensions List
  • POST Parameters
  • Example JSON Response
  • JSON Response Parameters
Voice
Cloud PBX
SIP Trunking
Toll Free Voice
Messaging
Business Texting
Internal Messaging
Cloud Fax
Products
Desk Phones
3CX PBX
Developers
SMS API
Fax API
Service Status
Realtime
Follow us
Linkedin Instagram Twitter Icon-facebook

© 2022 PointVoIP, LLC. All rights reserved

Terms and Conditions
Privacy Policy
Powered by Pixel Rush Media