API 接口列表
本文提供了 YCM API 接口列表。
注: 需注意,每个发送到 YCM API 的请求,其头域 (Headers) 中都需要携带 User Agent (UA)
信息,以便星纵统一管理平台能够识别你的应用并响应请求。例如:
User-Agent: OpenAPI
。API 认证
功能 | HTTP 请求方式 | API endpoint |
---|---|---|
请求访问 Token | POST | /dm/open_api/oauth/token |
刷新访问 Token | POST | /dm/open_api/oauth/token |
撤销刷新 Token | DELETE | /dm/open_api/oauth/token/refresh_token |
订阅
功能 | HTTP 请求方式 | API endpoint |
---|---|---|
查询套餐包的订阅信息 | GET | /dm/open_api/v1/subscription |
查询云 PBX 订阅服务统计 | GET | /dm/open_api/v1/subscription/plan_statistics |
云 PBX
功能 | HTTP 请求方式 | API endpoint |
---|---|---|
查询所有云 PBX | GET | /dm/open_api/v2/cloud_pbx/instances |
查询指定云 PBX | GET | /dm/open_api/v1/cloud_pbx/instances/{cloudPbxId} |
查询云 PBX 状态 | GET | /dm/open_api/v1/cloud_pbx/instances/{cloudPbxId}/status |
查询云 PBX 的激活信息 | GET | /dm/open_api/v1/cloud_pbx/instances/{cloudPbxId}/activation_info |
查询云 PBX 的客户 | GET | /dm/open_api/v1/cloud_pbx/instances/{cloudPbxId}/customers |
创建云 PBX | POST | /dm/open_api/v1/cloud_pbx/instances |
发送 PBX 激活邮件 | POST | /dm/open_api/v1/cloud_pbx/instances/{cloudPbxId}/activation_email |
启动云 PBX | PUT | /dm/open_api/v1/cloud_pbx/instances/{cloudPbxId}/start |
更新云 PBX 的信息 | PUT | /dm/open_api/v1/cloud_pbx/instances/{cloudPbxId} |
更新云 PBX 的客户 | PUT | /dm/open_api/v1/cloud_pbx/instances/{cloudPbxId}/customers |
扩容云 PBX | PUT | /dm/open_api/v1/cloud_pbx/instances/{cloudPbxId}/capacity |
停止云 PBX | PUT | /dm/open_api/v1/cloud_pbx/instances/{cloudPbxId}/stop |
删除云 PBX | DELETE | /dm/open_api/v1/cloud_pbx/instances |
客户
集群服务器
YCM 用户
功能 | HTTP 请求方式 | API endpoint |
---|---|---|
查询所有 YCM 用户 | GET | /dm/open_api/v2/users |
查询指定 YCM 用户 | GET | /dm/open_api/v1/users/{userId} |
查询 YCM 用户的订阅信息 | GET | /dm/open_api/v1/users/{userId}/subscription_info |
创建 YCM 用户 | POST | /dm/open_api/v1/users |
发送账号激活邮件 | POST | /dm/open_api/v1/users/{userId}/activation_email |
更新 YCM 用户的信息 | PUT | /dm/open_api/v1/users/{userId} |
更新 YCM 用户的订阅信息 | PUT | /dm/open_api/v1/users/{userId}/subscription_info |
删除 YCM 用户 | DELETE | /dm/open_api/v1/users |
固件
功能 | HTTP 请求方式 | API endpoint |
---|---|---|
查询可用固件版本 | GET | /dm/open_api/v1/firmware |