API 接口列表

本文提供了 YCM API 接口列表。

注： 需注意，每个发送到 YCM API 的请求，其头域 (Headers) 中都需要携带 User Agent (UA) 信息，以便Yeastar 统一管理平台能够识别你的应用并响应请求。例如：User-Agent: OpenAPI。

API 认证

表 1.
功能 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
查询远程管理连接数 GET /dm/open_api/v1/subscription/rm_connections

云 PBX

表 2.
功能 HTTP 请求方式 API endpoint
查询所有云 PBX GET /dm/open_api/v2/cloud_pbx/instances
使用 ID 查询指定云 PBX GET /dm/open_api/v1/cloud_pbx/instances/{cloudPbxId}
使用 URL 查询指定云 PBX GET /dm/open_api/v1/cloud_pbx/instances/get
查询云 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/shared_trunk/pbx/used
查询分配给云 PBX 的 DID 号码 GET /dm/open_api/v1/did_management/{cloudPbxId}/did
查询云 PBX 的客户 GET /dm/open_api/v1/cloud_pbx/instances/{cloudPbxId}/customers
查询可用区域 GET /dm/open_api/v1/cluster/regions
查询可用域名 GET /dm/open_api/v1/cluster/domains
创建云 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 的 DID 关联关系 PUT /dm/open_api/v1/cloud_pbx/instances/{cloudPbxId}/did
更新云 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
调用云 PBX 的 GET 接口 GET dm/open_api/v1/cloud_pbx/{sn}/**
调用云 PBX 的 POST 接口 POST dm/open_api/v1/cloud_pbx/{sn}/**

共享中继

功能 HTTP 请求方式 API endpoint
查询所有共享中继 GET /dm/open_api/v1/shared_trunk
查询指定共享中继 GET /dm/open_api/v1/shared_trunk/{id}
查询指定共享中继的状态 GET /dm/open_api/v1/shared_trunk/{id}/status
查询共享中继的 SIP 运营商 GET /dm/open_api/v1/shared_trunk/itsp
创建共享中继 POST /dm/open_api/v1/shared_trunk
更新共享中继 PUT /dm/open_api/v1/shared_trunk/{id}
删除共享中继 DELETE /dm/open_api/v1/shared_trunk

DID 管理

功能 HTTP 请求方式 API endpoint
查询所有 DID 号码 GET /dm/open_api/v1/did_management
查询指定 DID 号码 GET /dm/open_api/v1/did_management/{didId}
添加 DID 号码 POST /dm/open_api/v1/did_management
更新 DID 号码 PUT /dm/open_api/v1/did_management
删除 DID 号码 DELETE /dm/open_api/v1/did_management

客户

功能 HTTP 请求方式 API endpoint
查询所有客户 GET /dm/open_api/v1/customers
查询指定客户 GET /dm/open_api/v1/customers/{customerId}
创建客户 POST /dm/open_api/v1/customers
更新客户信息 PUT /dm/open_api/v1/customers/{customerId}
删除客户 DELETE /dm/open_api/v1/customers

YCM 用户

表 3.
功能 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

备份包

功能 HTTP 请求方式 API endpoint
查询所有备份包 GET /dm/open_api/v1/backup_file
还原备份包 POST /dm/open_api/v1/backup_file/restore
查询还原状态 GET /dm/open_api/v1/backup_file/restore_result/{restoreDstPbxSn}

配置模板

功能 HTTP 请求方式 API endpoint
查询所有配置模板 GET /dm/open_api/v1/provision_template