Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/TencentCloudBase/tcb-service-sdk
云开发增值服务SDK（小程序/Node）
https://github.com/TencentCloudBase/tcb-service-sdk
Last synced: about 1 month ago
JSON representation
云开发增值服务SDK（小程序/Node）
- Host: GitHub
- URL: https://github.com/TencentCloudBase/tcb-service-sdk
- Owner: TencentCloudBase
- Created: 2019-02-23T13:22:16.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T21:39:32.000Z (almost 2 years ago)
- Last Synced: 2024-09-18T20:19:31.155Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 1.25 MB
- Stars: 9
- Watchers: 3
- Forks: 6
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# tcb-service-sdk
云开发增值服务调用 SDK
## 支持服务
以下是支持服务的接口入参，具体用法请参考下节的[支持平台及使用步骤](#支持平台及使用步骤)。
* [短信](/docs/sms/README.md)
* [AI](/docs/ai/README.md)
## 支持平台及使用步骤
### 小程序
1. 将 `dist/tcb-service-js-sdk` 目录复制到小程序中，默认使用的模式是 `ES6 转 ES5`。
勾选ES6 转 ES5
2. 初始化：
```js
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](/tools/runtime.js) 文件，例如：
```js
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` 文件。
```js
import TcbService from '路径/tcb-service-sdk/cjs'
```
### Node （云函数或云主机）
1. 使用该命令安装依赖： `npm i --save tcb-service-sdk wx-server-sdk`
2. 初始化
```js
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 | 否 | 传入其它参数，比如这里若传入 `secretID` 和 `secretKey`，则与在初始化的时候传入的不同，表时此处 `callFunction` 希望调用其它腾讯云账号的服务
- 返回值说明
| 字段 | 类型 | 必填 | 说明
| --- | --- | --- | ---
| code | string | 是 | 返回错误码，0为成功
| message | string | 是 | 返回信息
| data | object|array | 是 | 返回数据
- 使用例子
```js
tcbService.callService({
service: 'video',
action: 'WebrtcEnterRoom',
data: {
roomID: '1234'
}
}).then((res) => {
// 处理数据
})
```
### utils.getContent
> 仅适用于服务端
- 参数说明
| 字段 | 类型 | 必填 | 说明
| --- | --- | --- | ---
| fileID | string | 否 | 资源的 fileID
| url | string | 否 | 资源的链接，fileID 和 url 选填一个
| options | object | 否 | 当传入 url 参数时，发送请求的参数，参考 [axios](https://github.com/axios/axios) 的文档
- 返回值说明
类型 | 说明
| --- | ---
| buffer | 资源的内容 buffer
- 使用例子
```js
tcbService.utils.getContent({
fileID: 'cloud://test-f4c0d1.7465-test-f4c0d1/face.jpg'
})
```
### 第三方能力接入
[接入文档](/docs/接入指南.md)