Como atribuir números de Fax usando a API Fax.Plus?

Geral

Este guia explica como atribuir números de fax para usuários corporativos através do Fax.Plus API. Você vai aprender como listar membros corporativos, atribuir números a usuários específicos, e revogar atribuições de números quando necessário.

Pré-requisitos

• Uma conta ativa do Fax.Plus Enterprise
• Credenciais de API válidas
• Dois ou mais números de fax em sua conta

Guia de passo

1. Listar membros corporativos
   Primeiro, recupere uma lista de todos os membros da sua conta corporativa. 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. Você precisará disso na próxima etapa.
   Saiba mais: lista membros corporativos - 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. Revogar o número da atividade
   Se você precisar excluir um número de atividade de um usuário, use este endpoint:
   DELETE /v3/accounts/{user_id}/numbers/{number}
   Saiba mais: Revogar número - Fax. Parâmetros API
   lus API:
   
   • user_idID do usuário para revogar o número de
   • númeroNúmero do fax a ser removido do usuário

Solução de problemas

Questões e soluções comuns

1. 403 Erro Proibido
   
   • Cause: Insufficient permissions or non-admin account
   • Solução: Verifique se você está usando uma conta de administrador e tenha os escopos da API necessários
2. Erro não encontrado 404
   • Causa: ID de usuário ou número de fax inválido
   • Solution: Double-check the user ID and fax number are correct
3. Erro de requisição 400 inválida
   • Causa: Formato de solicitação inválido ou tentativa de remover um número do admin
   • Solution: Verify request format and ensure you're not trying to remove numbers from admin accounts