Alpha-Namensanfragen

API-Routen zum Erstellen und Auflisten von Alpha-Namen (verifizierte Firmennamen, die als Nachrichtenabsender verwendet werden).

1. Erstellen Sie einen Alpha-Namen für die Organisation

Diese POST-Anfrage wird verwendet, um einen neuen Alpha-Namen zu erstellen, der einer Organisation zugeordnet ist. Die Anfrage erfordert einen Organisationsautorisierungsschlüssel in den Headern.

Anfrage - URL: https://restapi.smsbat.com/organizations/alpha_name - Methode: POST - Überschriften: - „Akzeptieren: application/json“. - „X-Authorization-Key: {organization_token}“ (Erstellt im Abschnitt „Benutzerprofil“).

Text:

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

Körperparameter: 1. „name“ (String): Der vorgeschlagene Alpha-Name. - Anforderung: Die Länge sollte weniger als 12 Zeichen betragen. 2. „companyCode“ (String): Der mit dem Alphanamen verknüpfte Unternehmensregistrierungscode (ERPOU/IPN für die Ukraine).

Mögliche Antworten: - 200 OK: Alpha-Name wurde erfolgreich zur Moderation/Erstellung gesendet. - 400 Bad Request: Validierungsfehler (z. B. Name ist zu lang). - 401 Nicht autorisiert: Ungültiger oder fehlender „X-Authorization-Key“.

---

2. AlphaName-Liste abrufen

Ruft eine aktuelle Liste der Alpha-Namen ab, einschließlich ihres aktuellen Moderationsstatus.

Anfrage - URL: https://restapi.smsbat.com/organizations/alpha_name/list - Methode: GET - Überschriften: - „X-Authorization-Key: {organization_token}“.

Antwort (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-Namensstatus (statusCode): - „PA“ – Genehmigung ausstehend - „A“ – genehmigt - „D“ – Abgelehnt