基础术语
中文 释义 API 应用程序编程接口，是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。API 分组 用于将 API 进行逻辑的分组，同个分组下的 API 使用相同的分组标识做隔离。分组标识 是网关全局的唯一标识，用于定位在访问的 API。...
创建 API
在 定义 API 步骤中，您需要配置以下信息：所属分组：必填，用于将 API 进行逻辑的分组，分组下的 API 相同的分组 ID 进行隔离。说明 您可以选择从下拉菜单中选择已有分组，也可以单击 创建分组 新建一个 API 分组。详见 创建 API 分组。...
API 属性说明
API 分组 是 用于将 API 进行逻辑的分组，分组下的 API 相同的分组 ID 进行隔离。同一个环境下，API 分组名称不能相同。API 分组名称：支持英文字母、中文、数字、下划线（_）、连接符（-），32 个字符以内。API 描述 否 用于描述 API 的...
API 管理
创建 API 信息 sofa.apigateway.api.create 用于快速创建一个 API 服务。请求参数 名称 类型 是否必填 示例 描述 param ApiInfoVO 是-param tenant_id STRING 是 TSCPDICNT 租户标识 workspace_id STRING 是 default 工作空间标识 返回参数...
流量控制插件
1.概述 流量控制插件用于对API进行限流，流量控制插件可以对 API，App（访问的AK），用户（访问方的App归属用户），以及 自定义参数 进行多种维度的限流。流量控制插件 目前支持两种配置模板：参数流控配置，支持 自定义参数 的流控配置。...
导入API网关的扩展Swagger定义
Swagger 是一种用于描述API定义的规范，被广泛应用于定义和描述后端应用服务的API。现在，API网关支持导入Swagger 2.0的文件来创建API，您可以参考ImportSwagger，或在控制台上进行操作，入口见下图：API网关的Swagger扩展基于Swagger 2.0...
号码加密
应用场景 企业将自己客户的联系方式加密成虚拟号码，然后通过第三方呼叫中心进行呼叫。第三方呼叫中心使用阿里云的线路将虚拟号码解密成真实号码，再实际发起呼叫。保护企业核心数据资产不外泄。相关文档 PhoneNumberEncrypt-加密号码
接口说明
该参数可用于字幕生成场景，控制单行字幕最大字数。自定义过滤词调用示例如下：/以实时转写为例，JSONObject root=new JSONObject();root.put("system_reserved_filter",true);将以下词语替换成空 JSONObject root1=new JSONObject();...
简介
API 应用程序编程接口 用户开放API，在API网关录入API，以提供接口的方式对外提供服务或者数据。Group API Group API分组 一组API。用户开放API，首先需要创建API分组 每个API分组拥有一个二级域名，两个Stage 用户需要将已经备案且解析至...
快速使用
呼叫中心预置了完整呼叫的所有功能，您只需要简单配置就可以快速建立一个呼叫中心。前提条件 开通云呼叫中心 号码申请 一分钟快速建立呼叫中心 第一步：进入云智能客服控制台，实例管理-V2页面点击 新建 按钮，弹出右侧滑层，填写表单信息...
环境管理
本文档介绍如何在API网关上进行环境管理。1.什么是环境管理 当前每个分组内的API支持设置三个环境：测试（TEST）、预发（PRE）和线上（RELEASE）。目的是能够满足不同您的不同研发场景下的API 调用需求，如API测试环境，后端服务对应到您的...
天猫精灵
对设备进行别名设置 猫灵社区服务 绑定完成后天猫精灵已经成为社区服务终端，您可以在天猫精灵社区服务应用中体验到以下功能 门禁可视对讲，当居民通过室内猫精进行呼叫物业操作时，您的天猫精灵将会通过响铃方式通知您，您可以通过说...
为分组绑定插件
1.概述 插件是API网关提供的一种独立的配置组件，主要用于拓展API的功能，为API提供更多的定制能力和扩展选项，以满足用户的多样化需求。插件需绑定到API上才能生效，如果API的数量较多，那么绑定插件可能会变得繁琐且耗时，因此我们提供了...
创建后端服务为HTTP的API
步骤6 定义返回结果 本环节用于API帮助文档的自助生成，帮助API使用者更好理解。可以设置返回ContentType、返回结果示例和失败返回结果示例。本例中不涉及到这部分，因此可以点击 创建 按钮。步骤7 发布API 在上一环节保存成功后，会提示...
函数计算内网访问API网关
步骤6：配置函数计算的VPC访问 首先需要在vpc-api-access中再创建一个vswitch，用于函数计算的接入，如下图所示：其次在函数计算控制台中，在上一步骤中新建应用的配置服务菜单中进行配置，具体过程以函数计算的文档为准 配置网络。...
VPC授权连通性测试
VPC授权连通性测试用于验证API网关实例到您授权的VPC中实例的网络连通性，有助于将API调试阶段由于网络连通问题引发的调用失败提前暴露。本文将重点介绍VPC授权连通性测试功能，以及如何根据排错引导解决连通性测试失败的情况。1.概述 VPC...
语音通知实现告警功能
通过API查询 主动获取呼叫结果：通过 QueryCallDetailByCallId 接口，您就可以主动获取到一通呼叫的呼叫结果。在调用API时，请输入呼叫时返回的CallId值进行查询。说明 CallId为呼叫时返回的CallId，ProdId为语音通知的ProdId，QueryDate...
导入导出 API
在弹出的窗口中，选择本地的 JSON 文件进行 API 导入。如果 API 导入失败，您可以在弹出的窗口中查看到导入失败的 API 数量及名称，如下图所示。导入失败，大多情况是因为导入的 API 数据与当前选择的租户、工作空间下的现有 API 数据重复...
API概览
我们已经为开发者封装了常见编程语言的SDK，开发者可通过 下载SDK 直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入...
功能特性
资质与话术管理 语音 Cloud API 语音通知 通过调用API向指定号码发起一通呼叫，呼叫被应答后，播放一段指定的音频，支持播放文本转语音的音频，也支持直接播放录音文件。SingleCallByVoice 语音验证码 通过调用API向指定号码发起呼叫，呼叫...
人物写真生成API详情
AI写真照相馆应用：通过构建智能写真照相馆应用程序，为用户提供便捷、高效且高度个性化的在线摄影体验，让用户无论何时何地都能拍出媲美专业摄影师水准的高品质多样化风格个人写真照片。环球旅拍写真生成：线上数字化创新旅拍写真生成应用...
发布日志
SDK增加meetingsdk-api的source.jar，仅用于调试。当服务出现404、405错误时修改为内部重新入会。内部日志优化。V1.1.0.7 优化内部数据清理导致会议被挂断的逻辑问题。V1.1.0.6 SDK增加t28、t29两个文件，用户可根据不同的targetVersion...
创建后端为函数计算的API
步骤7 定义返回结果 本环节用于API帮助文档的自助生成，帮助API使用者更好理解。可以设置返回ContentType、返回结果示例和失败返回结果示例。本例中不涉及到这部分，因此可以点击 保存 按钮。步骤8 发布API 在上一环节保存成功后，会提示...
名词解释
使用API网关，您需要对以下名词有所了解。名词 解释 应用（APP）用户需要创建APP作为调用API时的身份。AppKey、AppSecret 每个APP都有这样一对密钥对，加密计算...流量控制策略 用于API服务方对API、用户、APP按天、小时、分钟进行流量限制。
构造请求
取值范围：json xml（默认）接口自定义参数 请在API概览中，单击每个API进行查询。更多信息，请参见 API概览。签名机制 对于每一次HTTP或者HTTPS协议请求，我们会根据访问中的签名信息验证访问请求者身份。具体通过AccessKey ID和AccessKey...
产品业务架构
下发呼叫任务：在智能外呼控制台中通过上传Excel名单的方式下发任务、或调用智能外呼的OpenAPI接口批量下发任务；外呼任务调度：会根据系统中设置的并发数对呼叫任务进行调度，当满足呼出时间时，调用智能语音中间件下发呼叫；说明 当某...
对象存储
步骤8 定义返回结果 本环节用于API帮助文档的自助生成，帮助API使用者更好理解。可以设置返回ContentType、返回结果示例和失败返回结果示例。本例中不涉及到这部分，因此可以单击保存按钮。步骤9 发布API 您对API进行过任何的配置，都需要...
用户管理
读写TSDB时使用用户信息进行鉴权 在上一章节中添加的TSDB用户，需要在查询/写入TSDB时使用添加的TSDB用户信息进行API鉴权。在开启用户账号管理的状态下，访问TSDB的大部分HTTP API时都需要以用户鉴权的方式进行HTTP请求。TSDB各个HTTP API...
概述
本文主要介绍网关的几个核心概念，以便更好地进行 API 服务开发与调用。协议转换 API 网关不仅是一个简单的反向代理服务，同时还提供协议转换的能力，支持使用 A 协议调用 B 协议的接口。协议转换与使用的编程语言无关，但是仅 Java 语言...
RESTful API
使用如下cURL命令行进行一句话识别的RESTful API测试。curl-X POST-H"X-NLS-Token:${token}"https://nls-gateway-cn-shanghai.aliyuncs.com/stream/v1/asr?appkey=${appkey}-data-binary@${audio_file} 举例如下：curl-X POST-H"X-NLS-...
前端调用集成API
简介 前端调用集成API操作可用于在当前逻辑流执行环境中在前端环境调用 API。环境限制 前端调用集成 API 操作仅用于前端逻辑流环境。配置属性 前端调用集成 API 操作属性由以下部分组成，逻辑流通用属性部分请参考 逻辑流操作通用属性：...
OAuth应用概览
阿里云API 应用通过调用API可以访问相应资源。应用场景 Web应用登录阿里云 Native应用登录阿里云 通过OIDC获取用户信息 通过SCIM协议将企业内部账号同步到阿里云RAM 通过SCIM协议同步Okta用户到阿里云RAM 使用 IDaaS 同步LDAP/钉钉账户至 ...
获取服务端信息
API 请求路径/接口名称/方法 应用发送请求至 API 的请求路径以进行 API 调用。操作步骤：进入 API 网关控制台>API 订阅>应用管理 页面。在列表中，找到目标应用，单击其名称，进入应用详情页。在 API 订阅列表 中，找到目标 API，即可获取...
HTTP API SQL接口开发手册
对于Java语言的应用开发，建议基于Java JDBC Driver构建时序引擎的应用程序，具体请参见 Java JDBC Driver开发手册。说明 单机版不支持此功能。请求路径与方法 请求路径 请求方法 描述/api/v2/sql POST 发送并执行SQL语句。请求内容 请求...
Connector使用案例
Connector Rest API 重要 强制更新Connector可能导致正在运行的job结束，且会导致Control Center中Connect信息异常，可通过Restful API手动删除Connector进行解决，更多API使用详情，请参见 API文档。查看Connector实例信息 API格式：GET/...
API概览
本文列出了密钥管理服务KMS（Key Management Service）提供的API接口及相关描述。密钥服务接口 用户主密钥管理 密钥管理接口用于密钥的创建、属性修改以及生命周期管理。API 描述 CreateKey 创建用户主密钥。用户可以选择由KMS生成密钥材料...
基于JWT的token认证
阿里云API网关在Json Web Token（JWT）这种结构化令牌的基础上实现了一套基于用户体系对用户的API进行授权访问的机制，满足用户个性化安全设置的需求。一、基于token的认证 1.1 简介 很多对外开放的API需要识别请求者的身份，并据此判断所...
使用简单认证（AppCode）方式调用API
API提供者给调用者的APP进行API授权，具体授权方式请参考文档：创建后端服务为HTTP的API；API调用者到API网关控制台的”应用管理“找到AppCode/AppSecret进行签名认证的调用或者AppCode进行简单认证的API调用。2.创建支持简单认证方式API ...
key-auth插件
key-auth插件实现了基于API Key进行认证鉴权的功能，支持从HTTP请求的URL参数或者请求头解析API Key，同时验证该API Key是否有权限访问。本文介绍如何配置key-auth插件。插件类型 认证鉴权。配置字段 名称 数据类型 填写要求 默认值 描述 ...
IVR模块介绍
如果需要自定义变量参数一般可在开始模块进行填写自定义变量参数，参数用在ivr流程中进行传递，参数名称不可重复 放音模块 用于播放音频文件或文字转语音，通常用作开场的欢迎语和模块间的过度使用。模块名称，可根据需要自定义。语音提示-...
- 产品推荐
- 这些文档可能帮助您