Como atribuir números de fax utilizando a API do Fax.Plus?

Visão geral

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

Pré-requisitos

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

Guia passo a passo

1. Listar membros corporativos
   Primeiro, obtenha uma lista de todos os membros da sua conta corporativa. Este endpoint só pode ser acedido por contas de administrador.
   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"
}
]
}Importante: Anote o UIDdo membro ao qual pretende atribuir o número. Vai precisar deste dado no passo seguinte.
   Saiba mais: Listar membros corporativos - API do Fax.Plus
2. Atribuir um número ao utilizador
   Depois de ter o UIDdo utilizador, pode atribuir-lhe um número de fax utilizando o seguinte endpoint:
   POST /v3/accounts/self/numbers/{number}
   Corpo do pedido:
   {
"assigned_to": "<uid>"
}Substitua {number} na URL pelo número de fax real que pretende atribuir, e o valor de assigned_topelo UIDdo utilizador.
   Saiba mais: Atribuir número - API do Fax.Plus
3. Revogar atribuição de número
   Se precisar de remover a atribuição de um número a um utilizador, use este endpoint:
   DELETE /v3/accounts/{user_id}/numbers/{number}
   Saiba mais: Revogar número - API do Fax.Plus
   Parâmetros:
   
   • user_idID do utilizador ao qual pretende revogar o número
   • numberNúmero de fax a remover do utilizador

Resolução de problemas

Problemas comuns e soluções

1. Erro 403 Forbidden
   
   • Causa: Permissões insuficientes ou conta sem privilégios de administrador
   • Solução: Verifique se está a utilizar uma conta de administrador e se tem os âmbitos de API necessários
2. Erro 404 Not Found
   • Causa: ID de utilizador ou número de fax inválido
   • Solução: Verifique novamente se o ID de utilizador e o número de fax estão corretos
3. Erro 400 Bad Request
   • Causa: Formato de pedido inválido ou tentativa de remover um número de um administrador
   • Solução: Verifique o formato do pedido e certifique-se de que não está a tentar remover números de contas de administrador