XSwitch

https://docs.xswitch.cn/
Admin
XSwitch provides a one-stop solution for voice, video, conferencing, and AI, meeting enterprises'...
Tokens:1,067,138
Snippets:5,026
Trust Score:5.3
Update:7 months ago
Show doc for...
Tokens:
Raw
### Initialize XSwitch Setup

Source: https://docs.xswitch.cn/installation/installation

This command initiates the XSwitch setup process. It automatically downloads necessary sound files from the XSwitch website and generates a '.env' file containing environment variables for Docker container runtime.

```bash
make setup
```

--------------------------------

### Initialize XSwitch Setup on Windows

Source: https://docs.xswitch.cn/installation/installation

This command initializes the XSwitch setup process on Windows. It uses a build script (build.cmd) to perform the setup, which includes downloading sound files and generating the '.env' configuration file.

```cmd
cd xswitch-community-6.5.2-pre
.\build.cmd setup
```

--------------------------------

### Install Docker on Debian/Ubuntu

Source: https://docs.xswitch.cn/installation/attachment

This snippet provides a one-click installation command for Docker on Debian or Ubuntu systems using a specified mirror for faster downloads. It's suitable for development environments, with a recommendation to consult official documentation for production setups.

```bash
curl -fsSL https://get.docker.com | bash -s docker --mirror Aliyun

```

```bash
curl -sSL https://get.daocloud.io/docker | sh

```

--------------------------------

### Python Test Setup

Source: https://docs.xswitch.cn/rest-api/overview

Commands to set up the Python testing environment, including installing dependencies and running initial setup scripts.

```bash
pip install pytest requests python-dotenv
make setup
```

--------------------------------

### Start XSwitch

Source: https://docs.xswitch.cn/blog/2023-11/xswitch-windows

Starts the XSwitch services using the 'make up' command. After starting, XSwitch can be accessed via a web browser at http://ip:8081.

```bash
make up

```

--------------------------------

### Start XSwitch Services on Windows

Source: https://docs.xswitch.cn/installation/installation

This command starts the XSwitch services on Windows using the build script. It will pull Docker images if they are not already present and then launch the XSwitch containers. The process may take a few minutes for the initial startup.

```cmd
.\build.cmd start
```

--------------------------------

### Start XSwitch Services

Source: https://docs.xswitch.cn/installation/installation

This command starts the XSwitch services. On the first run, it will automatically pull the necessary Docker images. After successful startup, the XSwitch web interface can be accessed via HTTP.

```bash
make up
```

--------------------------------

### Example xlonglive Script for XSwitch

Source: https://docs.xswitch.cn/xswitch-advanced/xswitch-xlonglive

A comprehensive example of an xlonglive script for XSwitch. It demonstrates initializing utilities, database connections, subscribing to FreeSWITCH events (HEARTBEAT and custom), handling RPC calls, and managing script lifecycle (start/stop/check).

```lua
-- Get lua environment information
local cur_dir = debug.getinfo(1).source;
cur_dir = string.gsub(debug.getinfo(1).source, "^@(.+/)[^/]+$", "%1")
if cur_dir:sub(1,1) == '/' then -- plain Lua
	package.path = package.path .. ";/etc/xtra/?.lua"
	package.path = package.path .. ";" .. cur_dir .. "?.lua"
	package.path = package.path .. ";" .. cur_dir .. "vendor/?.lua"
end
-- Get XSwitch internal utility functions component
local utils = require 'utils'
-- And get configuration component from XSwitch config.lua
local config = require 'xtra_config'
-- Get XSwitch database connection component
local xdb = require 'xdb'

-- Create a new database connection instance
local dbh = xdb.new()
if config.db_auto_connect then dbh:connect(config.fifo_cdr_dsn or config.dsn) end

-- Declare this lua script
xlonglive = (require 'xlonglive').new('my_test')

-- Determine the specific action based on argv[1], values can be stop/start/check/purge
if not xlonglive:start(argv[1]) then
	goto donedone
end

function recv_heartbeat(event)
	freeswitch.consoleLog("INFO", "so good, we received a HEARTBEAT event!\n")
end

-- Print a line of log in FreeSWITCH
freeswitch.consoleLog("INFO", "BINDING to HEARTBEAT\n")

-- Subscribe to HEARTBEAT event
con = freeswitch.EventConsumer("HEARTBEAT")
-- Subscribe to events generated by xlonglive named `xlonglive::my_test`
con:bind('CUSTOM', xlonglive.event_name)

-- Start the loop to fetch events
while true do
	::continue::
	-- Continuously block waiting for the next subscribed event
	local event = con:pop(1)
	-- pop timed out after 1 second, if no subscribed event is received within 1 second, continue to the next step
	-- local event = con:pop(1, 1000)
	-- Either of the above pop methods can be chosen

	if event and event:getHeader("Event-Subclass") == xlonglive.event_name then
		-- Received event generated by xlonglive, Event-Subclass is "xlonglive::my_test"
		local action = event:getHeader('Action')
		-- RPC events generated by xlonglive can be generated via xlonglive:new_rpc_event(method)
		if action == 'rpc' then
			reply = xlonglive:new_rpc_reply_event(event)
			reply:addBody("Reply Body")
			freeswitch.consoleLog("INFO", reply:serialize())
			reply:fire()
		end
		if not xlonglive:check(event) then
			-- If a stop script event is received, exit the loop
			freeswitch.consoleLog("INFO", "Stopping my_test ...\n")
			break
		end
		goto continue
	end

	-- Call custom function to print a line of log
	recv_heartbeat(event)
end

-- Cancel event subscription
con:cleanup()

-- Release database connection
if dbh then
	dbh:release()
end

freeswitch.consoleLog("INFO", "my_test script down\n")
::donedone::

```

--------------------------------

### cURL Examples for REST Requests

Source: https://docs.xswitch.cn/ai-api/attachment

Examples demonstrating various HTTP requests using cURL, including GET, PUT, and requests with parameters.

```APIDOC
## cURL Examples

### GET Request

#### Description
Performs a simple GET request to a specified URL.

#### Method
GET

#### Endpoint
`http://www.google.com`

#### Request Example
```bash
curl http://www.google.com
```

### PUT Request

#### Description
Performs a PUT request to a specified URL.

#### Method
PUT

#### Endpoint
`http://192.168.1.100:8080`

#### Request Example
```bash
curl -XPUT http://192.168.1.100:8080
```

### PUT Request with Form Data

#### Description
Performs a PUT request with URL-encoded form data.

#### Method
PUT

#### Endpoint
`http://192.168.1.10:8080`

#### Request Body
- **username** (string) - Required - The username for authentication.
- **password** (string) - Required - The password for authentication.

#### Request Example
```bash
curl -XPUT -d "username=someone&password=1234" http://192.168.1.10:8080
```

### PUT Request with JSON Data

#### Description
Performs a PUT request with JSON data in the request body.

#### Method
PUT

#### Endpoint
`http://192.168.1.10:8080`

#### Request Body
- **username** (string) - Required - The username for authentication.

#### Request Example
```bash
curl -d '{"username":"someone"}' -H "Content-Type: application/json" http://192.168.1.10:8080
```

### HTTP Basic Authentication

#### Description
Performs a request with HTTP Basic Authentication.

#### Method
GET (or other appropriate method)

#### Endpoint
`http://........`

#### Parameters
- **username** (string) - Required - The username for authentication.
- **password** (string) - Required - The password for authentication.

#### Request Example
```bash
curl --basic --user username:password http://........
```

### Debugging Request

#### Description
Performs a request and displays detailed information about the communication.

#### Method
GET (or other appropriate method)

#### Endpoint
`http://.....`

#### Request Example
```bash
curl -v http://.....
```
```

--------------------------------

### Install Docker Engine and Compose on Debian

Source: https://docs.xswitch.cn/installation/attachment

This command sequence installs Docker Engine and Docker Compose on Debian systems. It first removes existing Docker packages, updates the package list, installs necessary certificates and repositories, and finally installs the Docker packages. Ensure you have root privileges or use 'sudo'.

```bash
apt-get remove docker docker-engine docker.io containerd runc
apt-get update
apt-get install ca-certificates curl gnupg lsb-release
mkdir -p /etc/apt/keyrings
curl -fsSL https://download.docker.com/linux/debian/gpg | gpg --dearmor -o /etc/apt/keyrings/docker.gpg
echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/debian \
  $(lsb_release -cs) stable" | tee /etc/apt/sources.list.d/docker.list > /dev/null
apt-get update
apt-get install docker-ce docker-ce-cli containerd.io docker-compose-plugin

```

--------------------------------

### mod_azure ASR Call Example

Source: https://docs.xswitch.cn/mod-api/mod_azure

Provides a system routing example demonstrating how to use the Azure ASR engine with mod_azure. It shows a sequence of commands, starting with answering a call and then using `play_and_detect_speech` to perform speech-to-text analysis.

```bash
answer
play_and_detect_speech /root/10s.wav detect:azure {start-input-timers=true,no-input-timeout=5000,speech-timeout=5000,asr-result-fire-switch-event=true}default

```

--------------------------------

### Install Old Docker Compose Version

Source: https://docs.xswitch.cn/installation/attachment

This snippet provides the shell commands to download and install a specific older version of docker-compose. It uses curl to fetch the binary, then makes it executable and creates a symbolic link for system-wide access. Ensure you have the necessary permissions to write to /usr/local/bin and /usr/bin.

```shell
curl -L https://get.daocloud.io/docker/compose/releases/download/1.27.4/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose
chmod +x /usr/local/bin/docker-compose
ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose
```

--------------------------------

### Initialize and Configure XSwitch Environment

Source: https://docs.xswitch.cn/blog/2023-11/xswitch-windows

Sets up the XSwitch environment by running the setup make command and then modifying the .env file to configure system parameters like external IP, local IP, and database connection strings.

```bash
make setup
vi .env

```

--------------------------------

### Start NATS Service

Source: https://docs.xswitch.cn/installation/installation

This command starts the NATS messaging system, which is used for certain XSwitch functionalities. NATS runs on a default port and can be accessed via a specific URL.

```bash
make nats
```

--------------------------------

### Docker Compose 配置: xswitch-pg 服务

Source: https://docs.xswitch.cn/howto/portainer

此 Docker Compose 文件片段定义了 'xswitch-pg' 服务。它使用 'ccr.ccs.tencentyun.com/free/xswitch-pg:latest' 镜像，配置为使用 'host' 网络模式，并挂载了本地 `/data/postgres` 目录到容器的 `/var/lib/postgresq/data` 路径。

```yaml
version: "3" 

services:
  xswitch-pg:
    container_name: "xswitch-pg"
    image: ccr.ccs.tencentyun.com/free/xswitch-pg:latest
    network_mode: "host"
    restart: always
    env_file: ./.env
    volumes: 
      - /data/postgres:/var/lib/postgresq/data
```

--------------------------------

### Download and Extract XSwitch

Source: https://docs.xswitch.cn/blog/2023-11/xswitch-windows

Downloads the XSwitch community edition tarball using wget and then extracts it to the /usr/local directory. Requires valid user and password for download.

```bash
wget https://xswitch.cn/download/xswitch-community-6.1.2.tar.gz --user xswitch --password password
tar zxvf xswitch-community-6.1.2.tar.gz -C /usr/local
cd /usr/local/xswitch-community-6.1.2

```

--------------------------------

### Docker Compose 卷挂载配置示例

Source: https://docs.xswitch.cn/howto/myd

通过docker-compose.yml文件配置卷挂载，实现自定义音频文件和Lua脚本的永久化。

```YAML
volumes:
  - ./sounds/zh/cn/link/xswitch/grade_welcome.wav:/usr/local/freeswitch/sounds/zh/cn/link/xswitch/grade_welcome.wav
  - ./scripts/grade_ivr.lua:/usr/local/freeswitch/xui/lua/xui/xui/scripts/grade_ivr.lua
```

--------------------------------

### Install Wget on Debian

Source: https://docs.xswitch.cn/blog/2023-11/xswitch-windows

Installs necessary packages including make, zip, and wget on a Debian system using apt-get. This is a prerequisite for downloading XSwitch.

```bash
apt-get update
apt-get install -y make zip wget

```

--------------------------------

### 配置通用 ODBC 连接 (XSwitch)

Source: https://docs.xswitch.cn/howto/db

展示了如何编辑 `/etc/odbc.ini` 文件来配置通用的 ODBC 连接，包括连接 PostgreSQL 的两个示例 (`[freeswitch]` 和 `[xui]`)。配置项涵盖驱动路径、服务器名、端口、用户名、密码和数据库名等。

```ini
[freeswitch]
# X84-64
#Driver      = /usr/lib64/odbc/psqlodbca.so
Driver      = /usr/lib64/odbc/psqlodbcw.so
# ARM64
#Driver = /usr/lib/aarch64-linux-gnu/odbc/psqlodbca.so
#Driver = /usr/lib/aarch64-linux-gnu/odbc/psqlodbcw.so
Description = PostgreSQL
Servername  = xswitch-pg
Port        = 5432
Protocol    = 6.4
FetchBufferSize = 99
Username        = freeswitch
Password        = freeswitch
Database        = freeswitch
ReadOnly        = no
Debug           = 1
CommLog         = 1

[xui]
Driver      = /usr/lib64/odbc/psqlodbcw.so
Description = PostgreSQL
Servername  = xswitch-pg
Port        = 5432
Protocol    = 6.4
FetchBufferSize = 99
Username        = xui
Password        = xui
Database        = xui
ReadOnly        = no
Debug           = 1
CommLog         = 1
```

--------------------------------

### Query All Agents - GET Request Example

Source: https://docs.xswitch.cn/callcenter-api/cc-xswitch

This example shows a GET request to the /api/users endpoint to retrieve a list of all agents. The response is paginated and includes details for each agent.

```http
GET /api/users
```

--------------------------------

### Navigate to XSwitch Installation Directory

Source: https://docs.xswitch.cn/installation/installation

This command changes the current directory to the XSwitch installation path. This is typically done after extracting the archive to proceed with the installation or configuration steps.

```bash
cd /usr/local/xswitch-community-6.5.2-pre-trixie
```

--------------------------------

### Configure XSwitch Environment Variables

Source: https://docs.xswitch.cn/installation/installation

This snippet shows example configurations for the '.env' file, which controls Docker container runtime variables. Key parameters include external and internal IP addresses, and the Freeswitch domain. Modifying FREESWITCH_DOMAIN requires running 'bash update.sh'.

```ini
EXT_IP=22.22.2.2     # 这是外网地址（如果是内网使用，填写内网地址即可）
LOCAL_IP=192.168.1.1 # 这是内网地址（如果是内网使用，填写内网地址即可），如果是 Mac 则无此参数
FREESWITCH_DOMAIN=demo.xswitch.cn # 这是填写域的地方（用户或分机的域，可根据需要自行设置，也可以设成 IP 地址）
```

--------------------------------

### Basic Git Workflow Example

Source: https://docs.xswitch.cn/xpedia/coders

Demonstrates a typical Git workflow for cloning a repository, creating a new branch, making edits, committing changes, and pushing to a remote repository to initiate a Pull Request.

```bash
git clone git@git.xswitch.cn/xyt/freeswitch.git
git checkout -b new-feature-branch
edit
git diff
git commit
git diff --cached
git push

```

--------------------------------

### Docker Compose 配置: xswitch 服务

Source: https://docs.xswitch.cn/howto/portainer

此 Docker Compose 文件片段定义了 'xswitch' 服务。它使用 'ccr.ccs.tencentyun.com/free/xswitch-lua-free:4.0.0' 镜像，配置了日志驱动和大小限制，并挂载了多个本地目录用于存储日志、上传文件、VOSK 模型、存储数据、声音文件以及配置文件。

```yaml
version: "3" 

services:
  xswitch:
    container_name: "xswitch"
    image: ccr.ccs.tencentyun.com/free/xswitch-lua-free:4.0.0
    network_mode: host
    logging:
      driver: "json-file"
      options:
        max-file: "10"
        max-size: "200m"
    restart: always
    env_file: ./.env
    ulimits:
      core: -1
    privileged: true
    stdin_open: true
    tty: true
    volumes: 
      - /data/log:/usr/local/freeswitch/log
      - /data/storage/upload:/usr/local/freeswitch/storage/upload
      - /data/storage/vosk:/usr/local/freeswitch/storage/vosk
      - /data/storage:/usr/local/freeswitch/storage
      - /data/sounds:/usr/local/freeswitch/sounds
      - /data/blocks:/usr/local/freeswitch/blocks
      - /data/xtra_config.lua:/etc/xtra/xtra_config.lua
```

--------------------------------

### Install Debian on Windows using WSL

Source: https://docs.xswitch.cn/installation/attachment

This command installs the Debian Linux distribution on Windows using the Windows Subsystem for Linux (WSL). After installation, you will be prompted to create a username and password for your Debian environment. This is a prerequisite for installing Docker within WSL.

```bash
wsl --install -d Debian

```

--------------------------------

### Install CentOS Tools (yum)

Source: https://docs.xswitch.cn/installation/prepare

Installs necessary tools such as make, zip, and wget on CentOS 7 systems using the yum package manager. These utilities are prerequisites for setting up XSwitch.

```shell
yum install -y make zip wget

```

--------------------------------

### GET /api/meetings/immediate_meeting - Get Immediate Meeting Number

Source: https://docs.xswitch.cn/rest-api/meetings

Retrieves a unique meeting number suitable for starting an immediate, ad-hoc meeting.

```APIDOC
## GET /api/meetings/immediate_meeting

### Description
Retrieves a unique meeting number suitable for starting an immediate, ad-hoc meeting. The number returned is a 9-digit number starting with '72'.

### Method
GET

### Endpoint
/api/meetings/immediate_meeting

### Request Example
```bash
curl -XGET -H "X-XTRA-AUTH-ID: 62dd0173-4916-4b1c-b958-546e4d7c91fe" 192.168.1.100:8081/api/meetings/immediate_meeting
```

### Response
#### Success Response (200)
- **Response Body** (string) - A 9-digit meeting number starting with '72'.

#### Response Example
```
722458261
```
```

--------------------------------

### TTS Playback Example

Source: https://docs.xswitch.cn/mod-api/mod_huawei

This example demonstrates how to use the 'answer' and 'speak' commands for TTS playback. It shows how to specify a TTS engine, a speaker, and the text to be spoken.

```APIDOC
## POST /tts/speak

### Description
Initiates a TTS playback with specified engine, speaker, and text.

### Method
POST

### Endpoint
/tts/speak

### Parameters
#### Query Parameters
- **engine** (string) - Required - The TTS engine to use (e.g., `huawei`).
- **speaker** (string) - Required - The voice/speaker to use (e.g., `chinese_xiaoyan_common`).
- **text** (string) - Required - The text content to be spoken.

### Request Example
```
answer
speak huawei|chinese_xiaoyan_common|这是一个测试字符串。
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.

#### Response Example
```json
{
  "status": "success"
}
```
```

--------------------------------

### REST API: Get All Extensions

Source: https://docs.xswitch.cn/rest-api/overview

Example of a REST API GET request to retrieve a collection of resources, typically represented in plural form.

```http
GET /api/extensions
```

--------------------------------

### 配置 MSSQL 数据库 ODBC 连接 (XSwitch)

Source: https://docs.xswitch.cn/howto/db

提供了配置 `odbc.ini` 文件以通过 ODBC 连接 MSSQL 数据库的示例。配置项包括驱动程序路径、服务器信息、用户凭据和数据库选项。

```ini
[MYSQL]
Driver=/usr/lib/x86_64-linux-gnu/odbc/libmyodbc8w.so
Description =MySQL ODBC 8.0 Unicode Driver
SERVER      = 192.168.3.164
PORT        = 3306
USER        = root
Password    = root
Database    = mysql
OPTION      = 3
charsetI    =UTF8
```

--------------------------------

### 测试 ODBC 连接 (XSwitch)

Source: https://docs.xswitch.cn/howto/db

提供了一个使用 `isql` 命令测试 ODBC 连接的示例。该命令用于验证 `/etc/odbc.ini` 中配置的数据库连接是否正常工作。

```bash
isql -v xui xui xui
```

--------------------------------

### REST API: Get Single Extension by UUID

Source: https://docs.xswitch.cn/rest-api/overview

Example of a REST API GET request to retrieve a specific resource using its unique identifier (UUID).

```http
GET /api/extensions/$uuid
```

--------------------------------

### Prepare and Install Harbor

Source: https://docs.xswitch.cn/blog/2023-03/harbor

These commands involve extracting the Harbor installation package, navigating into the directory, backing up the configuration file, modifying it to set the correct hostname, and then executing the preparation and installation scripts. Ensure you have downloaded the Harbor offline installer package beforehand.

```bash
[root@localhost harbor]# tar -xvf harbor-offline-installer-v2.4.2.tgz
[root@localhost harbor]# cd harbor
[root@localhost harbor]# cp harbor.yml harbor.yml.bak
[root@localhost harbor]# vim harbor.yml
hostname:192.168.43.19
[root@localhost harbor]# ./prepare
[root@localhost harbor]# ./install.sh
```

--------------------------------

### System Route Examples in XSwitch

Source: https://docs.xswitch.cn/xswitch-lite/call

Demonstrates the use of system routes for advanced XSwitch configurations, including executing standard FreeSWITCH applications like 'answer' and 'echo', playing back audio files, and integrating with external controllers like XCC.

```text
answer
echo

```

```text
answer
playback http://ip:port/welcome.wav

```

```text
xcc cn.xswitch.ctrl.chatgpt

```

--------------------------------

### cURL GET Request Example

Source: https://docs.xswitch.cn/ai-api/attachment

Demonstrates a basic GET request using cURL to fetch content from a specified URL. This is a fundamental operation for retrieving data from web services.

```bash
curl http://www.google.com
```

--------------------------------

### Get Hotline - cURL Example

Source: https://docs.xswitch.cn/callcenter-api/rest-api

This example shows how to retrieve details for a specific hotline number using its ID via a cURL command. It requires a user token for authentication.

```bash
curl -XPOST -H "token: db232730-8885-42c9-b60a-25072e8f4957" \
    -H "Content-Type: application/json" \
    -d '{"id":"3"}' \
    localhost:8081/api/xcc/hostlines/get
```

--------------------------------

### Makefile for Document Deployment

Source: https://docs.xswitch.cn/xpedia/markdown

Shows a simple Makefile example for copying generated PDF files to a specified network drive destination, facilitating document sharing.

```makefile
DEST := ~/Library/Containers/com.tencent.WeWorkMac/Data/WeDrive/小樱桃科技/项目与方案/解决方案/


install:
	cp ../pdf/xswitch-*.pdf $(DEST)
```

--------------------------------

### Get Port Configuration - GET api/system/port

Source: https://docs.xswitch.cn/rest-api/manage

Fetches the current port configurations for various services like RTP, SIP, and Verto. This GET request returns a JSON object detailing the start and end ports for RTP, and specific ports for SIP and Verto.

```json
{
	"data": {
		"rtp_start_port": "19000",
		"rtp_end_port": "19100",
		"sip_wss_port": "",
		"sip_tls_port": "",
		"verto_ws_port": "18081",
		"agora_rtp_end": "",
		"agora_rtp_start": "",
		"sip_public_port": "5080",
		"sip_ws_port": "",
		"bfcp": "",
		"sip_port": "5060",
		"verto_wss_port": "8082"
	},
	"code": 200,
	"message": "success"
}
```

--------------------------------

### 配置达梦数据库 ODBC 连接 (XSwitch)

Source: https://docs.xswitch.cn/howto/db

展示了如何配置 `odbcinst.ini` 和 `odbc.ini` 文件以通过 ODBC 连接达梦数据库。这包括指定驱动程序的路径和数据库连接参数。

```ini
[DM8 ODBC DRIVER]
Description = DM ODBC DRIVER FOR DM8
Driver      = /opt/dmdbms/bin/libdodbc.so

[DM]
DRIVER = DM8 ODBC DRIVER
SERVER = 192.168.3.164
UID = SYSDBA
PWD = SYSDBA001
TCP_PORT = 5236
```

--------------------------------

### TTS Example Call

Source: https://docs.xswitch.cn/mod-api/mod_ali

This section demonstrates how to use the TTS engine by first executing the 'answer' application and then calling the 'speak' command with a specified voice and text.

```APIDOC
## POST /tts/speak

### Description
Executes the TTS engine to speak a given string with a specified voice.

### Method
POST

### Endpoint
/tts/speak

### Parameters
#### Query Parameters
- **voice** (string) - Required - The voice to use for TTS (e.g., 'zhixiaoxia').
- **text** (string) - Required - The text string to be spoken.

### Request Example
```
{
  "voice": "zhixiaoxia",
  "text": "这是一个测试字符串。"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success or failure of the operation.

#### Response Example
```
{
  "status": "success"
}
```
```

--------------------------------

### Get User Count using cURL

Source: https://docs.xswitch.cn/rest-api/user

Example of retrieving the user count using cURL. This demonstrates a GET request to the /api/users/total endpoint with the necessary authentication and content type headers.

```bash
curl -XGET -H "X-XTRA-AUTH-ID: 790480b3-d930-435a-87c4-6990e01cafc9" -H "Content-Type: application/json" "http://192.168.31.98:8081/api/users/total"
```

--------------------------------

### Get Default Domain Information using cURL

Source: https://docs.xswitch.cn/rest-api/user

Example of retrieving default domain information using cURL. This demonstrates a GET request to the /api/users/force_domain/default endpoint with authentication and content type headers.

```bash
curl -0 -H "X-XTRA-AUTH-ID: 790480b3-d930-435a-87c4-6990e01cafc9" -H "Content-Type: application/json" "http://192.168.31.98:8081/api/users/force_domain/default"
```

--------------------------------

### Get Current User Information using cURL

Source: https://docs.xswitch.cn/rest-api/user

Example of retrieving current user information using cURL. This demonstrates a GET request to the /api/users/info endpoint with authentication and content type headers.

```bash
curl -0 -H "X-XTRA-AUTH-ID: 790480b3-d930-435a-87c4-6990e01cafc9" -H "Content-Type: application/json" "http://192.168.31.98:8081/api/users/info"
```
Tokens:
Raw