Общий обзор
В этом руководстве объясняется, как назначить номер факса корпоративным пользователям через Fax.Plus API. Вы узнаете, как составить список корпоративных участников, назначить номера определенным пользователям и, при необходимости, отозвать номера назначений.
Предпосылки
- Активная учетная запись Fax.Plus Enterprise
- Допустимые учетные данные API
- Два или более номера факсов на вашем счете
Пошаговое руководство
-
Список корпоративных членов
Во-первых, вы получите список всех участников вашей корпоративной учетной записи. Доступ к этой конечной точке возможен только с помощью учетных записей администратора.GET /v3/accounts
{
Важно: Обратите внимание на
"members": [
{
"account_data": {
"company_name": "Название компании",
"default_file_type": "pdf",
"save_history": истина
},
"account_type": "corporate_admin",
"email": "John@sample. om",
"фамилия": "Смит",
"статус": "активный", "активный",
"uid": "7724157c0974440293e45877c57f0703"
}
]
}UID
члена для назначения номера. You'll need this in the next step.
Learn more: List corporate members - 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 пользователя для снятия номера с -
number
Fax number to remove from the user
-
Устранение проблем
Общие вопросы и решения
-
403 Запрещенная ошибка
- Причина: Недостаточно прав доступа или учетной записи без администрирования
- Решение: Проверьте, что вы используете учетную запись администратора и имеете необходимые области API
-
Ошибка 404 не найдена
- Причина: Неверный ID пользователя или номер факса
- Решение: Проверьте правильность номера пользователя и факса
-
400 ошибочная ошибка запроса
- Причина: Неверный формат запроса или попытка удалить число из администратора
- Решение: Подтвердите формат запроса и убедитесь, что вы не пытаетесь удалить номера из учетной записи администратора