Get hotline list

This API is used to get the list of hotlines that have been attached to 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.

GetHotlines

POST$BASE_URL.ETelecom/GetHotlines

Body

application/json

pagingktCursorPaging (object)

Response

200

A successful response

Body

application/json

hotlinesarray of mrHotline (object)

pagingktCursorPageInfo (object)

Request

JavaScriptCurlPython

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

Response

200

{
  "hotlines": [
    {
      "connection_id": "text",
      "connection_method": "unknown",
      "created_at": "2025-01-09T21:52:08.886Z",
      "description": "text",
      "hotline": "text",
      "id": "text",
      "is_free_charge": false,
      "name": "text",
      "network": "unknown",
      "owner_id": "text",
      "status": "Z",
      "updated_at": "2025-01-09T21:52:08.886Z"
    }
  ],
  "paging": {
    "after": "text",
    "before": "text",
    "limit": 0,
    "next": "text",
    "prev": "text",
    "sort": "text"
  }
}

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	Status Z: Newly created P: Enable N: Disable