概述
小程序开放能力提供小程序开放平台接口能力,包括用户信息、小程序客服、消息相关、数据分析等。
使用步骤
1. 新建 APIs,选择开放服务小程序开放能力。
2. 配置 APIs 参数。
APIs 方法
小程序开放能力支持以下方法。
方法展示 | 方法标识 | 方法描述 |
查询 API 调用额度 | getApiQuota | 本接口用于查询公众号、小程序、第三方平台等接口的每日调用接口的额度以及调用次数 |
查询 rid 信息 | getRidInfo | 本接口用于查询调用公众号、小程序、第三方平台等接口报错返回的 rid 详情信息,辅助开发者高效定位问题 |
用 AppSecret 重置 API 调用次数 | clearQuotaByAppSecret | 本接口用于清空公众号、小程序等接口的每日调用接口次数 |
重置 API 调用次数 | clearQuota | 本接口用于清空公众号、小程序、第三方平台等接口的每日调用接口次数 |
下发客服当前输入状态 | setTyping | 该接口用于下发客服当前输入状态给用户 |
发送客服消息 | sendCustomMessage | 该接口用于发送客服消息给用户 |
创建 activity_id | createActivityId | 该接口用于创建被分享动态消息或私密消息的 activity_id |
修改动态消息 | setUpdatableMsg | 该接口用于修改被分享的动态消息 |
删除模板 | deleteMessageTemplate | 该接口用于删除小程序下的个人模板 |
获取类目 | getCategory | 该接口用于获取小程序账号的类目 |
获取关键词列表 | getPubTemplateKeyWordsById | 该接口用于获取模板标题下的关键词列表 |
获取所属类目下的公共模板 | getPubTemplateTitleList | 该接口用于获取所属类目下的公共模板标题 |
获取个人模板列表 | getMessageTemplateList | 该接口用于获取当前模板列表 |
发送订阅消息 | sendMessage | 该接口用于发送订阅消息 |
添加模板 | addMessageTemplate | 该接口用于组合模板并添加至小程序下的个人模板库 |
获取用户访问小程序周留存 | getWeeklyRetain | 该接口用于获取用户访问小程序周留存 |
获取用户访问小程序月留存 | getMonthlyRetain | 该接口用于获取用户访问小程序月留存 |
获取用户访问小程序日留存 | getDailyRetain | 该接口用于获取用户访问小程序日留存 |
获取用户访问小程序数据月趋势 | getMonthlyVisitTrend | 该接口用于获取用户访问小程序数据月趋势 |
获取用户访问小程序数据日趋势 | getDailyVisitTrend | 该接口用于获取用户访问小程序数据日趋势 |
获取用户访问小程序数据周趋势 | getWeeklyVisitTrend | 该接口用于获取用户访问小程序数据周趋势 |
获取用户访问小程序数据概况 | getDailySummary | 该接口用于获取用户访问小程序数据概况 |
获取访问页面数据 | getVisitPage | 该接口用于访问页面 |
获取小程序用户画像分布 | getUserPortrait | 该接口用于获取小程序新增或活跃用户的画像分布数据 |
获取小程序性能数据 | getPerformanceData | 该接口用于获取小程序启动性能,运行性能等数据 |
获取用户小程序访问分布数据 | getVisitDistribution | 该接口用于获取用户小程序访问分布数据 |
获取 cloudID 对应的数据 | getOpenData | 该接口用于换取 cloudID 对应的开放数据 |
获取实时语音签名 | getCloudBaseVoIPSign | 该接口用于获取实时语音签名 |
触发云函数 | invokeCloudFunction | 通过本接口可以触发云函数 |
拉取上传 | vodPullUpload | 该接口用于将一个网络上的视频拉取上传到平台 |
查询任务 | vodGetTask | 该接口用于查询拉取上传的任务状态 |
获取媒资列表 | vodListMedia | 该接口用于获取已上传到平台的媒资列表 |
获取媒资详细信息 | vodGetMedia | 该接口用于获取已上传到平台的指定媒资信息,用于开发者后台管理使用 |
获取媒资播放链接 | vodGetMediaLink | 该接口用于获取视频临时播放链接,用于给用户的播放使用 |
删除媒资 | vodDeleteMedia | 该接口用于删除指定媒资 |
剧目提审 | vodAuditDrama | 剧目提交审核 |
获取剧目列表 | vodListDramas | 该接口用于获取已提交的剧目列表 |
获取剧目信息 | vodGetDrama | 该接口用于查询已提交的剧目 |
提交替换剧集审核 | vodSubmitReplaceDramaMedias | 该接口用于提交剧目替换剧集审核。 |
替换审核通过的剧集 | vodReplaceDramaMedia | 该接口用于替换剧目审核通过的剧集 |
查询 CDN 用量数据 | vodGetCDNUsageData | 该接口用于查询点播 CDN 的流量数据 |
查询 CDN 日志下载链接列表 | vodGetCDNLogs | 查询域名的 CDN 访问日志的下载链接 |
查询流量包详情 | vodListPackages | 该接口用于查询流量包的使用详情 |
小程序登录 | code2Session | 通过 wx.login 接口获得临时登录凭证 code 后传到开发者服务器调用此接口完成登录流程 |