Nexmo
Nexmo、Vonage API プラットフォームを使用すると、SMS、音声、チャットなど、アプリケーションのコンテキスト内で通信を追加できます。 Nexmo アカウントはこちらからサインアップします - https://www.nexmo.com/
このコネクタは、次の製品および地域で利用可能です:
| Service | クラス | 地域 |
|---|---|---|
| Logic Apps | 標準 | 以下を除くすべての Logic Apps 地域 : - Azure 政府の地域 - Azure 中国の地域 - 国防総省 (DoD) |
| Power Automate | プレミアム | 以下を除くすべての Power Automate 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 国防総省 (DoD) |
| Power Apps | プレミアム | 以下を除くすべての Power Apps 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 国防総省 (DoD) |
| コネクタ メタデータ | |
|---|---|
| 公開元 | Microsoft |
接続の作成
コネクタは、次の認証タイプをサポートしています:
| 既定 | 接続を作成するためのパラメーター。 | すべての地域 | 共有不可 |
既定
適用できるもの: すべての領域
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 パワー アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
| 件名 | タイプ | 内容 | 必要 |
|---|---|---|---|
| API キー | 文字列 | API キー | 真 |
| API シークレット | securestring | API シークレット | True |
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| ID でアプリケーションを取得する |
この操作は、ID を指定して、単一のアプリケーションに関する情報を取得するために使用されます。 |
| SMS を送信する |
この操作は、SMS を送信するために使用されます。 |
| アプリケーションを一覧表示する |
アカウントに関連付けられているすべてのアプリケーションの一覧表示を取得します。 |
| アプリケーションを削除する |
この操作は、アカウントから既存のアプリケーションを削除するために使用されます。 |
| アプリケーションを更新する |
この操作は、アカウントから既存のアプリケーションを変更するために使用されます。 |
| インバウンド番号を一覧表示する |
この操作は、特定の国で利用可能なすべてのインバウンド番号を取得するために使用されます。 |
| 所有番号を一覧表示する |
この操作により、アカウントに関連付けられているすべての番号が取得されます。 |
| 新しいアプリケーションを作成する |
この操作は、アカウントに新しいアプリケーションを作成するために使用されます。 |
| 音声ファイルを送信する |
この操作は、合成音声または録音された音声ファイルを電話番号に送信するために使用されます。 |
ID でアプリケーションを取得する
この操作は、ID を指定して、単一のアプリケーションに関する情報を取得するために使用されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
アプリケーション ID
|
application_id | True | string |
アプリケーションの一意の識別子。 |
戻り値
- 本文
- applicationResponse
SMS を送信する
この操作は、SMS を送信するために使用されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
送信者 ID
|
from | True | string |
英数字の文字列。 |
|
電話番号
|
to | True | string |
国際フォーマット E.164。 |
|
テキスト
|
text | True | string |
SMS 本文。 |
|
タイプ
|
type | string |
既定値はテキスト。 |
|
|
受信確認
|
status-report-req | number |
有効にするには 1 に設定する。 |
|
|
クライアント リファレンス
|
client-ref | string |
内部報告用。 |
|
|
名刺
|
vcard | string |
vCard 形式。 |
|
|
カレンダーのイベント
|
vcal | string |
vCal 形式。 |
|
|
SMSの有効期間
|
ttl | number |
ミリ秒単位。 |
|
|
コールバック URL
|
callback | url |
配信受領エンドポイント。 |
|
|
メッセージ クラス
|
message-class | number |
クラスを選択する。 |
|
|
ユーザー データ ヘッダー
|
udh | string |
16 進数でエンコードされた UDH。 |
|
|
より高いレベルのプロトコル
|
protocol-id | string |
プロトコル ID。 |
|
|
本文 (型がバイナリの場合。)
|
body | string |
16 進数でエンコードされたバイナリ データ。 |
|
|
敬称
|
title | string |
型が wappush の場合。 |
|
|
URL
|
url | url |
Web サイトの URL (型が wappush の場合。)。 |
|
|
可用性 (型が wappush の場合。)
|
validity | string |
ミリ秒単位。 |
戻り値
- 本文
- smsResponse
アプリケーションを一覧表示する
アカウントに関連付けられているすべてのアプリケーションの一覧表示を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
結果数
|
page_size | number |
各呼び出しで返されるアイテム (既定は 10)。 |
|
|
ページ インデックス
|
page_index | number |
最初のページからのオフセット (既定 0)。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
アプリケーション
|
_embedded.applications | array of applicationResponse |
アプリケーションを削除する
この操作は、アカウントから既存のアプリケーションを削除するために使用されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
アプリケーション ID
|
application_id | True | string |
アプリケーションの一意の識別子。 |
戻り値
- 本文
- common
アプリケーションを更新する
この操作は、アカウントから既存のアプリケーションを変更するために使用されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
アプリケーション ID
|
application_id | True | string |
アプリケーションの一意の識別子。 |
|
件名
|
name | True | string |
アプリケーションの件名。 |
|
タイプ
|
type | True | string |
アプリケーションのタイプ。 |
|
URL に応答する
|
answer_url | True | string |
Webhook が Nexmo Call Control Object を配信する場所。 |
|
イベント URL
|
event_url | True | string |
開始、呼び出し中、または完了 |
|
応答方法
|
answer_method | string |
HTTP メソッド (既定の GET)。 |
|
|
イベント メソッド
|
event_method | string |
HTTP メソッド (既定の POST)。 |
戻り値
- 本文
- applicationResponse
インバウンド番号を一覧表示する
この操作は、特定の国で利用可能なすべてのインバウンド番号を取得するために使用されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
国
|
country | True | string |
ISO 3166-1 alpha-2 形式のコード。 |
|
検索パターン
|
Search Pattern | string |
パターンを選ぶ。 |
|
|
パターン
|
pattern | number |
検索する番号パターン。 |
|
|
利用可能な機能
|
features | string |
SMS または音声 |
|
|
結果数
|
size | number |
規定 10。 |
|
|
ページ インデックス
|
index | number |
応答のインデックス。 |
戻り値
- 本文
- ListNumbersResponse
所有番号を一覧表示する
この操作により、アカウントに関連付けられているすべての番号が取得されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
検索パターン
|
Search Pattern | string |
パターンを選ぶ。 |
|
|
ページ インデックス
|
index | number |
応答のインデックス。 |
|
|
結果数
|
size | number |
既定 10、最大 100。 |
|
|
パターン
|
pattern | number |
検索する番号パターン。 |
戻り値
- 本文
- ListNumbersResponse
新しいアプリケーションを作成する
この操作は、アカウントに新しいアプリケーションを作成するために使用されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
件名
|
name | True | string |
アプリケーションの件名。 |
|
タイプ
|
type | True | string |
アプリケーションのタイプ。 |
|
URL に応答する
|
answer_url | True | string |
Webhook が Nexmo Call Control Object を配信する場所。 |
|
イベント URL
|
event_url | True | string |
開始、呼び出し中、または完了 |
|
応答方法
|
answer_method | string |
HTTP メソッド (既定の GET)。 |
|
|
イベント メソッド
|
event_method | string |
HTTP メソッド (既定の POST)。 |
戻り値
- 本文
- applicationResponse
音声ファイルを送信する
この操作は、合成音声または録音された音声ファイルを電話番号に送信するために使用されます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
電話番号
|
to | True | string |
国際フォーマット E.164。 |
|
電話番号から
|
from | string |
音声対応の Nexmo 番号。 |
|
|
Message
|
text | True | string |
音声テキスト。 |
|
Language
|
lg | string |
メッセージを合成する。 |
|
|
性別
|
voice | string |
女性または男性。 |
|
|
繰り返し回数
|
repeat | number |
10 回まで。 |
|
|
マシン検出を許可する
|
machine_detection | string |
True または通話終了。 |
|
|
マシン タイムアウト
|
machine_timeout | number |
400 ミリ秒から 10000 ミリ秒。 |
|
|
コールバック URL
|
callback | url |
コールバックの URL。 |
|
|
コールバック方式
|
callback_method | string |
GET または POST。 |
戻り値
- 本文
- ttsResponse
定義
smsResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
メッセージ数
|
message-count | string |
メッセージが分割された部分の数。 |
|
メッセージ配列
|
messages | array of object |
各メッセージ部分を含む。 |
|
ステータス
|
messages.status | string |
SMS 送信がどのように処理されているかを示す。 |
|
メッセージ ID
|
messages.message-id | string |
送信された SMS の 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 |
登録されているキャリアの Mobile Country Code Mobile Network Code (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 | string |
アプリケーション名。 |
|
キー
|
keys.public_key | string |
https://en.wikipedia.org/wiki/JSON_Web_Token の jwt を検証するために使用される公開鍵。 |
共通
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
回答
|
type | string |
人間が読み取れるメッセージ。 |
|
エラー テキスト
|
error_title | string |
失敗した場合に返されるエラーのタイトル。 |