tinet-cticloud-cli 0.1.9

CTICloud / Clink2 命令行客户端，封装 OpenAPI 接口，适合脚本化集成与 Agent 调用。

当前版本： 0.1.9
PyPI： https://pypi.org/project/tinet-cticloud-cli/

功能概览

所有出站 HTTP 请求自动附加：

• X-CtiCloud-CLI-Version: {版本号}
• X-Trace-Id: {UUID}

环境要求

• Python ≥ 3.10
• 通过 endpoint 访问平台 API（CtiCloud 如 https://api-1.cticloud.cn；Clink2 如 https://api-bj.clink.cn）
• 鉴权方式按平台区分（二者不可混用）：
  • CtiCloud：validateType + 企业编号（或部门编号）+ token，请求侧计算 MD5 sign
  • Clink2：AccessKeyId + AccessKeySecret（+ Expires），请求侧计算 HMAC-SHA1 Signature

安装

从 PyPI 安装（推荐）：

pip install tinet-cticloud-cli
tinet-cticloud-cli --version   # 0.1.9
tinet-cticloud-cli --help

指定版本或升级：

pip install 'tinet-cticloud-cli==0.1.9'
pip install --upgrade tinet-cticloud-cli

macOS 等受限环境可使用 pipx：

pipx install tinet-cticloud-cli

配置凭证

配置文件：

# CtiCloud（--validate-type：1 部门编号验证 2 企业编号验证）
tinet-cticloud-cli config set \
  --platform-type cticloud \
  --endpoint https://api-1.cticloud.cn \
  --validate-type 2 \
  --enterprise-id your_enterprise_id \
  --token your_token

# Clink2
tinet-cticloud-cli config set \
  --platform-type clink2 \
  --endpoint https://api-bj.clink.cn \
  --access-key-id your_ak \
  --access-key-secret your_sk \
  --expires 60

多配置（profile）：

--profile 为可选全局参数。凭证解析优先级：

# 创建 CtiCloud profile
tinet-cticloud-cli profile set --name prod \
  --platform-type cticloud \
  --endpoint https://api-1.cticloud.cn \
  --validate-type 2 \
  --enterprise-id your_enterprise_id \
  --token your_token

# 创建 Clink2 profile
tinet-cticloud-cli profile set --name clink-bj \
  --platform-type clink2 \
  --endpoint https://api-bj.clink.cn \
  --access-key-id your_ak \
  --access-key-secret your_sk

tinet-cticloud-cli profile list
tinet-cticloud-cli --profile prod task query --type 1
tinet-cticloud-cli task query --type 1
tinet-cticloud-cli profile use prod
tinet-cticloud-cli profile delete prod

profile 保存在 ~/.cticloud/profile.json，命名规则：^[a-z][a-z0-9-]{0,63}$。

快速示例

# config
tinet-cticloud-cli config show

# profile
tinet-cticloud-cli profile set --name staging \
  --platform-type cticloud \
  --endpoint https://api-5.cticloud.cn \
  --enterprise-id E002 --token tok
tinet-cticloud-cli profile list
tinet-cticloud-cli profile use staging
tinet-cticloud-cli task query --type 1
tinet-cticloud-cli --profile staging task query --type 1

# task 
tinet-cticloud-cli task get --task-id 34
tinet-cticloud-cli task query --type 1 --limit 10
tinet-cticloud-cli --profile clink-bj task query --type 2
tinet-cticloud-cli task list-tel --task-id 34
tinet-cticloud-cli task list-file --task-id 34
tinet-cticloud-cli task get-file --task-id 34 --file-id 59

# agent
tinet-cticloud-cli agent query --limit 10
tinet-cticloud-cli agent get --cno 2000
tinet-cticloud-cli agent login --cno 2000 --bind-tel 13800000001 --bind-type 1
tinet-cticloud-cli agent create --cno 9001 --name 张三 --area-code 010
tinet-cticloud-cli agent update --cno 9001 --comment 备注
tinet-cticloud-cli agent preview-outcall --cno 9001 --tel your_tel
tinet-cticloud-cli agent preview-outcall-cancel --cno 9001

# agent-login / agent-report / agent-status / agent-tel
tinet-cticloud-cli agent-login authenticate --cno 9001 --pwd your_password
tinet-cticloud-cli agent-report agent-duration \
  --time-range-type 1 \
  --start-time 2026-07-01 --end-time 2026-07-01
tinet-cticloud-cli agent-status get --cno 9001
tinet-cticloud-cli agent-tel tel-list --cno 9001

# area-code / asr
tinet-cticloud-cli --json area-code get --tel 13800138000
tinet-cticloud-cli --json asr get --call-type 4 --main-unique-id sip-xxx

# cdr
tinet-cticloud-cli --json cdr ib-query --start-time 1700000000 --end-time 1700086400

# data-manager / enterprise*
tinet-cticloud-cli --json data-manager --method get --key your_key
tinet-cticloud-cli --json enterprise get
tinet-cticloud-cli --json enterprise-hotline list-page --limit 10
tinet-cticloud-cli --json enterprise-setting list
tinet-cticloud-cli --json exten get --exten 8001
tinet-cticloud-cli --json hybrid-group list
tinet-cticloud-cli --json investigation query --limit 10
tinet-cticloud-cli --json ivr-router list

# monitor
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

# rasr / record / skill / webcall
tinet-cticloud-cli --json rasr query --unique-id your-unique-id
tinet-cticloud-cli record get-info --record-file your-record-file.mp3
tinet-cticloud-cli --json record get-url --record-file your-record-file.mp3
tinet-cticloud-cli --json record get-batch-url --record-type record --record-file a.mp3,b.mp3
tinet-cticloud-cli --json skill list-relation --relation-type cno --name your-skill
tinet-cticloud-cli webcall --tel your_tel

# task
tinet-cticloud-cli task monitor-tasks --status 2

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

写操作可用全局 --dry-run 做本地校验与预览（不发写请求、不写本地配置），详见 --help。

帮助与 API 文档

tinet-cticloud-cli --help
tinet-cticloud-cli config --help
tinet-cticloud-cli config set --help
tinet-cticloud-cli profile --help
tinet-cticloud-cli task --help

CtiCloud OpenAPI 契约与字段说明见 CTICloud Wiki，Clink2 契约与字段说明见 开发者中心。