Prośby o nazwy alfa

Trasy API do tworzenia i wyświetlania nazw Alpha (zweryfikowanych nazw firm używanych jako nadawca wiadomości).

1. Utwórz nazwę alfa organizacji

To żądanie POST służy do utworzenia nowej nazwy alfa powiązanej z organizacją. Żądanie wymaga klucza autoryzacji organizacji w nagłówkach.

Prośba

• URL: https://restapi.smsbat.com/organizations/alpha_name
• Metoda: POST
• Nagłówki:
  • Akceptuj: wniosek/json
  • X-Klucz autoryzacyjny: {organization_token} (Utworzony w sekcji profilu użytkownika).

Ciało:

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

Parametry ciała:

1. name (String): Proponowana nazwa alfa.
   • Wymagania: Długość powinna być mniejsza niż 12 znaków.
2. companyCode (String): Kod rejestracyjny firmy powiązany z nazwą alfa (ERPOU/IPN dla Ukrainy).

Możliwe odpowiedzi:

• 200 OK: Nazwa alfa została pomyślnie wysłana do moderacji/utworzenia.
• 400 Złe żądanie: Błąd walidacji (np. nazwa jest za długa).
• 401 Nieautoryzowane: Nieprawidłowy lub brakujący Klucz autoryzacji X.

---

2. Pobierz listę AlphaName

Pobiera aktualną listę nazw alfa, w tym ich aktualne statusy moderacji.

Prośba

• URL: https://restapi.smsbat.com/organizations/alpha_name/list
• Metoda: GET
• Nagłówki:
  • Klucz autoryzacyjny X: {organization_token}

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

Statusy nazw alfa („statusCode”):

• PA - Oczekuje na zatwierdzenie
• A - Zatwierdzone
• D - Odrzucono