この API を呼び出して、電話番号の基本情報とステータスを照会します。
操作説明
この API を呼び出す前に、Number Encyclopedia の料金体系を十分に理解していることを確認してください。
この API を呼び出す前に、Number Encyclopedia コンソールにログインします。[タグスクエア] ページで、必要なタグを見つけて [Request Access] をクリックします。
この API は、応答内の
CodeパラメータがOKの場合にのみ課金されます。その他の結果を返す呼び出しに対しては課金されません。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| PhoneNumber |
string |
任意 |
照会する電話番号。 |
example |
| AuthCode |
string |
任意 |
認可コード。 説明
Number Encyclopedia コンソールにログインします。[マイアプリケーション] ページで、認可コードを取得します。 |
example |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| AccessDeniedDetail |
string |
アクセス拒否の詳細です。このパラメータは、RAM 認証が失敗した場合にのみ返されます。 |
None |
| RequestId |
string |
リクエストの一意の ID です。 |
1C3B8084-3A7D-570B-BC84-BF945A9CF65E |
| Message |
string |
ステータスコードの説明です。 |
OK |
| Data |
object |
返されるデータです。 |
|
| Call |
object |
呼び出しの詳細です。 |
|
| MinLength |
integer |
最小長です。 |
21 |
| CleansedCode |
string |
クレンジングコードです。 |
example |
| MaxLength |
integer |
最大長です。 |
22 |
| PhoneType |
string |
電話番号のタイプです。 |
example |
| CountryIso3 |
string |
電話番号が登録されている国の ISO 3166-1 alpha-3 コードです。 |
example |
| Live |
object |
電話番号のリアルタイムステータスです。 |
|
| RoamingCountry |
string |
ローミング国です。 |
example |
| DeviceStatus |
string |
デバイスステータスです。 |
example |
| SubscriberStatus |
string |
サブスクリプションステータスです。 |
example |
| Roaming |
string |
ローミングステータスです。 |
example |
| Sms |
object |
SMS の詳細です。 |
|
| MinLength |
integer |
最小長です。 |
2 |
| MaxLength |
integer |
最大長です。 |
59 |
| CleansedCode |
integer |
クレンジングコードです。 |
58 |
| Carrier |
string |
電話番号のキャリアです。 |
example |
| City |
string |
電話番号が登録されている都市です。 |
example |
| Blocked |
string |
分析が失敗した場合に実行がブロックされるかどうかを示します。 |
example |
| Code |
string |
ステータスコードです。有効な値：
|
OK |
例
成功レスポンス
JSONJSON
{
"AccessDeniedDetail": "None",
"RequestId": "1C3B8084-3A7D-570B-BC84-BF945A9CF65E",
"Message": "OK",
"Data": {
"Call": {
"MinLength": 21,
"CleansedCode": "example",
"MaxLength": 22
},
"PhoneType": "example",
"CountryIso3": "example",
"Live": {
"RoamingCountry": "example",
"DeviceStatus": "example",
"SubscriberStatus": "example",
"Roaming": "example"
},
"Sms": {
"MinLength": 2,
"MaxLength": 59,
"CleansedCode": 58
},
"Carrier": "example",
"City": "example",
"Blocked": "example"
},
"Code": "OK"
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。