> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xhuoapi.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# 電話番号の状態確認 API 接続説明

> Identity Authentication 集成指南 - XHuoAPI

本文では、電話番号の状態確認 API 接続説明を紹介します。これは電話番号の状態を検証するために使用でき、電話番号を入力して確認できます。

## 申請プロセス

APIを使用するには、まず [電話番号の状態確認 API](https://api.xhuoapi.ai/documents/037e2b5b-d0c0-425c-9e13-955ac64d1e07) の該当ページでサービスを申請する必要があります。ページに入ったら、「Acquire」ボタンをクリックします。以下の図のように：

![](https://cdn.xhuoapi.ai/q6ytrc.png)

まだログインまたは登録していない場合、自動的にログインページにリダイレクトされ、登録とログインを促されます。ログインまたは登録後、現在のページに自動的に戻ります。

初回申請時には無料のクレジットが付与され、この API を無料で使用できます。

## 基本使用

まず基本的な使用方法を理解します。電話番号を入力することで処理された結果を得ることができます。まず、`mobile` フィールドを簡単に渡す必要があります。次に、インターフェースに対応する内容を記入できます。以下の図のように：

<p>
  <img src="https://cdn.xhuoapi.ai/r17llo.png" width="500" className="m-auto" />
</p>

ここでは、Request Headers を設定しました。含まれるのは：

* `accept`：受け取りたいレスポンス結果の形式。ここでは `application/json`、つまり JSON 形式を記入します。
* `authorization`：APIを呼び出すためのキー。申請後、直接ドロップダウンから選択できます。

また、Request Body を設定しました。含まれるのは：

* `mobile`：処理する電話番号。必須パラメータです。
* `encryption`：オプション、機密フィールドの暗号化パラメータ（暗号文を送信する必要がある場合）。

選択後、右側にも対応するコードが生成されていることがわかります。以下の図のように：

<p>
  <img src="https://cdn.xhuoapi.ai/dpun55.png" width="500" className="m-auto" />
</p>

「Try」ボタンをクリックするとテストができます。上の図のように、以下の結果が得られました：

```json theme={null}
{
  "result": "0",
  "description": "成功",
  "status_code": 0
}
```

返された結果には複数のフィールドがあり、以下のように説明します：

* `result`、認証結果コード、料金状況は以下の通りです。
  * 料金結果コード：
    * 0：成功
  * 無料結果コード：
    * -1：結果が見つかりません
    * -2：電話番号の形式が正しくありません
    * -3：検証センターのサービスが混雑しています
* `description`、ビジネス結果の説明。
* `status_code`、ステータスコード：
  * 0：正常
  * 1：停止
  * 2：解約
  * 3：空番号
  * 4：ネットワーク外
  * 99：不明な状態

この電話番号の状態が確認できたことがわかります。

また、対応する接続コードを生成したい場合は、生成されたものを直接コピーできます。例えば、CURL のコードは以下の通りです：

```shell theme={null}
curl -X POST 'https://api.xhuoapi.ai/v1/identity/phone/check-1e' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "mobile": "***"
}'
```

Python の接続コードは以下の通りです：

```python theme={null}
import requests

url = "https://api.xhuoapi.ai/v1/identity/phone/check-1e"

headers = {
    "accept": "application/json",
    "authorization": "Bearer {token}",
    "content-type": "application/json"
}

payload = {
    "mobile": "***"
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)
```

## エラーハンドリング

APIを呼び出す際にエラーが発生した場合、APIは対応するエラーコードと情報を返します。例えば：

* `400 token_mismatched`：不正なリクエスト、パラメータが欠落または無効な可能性があります。
* `400 api_not_implemented`：不正なリクエスト、パラメータが欠落または無効な可能性があります。
* `401 invalid_token`：未認証、無効または欠落した認証トークン。
* `429 too_many_requests`：リクエストが多すぎます、レート制限を超えました。
* `500 api_error`：内部サーバーエラー、サーバーで何かがうまくいきませんでした。

### エラー応答の例

```json theme={null}
{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "fetch failed"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}
```

## 結論

この文書を通じて、電話番号の状態確認 API を使用して電話番号の状態を検証する方法を理解しました。電話番号を入力して確認できます。この文書が、APIの接続と使用をより良くする手助けとなることを願っています。何か問題があれば、いつでも技術サポートチームにお問い合わせください。