Как назначить номера fax через API Fax.Plus?

Кто может использовать эту функцию?

Доступно на Enterprise тарифе.

Владелец и администраторы.

Обзор

Эта статья объясняет, как назначать номера fax корпоративным пользователям через API Fax.Plus. Вы узнаете, как получить список корпоративных участников, назначить номера конкретным пользователям и отменить назначение номеров при необходимости.

Предварительные требования

  • Активная учётная запись Fax.Plus Enterprise
  • Действительные API-ключи
  • Два или более номера 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>"
    }
    Замените {number} в URL на фактический номер fax, который нужно назначить, а значение assigned_to— на UIDпользователя.
    Подробнее: Назначение номера — Fax.Plus API
  3. Отмена назначения номера
    Если нужно снять назначение номера с пользователя, используйте этот эндпоинт:
    DELETE /v3/accounts/{user_id}/numbers/{number}
    Подробнее: Отмена назначения номера — Fax.Plus API
    Параметры:
    • user_idID пользователя, у которого нужно отменить назначение номера
    • numberНомер fax, который нужно снять с пользователя

Устранение неполадок

Распространённые проблемы и способы их решения

  1. Ошибка 403 Forbidden
    • Причина: недостаточно прав доступа или используется не административная учётная запись
    • Решение: убедитесь, что вы используете учётную запись администратора и обладаете необходимыми правами доступа к API
  2. Ошибка 404 Not Found
    • Причина: неверный идентификатор пользователя или номер fax
    • Решение: проверьте правильность идентификатора пользователя и номера fax
  3. Ошибка 400 Bad Request
    • Причина: неверный формат запроса или попытка отменить назначение номера у администратора
    • Решение: проверьте формат запроса и убедитесь, что вы не пытаетесь отменить назначение номеров у учётных записей администраторов

 

Была ли эта статья полезной?
Пользователи, считающие этот материал полезным: 0 из 1
More Articles in this section