Begäran om alfanamn

API-rutter för att skapa och lista alfanamn (verifierade företagsnamn som används som meddelandeavsändare).

1. Skapa organisationens alfanamn

Denna POST-begäran används för att skapa ett nytt alfanamn kopplat till en organisation. Förfrågan kräver en organisationsauktoriseringsnyckel i rubrikerna.

Begäran

• URL: https://restapi.smsbat.com/organizations/alpha_name
• Metod: POST
• Rubriker:
  • Acceptera: application/json
  • X-Authorization-Key: {organization_token} (Skapat i avsnittet Användarprofil).

Kroppen:

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

Kroppsparametrar:

1. namn (sträng): Det föreslagna alfanamnet.
   • Krav: Längden ska vara mindre än 12 tecken.
2. companyCode (String): Företagsregistreringskoden som är kopplad till Alphaname (ERPOU/IPN för Ukraina).

Möjliga svar:

• 200 OK: Alfanamn skickades för moderering/skapande.
• 400 Bad Request: Valideringsfel (t.ex. namnet är för långt).
• 401 Ej auktoriserad: Ogiltig eller saknad “X-Authorization-Key”.

---

2. Hämta alfanamnslista

Hämtar en uppdaterad lista över alfanamn, inklusive deras nuvarande modereringsstatus.

Begäran

• URL: https://restapi.smsbat.com/organizations/alpha_name/list
• Metod: GET
• Rubriker:
  • X-Authorization-Key: {organization_token}

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

Alpha Name Statuses (statusCode):

• PA - Väntar på godkännande
• A - Godkänd
• D - Avvisade