電話番号の検証ステータスを取得します。
操作説明
-
この API を呼び出して、電話番号の確認ステータスを取得できます。ステータスは、[チャネル管理] > [管理] > [WABA 管理] > [電話番号管理] ページで表示することもできます。
-
この API を呼び出す前に、WhatsApp Business Account (WABA) に電話番号を追加し、確認のために送信してください。
-
WABA に電話番号を追加していない場合は、GetChatappVerifyCode API と ChatappVerifyAndRegister API を呼び出して確認コードを取得し、番号を登録できます。
この API には、ユーザーあたり 10 クエリ/秒 (QPS) の制限があります。この制限を超えると、API 呼び出しがスロットリングされ、ビジネスに影響を与える可能性があります。指定された制限内でこの API を呼び出してください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
cams:GetPhoneNumberVerificationStatus |
get |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| PhoneNumber |
string |
必須 |
電話番号。電話番号は、[チャネル管理] > [管理] > [WABA 管理] > [電話番号管理] ページで表示できます。 |
86138009**** |
| CustSpaceId |
string |
必須 |
独立系ソフトウェアベンダー (ISV) のサブ顧客の Space ID、または直接の顧客のインスタンス ID。Space ID は、[チャネル管理] ページで表示できます。 |
cams-kei**** |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスパラメーター。 |
||
| AccessDeniedDetail |
string |
アクセス拒否に関する詳細。 |
None |
| RequestId |
string |
リクエスト ID。 |
90E63D28-E31D-1EB2-8939-A94866411B2D |
| Message |
string |
エラーメッセージ。 |
None |
| Data |
object |
返されたデータ。 |
|
| CodeVerificationStatus |
string |
確認ステータス。有効な値:
列挙値:
|
VERIFIED |
| PhoneNumber |
string |
電話番号。 |
861390000**** |
| Id |
string |
電話番号の ID。 |
222434**** |
| Code |
string |
リクエストのステータスコード。
|
OK |
例
成功レスポンス
JSONJSON
{
"AccessDeniedDetail": "None\n",
"RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2D",
"Message": "None",
"Data": {
"CodeVerificationStatus": "VERIFIED",
"PhoneNumber": "861390000****",
"Id": "222434****"
},
"Code": "OK"
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | Product.Unsubscript | You have not subscribed to the specified product. | |
| 400 | Ram.PermissionDeny | You are not authorized to perform the operation. | |
| 400 | System.LimitControl | The system is under flow control. | |
| 400 | Unknown.ResourceOwnerId | The resource does not belong to the current user. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。