{"id":13654083,"url":"https://github.com/TencentCloudBase/tcb-service-sdk","last_synced_at":"2025-04-23T07:30:27.415Z","repository":{"id":34298090,"uuid":"172216966","full_name":"TencentCloudBase/tcb-service-sdk","owner":"TencentCloudBase","description":"云开发增值服务SDK（小程序/Node）","archived":false,"fork":false,"pushed_at":"2023-01-04T21:39:32.000Z","size":1312,"stargazers_count":9,"open_issues_count":13,"forks_count":6,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-04T09:39:53.112Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TencentCloudBase.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-02-23T13:22:16.000Z","updated_at":"2023-07-24T07:19:33.000Z","dependencies_parsed_at":"2023-01-15T06:03:19.962Z","dependency_job_id":null,"html_url":"https://github.com/TencentCloudBase/tcb-service-sdk","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TencentCloudBase%2Ftcb-service-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TencentCloudBase%2Ftcb-service-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TencentCloudBase%2Ftcb-service-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TencentCloudBase%2Ftcb-service-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TencentCloudBase","download_url":"https://codeload.github.com/TencentCloudBase/tcb-service-sdk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250390793,"owners_count":21422783,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-02T02:01:23.181Z","updated_at":"2025-04-23T07:30:27.043Z","avatar_url":"https://github.com/TencentCloudBase.png","language":"JavaScript","funding_links":[],"categories":["官方资源"],"sub_categories":[],"readme":"# tcb-service-sdk\n云开发增值服务调用 SDK\n\n## 支持服务\n\n以下是支持服务的接口入参，具体用法请参考下节的[支持平台及使用步骤](#支持平台及使用步骤)。\n\n* [短信](/docs/sms/README.md)\n* [AI](/docs/ai/README.md)\n\n## 支持平台及使用步骤\n\n### 小程序\n1. 将 `dist/tcb-service-js-sdk` 目录复制到小程序中，默认使用的模式是 `ES6 转 ES5`。\n\n\u003cp align=\"center\"\u003e\n    \u003cimg src=\"https://main.qcloudimg.com/raw/39458b2749f1ba607d9651c88241dad2.png\" width=\"300px\"\u003e\n    \u003cp align=\"center\"\u003e勾选ES6 转 ES5\u003c/p\u003e\n\u003c/p\u003e\n\n2. 初始化：\n\n```js\nimport TcbService from '路径/tcb-service-sdk/index'\nlet tcbService = new TcbService()\ntcbService.callService({\n    service: 'video',\n    action: 'WebrtcEnterRoom',\n    data: {\n        roomID: '1234' \n    }\n}).then((res) =\u003e {\n    // 处理结果\n})\n```\n\n如果要使用 `async/await`，需要引入 [runtime](/tools/runtime.js) 文件，例如：\n\n```js\nimport regeneratorRuntime from '路径/runtime'\nimport TcbService from '路径/tcb-service-sdk/index'\nlet tcbService = new TcbService()\n\nPage({\n    async callService() {\n        let result = await tcbService.callService({\n            service: 'video',\n            action: 'WebrtcEnterRoom',\n            data: {\n                roomID: '1234' \n            }\n        })\n    }\n})\n```\n\n如果有特殊原因，不能使用 `ES6 转 ES5` 模式，则可引用目录里的 `cjs.js` 文件。\n\n```js\nimport TcbService from '路径/tcb-service-sdk/cjs'\n```\n\n### Node （云函数或云主机）\n1. 使用该命令安装依赖： `npm i --save tcb-service-sdk wx-server-sdk`\n2. 初始化\n\n```js\nconst cloud = require('wx-server-sdk')\ncloud.init()\nimport TcbService from 'tcb-service-sdk'\nlet tcbService = new TcbService({\n    // 相关参数，secret, env 等\n})\ntcbService.callService({\n    service: 'video',\n    action: 'WebrtcEnterRoom',\n    data: {\n        roomID: '1234' \n    }\n}).then((res) =\u003e {\n    // 处理数据\n})\n```\n\n## 接口文档\n\n### callService\n\n- 参数说明\n\n| 字段 | 类型 | 必填 | 说明\n| --- | --- | --- | ---\n| service | string | 是 | 服务模块名称 \u003cbr\u003e 1. sms 短信 \u003cbr\u003e 2. ai 智能图像 \n| action | string | 是 | 具体服务\n| data | object | 否 | 传入请求参数\n| options | object | 否 | 传入其它参数，比如这里若传入 `secretID` 和 `secretKey`，则与在初始化的时候传入的不同，表时此处 `callFunction` 希望调用其它腾讯云账号的服务\n\n- 返回值说明\n\n| 字段 | 类型 | 必填 | 说明\n| --- | --- | --- | ---\n| code | string | 是 | 返回错误码，0为成功\n| message | string | 是 | 返回信息\n| data | object|array | 是 | 返回数据\n\n- 使用例子\n\n```js\ntcbService.callService({\n    service: 'video',\n    action: 'WebrtcEnterRoom',\n    data: {\n        roomID: '1234' \n    }\n}).then((res) =\u003e {\n    // 处理数据\n})\n```\n\n### utils.getContent\n\n\u003e 仅适用于服务端\n\n- 参数说明\n\n| 字段 | 类型 | 必填 | 说明\n| --- | --- | --- | ---\n| fileID | string | 否 | 资源的 fileID\n| url | string | 否 | 资源的链接，fileID 和 url 选填一个\n| options | object | 否 | 当传入 url 参数时，发送请求的参数，参考 [axios](https://github.com/axios/axios) 的文档 \n\n- 返回值说明\n\n类型 | 说明\n| --- | ---\n| buffer | 资源的内容 buffer\n\n- 使用例子\n\n```js\ntcbService.utils.getContent({\n    fileID: 'cloud://test-f4c0d1.7465-test-f4c0d1/face.jpg'\n})\n```\n\n### 第三方能力接入\n[接入文档](/docs/接入指南.md)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTencentCloudBase%2Ftcb-service-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FTencentCloudBase%2Ftcb-service-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTencentCloudBase%2Ftcb-service-sdk/lists"}