Get extension information

This API is used to get previously created extension information.

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.

GetExtensionInfo

post
Body
emailstringOptional
extension_numberstringOptional
phonestringOptional
Responses
200
A successful response
application/json
post
POST /GetExtensionInfo HTTP/1.1
Host: $BASE_URL.ETelecom
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "email": "text",
  "extension_number": "text",
  "phone": "text"
}
200

A successful response

{
  "expires_at": "2025-06-30T19:55:33.578Z",
  "extension_number": "text",
  "extension_password": "text",
  "tenant_domain": "text"
}

Request:

curl --location '$BASE_URL.Etelecom/GetExtensionInfo' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer $API-KEY' \
--data '{
  "email": "<string>",
  "extension_number": "<string>",
  "phone": "<string>"
}'

Response:

{
  "expires_at": "2019-08-24T14:15:22Z",
  "extension_number": "string",
  "extension_password": "string",
  "tenant_domain": "string"
}

Request body structure:

School name
Data type
Describe

extension_number required

string

Extension number

email

string

Email

phone

string

Extension phone number

Return data attribute structure:

School name
Data type
Describe

extension_number

string

Extension number

extension_password

string

Extension password

tenant_domain

string

Switchboard domain

expires_at

string

Extension Expiration Date (eg: "2021-03-10T17:07:19+07:00")

Last updated