概述
本指南将说明如何通过Fax.Plus API将 fax 号码分配给企业用户。您将了解如何列出企业成员、将号码分配给特定用户,以及在需要时撤销号码分配。
前提条件
- 一个有效的 Fax.Plus Enterprise 账户
- 有效的 API 凭证
- 您的账户中有两个或更多 fax 号码
分步指南
-
列出企业成员
首先,获取您企业账户中所有成员的列表。此端点只能由管理员账户访问。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 -
将号码分配给用户
获得用户的UID后,您可以使用以下端点将 fax 号码分配给该用户:POST /v3/accounts/self/numbers/{number}
请求正文:{将 URL 中的
"assigned_to": "<uid>"
}{number}替换为您要分配的实际 fax 号码,并将assigned_to的值替换为该用户的UID。
了解更多:分配号码 - Fax.Plus API - 撤销号码分配
如果您需要撤销某个用户的号码分配,请使用此端点:DELETE /v3/accounts/{user_id}/numbers/{number}
了解更多:撤销号码 - Fax.Plus API
参数:
-
user_id要撤销号码的用户 ID -
number要从用户处移除的 fax 号码
-
故障排除
常见问题及解决方法
-
403 Forbidden 错误
- 原因:权限不足或使用了非管理员账户
- 解决方法:确认您使用的是管理员账户,并具有所需的 API 权限范围
-
404 Not Found 错误
- 原因:用户 ID 或 fax 号码无效
- 解决方法:再次核实用户 ID 和 fax 号码是否正确
-
400 Bad Request 错误
- 原因:请求格式无效,或尝试从管理员账户中移除号码
- 解决方法:确认请求格式正确,并确保您没有尝试从管理员账户中移除号码