Skip to content

TencentCloudBase/tcb-service-sdk

Repository files navigation

tcb-service-sdk

云开发增值服务调用 SDK

支持服务

以下是支持服务的接口入参,具体用法请参考下节的支持平台及使用步骤

支持平台及使用步骤

小程序

  1. dist/tcb-service-js-sdk 目录复制到小程序中,默认使用的模式是 ES6 转 ES5

勾选ES6 转 ES5

  1. 初始化:
import TcbService from '路径/tcb-service-sdk/index'
let tcbService = new TcbService()
tcbService.callService({
    service: 'video',
    action: 'WebrtcEnterRoom',
    data: {
        roomID: '1234' 
    }
}).then((res) => {
    // 处理结果
})

如果要使用 async/await,需要引入 runtime 文件,例如:

import regeneratorRuntime from '路径/runtime'
import TcbService from '路径/tcb-service-sdk/index'
let tcbService = new TcbService()

Page({
    async callService() {
        let result = await tcbService.callService({
            service: 'video',
            action: 'WebrtcEnterRoom',
            data: {
                roomID: '1234' 
            }
        })
    }
})

如果有特殊原因,不能使用 ES6 转 ES5 模式,则可引用目录里的 cjs.js 文件。

import TcbService from '路径/tcb-service-sdk/cjs'

Node (云函数或云主机)

  1. 使用该命令安装依赖: npm i --save tcb-service-sdk wx-server-sdk
  2. 初始化
const cloud = require('wx-server-sdk')
cloud.init()
import TcbService from 'tcb-service-sdk'
let tcbService = new TcbService({
    // 相关参数,secret, env 等
})
tcbService.callService({
    service: 'video',
    action: 'WebrtcEnterRoom',
    data: {
        roomID: '1234' 
    }
}).then((res) => {
    // 处理数据
})

接口文档

callService

  • 参数说明
字段 类型 必填 说明
service string 服务模块名称
1. sms 短信
2. ai 智能图像
action string 具体服务
data object 传入请求参数
options object 传入其它参数,比如这里若传入 secretIDsecretKey,则与在初始化的时候传入的不同,表时此处 callFunction 希望调用其它腾讯云账号的服务
  • 返回值说明
字段 类型 必填 说明
code string 返回错误码,0为成功
message string 返回信息
data object array
  • 使用例子
tcbService.callService({
    service: 'video',
    action: 'WebrtcEnterRoom',
    data: {
        roomID: '1234' 
    }
}).then((res) => {
    // 处理数据
})

utils.getContent

仅适用于服务端

  • 参数说明
字段 类型 必填 说明
fileID string 资源的 fileID
url string 资源的链接,fileID 和 url 选填一个
options object 当传入 url 参数时,发送请求的参数,参考 axios 的文档
  • 返回值说明
类型 说明
buffer 资源的内容 buffer
  • 使用例子
tcbService.utils.getContent({
    fileID: 'cloud://test-f4c0d1.7465-test-f4c0d1/face.jpg'
})

第三方能力接入

接入文档