変数付きの音声検証コードまたは音声通知を、電話番号宛てに送信します。音声ファイルまたは音声合成 (TTS) テンプレートを使用できます。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| CallerIdNumber |
string |
任意 |
発信者番号です。このパラメータを指定しない場合、システムはローカルのランダム番号を表示番号として使用します。アウトバウンドコールに専用番号を使用する場合は、購入した番号を指定する必要があります。指定できる番号は 1 つのみです。購入済みの電話番号は、VMS コンソールにログインし、番号管理ページで確認できます。 |
852****0001 |
| CalledNumber |
string |
任意 |
音声通知を受信する電話番号です。電話番号の先頭に国/地域のダイヤルコードを付加する必要があります。例： 85200****00。 |
852****0000 |
| TtsCode |
string |
任意 |
TTS テンプレートのテンプレート ID です。テンプレート ID は、VMS コンソールにログインし、TTS テンプレートページで確認できます。TtsCode または VoiceCode のいずれかを指定する必要があります。TtsCode を指定すると音声合成が通話内容として使用され、VoiceCode を指定すると音声ファイルが通話内容として使用されます。 |
1001 |
| TtsParam |
string |
任意 |
テンプレート内の変数です。JSON フォーマットで指定します。 |
{"code":"1234"} |
| VoiceCode |
string |
任意 |
音声ファイルテンプレートのテンプレート ID です。テンプレート ID は、VMS コンソールにログインし、音声ファイルテンプレートページで確認できます。TtsCode または VoiceCode のいずれかを指定する必要があります。TtsCode を指定すると音声合成が通話内容として使用され、VoiceCode を指定すると音声ファイルが通話内容として使用されます。 |
1002 |
| PlayTimes |
integer |
任意 |
通話中に音声通知を再生する回数です。有効値： 1～3。デフォルト値： 3。 |
2 |
| Volume |
integer |
任意 |
音声通知の再生音量です。有効値： 0～100。デフォルト値： 100。 |
100 |
| Speed |
integer |
任意 |
再生速度です。有効値： -500～500。 |
0 |
| TaskName |
string |
任意 |
タスク名です。 |
单呼任务名 |
| SendType |
integer |
任意 |
配信タイプです。有効値： 1、2。1： タスクを即時配信します。2： 予約した時刻にタスクを配信します。このパラメータを 2 に設定する場合は、TimingStart を指定する必要があります。 |
1 |
| TimingStart |
string |
任意 |
タスクの予約時刻です。 |
2022-05-01T08:00:00+08:00 |
| OutId |
string |
任意 |
呼び出し元向けに予約された外部 ID です。この ID は、レシートメッセージで呼び出し元に返されます。値は 1～15 バイトの文字列である必要があります。 |
22522**** |
| CountryId |
string |
任意 |
ISO2 の国/地域コードです。 |
HK |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| AccessDeniedDetail |
string |
アクセス拒否の詳細です。 |
"" |
| Message |
string |
戻りメッセージです。 |
OK |
| RequestId |
string |
リクエスト ID です。 |
D9CB****-****-****-****-********9D23 |
| Model |
object |
戻りデータです。 |
|
| Code |
string |
エラーコードです。「SUCCESS」はリクエストが成功したことを示します。その他のエラーコードについては、「Error codes」をご参照ください。 |
SUCCESS |
| Success |
boolean |
リクエストが成功したかどうかを示します。有効値： true、false。 |
true |
例
成功レスポンス
JSONJSON
{
"AccessDeniedDetail": "\"\"",
"Message": "OK",
"RequestId": "D9CB****-****-****-****-********9D23\n",
"Model": {
"test": "test",
"test2": 1
},
"Code": "SUCCESS",
"Success": true
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。