Skip to content
产品中心
能力中心
场景方案
应用市场
WebOffice
开发者后台

获取搬家任务列表

标签邮箱搬家

请求说明

字段
请求地址
https://openapi.wps.cn/v7/mail_migrations/{migration_id}/tasks
HTTP 方法
GET
接口描述
获取搬家任务列表
签名方式
KSO-1
限频策略
权限要求
查询和管理邮箱搬家(应用授权) kso.mail_migration.readwrite
查询邮箱搬家(应用授权) kso.mail_migration.read

路径参数 (Path)

属性名类型是否必填描述可选值
migration_id
string搬家作业ID,填入current获取当前企业正在进行作业的搬家任务-

查询参数 (Query)

属性名类型是否必填描述可选值
state
string搬家任务状态,默认全部pending, running, paused, failed, cancelled, success, closed
page_size
integer分页大小(范围1-100,默认20)-
page_token
string翻页token(第一次请求不传)-

响应体(Response)

HTTP状态码: 200
响应体格式: application/json

没有可用的数据

响应体示例

json
{
  "data": {
    "items": [
      {
        "ctime": 0,
        "email_address": "string",
        "error_msg": "string",
        "failed": 0,
        "ftime": 0,
        "remote_email_address": "string",
        "start_by_admin": true,
        "state": "pending",
        "succeed": 0,
        "task_id": "string",
        "total": 0
      }
    ],
    "next_page_token": "string",
    "total": 0
  },
  "code": 0,
  "msg": "string"
}