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. Когда completed=true будет готов, операция будет завершена. Повторное использование идентификатора возвращает тот же результат вместо удаления вновь поступивших записей. Используйте новый идентификатор только для преднамеренной очистки.

request_id идентифицирует вашу операцию удаления, а не отдельный SMS. Разрешенный формат: 16-128 букв ASCII, цифр, дефисов или подчеркиваний. UUID, созданный с помощью crypto.randomUUID(), подходит.

Удаление выполняется пакетами. При 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. Токены Legacy без ограничений сохраняют свой существующий доступ к учетной записи.

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: для этого идентификатора, ключа API и истории не существует никакой операции.
• 401: недействительные или просроченные учетные данные. 403: недостаточный объем OAuth или несанкционированная учетная запись.
• 409 HISTORY_BUSY: еще одна уборка запущена; продолжайте ее с оригинального клиента. 409 INCLUDE_LINKED_CONFLICT: Восстановите исходное значение include_linked.
• 409 OAUTH_ACCOUNT_AMBIGUOUS: предоставить ключ API, принадлежащий этой учетной записи.
• 503 или прерывание сети: некоторые партии могут быть уже завершены. Проверьте конфигурацию, а затем повторите с оригинальным request_id. Не создавайте автоматически замену.