Alfa Adları İstekleri

Alfa adlarını (mesaj gönderen olarak kullanılan doğrulanmış işletme adları) oluşturmak ve listelemek için API yolları.

1. Organizasyon Alfa Adı Oluşturun

Bu POST isteği, bir kuruluşla ilişkili yeni bir Alfa Adı oluşturmak için kullanılır. İstek, başlıklarda bir kuruluş yetkilendirme anahtarı gerektirir.

Talep - URL: https://restapi.smsbat.com/organizations/alpha_name - Yöntem: POST - Başlıklar: - 'Kabul et: uygulama/json' - X-Yetkilendirme Anahtarı: {organization_token} (Kullanıcı Profili bölümünde oluşturulmuştur).

Gövde:

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

Gövde Parametreleri: 1. name (Dize): Önerilen Alfa Adı. - Gereksinim: Uzunluk 12 karakterden az olmalıdır. 2. companyCode (String): Alphaname (Ukrayna için ERPOU/IPN) ile ilişkili şirket kayıt kodu.

Olası Yanıtlar: - 200 Tamam: Alfa Adı, denetleme/oluşturma için başarıyla gönderildi. - 400 Hatalı İstek: Doğrulama hatası (ör. ad çok uzun). - 401 Yetkisiz: Geçersiz veya eksik 'X-Yetkilendirme Anahtarı'.

---

2. AlphaName Listesini Getir

Mevcut denetleme durumları da dahil olmak üzere Alfa Adlarının güncel bir listesini alır.

Talep - URL: https://restapi.smsbat.com/organizations/alpha_name/list - Yöntem: AL - Başlıklar: - X-Yetkilendirme Anahtarı: {organization_token}

Yanıt (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"
    }
]

Alfa Adı Durumları (statusCode): - PA - Onay Bekleniyor - 'A' - Onaylandı - 'D' - Reddedildi