Richieste di nomi alfa

Percorsi API per creare ed elencare nomi Alpha (nomi aziendali verificati utilizzati come mittente del messaggio).

1. Crea il nome alfa dell'organizzazione

Questa richiesta POST viene utilizzata per creare un nuovo nome alfa associato a un'organizzazione. La richiesta richiede una chiave di autorizzazione dell'organizzazione nelle intestazioni.

Richiesta - URL: https://restapi.smsbat.com/organizations/alpha_name - Metodo: POST - Intestazioni: - "Accetta: application/json". - Chiave di autorizzazione X: {organization_token} (Creato nella sezione Profilo utente).

Corpo:

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

Parametri corporei: 1. "nome" (stringa): il nome alfa proposto. - Requisito: La lunghezza deve essere inferiore a 12 caratteri. 2. "companyCode" (stringa): il codice di registrazione della società associato all'Alphaname (ERPOU/IPN per l'Ucraina).

Risposte possibili: - 200 OK: Il nome alfa è stato inviato con successo per la moderazione/creazione. - 400 Richiesta errata: Errore di convalida (ad esempio, il nome è troppo lungo). - 401 Non autorizzato: Chiave di autorizzazione X non valida o mancante.

2. Recupera l'elenco AlphaName

Recupera un elenco aggiornato di nomi alfa, inclusi i loro attuali stati di moderazione.

Richiesta - URL: https://restapi.smsbat.com/organizations/alpha_name/list - Metodo: OTTIENI - Intestazioni: - "Chiave di autorizzazione X: {token_organizzazione}".

Risposta (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"
    }
]

Stati dei nomi alfanumerici (statusCode): - "PA" - In attesa di approvazione - "A" - Approvato - "D" - Rifiutato