Help Center Zahtjevi za alfa imena

Zahtjevi za alfa imena

API rute za kreiranje i listanje alfa imena (provjerena imena preduzeća koja se koriste kao pošiljalac poruke).

1. Kreirajte alfa naziv organizacije

Ovaj POST zahtjev se koristi za kreiranje novog alfa imena povezanog s organizacijom. Zahtjev zahtijeva ključ autorizacije organizacije u zaglavljima.

Zahtjev

  • URL: https://restapi.smsbat.com/organizations/alpha_name
  • Metoda: POST
  • Zaglavlja:
    • Prihvati: aplikacija/json
    • X-Authorization-Key: {organization_token} (Kreirano u odjeljku Profil korisnika).

Tijelo:

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

Parametri tijela:

  1. name (String): predloženo alfa ime.
    • Uslov: Dužina treba da bude manja od 12 karaktera.
  2. companyCode (String): Registracijski kod kompanije povezan sa alfaimom (ERPOU/IPN za Ukrajinu).

Mogući odgovori:

  • 200 OK: Alfa ime je uspješno poslano na moderiranje/kreaciju.
  • 400 Loš zahtjev: Greška u validaciji (npr. ime je predugačko).
  • 401 Neovlašteno: Nevažeći ili nedostaje X-Authorization-Key.

2. Dohvati AlphaName Listu

Dohvaća ažurnu listu alfa imena, uključujući njihove trenutne statuse moderiranja.

Zahtjev

  • URL: https://restapi.smsbat.com/organizations/alpha_name/list
  • Metoda: GET
  • Zaglavlja:
    • X-Ključ autorizacije: {organization_token}

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

Statusi alfa imena (statusCode):

  • PA - Čeka odobrenje
  • A - Odobreno
  • D - Odbio