Alfanamenverzoeken

API-routes voor het maken en weergeven van alfanamen (geverifieerde bedrijfsnamen die worden gebruikt als afzender van berichten).

1. Maak een alfanaam van de organisatie

Dit POST-verzoek wordt gebruikt om een nieuwe alfanaam aan te maken die aan een organisatie is gekoppeld. Voor het verzoek is een autorisatiesleutel van de organisatie in de headers vereist.

Verzoek

• URL: https://restapi.smsbat.com/organizations/alpha_name
• Methode: POST
• Koppen:
  • Accepteer: applicatie/json
  • X-Authorization-Key: {organization_token} (Aangemaakt in de sectie Gebruikersprofiel).

Lichaam:

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

Lichaamsparameters:

1. name (String): De voorgestelde alfanaam.
   • Vereiste: De lengte moet minder dan 12 tekens zijn.
2. companyCode (String): De bedrijfsregistratiecode die is gekoppeld aan de alfanaam (ERPOU/IPN voor Oekraïne).

Mogelijke reacties:

• 200 OK: Alfanaam is succesvol verzonden voor moderatie/creatie.
• 400 Ongeldig verzoek: Validatiefout (naam is bijvoorbeeld te lang).
• 401 Ongeautoriseerd: Ongeldige of ontbrekende X-Authorization-Key.

---

2. Haal de AlphaName-lijst op

Haalt een actuele lijst met alfanamen op, inclusief hun huidige moderatiestatus.

Verzoek

• URL: https://restapi.smsbat.com/organizations/alpha_name/list
• Methode: KRIJG
• Koppen:
  • X-autorisatiesleutel: {organization_token}

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

Alfanaamstatussen (statusCode):

• PA - In afwachting van goedkeuring
• A - Goedgekeurd
• D - Geweigerd