Fax.Plus APIを使用してFAX番号を割り当てる方法

概要

このガイドでは、Fax.Plus APIを使用して法人ユーザーにFAX番号を割り当てる方法について説明します。法人メンバーの一覧表示、特定のユーザーへの番号の割り当て、必要に応じた番号割り当ての取り消しの方法について学びます。

前提条件

• 有効なFax.Plus Enterpriseアカウント
• 有効なAPI認証情報
• アカウント内に2つ以上のFAX番号があること

手順ガイド

1. 法人メンバーを一覧表示する
   まず、法人アカウント内のすべてのメンバーの一覧を取得します。このエンドポイントには、管理者アカウントのみがアクセスできます。
   GET /v3/accounts

{
"members": [
{
"account_data": {
"company_name": "Company name",
"default_file_type": "pdf",
"save_history": true
},
"account_type": "corporate_admin",
"email": "John@sample.com",
"lastname": "Smith",
"status": "active",
"uid": "7724157c0974440293e45877c57f0703"
}
]
}重要: 番号を割り当てたいメンバーのUIDを記録しておいてください。次のステップで必要になります。
   詳細情報: 法人メンバーを一覧表示する - Fax.Plus API
2. ユーザーに番号を割り当てる
   ユーザーのUIDがわかったら、次のエンドポイントを使用してFAX番号を割り当てることができます。
   POST /v3/accounts/self/numbers/{number}
   リクエストボディ:
   {
"assigned_to": "<uid>"
}URL内の{number}を割り当てたい実際のFAX番号に置き換え、assigned_toの値をユーザーのUIDに置き換えてください。
   詳細情報: 番号を割り当てる - Fax.Plus API
3. 番号の割り当てを解除する
   ユーザーから番号の割り当てを削除する必要がある場合は、このエンドポイントを使用します。
   DELETE /v3/accounts/{user_id}/numbers/{number}
   詳細情報: 番号の割り当てを解除する - Fax.Plus API
   パラメーター:
   
   • user_id番号の割り当てを解除するユーザーのID
   • numberユーザーから削除するFAX番号

トラブルシューティング

よくある問題と解決方法

1. 403 Forbidden エラー
   
   • 原因: 権限が不十分、または管理者以外のアカウントを使用している
   • 解決方法: 管理者アカウントを使用しており、必要なAPIスコープを持っていることを確認してください
2. 404 Not Found エラー
   • 原因: 無効なユーザーIDまたはFAX番号
   • 解決方法: ユーザーIDとFAX番号が正しいことを再確認してください
3. 400 Bad Request エラー
   • 原因: 無効なリクエスト形式、または管理者から番号を削除しようとしている
   • 解決方法: リクエスト形式を確認し、管理者アカウントから番号を削除しようとしていないことを確認してください