开发者文档中心

OpenAPI进入控制台

iOS · 2026-10-31

iOS:快速接入

WKWebView 源码示例,需加入自己的宿主工程编译。

下载接入包

开始前准备

  1. 在“渠道 → 自建渠道 → 服务入口”创建专用 Web 入口,启用入口并绑定已发布智能体。需要渠道管理权限;没有入口时请企业管理员协助。
  2. 将 Swift 文件加入最低 iOS 15 的现有 Xcode 工程,合并 Info.plist.fragment.xml 中的麦克风用途说明,使用宿主自己的签名和 Bundle ID。没有预编译 framework 或 CocoaPods 包。

从哪里取得入口参数

参数填写内容获取位置
origin部署客服的公网 HTTPS 主机,不带 /support、路径或查询参数从“服务入口 → 皮肤与代码”的入口链接提取协议和主机
key / publicKey同一入口的公开 UUID key从该入口生成的链接或代码复制 key;Android 字段名为 publicKey
entryId同一入口的 ID从该入口生成的链接或代码复制 entryId,不填写智能体 ID

客户端只填公开参数

管理 API Key、AppSecret 和登录 token 不得放入 App 源码或入口链接。公开 key 不是管理授权;本地会话编号也不代表可信会员身份。

安装与配置

  1. 下载本页客户端接入包,将 ios/YunfuSupportViewController.swift 及准备要求中的配套文件合并到宿主工程,不覆盖原有业务配置。
  2. 填入 HTTPS origin、公开 key(UUID)和 entryId;在用户点击客服后创建并 present 控制器。使用非持久化 WKWebsiteDataStore,不添加 ATS 明文例外。

宿主接入示例

运行前

ios/usage.swift · 宿主调用文件 · 接入包 0.3.15

  • iOS15+ target 同时加入 YunfuSupportViewController.swift 和麦克风用途说明。
  • 由宿主配置产生 HTTPS URL、公开 UUID key 和 entryId,保留函数返回的控制器。
完整代码 · 13 行
ios/usage.swiftSwift
import UIKit

// Add YunfuSupportViewController.swift and microphone Info.plist settings to this same target.
@available(iOS 15.0, *)
@MainActor
func openYunfuSupport(from host: UIViewController, origin: URL,
                      publicKey: UUID, entryId: String) -> YunfuSupportViewController {
    let support = YunfuSupportViewController(origin: origin, publicKey: publicKey, entryId: entryId)
    host.present(support, animated: true)
    return support // Retain it; call closeForAccountChange() before logout/account switch.
}
// Call from the customer's support button, using validated public entry values.
// Starting the page does not start recording. The customer starts voice inside the channel UI.
聊天交互预览 · 本地示意

通用聊天交互示意,回复为固定演示内容;不执行此源码、不连接当前渠道或调用模型。

客户服务助手欢迎咨询

您好,我是您的服务助手。有什么可以帮您?

对应源码:ios/usage.swift。实际效果请在自己的宿主中按下方验收项核对。

预期结果:从客服按钮调用 openYunfuSupport;退出账号前调用控制器 closeForAccountChange。需 Xcode 编译与真机验收。

实际接待范围

容器承载现有 /support 页面:当前读取最近 100 条消息,尚未接线显式转人工按钮与更早历史翻页。人工接待沿服务端路由进入。页面能打开不代表宿主、文件与真实接待已验收。

本平台能力边界

用户开始语音后,仅对当前入口主框架的可信 HTTPS 麦克风请求显示授权;摄像头拒绝。使用渠道现有 Web 语音链路,需同步更新 /support;没有 APNs、后台通话、CallKit 或附件原生保存桥。

怎样确认接入成功

  1. 从自己的 App 入口发送一条带唯一标记的测试问题,确认收到回复,并在接待台找到同一企业、入口和会话。仅页面打开或编译成功不能代替这一步。
  2. 真机验收首次允许/拒绝录音、AI 出声与打断、挂断释放、后台/锁屏/电话中断、耳机、账号切换、安全区、键盘和文件选择。
  3. 退出 A 账号后用 B 账号重新进入,确认 B 看不到 A 的内容;挂断或离开页面后确认录音指示消失。

没有成功时先检查

现象下一步
页面打不开 / 连接被拒绝先核对 HTTPS 证书、origin 与同一入口的 key / entryId,再检查入口是否启用及来源限制;不要关闭安全校验绕过问题。
页面打开但没有回复检查入口接待方案是否绑定已发布智能体、模型是否可用;在接待台按测试标记查找会话,确认是否已转人工。
文字可用,但无法语音检查企业和入口是否开启语音、系统录音权限与网页授权是否都满足;由用户主动点击开始,分别确认实际收音、AI 出声和挂断释放。

继续接入与配置

官方原始接入文档

先按云蝠指南完成入口、智能体和服务配置,再按下列官方原文配置宿主权限或供应商资源。外部文档说明对应平台能力,不代表云蝠已开放其中全部接口;腾讯 SecretKey、签名密钥和管理 API Key 仅放服务端。参数、地域、类目和资费以官方当前页面及账号实际开通结果为准。

实现依据 · 仓库内路径
  • sdk/client-kit/ios/YunfuSupportViewController.swift
  • sdk/client-kit/README.md

文档描述当前源码能力;不等于你的宿主或生产环境已通过验收。