使用 License 模式接入 iOS SDK

1. 模式说明

使用 License 计费模式访问多模态交互开发套件需要集成 License SDK，请参考本文第 4 节集成 SDK。

2. 使用前注意需了解事项

• 使用License模式前在百炼控制台创建了应用，并购买了License。

• SDK中封装了设备唯一标识生成逻辑并存储到keychain，避免同1设备重复注册，通过DeviceInfoUtils.shared.getDeviceId()调用，请务必使用SDK中获取deviceName接口逻辑或者接入方自行保证deviceName唯一性。

3. 接口说明

/// 初始化SDK，写入产品信息
func initializeExample() {
    let params = InitParams(
        appId: "your_app_id",
        appSecret: "your_app_secret",
        deviceName: "your_device_name_or_uuid"
    )
    
    // 定义回调类
    class InitCallback: InitCallBack {
        func success() {
            print("初始化成功")
        }
        
        func fail(error: ResultError) {
            print("初始化失败: \(error.message ?? "unknown error")")
        }
    }
    
    let callback = InitCallback()
    DeviceAuthClient.companion.instance.initialize(params: params, callBack: callback)
}

/// 半托管模式：生成设备注册请求签名
func genRegisterReqExample() {
        let registerInfo = DeviceRegisterInfo(
            reqNonce: "random_nonce_string",
            appId: "your_app_id",
            deviceName: "your_device_name",
            payMode: PayMode.license.payMode,
            requestTime: "\(Int64(Date().timeIntervalSince1970 * 1000))"
        )
        
        let result = DeviceAuthClient.companion.instance.genRegisterReq(registerInfo: registerInfo)
        
    if result.success {
            let signature = result.data
            print("生成注册签名成功: \(signature ?? "")")
            // 使用签名调用服务端注册接口
        } else {
            print("生成注册签名失败: \(result.message)")
        }
    }

/// 半托管模式：写入设备注册成功的信息
func writeDeviceInfoExample() {
    let deviceInfo = DeviceRegisterRsp(
        appId: "your_app_id",
        reqNonce: "request_nonce",
        rspNonce: "response_nonce_from_server",
        responseTime: "response_time_from_server",
        deviceName: "your_device_name",
        signature: "signature_from_server"
    )
    
    let result = DeviceAuthClient.companion.instance.writeDeviceInfo(deviceInfo: deviceInfo)
    
    if result.success {
        print("写入设备信息成功")
    } else {
        print("写入设备信息失败: \(result.message)")
    }
}

{
    "success": true,
    "data": "84uoRCyy6AG/SH7LrHjJW0D7lsBp/H4RReS7gJY5L0oC517xJWAmwtmghLjYkW/Qj4ZvK6vrM7QC5yxtMl3TQLHdAGSsqQLb0bP6zKOiDzoNFwqs61+GMQ7guTPjbE9Fqaf7"
}

/// 半托管模式：生成获取token请求的签名
func genGetTokenReqExample() {
     let getTokenParams = GenGetTokenParams(
         nonce: "random_nonce_string",
         appId: "your_app_id",
         deviceName: "your_device_name",
         payMode: PayMode.license.payMode,
         requestTime: "\(Int64(Date().timeIntervalSince1970 * 1000))",
         signature: nil, // 由SDK生成
         tokenType: "MMI"
     )
     
     let result = DeviceAuthClient.companion.instance.genGetTokenReq(getTokenParams: getTokenParams)
     
     if result.success {
         let signature = result.data
         print("生成token请求签名成功: \(signature ?? "")")
         // 使用签名调用服务端获取token接口
     } else {
         print("生成token请求签名失败: \(result.message)")
     }
 }

/// 半托管模式：获取token后进行解签
func getTokenWithSignatureExample() {
    let tokenRsp = AnalyzeTokenSignRsp(
        reqNonce: "request_nonce",
        rspNonce: "response_nonce_from_server",
        responseTime: "response_time_from_server",
        appId: "your_app_id",
        deviceName: "your_device_name",
        signature: "signature_from_server"
    )
    
    let result = DeviceAuthClient.companion.instance.getToken(tokenRsp: tokenRsp)
    
    if result.success {
        let token = result.data
        print("获取token成功: \(token ?? "")")
        // 使用token进行后续业务调用
    } else {
        print("获取token失败: \(result.message)")
    }
}

/// 检查设备是否完成注册
func checkDeviceRegisteredExample() {
    let isRegistered = DeviceAuthClient.companion.instance.deviceIsRegistered()
    
    if isRegistered {
        print("设备已注册")
    } else {
        print("设备未注册，需要先进行设备注册")
    }
}

/// 全托管模式：设备注册
func deviceRegisterExample() {
    let params = DeviceRegisterParams(
        nonce: "random_nonce_string",
        appId: "your_app_id",
        deviceName: "your_device_name",
        payMode: PayMode.license.payMode,
        requestTime: "\(Int64(Date().timeIntervalSince1970 * 1000))",
        signature: nil
    )
    
    // 定义回调类
    class DeviceRegisterCallback: DeviceRegisterCallBack {
        func success() {
            print("设备注册成功")
        }
        
        func fail(error: ResultError) {
            print("设备注册失败: \(error.message ?? "unknown error")")
        }
    }
    
    let callback = DeviceRegisterCallback()
    DeviceAuthClient.companion.instance.deviceRegister(
        params: params,
        callBack: callback,
        completionHandler: { _ in }
    )
}

/// 全托管模式：获取token
func getTokenFullManagedExample() {
    let params = GenGetTokenParams(
        nonce: "random_nonce_string",
        appId: "your_app_id",
        deviceName: "your_device_name",
        payMode: PayMode.license.payMode,
        requestTime: "\(Int64(Date().timeIntervalSince1970 * 1000))",
        signature: nil,
        tokenType: "MMI"
    )
    
    // 定义回调类
    class GetTokenCallback: GetTokenCallBack {
        func success(tokenInfo: String?) {
            print("获取token成功: \(tokenInfo ?? "")")
        }
        
        func fail(error_ error: ResultError?) {
            print("获取token失败: \(error?.message ?? "unknown error")")
        }
    }
    
    let callback = GetTokenCallback()
    DeviceAuthClient.companion.instance.getToken(
        params: params,
        callBack: callback,
        completionHandler: { _ in }
    )
}

/// 获取license签名
func getLicenseSignatureExample() {
    let params = LicenseSignatureParams(
        appId: "your_app_id",
        deviceName: "your_device_name",
        taskId: "your_task_id"
    )
    
    let licenseSignature = DeviceAuthClient.companion.instance.getLicenseSignature(params: params)
    print("License签名结果: \(licenseSignature)")
    // 返回包含timestamp和license_info的JSON字符串
}

 let result = DeviceAuthClient.companion.instance.deviceReset()
 if(result){
     print("设备重置成功")
 }else{
     print("设备重置失败")
 }

4. 集成依赖库

使用最新版本 iOS SDK，引用其中的MultimodalDialogTongyiMetathings.framework

5. 涉及多模态SDK接入修改

1. 在启动会话前完成tongyimetathings SDK的初始化和检测设备是否注册，未注册执行设备注册，具体参考接入示例工程。

2. 初始化该SDK，设备注册完成后获取多模态会话token，参考上述2.1，2.3接口，将getToken接口返回的dashToken数据设置为apiKey，具体参考示例工程。

chatView.updateParam(url: host, apiKey: dashToken, workSpaceId: workSpaceId, appId: appId, chain: chainMode, image_url: img, payType: self.mPayMode, voice: voice)

3. 创建会话时传入license计费标识,参考接入示例：

func connect(){
    self.conversation?.stop()
    isInDialog = false
    
    var mode = DialogMode.duplex
    if(!duplexMode){
        mode = DialogMode.tap2talk
    }
    let taskId = UUID().uuidString.replacingOccurrences(of: "-", with: "").lowercased()
    let promptParam = ["user_name" : "大米"]
    TYLogger.shared.debug("current voice:" + voice)
    var params:MultiModalRequestParam
            //构建License计费标识
            let deviceName = DeviceInfoUtils.shared.getDeviceId()
            let licenseParams = LicenseSignatureParams(appId: self.APP_ID, deviceName: deviceName, taskId: taskId)
            let signData = DeviceAuthClient.companion.instance.getLicenseSignature(params: licenseParams)
            print("signData: \(signData)")
             // 将 JSON 字符串转为字典
            guard let data = signData.data(using: .utf8),
                  let signatureJson = try? JSONSerialization.jsonObject(with: data) else {
                print("Failed to parse signData as JSON")
                return
            }
            let map: [String: Any] = ["signature": signatureJson]
            
            params = MultiModalRequestParam{ multiBuilder in
               multiBuilder.upStream = MultiModalRequestParam.UpStream(builder: { upstreamBuilder in
                   upstreamBuilder.mode = mode.rawValue
                   upstreamBuilder.type = "AudioAndVideo"
               })
                
               multiBuilder.clientInfo = MultiModalRequestParam.ClientInfo(builder: {
                   clientInfoBuilder in
                   clientInfoBuilder.userId = "test-ios-user"
                   clientInfoBuilder.device = MultiModalRequestParam.ClientInfo.Device(uuid: deviceName)
                   clientInfoBuilder.passThroughParams = map
               })
               multiBuilder.downStream = MultiModalRequestParam.DownStream(builder: {
                   downStreamBuilder in
                   downStreamBuilder.sampleRate = 16000
                   downStreamBuilder.voice = voice
                   downStreamBuilder.intermediateText = textStreamFeedback ? "dialog" : "transcript"
               })
               multiBuilder.bizParams = MultiModalRequestParam.BizParams(builder: {
                   bizBuilder in
                   bizBuilder.userPromptParams = promptParam
               })
           }
}