耐克斯莫
Nexmo 是 Vonage API 平台,可讓您在應用程式的上下文中新增通訊,包括簡訊、語音和聊天。 在這裡註冊一個 Nexmo 帳戶 - https://www.nexmo.com/
此連接器適用於以下產品和區域:
| 服務 | Class | Regions |
|---|---|---|
| 副駕駛工作室 | 進階 | 除下列區域外的所有 Power Automate 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| 邏輯應用程式 | 標準 | 所有 Logic Apps 區域, 但下列區域除外: - Azure Government 區域 - Azure 中國區域 - 美國國防部 (DoD) |
| Power Apps | 進階 | 除下列區域外的所有 Power Apps 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| Power Automate(自動化服務) | 進階 | 除下列區域外的所有 Power Automate 區域 : - 美國政府 (GCC) - 美國政府(海灣合作委員會高中) - 由 21Vianet 營運的中國雲 - 美國國防部 (DoD) |
| 連接器中繼資料 | |
|---|---|
| Publisher | Microsoft |
正在建立連線
連接器支援下列驗證類型:
| 預設值 | 建立連線的參數。 | 所有區域 | 不可共享 |
預設
適用:所有地區
建立連線的參數。
這不是可共用的連線。 如果 Power App 與其他使用者共用,系統會明確提示其他使用者建立新連線。
| 名稱 | 類型 | Description | 為必填項目 |
|---|---|---|---|
| API 金鑰 | 字串 | API 金鑰 | 對 |
| API 密碼 | securestring | API 秘密 | 對 |
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 100 | 60 秒 |
動作
| 傳送語音檔案 |
此操作用於將合成的語音或錄製的聲音文件發送到電話號碼。 |
| 列出傳入號碼 |
此作業用於擷取指定國家/地區可存取的所有傳入號碼。 |
| 列出應用程式 |
擷取與您的帳戶相關聯的所有應用程式清單。 |
| 列出擁有的號碼 |
此操作會擷取與您的帳戶相關聯的所有號碼。 |
| 刪除應用程式 |
此作業可用來刪除您帳戶中的現有應用程式。 |
| 建立新的應用程式 |
此作業可用來在您的帳戶中建立新應用程式。 |
| 更新應用程式 |
此作業可用來修改您帳戶中的現有應用程式。 |
| 發送短信 |
此操作用於發送短信。 |
| 通過 ID 獲取應用程序 |
此作業可用來擷取單一應用程式的相關資訊,指定其識別碼。 |
傳送語音檔案
此操作用於將合成的語音或錄製的聲音文件發送到電話號碼。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
至電話號碼
|
to | True | string |
國際格式 E.164。 |
|
從電話號碼
|
from | string |
支持語音的 Nexmo 號碼。 |
|
|
Message
|
text | True | string |
語音文字。 |
|
語言
|
lg | string |
合成訊息。 |
|
|
性別
|
voice | string |
男性或女性。 |
|
|
重複計數
|
repeat | number |
最多 10 次。 |
|
|
允許機器偵測
|
machine_detection | string |
真或掛斷。 |
|
|
機器逾時
|
machine_timeout | number |
400 毫秒到 10000 毫秒。 |
|
|
回呼 URL
|
callback | url |
回呼的 URL。 |
|
|
回呼方法
|
callback_method | string |
取得或發布。 |
傳回
- 身體
- ttsResponse
列出傳入號碼
此作業用於擷取指定國家/地區可存取的所有傳入號碼。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
國家
|
country | True | string |
ISO 3166-1 alpha-2 格式的代碼。 |
|
搜尋模式
|
Search Pattern | string |
選擇一種模式。 |
|
|
樣式
|
pattern | number |
要搜尋的數字模式。 |
|
|
可用功能
|
features | string |
簡訊或語音 |
|
|
結果計數
|
size | number |
預設值為 10。 |
|
|
頁面索引
|
index | number |
回應中的索引。 |
傳回
列出應用程式
擷取與您的帳戶相關聯的所有應用程式清單。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
結果計數
|
page_size | number |
每次呼叫時傳回的專案 (預設值 10)。 |
|
|
頁面索引
|
page_index | number |
從第一頁偏移 (預設值 0)。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
applications
|
_embedded.applications | array of applicationResponse |
列出擁有的號碼
此操作會擷取與您的帳戶相關聯的所有號碼。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
搜尋模式
|
Search Pattern | string |
選擇一種模式。 |
|
|
頁面索引
|
index | number |
回應中的索引。 |
|
|
結果計數
|
size | number |
預設值為 10,最多 100。 |
|
|
樣式
|
pattern | number |
要搜尋的數字模式。 |
傳回
刪除應用程式
此作業可用來刪除您帳戶中的現有應用程式。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
應用程式識別碼
|
application_id | True | string |
應用程式的唯一識別碼。 |
傳回
- 身體
- common
建立新的應用程式
此作業可用來在您的帳戶中建立新應用程式。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
名稱
|
name | True | string |
應用程式的名稱。 |
|
類型
|
type | True | string |
應用程式類型。 |
|
答案網址
|
answer_url | True | string |
您的 Webhook 傳遞 Nexmo 呼叫控制物件的位置。 |
|
事件網址
|
event_url | True | string |
已啟動、響鈴或完成 |
|
答題方法
|
answer_method | string |
HTTP 方法(預設 GET)。 |
|
|
活動方式
|
event_method | string |
HTTP 方法(預設 POST)。 |
傳回
更新應用程式
此作業可用來修改您帳戶中的現有應用程式。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
應用程式識別碼
|
application_id | True | string |
應用程式的唯一識別碼。 |
|
名稱
|
name | True | string |
應用程式的名稱。 |
|
類型
|
type | True | string |
應用程式類型。 |
|
答案網址
|
answer_url | True | string |
您的 Webhook 傳遞 Nexmo 呼叫控制物件的位置。 |
|
事件網址
|
event_url | True | string |
已啟動、響鈴或完成 |
|
答題方法
|
answer_method | string |
HTTP 方法(預設 GET)。 |
|
|
活動方式
|
event_method | string |
HTTP 方法(預設 POST)。 |
傳回
發送短信
此操作用於發送短信。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
寄件者識別碼
|
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-class | number |
選擇一個班級。 |
|
|
使用者資料標頭
|
udh | string |
十六進制編碼的 UDH。 |
|
|
更高級別的協議
|
protocol-id | string |
通訊協定識別碼。 |
|
|
Body (如果類型是二進位。
|
body | string |
十六進制編碼的二進位數據。 |
|
|
Title
|
title | string |
如果類型是 wappush。 |
|
|
網址
|
url | url |
網站網址(如果類型是 wappush。 |
|
|
可用性 (如果類型為 wappush。
|
validity | string |
以毫秒為單位。 |
傳回
- 身體
- smsResponse
通過 ID 獲取應用程序
此作業可用來擷取單一應用程式的相關資訊,指定其識別碼。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
應用程式識別碼
|
application_id | True | string |
應用程式的唯一識別碼。 |
傳回
定義
sms回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
訊息計數
|
message-count | string |
訊息分割成的部分數。 |
|
訊息陣列
|
messages | array of object |
包含每個訊息部分。 |
|
地位
|
messages.status | string |
顯示 SMS 傳送的處理方式。 |
|
訊息標識碼
|
messages.message-id | string |
已提交簡訊的 ID (8 到 16 個字元)。 |
|
至電話號碼
|
messages.to | string |
您的請求發送到的號碼。 |
|
客戶參考
|
messages.client-ref | string |
您在請求中設定的用戶端參考。 |
|
餘額
|
messages.remaining-balance | string |
您帳戶中的餘額。 該值以歐元為單位。 |
|
留言價格
|
messages.message-price | string |
為您的請求收取的金額。 該值以歐元為單位。 |
|
網路
|
messages.network | string |
移動國家/地區代碼 移動網絡代碼 (MCCMNC) 用於註冊的運營商。 |
|
錯誤文字
|
messages.error-text | string |
如果發生錯誤,這說明發生了什麼。 |
ListNumbers回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
count | integer |
結果計數。 |
|
數字陣列
|
numbers | array of object |
所有號碼的清單。 |
|
費用
|
numbers.cost | string |
數字成本。 |
|
國家
|
numbers.country | string |
ISO 3166-1 alpha-2 格式。 |
|
入站號碼
|
numbers.msisdn | string |
傳入虛擬號碼。 |
|
類型
|
numbers.type | string |
數字類型。 |
tts回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
通話 ID
|
call_id | string |
此呼叫的唯一英數字元 32 個字元 ID。 |
|
至電話號碼
|
to | string |
您傳送 TTS 或 TTS 提示給的使用者號碼。 |
|
地位
|
status | string |
此 TTS 或 TTS 提示的回應碼。 |
|
錯誤文字
|
error_text | string |
如果發生錯誤,這說明發生了什麼。 |
應用程式回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Id
|
id | string |
Nexmo 應用程式 ID。 |
|
名稱
|
name | string |
應用程式名稱。 |
|
Keys
|
keys.public_key | string |
通
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
回應
|
type | string |
人類可讀的訊息。 |
|
錯誤文字
|
error_title | string |
如果失敗,則傳回錯誤標題。 |