> For the complete documentation index, see [llms.txt](https://docs.etelecom.vn/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.etelecom.vn/api-etelecom-english/api-integration/vpbx/pbx-rest-apis/get-hotline-list.md).

# Get hotline list

This API is used to get the list of hotlines that have been attached to the tenant.

{% hint style="info" %}
**Note:**

* For APIs used for Shop, the API key is: [`<api_key>`](/api-etelecom-english/api-integration/shop/account.md). The base\_url information of the [Shop](/api-etelecom-english/api-integration/shop/account.md).
* For APIs used for Partner, the API key is: [`<shop_key>`](/api-etelecom-english/api-integration/partner/usage.md#retrieve-the-shop_key-information). The base\_url information of the [Partner](/api-etelecom-english/api-integration/partner/account.md).
  {% endhint %}

{% openapi src="/files/98tvgFAALfk6gcxXW2re" path="$BASE\_URL.ETelecom/GetHotlines" method="post" %}
[Etelecom.swagger.json](https://1712041776-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzzTMjVbVjwTuSbEGC7Ya%2Fuploads%2Fgit-blob-a79f1cdcdf6c0710885851e38f1e6c641fafb69b%2FEtelecom.swagger.json?alt=media)
{% endopenapi %}

**Request:**

```
curl --location '$BASE_URL.Etelecom/GetHotlines' \
--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:**

```
{
  "hotlines": [
    {
      "connection_id": "string",
      "connection_method": "unknown",
      "created_at": "2019-08-24T14:15:22Z",
      "description": "string",
      "hotline": "string",
      "id": "string",
      "is_free_charge": true,
      "name": "string",
      "network": "unknown",
      "owner_id": "string",
      "status": "Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "paging": {
    "after": "string",
    "before": "string",
    "limit": 0,
    "next": "string",
    "prev": "string",
    "sort": "string"
  }
}
```

**Return data attribute structure:**

| School name | Data type | Describe                                                                                                                                                        |
| ----------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id          | string    | ID hotline                                                                                                                                                      |
| name        | string    | Hotline name                                                                                                                                                    |
| hotline     | string    | Hotline number                                                                                                                                                  |
| network     | string    | Network                                                                                                                                                         |
| created\_at | string    | Extension creation date                                                                                                                                         |
| update\_at  | string    | Last updated time                                                                                                                                               |
| status      | string    | <p>Status</p><p><strong><code>Z</code></strong>: Newly created</p><p><strong><code>P</code></strong>: Enable</p><p><strong><code>N</code></strong>: Disable</p> |