概要
このガイドでは、 Fax.Plus API を介して企業ユーザーにFAX番号を割り当てる方法について説明します。 企業メンバーの一覧表示、特定のユーザーに番号の割り当て、必要に応じて番号の割り当てを取り消す方法を学びます。
前提条件
- アクティブな Fax.Plus Enterprise アカウント
- 有効な API 資格情報
- 2つ以上のFAX番号がアカウントにあります
ステップバイステップガイド
-
企業メンバー
まず、企業アカウント内のすべてのメンバーのリストを取得します。 This endpoint can be accessed only by Admin accounts.GET /v3/accounts
{
Important: Note down the
"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
of the member you want to assign the number to. 次のステップでこれが必要になります。
詳細: 企業メンバー一覧 - Fax.Plus API -
Assign a number to the user
Once you have the user'sUIU
, you can assign a fax number to them using the following endpoint:POST /v3/accounts/self/numbers/{number}
Request body:{
Replace
"assigned_to": "<uid>"
}{number}
in the URL with the actual fax number you want to assign, and theassigned_to
value with the user'sUIU
.
Learn more: Assign number - Fax.Plus API - Revoke number assignment
If you need to remove a number assignment from a user, use this endpoint:DELETE /v3/accounts/{user_id}/numbers/{number}
Learn more: Revoke number - Fax.Plus API
Parameters:
-
user_id
から番号を取り消すユーザの ID -
番号
ユーザから削除する Fax 番号
-
トラブルシューティング
一般的な問題と解決策
-
403 ForbiddenError
- 原因: 権限が不足している、または非管理者アカウント
- ソリューション: 管理者アカウントを使用していて、必要な API スコープがあることを確認してください
-
404 Not Found Error
- 原因: 無効なユーザーIDまたはFAX番号
- ソリューション: ユーザーIDとFAX番号を再確認してください
-
400 Bad Request Error
- 原因: 無効なリクエスト形式または管理者から番号を削除しようとしています
- ソリューション: リクエスト形式を確認し、管理者アカウントから番号を削除しようとしていないことを確認してください