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

この機能を使用できるのは誰ですか?

エンタープライズ プラン で利用できます。

所有者と管理者

概要

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

前提条件

  • アクティブな Fax.Plus Enterprise アカウント
  • 有効な API 資格情報
  • 2つ以上のFAX番号がアカウントにあります

ステップバイステップガイド

  1. 企業メンバー
    まず、企業アカウント内のすべてのメンバーのリストを取得します。 This endpoint can be accessed only by Admin accounts.
    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"
    }
    ]
    }
    Important: Note down the UIDof the member you want to assign the number to. 次のステップでこれが必要になります。
    詳細: 企業メンバー一覧 - Fax.Plus API
  2. Assign a number to the user
    Once you have the user's UIU, you can assign a fax number to them using the following endpoint:
    POST /v3/accounts/self/numbers/{number}
    Request body:
    {
    "assigned_to": "<uid>"
    }
    Replace {number} in the URL with the actual fax number you want to assign, and the assigned_tovalue with the user's UIU.
    Learn more: Assign number - Fax.Plus API
  3. 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 番号

トラブルシューティング

一般的な問題と解決策

  1. 403 ForbiddenError
    • 原因: 権限が不足している、または非管理者アカウント
    • ソリューション: 管理者アカウントを使用していて、必要な API スコープがあることを確認してください
  2. 404 Not Found Error
    • 原因: 無効なユーザーIDまたはFAX番号
    • ソリューション: ユーザーIDとFAX番号を再確認してください
  3. 400 Bad Request Error
    • 原因: 無効なリクエスト形式または管理者から番号を削除しようとしています
    • ソリューション: リクエスト形式を確認し、管理者アカウントから番号を削除しようとしていないことを確認してください

 

この記事は役に立ちましたか?
0人中0人がこの記事が役に立ったと言っています
More Articles in this section