电子邮件 API 文档

怎样 request_id 工作内容

1. 预览计数方式 action=preview。无 request_id 需要删除任何记录。
2. 生成一个独特的 request_id 用于删除新内容,例如a UUID。发送前保存它 action=delete. . . . . . . . . . . .
3. 重复、超时或 HTTP 202,再利用相同 API 键,历史终点, request_id 财务报告和已审计财务报表 include_linked 值。 错误发生后, 绝不自动生成新的 ID 。
4. 何时 completed=true,操作结束。 重用其ID返回的相同结果,而不是删除新到的记录. 仅为有意进行新清理而使用新ID.

request_id 识别您的删除操作, 而不是个人 SMS允许的格式:16-128 ASCII 字母、数字、连字符或下划线。 A. 国家 UUID 用 Crypto.randomUUID () 生成是合适的。

删除按批次执行。如果返回 HTTP 202 且 continue_required=true，请在 3 秒后再次请求 action=delete。没有后台 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 键为 a 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,000 个 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中,不自动创建替换操作。