Get extension list

This API is used to get the list of extensions created on the tenant.

Note:

• For APIs used for Shop, the API key is: <api_key>. The base_url information of the Shop.

• For APIs used for Partner, the API key is: <shop_key>. The base_url information of the Partner.

GetExtensions

POST$BASE_URL.ETelecom/GetExtensions

Body

application/json

pagingktCursorPaging (object)

Response

200

A successful response

Body

application/json

extensionsarray of mrExtension (object)

pagingktCursorPageInfo (object)

Request

JavaScriptCurlPython

const response = await fetch('$BASE_URL.ETelecom/GetExtensions', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "extensions": [
    {
      "account_id": "text",
      "created_at": "2025-01-09T12:44:52.932Z",
      "expires_at": "2025-01-09T12:44:52.932Z",
      "extension_number": "text",
      "extension_password": "text",
      "hotline_id": "text",
      "id": "text",
      "state": "Z",
      "subscription_id": "text",
      "tenant_domain": "text",
      "tenant_id": "text",
      "updated_at": "2025-01-09T12:44:52.932Z",
      "user_id": "text"
    }
  ],
  "paging": {
    "after": "text",
    "before": "text",
    "limit": 0,
    "next": "text",
    "prev": "text",
    "sort": "text"
  }
}

Request:

curl --location '$BASE_URL.Etelecom/GetExtensions' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer $API-KEY' \
--data '{
  "paging": {
    "after": "<string>",
    "before": "<string>",
    "limit": "<integer>",
    "sort": "<string>"
  }
}'

Response:

{
  "extensions": [
    {
      "account_id": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "expires_at": "2019-08-24T14:15:22Z",
      "extension_number": "string",
      "extension_password": "string",
      "hotline_id": "string",
      "id": "string",
      "state": "Z",
      "subscription_id": "string",
      "tenant_domain": "string",
      "tenant_id": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "user_id": "string"
    }
  ],
  "paging": {
    "after": "string",
    "before": "string",
    "limit": 0,
    "next": "string",
    "prev": "string",
    "sort": "string"
  }
}

Return data attribute structure:

School name	Data type	Describe
id	string	Extension ID
extension_number	string	Extension number
extension_password	string	Extension password
tenant_domain	string	Switchboard domain
hotline_id	string	Hotline ID assigned to extension
created_at	string	Extension creation date
expires_at	string	Extension Expiration Date (eg: "2021-03-10T17:07:19+07:00")