API 接口 & 事件概览
本文提供 Yeastar P 系列云 PBX API 接口列表和推送事件列表。
重要： 需注意，每个发送到 Yeastar P 系列云 PBX API
的请求，其头域 (Headers) 中都需要携带 User Agent (UA) 信息，以便 PBX 能够识别你的应用并响应请求。例如：
User-Agent:
OpenAPI。API 认证
| HTTP 请求方式 | API endpoint | 说明 |
|---|---|---|
| POST | get_token | 获取 API 访问 token。 |
| POST | refresh_token | 刷新 API 访问 token。 |
| GET | del_token | 撤销 API 访问 token。 |
系统
| HTTP 请求方式 | API endpoint | 说明 |
|---|---|---|
| GET | system/information | 查询 PBX 信息。 |
| GET | system/capacity | 查询 PBX 容量，包括分机数和通话并发数。 |
| GET | system/get_menuoptions | 在创建或更新功能时查询所需的菜单选项信息。 注： 此接口支持查询特定功能的选项信息
(ID、名称或类型)，支持的功能包括 分机、分机组、组织架构/部门、中继、用户角色、企业联系人群组、群语音邮箱、IVR、响铃组、队列和队列坐席、会议室、PIN
码列表等。
|
| POST | system/sendemail | 发送邮件到指定的邮箱地址。 |
分机
| HTTP 请求方式 | API endpoint | 说明 |
|---|---|---|
| GET | extension/list | 查询分机列表。 |
| GET | extension/search | 搜索特定分机。 |
| GET | extension/get | 查询单个分机信息。 |
| GET | extension/query | 查询多个分机信息。 |
| GET | extension/getpassword | 查询单个分机的注册密码和语音信箱密码。 |
| POST | extension/create | 添加分机。 |
| POST | extension/send_welcome_email | 发送 Linkus 欢迎邮件给指定分机。 |
| POST | extension/update | 编辑分机。 |
| GET | extension/delete | 删除分机。 |
组织架构/部门
| HTTP 请求方式 | API endpoint | 说明 |
|---|---|---|
| GET | organization/list | 查询部门列表。 |
| GET | organization/search | 搜索特定部门。 |
| GET | organization/get | 查询单个部门信息。 |
| GET | organization/query | 查询多个部门信息。 |
| POST | organization/create | 添加部门。 |
| POST | organization/update | 编辑部门。 |
| GET | organization/delete | 删除部门。 |
中继
| HTTP 请求方式 | API endpoint | 说明 |
|---|---|---|
| GET | trunk/list | 查询中继列表。 |
| GET | trunk/search | 搜索特定中继。 |
| GET | trunk/get | 查询单个中继的信息。 |
| GET | trunk/query | 查询多个中继的信息。 |
| GET | trunk/itsp_list | 查询 SIP 中继的 SIP 运营商列表。 |
| POST | trunk/create | 添加 SIP 中继。 |
| POST | trunk/update | 编辑 SIP 中继。 |
| GET | trunk/delete | 删除 SIP 中继。 |
通讯录
| HTTP 请求方式 | API endpoint | 说明 |
|---|---|---|
| GET | company_contact/list | 查询企业联系人列表。 |
| GET | company_contact/search | 搜索特定企业联系人。 |
| GET | company_contact/get | 查询单个企业联系人信息。 |
| GET | company_contact/query | 查询多个企业联系人信息。 |
| POST | company_contact/create | 添加企业联系人。 |
| POST | company_contact/update | 编辑企业联系人。 |
| GET | company_contact/delete | 删除企业联系人。 |
企业联系人群组
| HTTP 请求方式 | API endpoint | 说明 |
|---|---|---|
| GET | phonebook/list | 查询企业联系人群组列表。 |
| GET | phonebook/search | 搜索特定企业联系人群组。 |
| GET | phonebook/get | 查询单个企业联系人群组信息。 |
| GET | phonebook/query | 查询多个企业联系人群组信息。 |
| POST | phonebook/create | 添加企业联系人群组。 |
| POST | phonebook/update | 编辑企业联系人群组。 |
| GET | phonebook/delete | 删除企业联系人群组。 |
自动配置
| HTTP 请求方式 | API endpoint | 说明 |
|---|---|---|
| GET | phone/search | 搜索特定 IP 话机。 |
| GET | phone/get | 查询单台 IP 话机的信息。 |
| GET | auto_provisioning/compatibility | 查询添加 IP 话机进行自动配置时所需配置选项的信息。 |
| POST | phone/batchcreate | 批量添加相同供应商和型号的 IP 话机。 |
| POST | phone/batchupdate | 批量编辑使用相同模板的同型号 IP 话机。 |
| POST | phone/batchreprovision | 批量为多台 IP 话机重新下发配置。 |
| POST | phone/batchreboot | 批量重启多台 IP 话机。 |
| POST | phone/batchdelete | 批量删除多台 IP 话机。 |
呼入路由
| HTTP 请求方式 | API endpoint | 说明 |
|---|---|---|
| GET | inbound_route/list | 查询呼入路由列表。 |
| GET | inbound_route/search | 搜索特定呼入路由。 |
| GET | inbound_route/get | 查询单个呼入路由信息。 |
| GET | inbound_route/query | 查询多个呼入路由信息。 |
| POST | inbound_route/create | 添加呼入路由。 |
| POST | inbound_route/update | 编辑呼入路由。 |
| GET | inbound_route/delete | 删除呼入路由。 |
呼出路由
| HTTP 请求方式 | API endpoint | 说明 |
|---|---|---|
| GET | outbound_route/list | 查询呼出路由列表。 |
| GET | outbound_route/search | 搜索特定呼出路由。 |
| GET | outbound_route/get | 查询单个呼出路由信息。 |
| GET | outbound_route/query | 查询多个呼出路由信息。 |
| POST | outbound_route/create | 添加呼出路由。 |
| POST | outbound_route/update | 编辑呼出路由。 |
| GET | outbound_route/delete | 删除呼出路由。 |
语音留言
| HTTP 请求方式 | API endpoint | 说明 |
|---|---|---|
| GET | vm/query | 查询多个分机或群语音信箱中的语音留言。 |
| GET | vm/get | 查询单个分机或群语音信箱中的语音留言。 |
| GET | vm/download | 获取语音留言下载 URL，用于下载指定语音留言。 |
| POST | vm/create | 添加语音留言到指定分机。 |
| POST | vm/update | 更新语音留言的读取状态。 |
| GET | vm/delete | 删除单条语音留言。 |
| GET | vm/delete_extension_vm | 删除指定分机的所有语音留言。 |
IVR
| HTTP 请求方式 | API endpoint | 说明 |
|---|---|---|
| GET | ivr/list | 查询 IVR 列表。 |
| GET | ivr/search | 搜索特定的 IVR。 |
| GET | ivr/get | 查询单个 IVR 信息。 |
| GET | ivr/query | 查询多个 IVR 信息。 |
| POST | ivr/create | 添加 IVR。 |
| POST | ivr/update | 编辑 IVR。 |
| GET | ivr/delete | 删除 IVR。 |
队列
| HTTP 请求方式 | API endpoint | 说明 |
|---|---|---|
| GET | queue/list | 查询队列列表。 |
| GET | queue/search | 搜索特定队列。 |
| GET | queue/get | 查询单个队列信息。 |
| GET | queue/query | 查询多个队列信息。 |
| POST | queue/create | 添加队列。 |
| POST | queue/update | 编辑队列。 |
| GET | queue/delete | 删除队列。 |
| GET | queue/call_status | 查询队列的通话状态。 |
| GET | queue/agent_status | 查询队列的坐席状态。 |
| GET | queue_pause_reason/list | 查询暂停原因列表。 |
| POST | queue_pause_reason/update | 编辑暂停原因列表。 |
| GET | queue_option/get | 查询全局队列设置。 |
| POST | queue_option/update | 编辑全局队列设置。 |
| POST | queue/honor_wrapup_time | 启用或禁用队列间共享休息时间。 |
| GET | queue/agent_login | 队列管理 – 批量签入或签出指定队列中的动态坐席。 |
| GET | queue/agent_pause | 队列管理 – 为指定队列内的坐席暂停或恢复服务。 |
| GET | agent/login | 坐席管理 – 为指定的动态坐席签入或签出单个或多个队列。 |
| GET | agent/pause | 坐席管理 – 暂停或恢复坐席在单个或多个队列中的服务。 |
会议室
| HTTP 请求方式 | API endpoint | 说明 |
|---|---|---|
| GET | conference/list | 查询通过 PBX 管理网页或 API 请求创建的固定会议室列表。 |
| GET | conference/search | 从固定会议室列表中搜索特定会议室。 |
| GET | conference/get | 查询单个固定会议室的信息。 |
| GET | conference/query | 查询多个固定会议室的信息。 |
| GET | query_interim_conference | 查询通过 API 请求添加的临时会议室信息。 |
| GET | conference/viewpassword | 查询指定固定会议室的与会者密码或管理员密码。 |
| GET | conference/query_ongoing_conference | 查询指定正在进行的会议、多个正在进行的会议，或所有正在进行的会议的设置，支持查询固定会议和临时会议。 |
| POST | conference/create | 添加一个固定会议室。 |
| POST | conference/start_interim_conference | 添加并配置临时会议，并实时邀请成员加入会议室。 |
| POST | conference/invite_member | 邀请内部或外部成员加入会议室。 |
| POST | conference/kick_member | 将单个成员、多个成员或所有成员移出会议室。 |
| POST | conference/mute_member | 静音会议室中的单个成员、多个成员或所有成员。 |
| POST | conference/unmute_member | 取消会议室中单个成员、多个成员或所有成员的静音状态。 |
| POST | conference/update | 编辑固定会议室的设置。 |
| GET | conference/delete | 删除指定的固定会议室。 |
广播组
| HTTP 请求方式 | API endpoint | 说明 |
|---|---|---|
| GET | paging/list | 查询广播组列表。 |
| GET | paging/search | 搜索特定广播组。 |
| GET | paging/get | 查询单个广播组信息。 |
| GET | paging/query | 查询多个广播组信息。 |
| POST | paging/create | 添加广播组。 |
| POST | paging/update | 编辑广播组。 |
| GET | paging/delete | 删除广播组。 |
录音
| HTTP 请求方式 | API endpoint | 说明 |
|---|---|---|
| GET | autorecord/get | 查询录音设置。 |
| POST | autorecord/update | 编辑录音设置。 |
PIN 码列表
| HTTP 请求方式 | API endpoint | 说明 |
|---|---|---|
| GET | pin_list/list | 查询 PIN 码列表。 |
| GET | pin_list/search | 搜索特定 PIN 码列表。 |
| GET | pin_list/get | 查询单个 PIN 码列表信息。 |
| GET | pin_list/query | 查询多个 PIN 码列表信息。 |
| POST | pin_list/create | 添加 PIN 码列表。 |
| POST | pin_list/update | 编辑 PIN 码列表。 |
| GET | pin_list/delete | 删除 PIN 码列表。 |
禁止/允许号码
| HTTP 请求方式 | API endpoint | 说明 |
|---|---|---|
| 禁止号码 | ||
| GET | block_numbers/list | 查询禁止号码列表。 |
| GET | block_numbers/search | 搜索特定的禁止号码规则。 |
| GET | block_numbers/get | 查询单个禁止号码规则的信息。 |
| GET | block_numbers/query | 查询多个禁止号码规则的信息。 |
| POST | block_numbers/create | 添加禁止号码规则。 |
| POST | block_numbers/update | 编辑禁止号码规则。 |
| GET | block_numbers/delete | 删除禁止号码规则。 |
| 允许号码 | ||
| GET | allow_numbers/list | 查询允许号码列表。 |
| GET | allow_numbers/search | 搜索特定的允许号码规则。 |
| GET | allow_numbers/get | 查询单个允许号码规则的信息。 |
| GET | allow_numbers/query | 查询多个允许号码规则的信息。 |
| POST | allow_numbers/create | 添加允许号码规则。 |
| POST | allow_numbers/update | 编辑允许号码规则。 |
| GET | allow_numbers/delete | 删除允许号码规则。 |
通话备注
| HTTP 请求方式 | API endpoint | 说明 |
|---|---|---|
| GET | callnotes/get | 获取指定通话的通话备注 |
| GET | callnotes/update | 更新指定通话的通话备注。 |
讯息管理
注： 使用讯息管理功能 API 前，需订阅 隧道服务 以确保
全渠道讯息管理 功能可用，且 API 功能需启用。
| HTTP 请求方式 | API endpoint | 说明 |
|---|---|---|
| 消息渠道 | ||
| GET | message_channel/list | 查询消息渠道列表。 |
| GET | message_channel/search | 搜索特定的消息渠道。 |
| GET | message_channel/get | 查询单条消息渠道的信息 (包括 SMS 短信渠道、WhatsApp 消息渠道和 Facebook 消息渠道)。 |
| GET | message_channel/getlivechat | 查询单条在线咨询渠道的信息。 |
| GET | message_channel/query | 查询多条消息渠道详情 (包括 SMS 短信渠道、WhatsApp 消息渠道和 Facebook 消息渠道)。 |
| GET | message_channel/whatsapp_template | 获取 WhatsApp 消息渠道的消息模板详细信息及内容。 |
| GET | message_channel/embedcode | 获取在线咨询渠道的嵌入代码。 |
| POST | message_channel/uploadphoto | 上传照片到 PBX，以用作在线咨询渠道的自定义客服头像。 |
| POST | message_channel/create | 添加消息渠道 (包括 SMS 短信渠道、WhatsApp 消息渠道和 Facebook 消息渠道)。 |
| POST | message_channel/createlivechat | 添加在线咨询渠道。 |
| POST | message_channel/update | 编辑消息渠道 (包括 SMS 短信渠道、WhatsApp 消息渠道和 Facebook 消息渠道)。 |
| POST | message_channel/updatelivechat | 编辑在线咨询渠道。 |
| GET | message_channel/delete | 删除消息渠道。 |
| 消息队列 | ||
| GET | message_queue/list | 查询消息队列列表。 |
| GET | message_queue/search | 搜索特定的消息队列。 |
| GET | message_queue/get | 查询单个消息队列的信息。 |
| GET | message_queue/query | 查询多个消息队列的信息。 |
| POST | message_queue/create | 添加消息队列。 |
| POST | message_queue/update | 编辑消息队列。 |
| GET | message_queues/delete | 删除消息队列。 |
| 消息群发活动 | ||
| GET | message_campaign/list | 获取消息群发活动列表。 |
| GET | message_campaign/search | 搜索特定消息群发活动。 |
| GET | message_campaign/get | 查询单个消息群发活动的信息。 |
| GET | message_campaign/query | 查询多个消息群发活动的信息。 |
| POST | message_campaign/create | 添加消息群发活动。 |
| POST | message_campaign/update | 编辑消息群发活动。 |
| GET | message_campaign/retry | 重试消息群发活动。 |
| GET | message_campaign/delete | 删除消息群发活动。 |
| 消息会话 | ||
| GET | message_session/list | 查询消息会话列表。 |
| GET | message_session/search | 搜索特定的消息会话。 |
| GET | message_session/get | 查询单个消息会话的信息。 |
| GET | message_session/query | 查询多个消息会话的信息。 |
| POST | message_session/transfer | 转移消息会话。 |
| POST | message_session/close | 关闭消息会话。 |
| POST | message_session/archive | 存档消息会话。 |
| POST | message_session/unarchive | 取消存档消息会话。 |
| GET | message_session/delete | 删除消息会话。 |
| 消息 | ||
| GET | message/get | 查询单个消息会话中的消息。 |
| GET | message/query | 查询多个消息会话中的消息。 |
| POST | message/batchupload | 上传一个或多个文件到 PBX，可用于消息群发活动或单条消息发送。 |
| POST | message/send | 在单个消息会话中发送消息，或者创建消息会话。 |
存储
| HTTP 请求方式 | API endpoint | 说明 |
|---|---|---|
| GET | storage/list | 查询存储设备列表。 |
备份
| HTTP 请求方式 | API endpoint | 说明 |
|---|---|---|
| GET | backup/list | 查询备份文件列表。 |
| GET | backup/search | 搜索特定备份文件。 |
| GET | backup/get | 查询单个备份文件信息。 |
| GET | backup/query | 查询多个备份文件信息。 |
| GET | backup/getstatus | 获取指定备份文件的备份状态。 |
| GET | backup/download | 获取备份文件下载 URL，用于下载备份文件。 |
| POST | backup/create | 添加备份文件。 |
| GET | backup/delete | 删除备份文件。 |
系统日志
| HTTP 请求方式 | API endpoint | 说明 |
|---|---|---|
| GET | system_log/list | 查询系统日志列表。 |
| GET | system_log/download | 获取系统日志文件下载 URL，用于下载单个或多个系统日志文件。 |
API 功能设置
| HTTP 请求方式 | API endpoint | 说明 |
|---|---|---|
| GET | extension_status_monitor/list | 查询 API 功能的分机状态监控设置。 |
| POST | extension_status_monitor/update | 编辑 API 功能的分机状态监控设置。 |
| GET | trunk_status_monitor/list | 查询 API 功能的中继状态监控设置。 |
| POST | trunk_status_monitor/update | 编辑 API 功能的中继状态监控设置。 |
| GET | webhook/query | 查询 Webhook 事件推送设置。 |
| POST | webhook/update | 编辑 Webhook 事件推送设置。 |
| GET | webhook/test | 向指定的 Webhook URL 发送测试消息以测试 Webhook 连接。 |
WebSocket 音频推送
| HTTP 请求方式 | API endpoint | 说明 |
|---|---|---|
| GET | websocketaudiostream/get | 查询 WebSocket 音频推送功能设置。 |
| POST | websocketaudiostream/update | 编辑 WebSocket 音频推送功能设置。 |
录音
| HTTP 请求方式 | API endpoint | 说明 |
|---|---|---|
| GET | recording/list | 查询录音文件列表。 |
| GET | recording/search | 搜索特定录音文件。 |
| GET | recording/download | 获取录音文件下载 URL，用于下载录音文件。 |
| GET | recording/playtoextension | 向指定分机播放录音文件。 |
通话记录 (CDR)
| HTTP 请求方式 | API endpoint | 说明 |
|---|---|---|
| GET | cdr/list | 获取通话记录列表。 |
| GET | cdr/search | 搜索特定通话记录。 |
| GET | cdr/download | 获取通话记录下载 URL，用于下载通话记录文件。 |
| GET | cdr/getoption | 获取通话记录选项。 注： 此接口支持查询通话记录选项的启用状态，例如模糊搜索。
|
| POST | cdr/updateoption | 编辑通话记录选项。 注： 此接口支持更改通话记录选项的启用状态，例如模糊搜索。
|
通话报告
| HTTP 请求方式 | API endpoint | 说明 |
|---|---|---|
| GET | call_report/list | 查询即时通话报告列表。 |
| GET | call_report/detail |
查询指定 IVR / 队列 /坐席通话报告中的通话详情。 |
| GET | call_report/download | 获取下载 URL，用于下载即时通话报告。 |
| GET | call_schedule_report/list | 查询预约通话报告列表。 |
| GET | call_schedule_report/download | 获取下载 URL，用于下载预约通话报告。 |
酒店应用
| HTTP 请求方式 | API endpoint | 说明 |
|---|---|---|
| GET | wakeupcall/list | 查询闹铃列表。 |
| GET | wakeupcall/get | 查询单个分机的闹铃信息。 |
| GET | wakeupcall/query | 查询多个分机的闹铃信息。 |
| POST | wakeupcall/create | 为指定分机添加闹铃。 |
| POST | wakeupcall/update | 编辑闹铃。 |
| GET | wakeupcall/delete | 删除指定分机的闹铃。 |
| POST | hotel/checkout | 为酒店客人退房。 |
呼叫操控接口
| HTTP 请求方式 | API endpoint | 说明 |
|---|---|---|
| GET | call/query | 查询指定通话或指定类型的通话。 |
| POST | call/dial | 发起呼叫。 |
| POST | call/accept_inbound | 在呼入来电控制阶段，接听来电。 |
| POST | call/refuse_inbound | 在呼入来电控制阶段，拒接来电。 |
| POST | call/listen | 监听通话。 |
| POST | call/hold | 保持通话。 |
| POST | call/unhold | 恢复被保持的通话。 |
| POST | call/mute | 通话静音。 |
| POST | call/unmute | 取消通话静音。 |
| POST | call/park | 停泊通话。 |
| GET | call/park_status | 查询被停泊通话的信息。 |
| POST | call/directly_forward_to_voicemail | 将来电转到指定分机的语音信箱。 |
| POST | call/transfer | 呼叫转移，包括盲转和咨询转。 |
| POST | call/add_member | 通话过程中，邀请新成员加入通话。 |
| POST | call/play_prompt | 播放自定义提示音中的语音文件。 |
| POST | call/hangup | 挂断通话。 |
| POST | call/record_start | 开始通话录音。 |
| POST | call/record_pause | 暂停通话录音。 |
| POST | call/record_unpause | 恢复通话录音。 |
uaCSTA 呼叫操控接口
| HTTP 请求方式 | API endpoint | 说明 |
|---|---|---|
| POST | uacsta_call/accept | 通过 uaCSTA 接听来电。 |
| POST | uacsta_call/refuse | 通过 uaCSTA 拒接来电。 |
| POST | uacsta_call/hangup | 通过 uaCSTA 挂断通话。 |
事件报告
| 事件 | 说明 |
|---|---|
| (30005) 组织架构开关状态变更 | 表示组织架构/部门功能状态发生变更，并返回当前功能状态。 |
| (30006) 组织架构信息变更 | 表示组织架构/部门功能配置发生变更，并返回变更信息。 |
| (30007) 分机注册状态变更 | 表示分机注册状态发生变更，并返回分机详情。 |
| (30008) 分机通话状态变更 | 表示分机通话状态发生变更，并返回当前分机通话状态。 |
| (30009) 分机出席状态变更 | 表示分机出席状态发生变更，并返回当前分机出席状态。 |
| (30010) 中继注册状态变更 | 表示中继注册状态发生变更，并返回当前中继状态。 |
| (30011) 通话状态变更 | 表示通话状态发生变更，并返回当前通话状态。 |
| (30012) 通话结束详情推送 | 表示生成新的通话记录，并返回通话详情。 |
| (30013) 呼叫转移报告 | 表示发生呼叫转移事件，并返回通话详情。 |
| (30014) 呼叫前转报告 | 表示发生呼叫前转事件，并返回通话详情。 |
| (30015) 呼叫失败报告 | 表示发生呼叫失败事件，并返回通话详情。 |
| (30016) 来电呼叫请求 | 表示监控的中继上有外线呼入，并返回通话详情。 |
| (30017) DTMF 按键报告 | 表示通话过程中有按键事件，并返回通话信息和按键信息。 |
| (30018) 语音播放结束报告 | 表示语音播放结束，并返回通话详情和播放的语音文件名。 |
| (30019) 满意度调查结果 | 表示来电者完成满意度调查，并返回满意度调查结果。 |
| (30020) uaCSTA 通话报告 | 表示注册在 IP 话机上的分机的通话状态发生变更，并返回 uaCSTA 通话详情。 |
| (30022) 分机信息变更 | 表示分机配置发生变更，并返回变更信息。 |
| (30023) 中继信息变更 | 表示中继配置发生变更，并返回变更信息。 |
| (30024) 多方会议无主持人 | 表示主持人离开了语音会议，并返回语音会议 ID 和主持人分机号码。 |
| (30025) 坐席自动暂停 | 表示队列坐席因未接来电达到最大值而被自动暂停服务，并返回坐席及未接来电信息。 |
| (30026) 坐席响铃超时 | 表示队列坐席响铃超时，并返回坐席及未接来电信息。 |
| (30027) 通话报告下载结果 |
表示通话报告数据检索完成，并返回通话报告下载 URL。 |
| (30028) 通话备注状态变更 | 表示当前通话中通话备注是否可用，并返回通话和通话备注的相关 ID。 |
| (30029) 坐席状态变更 | 表示坐席状态发生变更，并返回变更信息。 |
| (30030) 消息群发失败 | 表示在消息群发活动中出现消息发送失败，并返回发送结果。 |
| (30031) 新消息通知 | 表示第三方应用收到由 PBX API 转发的消息渠道的入站消息，并返回该消息的详细信息。 |
| (30032) 消息发送结果 | 表示第三方应用通过 PBX API 发的消息，且消息的发送状态发生变化，并返回该消息的详细信息。 |
| (30033) 录音下载完成 | 表示录音文件通过 API 异步下载成功。 |