Extend API Methods

These are the Extend API methods that are used to integrate a Switchvox user and their calls with your web-based business application. 

User Methods

Name

Description

switchvox.users.getMyInfo

Get information about the extension making the API request. Easy way to get account_id for an extension.

switchvox.users.cookies.getPassword

This method fetches the token that can be set in the Cookie header of HTTPS requests for authentication. Cookie authentications is a lighter weight alternative to digest authentication on every request.

switchvox.users.info.getSoftwareVersion

Fetches the software version from the PBX.

switchvox.users.callLogs.search

Searches the call logs on the PBX system for an account.

switchvox.users.convergedDevices.getList

Get a list of Additional Phone extensions for an account. Previously, an 'additional phone' was referred to as a 'converged device'.

switchvox.users.call

Creates a call between two extensions or an extension and an external number.

 

Admin Methods

Name

Description

switchvox.extensions.getInfo

Retrieve simple information about extensions.

switchvox.extensions.search

Search extensions and retrieve simple extension information.

switchvox.extensions.phones.sip.getInfo

Get info about a SIP extension.

General Information

Generic Error Codes

Error Code Formatting

Switchvox Extension Types

 

Unable to render {include} The included page could not be found.