eTelecom docs
English
English
  • INSTRUCTIONS FOR USE
    • Administration page for cs.etelecom
    • Google Chrome Extension
    • App eTelecom
  • API INTEGRATION
    • Shop
      • Account
      • Usage
    • Partner
      • Account
      • Usage
    • VPBX
      • VoIP SDK
        • Android
        • iOS
        • Web
        • Flutter
      • PBX REST APIs
        • Partner Get Tenant List
        • Partner Add Hotline
        • Partner Get Hotline List
        • Partner Activate Tenant
        • Partner Add Hotline To Tenant
        • Partner Removed Hotline From Tenant
        • Partner Remove Hotline
        • Create Tenant
        • Get Tenant information
        • Get Driver Config
        • Get hotline list
        • Create Account User
        • Get List User
        • Create extension
        • Get extension information
        • Get extension list
        • Assign extension to user
        • Change hotline for extension
        • Remove User Of Extension
        • Get call history
    • Zalo Cloud
      • Instructions for connecting Zalo Cloud
      • Zalo Cloud API
        • Create OA authorization link
        • Connect OA
        • Get refresh token
        • Get OA list
        • Get OA information
        • Update Webhook for OA
        • Get list of users
        • Send Text Consulting
        • Send Consulting message according to user information request form
        • Send advice message with sticker
        • Send message Consulting with attached photo
        • Send message Consulting attached file
        • Send transaction message
        • Upload file
        • Send request for calling permission
        • Check if the customer has granted calling permission
        • Get list of requests for calling permission
        • Create a news template
        • Get sample details
        • Get list of news samples
        • Journey Token Creation
        • Get Journey Token Details
        • Get Journey Token List
        • Get message list
        • Get message details
        • Send ZNS
        • Send ZNS with Journey Token
  • SMS BRANDNAME
    • User manual
    • SMS API
      • Send SMS
      • Get message status
      • Get sample details
Powered by GitBook
On this page
  1. API INTEGRATION
  2. VPBX
  3. PBX REST APIs

Partner Get Hotline List

This API allows Partners to retrieve previously created hotline lists.

PreviousPartner Add HotlineNextPartner Activate Tenant

Last updated 5 months ago

Note

  • Please use the one eTelecom provided earlier. The base_url information of the .

Request:

curl --location 'BASE_URL.Etelecom/GetPartnerHotlineList' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer $API_KEY' \
--data '{
  "paging": {
    "after": "string",
    "before": "string",
    "limit": 0,
    "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:

Parameters
Data type
Data type

connection_id

string<int64>

Session ID

connection_method

string

Connection method

created_at

string<date-time>

Initialization time

description

string

Hotline description

hotline

string<int64>

Hotline number

id

string<int64>

Hotline ID

is_free_charge

boolean

true: no balance check when calling false: balance check when calling

name

string

Hotline name

network

string

Networkunknown mobifone vinaphone viettel other

owner_id

string<int64>

Manager ID

status

string

Status

Z: Newly created

P: Enable

N: Disable

updated_at

string

Update date

<api_key>
Partner

GetPartnerHotlineList

post
Body
Responses
200
A successful response
application/json
post
POST /GetPartnerHotlineList HTTP/1.1
Host: $BASE_URL.ETelecom
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "paging": {
    "after": "text",
    "before": "text",
    "limit": 1,
    "sort": "text"
  }
}
200

A successful response

{
  "hotlines": [
    {
      "connection_id": "text",
      "connection_method": "unknown",
      "created_at": "2025-06-15T01:53:50.391Z",
      "description": "text",
      "hotline": "text",
      "id": "text",
      "is_free_charge": true,
      "name": "text",
      "network": "unknown",
      "owner_id": "text",
      "status": "Z",
      "updated_at": "2025-06-15T01:53:50.391Z"
    }
  ],
  "paging": {
    "after": "text",
    "before": "text",
    "limit": 1,
    "next": "text",
    "prev": "text",
    "sort": "text"
  }
}