Альфа-імена

Альфа-ім’я — це бренд компанії або назва, від імені якої надсилаються повідомлення. Ці методи API дозволяють створювати нові альфа-імена організації та отримувати їх статус.

1. Створення організації та її Альфа-імені

Цей POST-запит використовується для реєстрації нового Альфа-імені. Він вимагає обов’язкової передачі ключа авторизації.

Запит

• URL: https://restapi.smsbat.com/organizations/alpha_name
• Метод: POST
• Заголовки:
  • Accept: application/json
  • X-Authorization-Key: {токен організації} (Створюється в Особистому кабінеті).

Тіло запиту:

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

Параметри:

1. name (Рядок): Бажане Альфа-ім’я.
   • Вимога: Довжина імені не має перевищувати 12 символів.
2. companyCode (Рядок): Код ЄДРПОУ/ІПН компанії, пов’язаної з Альфа-іменем.

Можливі відповіді:

• 200 OK: Альфа-ім’я успішно створено/передано на модерацію.
• 400 Bad Request: Помилка валідації (наприклад, занадто довге ім’я).
• 401 Unauthorized: Ключ X-Authorization-Key відсутній або помилковий.

---

2. Отримання списку Альфа-імен

Отримує актуальний список Альфа-імен організації з урахуванням поточних статусів модерації. Дані відсортовані за спаданням дати.

Запит

• URL: https://restapi.smsbat.com/organizations/alpha_name/list
• Метод: GET
• Заголовки:
  • X-Authorization-Key: {токен організації}

Відповідь (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"
    }
]

Статуси Альфа-імені (statusCode):

• PA - Очікує затвердження (Pending Approval)
• A - Затверджено (Approved)
• D - Відхилено (Declined)