Seleccione el país y el tipo de número
Elija un país de registro y, a continuación, utilice un nombre devuelto por get_document_number_types. Envíe ese nombre como number_type, no un identificador de tipo ni una categoría general de búsqueda de números.
Lea las instrucciones devueltas
Conserve los identificadores de requisitos y relaciones para el flujo de trabajo de identidad y documentos correspondiente. Esta llamada devuelve requisitos; no valida ni envía sus archivos. Siga las instrucciones devueltas y los requisitos específicos del número seleccionado.
No interprete un error como una exención
El error relativo a un país no válido o a la ausencia de documentos de registro del país combina dos condiciones. No demuestra que el registro sea innecesario. Un fallo en la consulta o un resultado vacío tampoco supone la aprobación de un cliente ni de un número. Póngase en contacto con el servicio de asistencia si el resultado no es claro.
Solicitud
Utilice las credenciales de su cuenta de API habilitada a través de HTTPS. Se admiten la autenticación básica y los tokens de portador habilitados de la cuenta de API; se aplican las restricciones de la cuenta.
POST con application/json o application/x-www-form-urlencoded.
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
--request POST \
--header "Content-Type: application/json" \
--data '{"country":"US","number_type":"Local"}' \
"https://api.multitel.net/v3/get_requirements"| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
country | cadena de caracteres | Sí | Código ISO del país obtenido de get_document_countries. |
number_type | cadena de caracteres | Sí | Nombre de tipo obtenido de get_document_number_types, como Local; la comparación no distingue entre mayúsculas y minúsculas. Proporcione el nombre, no su identificador. |
Respuesta
Compruebe status.code en el cuerpo JSON, además del estado HTTP. response es un único recurso de requisitos con id, type y attributes, además de relationships cuando se devuelven. Los identificadores de los datos del recurso y de las relaciones son opacos. Se eliminan las etiquetas HTML del texto opcional de restriction_message; trate el texto restante como texto, no como HTML de confianza. El controlador devuelve el primer recurso de requisitos, por lo que no debe deducir que esta respuesta sea una lista exhaustiva. La disponibilidad de atributos y relaciones depende del país y del tipo; el ejemplo no constituye un esquema fijo completo.
Estructura de respuesta ilustrativa; no contiene datos de la cuenta en tiempo real ni una cotización vigente.
{
"status": {
"code": 200,
"msg": ""
},
"response": {
"id": "REQUIREMENT_ID_FROM_RESPONSE",
"type": "RESOURCE_TYPE_FROM_RESPONSE",
"attributes": {
"restriction_message": "Example country-specific instructions."
}
}
}Errores
- 400: Falló la validación del país y de number_type: proporcione ambos valores obligatorios. El texto de validación puede contener formato.
- 400: Invalid country ISO or No country registration documents required.: este mensaje ambiguo no demuestra por sí solo que exista una exención del registro.
- 400: Invalid number type: utilice un nombre de tipo devuelto. El error heredado enumera Global, Local, Mobile, National, Shared Cost y Toll Free.
- 500: Unable to load registration requirements for the specified country and number type.: los requisitos no se devolvieron correctamente. Vuelva a intentarlo más tarde o póngase en contacto con el servicio de asistencia.
Disponibilidad y efectos secundarios
- Esta consulta del catálogo y de los requisitos no crea una identidad, no carga un documento justificativo, no registra un número ni realiza un pedido.
- Una respuesta correcta del catálogo no supone la aprobación de sus documentos ni confirma que se pueda activar un número seleccionado.