Metadata-Version: 2.4
Name: tinet-cticloud-cli
Version: 0.0.7
Summary: CTICloud OpenAPI CLI — 24 interfaces (task, cdr, record, monitor)
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: click>=8.0
Requires-Dist: httpx>=0.27
Provides-Extra: dev
Requires-Dist: pytest>=8.0; extra == "dev"
Requires-Dist: pytest-httpx>=0.30; extra == "dev"
Dynamic: description
Dynamic: description-content-type
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# tinet-cticloud-cli

CTICloud 命令行客户端（**0.0.7**），封装 **24 个** OpenAPI 接口，与 `cti-link-wiki` 中预测式外呼、任务呼叫记录、**平台监控与实时统计**文档**参数与响应一致**，适合脚本化集成与 Agent 调用。

## 功能概览

| 子命令 | 说明 |
|--------|------|
| **`task`** | 预测/自动外呼任务全生命周期：创建、查询、更新、启动/暂停/结束、删除；号码导入与查询；任务批次列表/详情；运行中任务监控总览与详情 |
| **`cdr`** | 外呼任务呼叫记录（话单）查询，支持 Wiki 全量筛选与 `--all` 自动翻页 |
| **`record`** | 根据录音文件名获取试听/下载 URL，可选 `--output` 落盘 |
| **`monitor`** | 平台监控与实时统计：座席/队列/话机/业务/中继监控；座席/满意度/队列实时统计 |
| **`config`** | 本地凭证管理（`~/.cticloud/config.json`） |

典型闭环：

```text
任务创建 → … → 任务监控 → 话单 → 录音
平台监控 (monitor agent/queue/…) → 实时统计 (monitor statistics-*)
```

### `monitor` 子命令

| 命令 | 说明 |
|------|------|
| `agent` | 座席监控 |
| `enterprise-call-latest` | 企业最新业务监控 |
| `trunk-monitor` | 中继组并发监控 |
| `exten` | 话机监控（`--extens` 或 `--cnos` 二选一） |
| `queue` | 队列监控（`--queue-monitor-fields` 必填） |
| `statistics-agent` | 座席实时统计 |
| `statistics-investigation` | 满意度调查实时统计 |
| `statistics-queue` | 队列实时统计 |

## 环境要求

- Python **≥ 3.10**
- 运行时需访问 `api-{region}.cticloud.cn`
- CTICloud 部门 token（环境变量或配置文件）

## 安装

```bash
pip install tinet-cticloud-cli
tinet-cticloud-cli --version   # 0.0.7
tinet-cticloud-cli --help
```

macOS 等受限环境可使用 [pipx](https://pipx.pypa.io/)：

```bash
pipx install tinet-cticloud-cli
```

从源码安装（开发）：

```bash
cd cli-anything-cticloud/agent-harness
pip install -e ".[dev]"
```

## 配置凭证

**环境变量：**

```bash
export CTICLOUD_REGION=1
export CTICLOUD_VALIDATE_TYPE=2
export CTICLOUD_ENTERPRISE_ID=your_enterprise_id
export CTICLOUD_TOKEN=your_token
```

**或配置文件：**

```bash
tinet-cticloud-cli config set \
  --region 1 \
  --validate-type 2 \
  --enterprise-id your_enterprise_id \
  --token your_token
```

## 快速示例

```bash
# 查询任务列表
tinet-cticloud-cli task query --limit 10

# 任务监控总览（运行中或暂停）
tinet-cticloud-cli task monitor-tasks --status 2

# 查询呼叫记录
tinet-cticloud-cli cdr list-auto-task --start-time 1700000000 --start-time-end 1700086400

# 平台监控与实时统计（--json 输出 Wiki 原始 JSON）
tinet-cticloud-cli --json monitor agent --limit 10
tinet-cticloud-cli --json monitor enterprise-call-latest
tinet-cticloud-cli --json monitor queue --queue-monitor-fields queueParams --qnos 1000
tinet-cticloud-cli --json monitor statistics-queue
```

全局 `--json` 输出 Wiki 原始 JSON；默认人类可读摘要，并对手机号、`password` / `encryptPassword` 等敏感字段脱敏。

## 文档

- 完整使用指南：源代码仓库 `cli-anything-cticloud/CTICLOUD-CLI.md`
- 包内参数与 Wiki 对照：安装包内 `cli_anything/cticloud/README.md`
