Siptalk API Reports / All Services

Navigation

Getting Started

Reports

Services

General Description

This endpoint will allow you to list the extensions on your account.

API URL

https://api.siptalk.com.au/services/list-extensions/

Required Fields

Field Description
apikey The API key created in the portal.
apisecret The API secret created in the portal.

Optional Fields

Field Description
sandbox Can be any non-empty value, including this will make classify the request as readonly and no changes will be made to the system.

Response Fields

Field Type Value Description
extensions array variable Contains an array of the extensions and extension detail.

Success Response

An example response.

{
    "extensions": [
        {
            "datetime": "2013-01-03 11:10:22",
            "number": "1001001",
            "label": "Home Phone",
            "status": "active"
        },
        {
            "datetime": "2013-01-03 11:10:22",
            "number": "1001002",
            "label": "Office Ext 1",
            "status": "active"
        },
        {
            "datetime": "2013-01-03 11:10:22",
            "number": "1001003",
            "label": "Office Ext 2",
            "status": "cancelled",
            "canceltime": "2014-01-03 13:12:21"
        }
}

The Extensions Array Fields

Field Description
datetime The date/time the extension was created.
number The extension.
label The label you created for the extension.
status The current status of the extension.
canceltime The date/time the extension was cancelled.