Email API documentation

request_id hoạt động như thế nào

1. Xem thử các đếm có action=previewKhông. request_id là cần thiết và không có hồ sơ nào bị xóa.
2. Tạo ra một độc nhất request_id Cho một xóa mới, ví dụ như UUIDHãy để dành nó trước khi gửi action=delete.
3. Để tái lưu trữ, hay thời hạn HTTP 202, tái sử dụng API Chìa khóa, điểm kết thúc lịch sử, request_id và include_linked giá trị. Không bao giờ tạo ra một ID mới tự động sau khi gặp lỗi.
4. Khi completed=true, chiến dịch đã kết thúc. Sử dụng lại thẻ căn cước của nó đã trả lại cùng kết quả thay vì xóa các hồ sơ mới đến. Dùng ID mới chỉ cho việc dọn dẹp mới có chủ đích.

request_id Xác định thao tác xoá của bạn, không phải cá nhân SMS. Cho phép định dạng: 16–128 ASCII chữ, chữ số, dấu gạch nối hay dấu gạch nối. A UUID tạo ra với mã hóa.randoUUID là thích hợp.

Việc xóa được thực hiện theo từng lô. Nếu nhận HTTP 202 với continue_required=true, hãy gửi lại action=delete sau 3 giây. Không có cron chạy nền. action=status chỉ đọc tiến độ, không tiếp tục xóa, ngay cả khi trả về HTTP 200.

Ví dụ xóa và kiểm tra trạng thái

Thay thế mẫu request_id với giá trị độc đáo của riêng mình trước khi bắt đầu. Những yêu cầu xoá theo đây thay đổi lịch sử tài khoản thật; không phải là xem thử.

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 cũng chấp nhận action=preview hay action=delete. POST khuyến khích: tham số URL có thể rò rỉ vào lịch sử trình duyệt và bản ghi máy phục vụ. Không bao giờ đặt địa chỉ URL xoá trong liên kết công cộng, ảnh hoặc tiềnfetch.

Vì POSTGửi tất cả các tham số vào cơ thể mẫu hoặc a JSON đối tượng, không bao giờ trong chuỗi truy vấn. Tham số không rõ bị từ chối; không hỗ trợ ngày tháng hay bộ lọc di động.

Xác thực cho điểm kết thúc lịch sử

Dùng apikey hay một Authorization: Bearer Comment SMSMobileAPI OAuth2Đừng gửi tín hiệu mới hay một thẻ API Chìa khóa là... Bearer - Tôi không biết. Vật trang trí bị bỏ hoang bị từ chối.

Khi phạm vi được đặt, history:read Cho phép xem thử/tatus và history:delete cũng cho phép xóa. Giới hạn cả vật tượng trưng lẫn vật kỷ niệm OAuth Khách áp dụng. Vật lưu giữ di sản mà không có phạm vi, giữ lại quyền truy cập tài khoản đã có của họ.

OAuth2 chọn điều cần thiết API Chìa khóa. Nếu có nhiều phím chính, cũng cung cấp apikey để chọn một phần của tài khoản. Chìa khóa thứ hai không bao giờ cho phép truy cập vào lịch sử chính.

Đọc câu trả lời trước khi tiếp tục

count_delete là số gia tăng được gỡ bỏ bởi chiến dịch này. selected_at_start là sự lựa chọn ban đầu; protected_at_start tính trừ các hồ sơ. Dùng preview.linked_or_processing để đếm hồ sơ liên kết ngay cả khi 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 có completed=true: xong. Chỉ xem trước 200 hoặc chỉ trả lời trạng thái thôi thì không chứng tỏ là hoàn tất.
• 400 INVALID_REQUEST_ID: kiểm tra định dạng . 404 REQUEST_NOT_FOUNDKhông có thao tác nào cho ID này, API Chìa khóa và lịch sử.
• 401: không hợp lệ hoặc hết hạn. 403: không đủ OAuth Phạm vi hoặc tài khoản trái phép.
• 409 HISTORY_BUSY: một việc dọn dẹp khác đang chạy; tiếp tục nó từ trình khách gốc. 409 INCLUDE_LINKED_CONFLICT: khôi phục lại bản gốc include_linked giá trị.
• 409 OAUTH_ACCOUNT_AMBIGUOUSCung cấp một API Chìa khóa của lời tường thuật này.
• 503 hoặc ngắt quãng mạng: một số mẻ có thể đã hoàn tất. Kiểm tra cấu hình, rồi thử lại với bản gốc request_idKhông tạo một thao tác thay thế tự động.