Zahteve za imena alfa

Poti API za ustvarjanje in seznam imen Alpha (preverjena imena podjetij, ki se uporabljajo kot pošiljatelji sporočil).

1. Ustvarite ime organizacije Alpha

Ta zahteva POST se uporablja za ustvarjanje novega imena alfa, povezanega z organizacijo. Zahteva zahteva avtorizacijski ključ organizacije v glavah.

Zahteva - URL: https://restapi.smsbat.com/organizations/alpha_name - Metoda: POST - Glave: - Sprejmi: aplikacija/json - X-Authorization-Key: {organization_token} (Ustvarjen v razdelku Uporabniški profil).

Telo:

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

Parametri telesa: 1. ime (niz): predlagano alfa ime. - Zahteva: Dolžina naj bo manjša od 12 znakov. 2. companyCode (niz): registracijska koda podjetja, povezana z imenom Alphaname (ERPOU/IPN za Ukrajino).

Možni odgovori: - 200 OK: Ime alfa je bilo uspešno poslano v moderiranje/ustvarjanje. - 400 Slaba zahteva: Napaka pri preverjanju (npr. ime je predolgo). - 401 Nepooblaščeno: Neveljaven ali manjkajoč X-Authorization-Key.

---

2. Pridobi seznam AlphaName

Pridobi posodobljen seznam alfa imen, vključno z njihovimi trenutnimi statusi moderiranja.

Zahteva - URL: https://restapi.smsbat.com/organizations/alpha_name/list - Metoda: GET - Glave: - 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"
    }
]

Stanje alfa imen (statusCode): - PA - čaka na odobritev - A - Odobreno - D - Zavrnjeno