Solicitudes de nombres alfa

Rutas API para crear y enumerar nombres alfa (nombres comerciales verificados utilizados como remitente de mensajes).

1. Crear nombre alfa de la organización

Esta solicitud POST se utiliza para crear un nuevo nombre alfa asociado con una organización. La solicitud requiere una clave de autorización de la organización en los encabezados.

Solicitar - URL: https://restapi.smsbat.com/organizations/alpha_name - Método: PUBLICAR - Encabezados: - Aceptar: aplicación/json - X-Authorization-Key: {organization_token} (Creado en la sección Perfil de usuario).

Cuerpo:

{
  "name": "testName",
  "companyCode": "88888888"
}

Parámetros del cuerpo: 1. name (Cadena): El nombre alfa propuesto. - Requisito: La longitud debe ser inferior a 12 caracteres. 2. companyCode (Cadena): El código de registro de la empresa asociado con Alphaname (ERPOU/IPN para Ucrania).

Posibles respuestas: - 200 OK: El nombre alfa se envió correctamente para moderación/creación. - 400 Solicitud incorrecta: Error de validación (por ejemplo, el nombre es demasiado largo). - 401 No autorizado: Clave de autorización X no válida o faltante.

---

2. Obtener la lista de nombres alfa

Recupera una lista actualizada de nombres alfa, incluidos sus estados de moderación actuales.

Solicitar - URL: https://restapi.smsbat.com/organizations/alpha_name/list - Método: OBTENER - Encabezados: - Clave de autorización X: {token_organización}

Respuesta (200 OK):

[
    {
        "name": "test1",
        "status": "Pending Approval",
        "statusCode": "PA",
        "statusUpdateDate": "2024-07-24T16:34:40.137432Z"
    },
    {
        "name": "test2",
        "status": "Approved",
        "statusCode": "A",
        "statusUpdateDate": "2024-07-24T15:46:50.494443Z"
    }
]

Estados del nombre alfa (statusCode): - PA - Pendiente de aprobación - A - Aprobado - D - Rechazado