Nexmo
Nexmo(Vonage API 平台)使你可以在应用程序的上下文中添加通信,包括短信、语音和聊天。 在此处注册 Nexmo 帐户 - https://www.nexmo.com/
此连接器在以下产品和区域中可用:
| 服务 | Class | 区域 |
|---|---|---|
| Copilot Studio | 高级 | 除以下各项外的所有 Power Automate 区域 : - 美国政府 (GCC) - 美国政府 (GCC High) - 由世纪互联运营的中国云 - 美国国防部(DoD) |
| 逻辑应用程序 | 标准 | 除以下各项外的所有 逻辑应用区域 : - Azure 政府区域 - Azure 中国区域 - 美国国防部(DoD) |
| Power Apps | 高级 | 除以下各项外的所有 Power Apps 区域 : - 美国政府 (GCC) - 美国政府 (GCC High) - 由世纪互联运营的中国云 - 美国国防部(DoD) |
| Power Automate | 高级 | 除以下各项外的所有 Power Automate 区域 : - 美国政府 (GCC) - 美国政府 (GCC High) - 由世纪互联运营的中国云 - 美国国防部(DoD) |
| 连接器元数据 | |
|---|---|
| 发布者 | Microsoft |
正在创建连接
连接器支持以下身份验证类型:
| 默认 | 用于创建连接的参数。 | 所有区域 | 不可共享 |
违约
适用:所有区域
用于创建连接的参数。
这是不可共享的连接。 如果 Power App 与另一个用户共享,系统会提示其他用户显式创建新连接。
| Name | 类型 | Description | 必选 |
|---|---|---|---|
| API 密钥 | 字符串 | API 密钥 | True |
| API 机密 | securestring | API 机密 | True |
限制
| 名称 | 调用 | 续订期 |
|---|---|---|
| 每个连接的 API 调用数 | 100 | 60 秒 |
操作
| 列出入站号码 |
此作用于检索为给定国家/地区提供的所有入站号码。 |
| 列出应用程序 |
检索与帐户关联的所有应用程序的列表。 |
| 列出拥有的数字 |
此作检索与帐户关联的所有数字。 |
| 创建新应用程序 |
此作用于在帐户中创建新应用程序。 |
| 删除应用程序 |
此作用于删除帐户中的现有应用程序。 |
| 发送短信 |
此作用于发送短信。 |
| 发送语音文件 |
此作用于将合成语音或录制的声音文件发送到电话号码。 |
| 按 ID 获取应用程序 |
此作用于在给定其 ID 的情况下检索有关单个应用程序的信息。 |
| 更新应用程序 |
此作用于修改帐户中的现有应用程序。 |
列出入站号码
此作用于检索为给定国家/地区提供的所有入站号码。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
国家
|
country | True | string |
ISO 3166-1 alpha-2 格式的代码。 |
|
搜索模式
|
Search Pattern | string |
选取模式。 |
|
|
图案
|
pattern | number |
要搜索的数字模式。 |
|
|
可用功能
|
features | string |
短信或语音 |
|
|
结果计数
|
size | number |
默认值为 10。 |
|
|
页面索引
|
index | number |
响应中的索引。 |
返回
- Body
- ListNumbersResponse
列出应用程序
检索与帐户关联的所有应用程序的列表。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
结果计数
|
page_size | number |
每次调用时返回的项目(默认值 10)。 |
|
|
页面索引
|
page_index | number |
从第一页偏移量(默认 0)。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
applications
|
_embedded.applications | array of applicationResponse |
列出拥有的数字
此作检索与帐户关联的所有数字。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
搜索模式
|
Search Pattern | string |
选取模式。 |
|
|
页面索引
|
index | number |
响应中的索引。 |
|
|
结果计数
|
size | number |
默认值 10 最大 100。 |
|
|
图案
|
pattern | number |
要搜索的数字模式。 |
返回
- Body
- ListNumbersResponse
创建新应用程序
此作用于在帐户中创建新应用程序。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Name
|
name | True | string |
应用程序的名称。 |
|
类型
|
type | True | string |
应用程序类型。 |
|
答案 URL
|
answer_url | True | string |
Webhook 提供 Nexmo 呼叫控制对象的位置。 |
|
事件 URL
|
event_url | True | string |
已启动、响铃或完成 |
|
Answer 方法
|
answer_method | string |
HTTP 方法(默认 GET)。 |
|
|
事件方法
|
event_method | string |
HTTP 方法(默认 POST)。 |
返回
- Body
- applicationResponse
删除应用程序
发送短信
此作用于发送短信。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
发件人 ID
|
from | True | string |
字母数字字符串。 |
|
到电话号码
|
to | True | string |
国际格式 E.164。 |
|
文本
|
text | True | string |
短信正文。 |
|
类型
|
type | string |
默认为文本。 |
|
|
送达收据
|
status-report-req | number |
设置为 1 以启用。 |
|
|
客户端参考
|
client-ref | string |
对于内部报告。 |
|
|
名片
|
vcard | string |
vCard 格式。 |
|
|
日历事件
|
vcal | string |
vCal 格式。 |
|
|
短信的生命周期
|
ttl | number |
以毫秒为单位。 |
|
|
回调 URL
|
callback | url |
传递收据终结点。 |
|
|
Message 类
|
message-class | number |
选取类。 |
|
|
用户数据标头
|
udh | string |
十六进制编码的 UDH。 |
|
|
更高级别的协议
|
protocol-id | string |
协议 ID。 |
|
|
正文 (如果类型为二进制。)
|
body | string |
十六进制编码的二进制数据。 |
|
|
Title
|
title | string |
如果类型为 wappush。 |
|
|
网址
|
url | url |
网站 URL (如果类型为 wappush.)。 |
|
|
可用性 (如果类型为 wappush。)
|
validity | string |
以毫秒为单位。 |
返回
- Body
- smsResponse
发送语音文件
此作用于将合成语音或录制的声音文件发送到电话号码。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
到电话号码
|
to | True | string |
国际格式 E.164。 |
|
从电话号码
|
from | string |
已启用语音的 Nexmo 号码。 |
|
|
Message
|
text | True | string |
语音文本。 |
|
语言
|
lg | string |
合成消息。 |
|
|
性别
|
voice | string |
男性或女性。 |
|
|
重复计数
|
repeat | number |
最多 10 次。 |
|
|
允许计算机检测
|
machine_detection | string |
True 或挂起。 |
|
|
计算机超时
|
machine_timeout | number |
400 毫秒到 10000 毫秒。 |
|
|
回调 URL
|
callback | url |
回调的 URL。 |
|
|
Callback 方法
|
callback_method | string |
GET 或 POST。 |
返回
- Body
- ttsResponse
按 ID 获取应用程序
此作用于在给定其 ID 的情况下检索有关单个应用程序的信息。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
应用程序 ID
|
application_id | True | string |
应用程序的唯一标识符。 |
返回
- Body
- applicationResponse
更新应用程序
此作用于修改帐户中的现有应用程序。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
应用程序 ID
|
application_id | True | string |
应用程序的唯一标识符。 |
|
Name
|
name | True | string |
应用程序的名称。 |
|
类型
|
type | True | string |
应用程序类型。 |
|
答案 URL
|
answer_url | True | string |
Webhook 提供 Nexmo 呼叫控制对象的位置。 |
|
事件 URL
|
event_url | True | string |
已启动、响铃或完成 |
|
Answer 方法
|
answer_method | string |
HTTP 方法(默认 GET)。 |
|
|
事件方法
|
event_method | string |
HTTP 方法(默认 POST)。 |
返回
- Body
- applicationResponse
定义
smsResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
消息计数
|
message-count | string |
消息拆分为的部分数。 |
|
消息数组
|
messages | array of object |
包含每个消息部分。 |
|
状态
|
messages.status | string |
显示短信发送的处理方式。 |
|
消息 ID
|
messages.message-id | string |
提交的短信的 ID(8 到 16 个字符)。 |
|
到电话号码
|
messages.to | string |
发送请求的编号。 |
|
客户端参考
|
messages.client-ref | string |
在请求中设置的 client-ref。 |
|
剩余余额
|
messages.remaining-balance | string |
帐户中的余额。 该值以 EUR 为单位。 |
|
消息价格
|
messages.message-price | string |
请求的金额。 该值以 EUR 为单位。 |
|
网络
|
messages.network | string |
要注册的运营商的移动国家/地区代码移动网络代码(MCCMNC)。 |
|
错误文本
|
messages.error-text | string |
如果发生错误,则说明所发生的情况。 |
ListNumbersResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
计数
|
count | integer |
结果计数。 |
|
数字数组
|
numbers | array of object |
所有数字的列表。 |
|
成本
|
numbers.cost | string |
数字成本。 |
|
国家
|
numbers.country | string |
ISO 3166-1 alpha-2 格式。 |
|
入站号码
|
numbers.msisdn | string |
入站虚拟编号。 |
|
类型
|
numbers.type | string |
数字的类型。 |
ttsResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
呼叫 ID
|
call_id | string |
此调用的唯一字母数字 32 字符 ID。 |
|
到电话号码
|
to | string |
你向其中发送 TTS 或 TTS 提示的用户数。 |
|
状态
|
status | string |
此 TTS 或 TTS 提示符的响应代码。 |
|
错误文本
|
error_text | string |
如果发生错误,则说明所发生的情况。 |
applicationResponse
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Id
|
id | string |
Nexmo 应用程序 ID。 |
|
Name
|
name | string |
应用程序名称。 |
|
Keys
|
keys.public_key | string |
用于在 . 中 https://en.wikipedia.org/wiki/JSON_Web_Token验证 jwt 的公钥。 |
常见
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
响应
|
type | string |
人工可读消息。 |
|
错误文本
|
error_title | string |
如果失败,则返回的错误标题。 |