Descripción general
Esta guía explica cómo asignar números de fax a usuarios corporativos a través de la API de Fax.Plus. Aprenderá a listar miembros corporativos, asignar números a usuarios específicos y revocar asignaciones de números cuando sea necesario.
Requisitos previos
- Una cuenta Fax.Plus Enterprise activa
- Credenciales de API válidas
- Dos o más números de fax en su cuenta
Guía paso a paso
-
Enumerar los miembros corporativos
Primero, obtenga una lista de todos los miembros de su cuenta corporativa. Este endpoint solo puede ser utilizado por cuentas de administrador.GET /v3/accounts{Importante: Anote el
"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"
}
]
}UIDdel miembro al que desea asignar el número. Lo necesitará en el siguiente paso.
Más información: Enumerar los miembros corporativos - Fax.Plus API -
Asignar un número al usuario
Una vez que tenga elUIUdel usuario, puede asignarle un número de fax utilizando el siguiente endpoint:POST /v3/accounts/self/numbers/{number}
Cuerpo de la solicitud:{Reemplace
"assigned_to": "<uid>"
}{number}en la URL por el número de fax real que desea asignar, y el valor deassigned_topor elUIUdel usuario.
Más información: Asignar número - Fax.Plus API - Revocar la asignación de un número
Si necesita eliminar la asignación de un número de un usuario, utilice este endpoint:DELETE /v3/accounts/{user_id}/numbers/{number}
Más información: Revocar número - Fax.Plus API
Parámetros:
-
user_idID del usuario del que se revocará el número -
numberNúmero de fax a eliminar del usuario
-
Solución de problemas
Problemas comunes y soluciones
-
Error 403 Forbidden
- Causa: Permisos insuficientes o cuenta que no es de administrador
- Solución: Compruebe que está utilizando una cuenta de administrador y que dispone de los ámbitos de API necesarios
-
Error 404 Not Found
- Causa: ID de usuario o número de fax no válido
- Solución: Compruebe que el ID de usuario y el número de fax son correctos
-
Error 400 Bad Request
- Causa: Formato de solicitud no válido o intento de eliminar un número de un administrador
- Solución: Compruebe el formato de la solicitud y asegúrese de que no está intentando eliminar números de cuentas de administrador