Desarrolladores

POST/v3/number_identity/{number}

Enviar un perfil de registro para un número

Asocie su perfil de registro guardado a un número comprado y, cuando se admita, solicite la revisión del operador.

En esta página
  1. Prepare el perfil guardado y el número
  2. Envíe la asociación
  3. Distinga la asociación de la aprobación
  4. Gestione los errores sin crear tareas duplicadas
  5. Limitación de los documentos de un solo uso
  6. Proteja la información de registro

Prepare el perfil guardado y el número

Utilice este flujo de trabajo para asociar un perfil de registro guardado a un número comprado y, en los números admitidos que dependen de un operador, solicitar la revisión del registro. No es una API de activación general para todos los proveedores de números. Una solicitud exitosa no demuestra que los documentos estén aprobados ni que el número esté activo.

Utilice una cuenta habilitada de la API de MultiTEL a través de HTTPS, con sus credenciales y restricciones de IP configuradas. Tanto el perfil no eliminado como el número comprado y no anulado deben pertenecer a su cuenta.

  1. Cree un perfil de registro o seleccione uno existente. Conserve el uuid del perfil local obtenido de create_document; get_document devuelve la misma referencia local como id.
  2. Para el envío al operador, el perfil necesita sus referencias guardadas de identidad y dirección. Adjunte las pruebas y los documentos justificativos requeridos mediante sus respectivos flujos de trabajo antes del envío.
  3. Compruebe que el número y el perfil cumplen los requisitos aplicables al país y al número. No dé por hecho que un perfil guardado está aprobado para todos los números.

Envíe la asociación

curl --silent --show-error --request POST \
  --user "$API_USER:$API_PASSWORD" \
  --form-string document_uuid="$PROFILE_UUID" \
  --form-string service_description="Example customer support line" \
  https://api.multitel.net/v3/number_identity/12125550123

La ruta contiene el número de teléfono comprado, no su UUID, una extensión de centralita PBX ni un identificador de identidad. El manejador elimina del número los caracteres que no son dígitos. Utilice el número internacional completo con el código de país. El ejemplo es ficticio y debe sustituirse por su propio número y la referencia de su perfil local guardado.

Campos del envío de registro
CampoObligatorioSignificado
document_uuidSíEl uuid exacto del perfil local guardado. No utilice en su lugar los identificadores remotos enmascarados identity_id o address_id, el identificador de una carga ni un valor devuelto de registration_details_id.
service_descriptionNoUna descripción del servicio previsto, que se remite para la verificación del operador. Se eliminan los espacios al principio y al final.
onetime_filesDepende del flujo de trabajoUna matriz admitida para los documentos de un solo uso del operador. El manejador actual elimina los espacios al principio y al final de sus cadenas y las remite sin resolver las referencias locales de las cargas. No se ha establecido la compatibilidad con los identificadores enmascarados devueltos por create_encrypt_files; consulte la limitación de los documentos de un solo uso que figura más abajo antes de utilizar este campo.

En las solicitudes multiparte, una matriz utiliza campos onetime_files[] repetidos. También se admite una solicitud JSON con Content-Type: application/json; sus propiedades se combinan con los datos del formulario. Puede proporcionarse un campo number en el cuerpo de la solicitud cuando se omite el número en la ruta. Utilice preferentemente la ruta explícita mostrada arriba para evitar ambigüedades.

Distinga la asociación de la aprobación

Lea tanto el resultado HTTP como el campo JSON status.code. Los errores JSON pueden llegar con HTTP 200. Un resultado exitoso del envío al operador devuelve el mensaje Address verification task created; awaiting carrier review. Este ejemplo utiliza referencias ficticias.

{
  "status": {
    "code": 200,
    "msg": "Address verification task created; awaiting carrier review."
  },
  "response": {
    "number": "+12125550123",
    "did_id": "11111111111111111111111111111111",
    "document_uuid": "0123456789abcdef0123456789abcdef",
    "identity_id": "22222222222222222222222222222222",
    "address_id": "33333333333333333333333333333333",
    "address_verification_id": "44444444444444444444444444444444",
    "verification_status": "pending",
    "verification_reference": null,
    "requirement_id": "55555555555555555555555555555555",
    "registration_details_id": "8516ac99dc60603295de7bdb6a153530"
  }
}

Los identificadores relacionados con el proveedor son referencias enmascaradas, no identificadores intercambiables de perfiles locales. document_uuid sigue siendo la referencia del perfil local que envió. En la vía de este manejador que recurre al operador, registration_details_id es un hash adicional de esa referencia local; no sustituya document_uuid por él en posteriores solicitudes de perfil o de envío.

Algunos números asignados utilizan una asociación local de identidad en lugar de crear una verificación del operador. Su resultado exitoso es Identity associated. con una matriz response vacía. Esto no crea una tarea de revisión del operador ni acredita la aprobación. El portal dispone de un flujo de asociación más reciente cuyo tratamiento de proveedores y cuyas comprobaciones de envíos repetidos difieren de los de este punto de acceso.

Gestione los errores sin crear tareas duplicadas

El código 400 de la API indica que falta el número o la referencia del perfil. El código 404 indica que el perfil o el número no está disponible para la cuenta, o que el número no figura en el inventario del operador. El código 422 puede indicar que faltan referencias de identidad o dirección, requisitos del vendedor o un rechazo en la validación del operador. La falta de configuración de la llamada de retorno puede producir un código 503, y un fallo de transporte durante la creación puede producir un código 502. Lea el mensaje y cualquier requirement_diagnostics en lugar de tratar todos los fallos de la misma manera.

La vía que recurre al operador puede actualizar los indicadores locales de registro pendiente antes de que terminen la validación de requisitos, las comprobaciones de la configuración de la llamada de retorno o la creación de la tarea. Por tanto, un error no implica que el estado local permanezca sin cambios, y un indicador de pendiente por sí solo no demuestra que exista una tarea. No utilice esos indicadores como confirmación de aprobación ni de entrega de la solicitud.

El proveedor puede aceptar una tarea aunque falle una operación posterior en la base de datos local, y esta función auxiliar no comprueba el resultado de todas las escrituras locales antes de informar de un resultado exitoso. Este manejador no dispone de un parámetro de idempotencia del cliente ni de protección contra envíos duplicados. Tras un tiempo de espera agotado, un error o un resultado incierto, consulte el historial de registro del número en el portal o póngase en contacto con el servicio de asistencia antes de volver a enviar la solicitud. La ausencia de un registro local no demuestra por sí sola que el proveedor no haya recibido nada.

Limitación de los documentos de un solo uso

El manejador acepta onetime_files y remite cada cadena no vacía a la relación de archivos cifrados del operador. No consulta los registros de cargas de la cuenta propietaria ni convierte los identificadores externos enmascarados de las cargas en identificadores de archivos del proveedor. La auditoría sin conexión verificó el comportamiento de reenvío, no que los archivos se adjuntaran correctamente en el operador.

No dé por hecho que se puede copiar en este campo un identificador de archivo de create_encrypt_files para completar un flujo de acuerdo de un solo uso. Utilice el portal o confirme con MultiTEL el flujo de identificadores admitido cuando un número requiera estos documentos. Este aspecto sigue sin resolverse en la revisión de la API; no constituye un ejemplo verificado de principio a fin.

Proteja la información de registro

Envíe únicamente información y documentos que esté autorizado a utilizar para el número. Mantenga las referencias de perfil y verificación asociadas a la cuenta correcta y evite guardar en los registros el contenido completo de las solicitudes de registro. Esta solicitud no elimina ni sustituye todas las pruebas o verificaciones anteriores. La revisión del operador, la activación y la conservación son procesos independientes.