Cereri de nume alfa

Rute API pentru a crea și lista nume Alpha (nume de afaceri verificate utilizate ca expeditor de mesaje).

1. Creați un nume alfa al organizației

Această solicitare POST este utilizată pentru a crea un nou nume alfa asociat unei organizații. Solicitarea necesită o cheie de autorizare a organizației în anteturi.

Solicitare

• URL: https://restapi.smsbat.com/organizations/alpha_name
• Metodă: POST
• Anteturi:
  • Accept: application/json
  • X-Authorization-Key: {organization_token} (Creat în secțiunea Profil de utilizator).

Corpul:

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

Parametrii corpului:

1. name (Șir): Numele Alpha propus.
   • Cerință: Lungimea trebuie să fie mai mică de 12 caractere.
2. „companyCode” (Șir): Codul de înregistrare al companiei asociat cu Alphaname (ERPOU/IPN pentru Ucraina).

Raspunsuri posibile:

• 200 OK: Numele alfa a fost trimis cu succes pentru moderare/creare.
• 400 Solicitare greșită: Eroare de validare (de exemplu, numele este prea lung).
• 401 Neautorizat: X-Authorization-Key nevalidă sau lipsește.

---

2. Preluați lista AlphaName

Preia o listă actualizată de Nume alfa, inclusiv stările lor curente de moderare.

Solicitare

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

Răspuns (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"
    }
]

Stari de nume alfa (statusCode):

• PA - În așteptarea aprobării
• A - Aprobat
• D - A refuzat