Retrive a list of system extensions

GET /system_extensions/list
Retrieves a list of system extensions, and a maximum of 100 extensions will be returned each time.

Request

Placeholders
  • access_token

    string

    required

    Access token is a 32-byte string with validity of 30 seconds.
  • pagination

    integer

    required

    The pagination of paging.
  • pagesize

    integer

    optional

    The pagesize of paging.
  • sort_by

    enum

    optional

    Values include "DEFAULT" and "Optional". Default value will be used when user does not specify value for this field.

Sample Request

https://example.com/api/system_extensions/list?access_token=196ACE20C6F34027895F7F95402BB164&pagesize=100&pagination=1&sort_by=DEFAULT

Response

Placeholders
  • pagination

    integer

    required

    The pagination of paging.
  • pagesize

    integer

    optional

    The pagesize of paging.
  • sort_by

    enum

    optional

    Values include "DEFAULT" and "Optional". Default value will be used when user does not specify value for this field.
  • page_count

    integer

    required

    The total count of pages.
  • count

    integer

    required

    Current pagesize.
  • extensions

    array

    required

    Collection of system extension objects.
    Show child attributes

Sample Response

{
    "pagination": 1,
    "pagesize": 100,
    "sort_by": "DEFAULT",
    "page_count": 100,
    "count": 100,
    "extensions": [
        {
            "extension_number": "1001",
            "type": "RING_GROUP",
            "status": "ONLINE"
        },
        {
            "extension_number": "1002",
            "type": "VOICE_MAIL",
            "status": "ONLINE"
        },
        {
            "extension_number": "1003",
            "type": "CALL_QUEUE",
            "status": "ONLINE"
        },
        {
            "extension_number": "1004",
            "type": "CONFERENCE_ROOM",
            "status": "ONLINE"
        },
        {
            "extension_number": "1005",
            "type": "VIRTUAL_RECEPTIONIST",
            "status": "ONLINE"
        },
        {
            "extension_number": "1006",
            "type": "MOH",
            "status": "ONLINE"
        }
    ]
}