Vonage (プレビュー)
Vonage API プラットフォームを使用すると、SMS、音声、チャットなど、アプリケーションのコンテキスト内で通信を追加できます。 Nexmo アカウントはこちらからサインアップします - https://www.vonage.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) - 21 Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
| お問い合わせ先 | |
|---|---|
| 件名 | Vonage サポート |
| [URL] | https://www.vonage.co.uk/support |
| メール | support@vonage.com |
| Connector Metadata | |
|---|---|
| 発行者 | Vonage |
| Web サイト | https://vonage.com |
| プライバシー ポリシー | https://www.vonage.com/legal/privacy-policy |
| カテゴリー | 通信 |
Vonage API プラットフォームを使用すると、SMS、音声、チャットなど、アプリケーションのコンテキスト内で通信を追加できます。
前提条件
続行するには、次のものが必要です。
- Vonage アカウント (https://dashboard.nexmo.com/sign-up でサインアップ)
資格情報の入手方法
資格情報を取得するには、https://dashboard.nexmo.com/sign-up で Vonage アカウントにサインアップできます
既知の問題と制限事項
このコネクタは現在、すべての Vonage 製品と API を公開しているわけではありません
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| チェックを確認する |
ユーザーから受け取った PIN が確認リクエストと一致することを確認します |
| 特定のチャネルにメッセージを送信する |
メッセージを送信する |
| 番号に関する基本的な番号洞察情報を提供します |
番号に関する基本的な番号洞察情報を提供します |
| 番号に関する標準番号洞察情報を提供します |
番号に関する標準番号洞察情報を提供します |
| 要求の検証 |
確認リクエストを使用して、PIN を生成してユーザーに送信します |
チェックを確認する
ユーザーから受け取った PIN が確認リクエストと一致することを確認します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
応答の形式
|
format | True | string |
応答の形式 |
|
あなたの API キー
|
api_key | True | string |
あなたの API キー |
|
あなたの API シークレット
|
api_secret | True | string |
あなたの API シークレット |
|
これは、確認リクエストへの応答で受け取った request_id です
|
request_id | True | string |
これは、確認リクエストへの応答で受け取った request_id です |
|
ユーザーが入力した確認コード
|
code | True | string |
ユーザーが入力した確認コード |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
request_id
|
request_id | string | |
|
event_id
|
event_id | string | |
|
状態
|
status | string | |
|
price
|
price | string | |
|
currency
|
currency | string | |
|
estimated_price_messages_sent
|
estimated_price_messages_sent | string |
特定のチャネルにメッセージを送信する
メッセージを送信する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Content-Type for request
|
Content-Type | True | string |
Content-Type |
|
受理した日付の種類
|
Accept | True | string |
引き受け |
|
メッセージの種類を表示します。 このフィールドにテキストを入力する必要があります
|
message_type | string |
メッセージの種類を表示します。 このフィールドにテキストを入力する必要があります |
|
|
送信するメッセージのテキスト; 最大 1000 文字に制限
|
text | string |
送信するメッセージのテキスト; 最大 1000 文字に制限 |
|
|
E.164 形式のメッセージ受信者の電話番号
|
to | string |
E.164 形式のメッセージ受信者の電話番号 |
|
|
E.164 形式のメッセージ受信者の電話番号
|
from | string |
E.164 形式のメッセージ受信者の電話番号 |
|
|
送信先のチャネル。 このフィールドに SMS を入力する必要があります
|
channel | string |
送信先のチャネル。 このフィールドに SMS を入力する必要があります |
|
|
最大 40 文字のクライアント参照
|
client_ref | string |
最大 40 文字のクライアント参照 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
message_uuid
|
message_uuid | string |
message_uuid |
番号に関する基本的な番号洞察情報を提供します
番号に関する基本的な番号洞察情報を提供します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
応答の形式
|
format | True | string |
応答の形式 |
|
あなたの API キー
|
api_key | True | string |
あなたの API キー |
|
あなたの API シークレット
|
api_secret | True | string |
あなたの API シークレット |
|
国内または国際的な形式で洞察が必要な電話番号
|
number | True | string |
国内または国際的な形式で洞察が必要な電話番号 |
|
2 文字の国コード (ISO 3166-1 alpha-2 format eg)。 GB または US
|
country | True | string |
2 文字の国コード (ISO 3166-1 alpha-2 format eg)。 GB または US |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
状態
|
status | integer | |
|
status_message
|
status_message | string | |
|
request_id
|
request_id | string | |
|
international_format_number
|
international_format_number | string | |
|
national_format_number
|
national_format_number | string | |
|
country_code
|
country_code | string | |
|
country_code_iso3
|
country_code_iso3 | string | |
|
country_name
|
country_name | string | |
|
country_prefix
|
country_prefix | string |
番号に関する標準番号洞察情報を提供します
番号に関する標準番号洞察情報を提供します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
応答の形式
|
format | True | string |
応答の形式 |
|
あなたの API キー
|
api_key | True | string |
あなたの API キー |
|
あなたの API シークレット
|
api_secret | True | string |
あなたの API シークレット |
|
国内または国際的な形式で洞察が必要な電話番号
|
number | True | string |
国内または国際的な形式で洞察が必要な電話番号 |
|
2 文字の国コード (ISO 3166-1 alpha-2 format eg)。 GB または US
|
country | True | string |
2 文字の国コード (ISO 3166-1 alpha-2 format eg)。 GB または US |
|
応答で電話番号の所有者名を受け取るには、true に設定します
|
cnam | string |
応答で電話番号の所有者名を受け取るには、true に設定します |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
状態
|
status | integer | |
|
status_message
|
status_message | string | |
|
request_id
|
request_id | string | |
|
international_format_number
|
international_format_number | string | |
|
national_format_number
|
national_format_number | string | |
|
country_code
|
country_code | string | |
|
country_code_iso3
|
country_code_iso3 | string | |
|
country_name
|
country_name | string | |
|
country_prefix
|
country_prefix | string | |
|
request_price
|
request_price | string | |
|
refund_price
|
refund_price | string | |
|
remaining_balance
|
remaining_balance | string | |
|
network_code
|
current_carrier.network_code | string | |
|
名前
|
current_carrier.name | string | |
|
国
|
current_carrier.country | string | |
|
network_type
|
current_carrier.network_type | string | |
|
network_code
|
original_carrier.network_code | string | |
|
名前
|
original_carrier.name | string | |
|
国
|
original_carrier.country | string | |
|
network_type
|
original_carrier.network_type | string | |
|
ポート
|
ported | string | |
|
caller_type
|
caller_identity.caller_type | string | |
|
caller_name
|
caller_identity.caller_name | string | |
|
first_name
|
caller_identity.first_name | string | |
|
last_name
|
caller_identity.last_name | string | |
|
caller_name
|
caller_name | string | |
|
last_name
|
last_name | string | |
|
first_name
|
first_name | string | |
|
caller_type
|
caller_type | string |
要求の検証
確認リクエストを使用して、PIN を生成してユーザーに送信します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
応答の形式
|
format | True | string |
応答の形式 |
|
自分の API キーは、アカウント ダッシュボード https://dashboard.nexmo.com にあります
|
api_key | True | string |
自分の API キーは、アカウント ダッシュボード https://dashboard.nexmo.com にあります |
|
自分の API シークレットは、アカウント ダッシュボード https://dashboard.nexmo.com にあります
|
api_secret | True | string |
自分の API シークレットは、アカウント ダッシュボード https://dashboard.nexmo.com にあります |
|
確認する携帯電話または固定電話の電話番号。 番号は、E.164 形式にする必要があります
|
number | True | string |
確認する携帯電話または固定電話の電話番号。 番号は、E.164 形式にする必要があります |
|
2 文字の国コードを指定し、確認すると番号がフォーマットされます
|
country | string |
2 文字の国コードを指定し、確認すると番号がフォーマットされます |
|
|
18 文字の英数字の文字列。リクエストの SMS 本文をパーソナライズするために使用します
|
brand | True | string |
18 文字の英数字の文字列。リクエストの SMS 本文をパーソナライズするために使用します |
|
送信者の ID を表す 11 文字の英数字の文字列
|
sender_id | string |
送信者の ID を表す 11 文字の英数字の文字列 |
|
|
確認コードの長さ
|
code_length | integer |
確認コードの長さ |
|
|
確認リクエストに使用される言語を制御する
|
lg | string |
確認リクエストに使用される言語を制御する |
|
|
生成された検証コードの有効期間 (秒単位)
|
pin_expiry | integer |
生成された検証コードの有効期間 (秒単位) |
|
|
確認コードの配信を試行する間隔 (秒単位)
|
next_event_wait | integer |
確認コードの配信を試行する間隔 (秒単位) |
|
|
PIN をユーザーに伝えるための事前定義された SMS および TTS アクションのシーケンス
|
workflow_id | integer |
PIN をユーザーに伝えるための事前定義された SMS および TTS アクションのシーケンス |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
状態
|
status | string | |
|
request_id
|
request_id | string |