Demandes de noms alpha

Routes API pour créer et répertorier les noms Alpha (noms commerciaux vérifiés utilisés comme expéditeur de message).

1. Créer le nom alpha de l'organisation

Cette requête POST est utilisée pour créer un nouveau nom Alpha associé à une organisation. La demande nécessite une clé d'autorisation d'organisation dans les en-têtes.

Demande - URL : https://restapi.smsbat.com/organizations/alpha_name - Méthode : POST - En-têtes : - Accepter : application/json - X-Authorization-Key : {organization_token} (Créé dans la section Profil utilisateur).

Corps :

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

Paramètres du corps : 1. name (String) : Le nom alpha proposé. - Exigence : La longueur doit être inférieure à 12 caractères. 2. companyCode (String) : Le code d'enregistrement de l'entreprise associé à l'Alphaname (ERPOU/IPN pour l'Ukraine).

Réponses possibles : - 200 OK : Le nom alpha a été envoyé avec succès pour modération/création. - 400 Bad Request : Erreur de validation (par exemple, le nom est trop long). - 401 Non autorisé : X-Authorization-Key invalide ou manquante.

---

2. Récupérer la liste AlphaName

Récupère une liste à jour des noms alpha, y compris leurs statuts de modération actuels.

Demande - URL : https://restapi.smsbat.com/organizations/alpha_name/list - Méthode : OBTENIR - En-têtes : - X-Authorization-Key : {organization_token}

Réponse (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"
    }
]

Statuts des noms alpha (statusCode) : - PA - En attente d'approbation - A - Approuvé - D - Refusé