Zahtjevi za alfa imena
API rute za stvaranje i popis Alpha naziva (potvrđeni nazivi tvrtki koji se koriste kao pošiljatelji poruka).
1. Stvorite alfa naziv organizacije
Ovaj POST zahtjev koristi se za stvaranje 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/jsonX-Authorization-Key: {organization_token}(Stvoreno u odjeljku Korisničkog profila).
Tijelo:
{
"name": "testName",
"companyCode": "88888888"
}
Parametri tijela:
ime(niz): predloženo alfa ime.- Zahtjev: Duljina bi trebala biti manja od 12 znakova.
companyCode(niz): Registracijski kod tvrtke povezan s alfanimom (ERPOU/IPN za Ukrajinu).
Mogući odgovori:
- 200 OK: Alfa naziv je uspješno poslan na moderiranje/kreiranje.
- 400 Loš zahtjev: Pogreška provjere (npr. ime je predugačko).
- 401 Neovlašteno: Nevažeći ili nedostaje
X-Authorization-Key.
2. Dohvati popis AlphaName
Dohvaća ažuran popis alfa naziva, uključujući njihove trenutne statuse moderiranja.
Zahtjev
- URL:
https://restapi.smsbat.com/organizations/alpha_name/list - Metoda: GET
- Zaglavlja:
X-Authorization-Key: {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 naziva (statusCode):
PA- Čeka se odobrenjeA- OdobrenoD- Odbijeno