Email API documentation

Як працює request_id

1. Перегляд кількості з action=preview. Немає request_id, що потрібно і не видаляється записів.
2. Сприяє відновленню унікальної request_id для нового видалення, наприклад, UUID. Заощаджуйте його перед відправленням action=delete.
3. Для рети, часових виходів або HTTP 202, повторно використовуйте той же ключ API, кінцева точка історії, request_id і include_linked значення. Не генеруйте новий ідентифікатор автоматично після помилки.
4. Коли ЗСКАЧАКСЗ завершується операція. Відновити свій ідентифікатор повертає той же результат замість видалення новоприбулих записів. Використовуйте новий ідентифікатор тільки для свідомо нового очищення.

request_id визначає вашу операцію видалення, не індивідуальну SMS. Додано формат: 16–128 ASCII літери, цифри, гіфени або низи. Для цього потрібен броньований броньований біржовий .randomUID()

Видалення виконується пакетами. За HTTP 202 і continue_required=true повторіть action=delete через 3 секунди. Фоновий cron не запускається. action=status лише читає перебіг і не продовжує видалення, навіть за HTTP 200.

Видалення та приклади стану

Замініть зразок request_id з власним унікальним значенням перед початком. Видаліть наступні запити, змінюйте історію реального облікового запису, вони не є попередніми переглядами.

curl -X POST "https://api.smsmobileapi.com/delete-history-email/" \
  --data-urlencode "apikey=YOUR_API_KEY" \
  -d "action=delete" -d "include_linked=0" \
  -d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"

curl -X POST "https://api.smsmobileapi.com/delete-history-email/" \
  -H "Authorization: Bearer YOUR_OAUTH_ACCESS_TOKEN" \
  -d "action=delete" -d "include_linked=0" \
  -d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"

curl -G "https://api.smsmobileapi.com/delete-history-email/" \
  --data-urlencode "apikey=YOUR_API_KEY" \
  -d "action=status" \
  -d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"

GET також приймає action=preview або action=delete. POST рекомендується: параметри URL можуть витікати в історію браузера і журнали сервера. Не розміщуйте URL-адресу видалення в публічному посилання, зображення або префікс.

Для POST надішлемо всі параметри у вигляді тіла або об'єкта JSON, ніколи не в рядку запиту. Невідомі параметри відхилені; дата або мобільні фільтри не підтримуються.

Ауттентика для ендто точок історії

Використовуйте apikey або Authorization: Bearer з'явився з SMSMobileAPI OAuth2. Не надсилайте освіження або ключ API як токен Bearer. Відхилено відхилені відтоки.

За допомогою history:read можна переглянути/стату та history:delete також дозволяє відхиляти. Обмеження на використання токени та OAuth. Ногати без очок зберігають наявний доступ до облікового запису.

OAuth2 вибирає унікальний ключ API. Якщо існують декілька основних ключів, також забезпечують apikey для вибору одного з речей до облікового запису. По-друге, ключі не надають доступу до початкової історії ключів.

Читати відповідь перед продовження

count_delete є кумулятивним числом, видаленим цією роботою. selected_at_start є початковим вибором; protected_at_start кількість виключених записів. Використовуйте preview.linked_or_processing для підрахунку пов'язаних записів навіть коли include_linked=1.

{
    "result": {
        "error": 0,
        "history": "email",
        "action": "delete",
        "request_id": "6d54ac58-41f1-4fbc-9a39-6e6c86089451",
        "status": "processing",
        "completed": false,
        "count_delete": 100,
        "total_before": 250,
        "selected_at_start": 200,
        "protected_at_start": 50,
        "include_linked": 0,
        "continue_required": true,
        "message": "Repeat GET or POST with the same request_id and include_linked to continue. Status requests do not run deletion."
    }
}

• 200 з completed=true: завершено. Відповідність 200 або статус не доведе завершення.
• 400 INVALID_REQUEST_ID: перевірити формат. 404 REQUEST_NOT_FOUND: немає операції для цього ID, ключа API і історії.
• 401: недійсні або невилічені повноваження. 403: недостатня сфера OAuth або несанкціонований рахунок.
• 409 HISTORY_BUSY: інший чистий процес працює; продовжуйте його з оригінального клієнта. 409 INCLUDE_LINKED_CONFLICT: відновлення оригінального значення include_linked.
• 409 OAUTH_ACCOUNT_AMBIGUOUS: забезпечити ключ API до цього облікового запису.
• 503 або мережевий перерву: вже завершені деякі партії. Перевірити налаштування, потім птиця з оригінальним request_id. Не створювати автоматично заміну.