Create extension

This API is used to create extensions 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.

CreateExtension

post

Body

extension_numberintegerOptional

hotline_idstring · int64Optional

user_idstring · int64Optional

Responses

200

A successful response

application/json

post

HTTPcURLJavaScriptPython

POST /CreateExtension HTTP/1.1
Host: $BASE_URL.ETelecom
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "extension_number": 1,
  "hotline_id": "text",
  "user_id": "text"
}

200

A successful response

{
  "account_id": "text",
  "created_at": "2025-06-15T03:10:29.039Z",
  "expires_at": "2025-06-15T03:10:29.039Z",
  "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-06-15T03:10:29.039Z",
  "user_id": "text"
}

Request:

curl --location '$BASE_URL.Etelecom/CreateExtension' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer $API_KEY' \
--data '{
  "extension_number": 1001,
  "hotline_id": "string",
  "user_id": "string"
}'

Response Sample:

{
  "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"
}

Request body structure:

School name	Data type	Describe
hotline_id required	string	ID hotline
extension_number required	int	Extension number
user_id	string	Employee ID assigned to extension

Return data attribute structure:

School name	Data type	Describe
id	string	Extension ID
user_id	string	Employee ID assigned to extension
account_id	string	Account ID
extension_number	string	Extension number
extension_password	string	Extension password
tenant_id	string	Call center ID
tenant_domain	string	Domain of the switchboard
hotline_id	string	Hotline ID
created_at	string	Extension initialization time
updated_at	string	Extension update time
expires_at	string	Extension Expiration Time
subscription_id	string<date-time>	Registration ID
state	string	Status Z: Newly created P: Valid N: Expired