导入结果回调数据格式说明

在调用号码导入接口之后，将导入的结果通过异步的方式回调到调用方

回调地址配置

在接收导入结果回调之前，需要先在平台中配置回调地址。

配置入口

前往 接口回调配置页，或在平台左侧导航栏中依次进入 空间管理 → 接口回调，切换到「回调设置」页签。

配置步骤

1. 在左侧「回调配置」列表中选择 导入结果回调。
2. 开启 启用 开关。
3. 在「回调地址」区域填写 回调 URL（回调方式固定为 POST）。
4. 在「请求 Header」区域按需添加鉴权、签名等自定义请求头，例如用于鉴权的 Token。
5. 点击 测试连接 验证地址是否可达。
6. 确认无误后点击 保存配置。

两类回调需分别配置

「通话记录回调」和「导入结果回调」是两套彼此独立的配置，各自有独立的地址与开关，保存时只作用于当前选中的那一项。若同时需要接收通话记录，请另行配置，详见《通话记录回调数据格式说明》。

字段说明

requestId string

对应导入接口返回的 ID。

---

taskId string

任务 ID。

---

totalCount number

导入请求总计需要导入的数据量。

---

failedCount number

导入失败的数量。

---

failedRecords array

导入失败的手机号列表，以数组格式存储。结构如下：

点击展开字段说明

phoneNumber string

失败的手机号

---

errorMessage string

失败的原因

---

ext object

导入时传入的随路数据

返回数据

回调方在成功接收到数据之后，需要返回指定结构的数据，如果没有收到该数据，认为是回调不成功，会进行重试。数据结构如下：

success boolean

true ：成功接收到数据，并且数据正常。

必须返回响应

请务必在成功处理后返回上述结构，且响应的 Content-Type 必须为 application/json。若系统未收到符合要求的响应（包括 Content-Type 非 application/json、返回 false、响应超时、非 200 状态码等），将判定本次回调失败并自动重试。

数据示例

{
  "requestId": "1234",
  "taskId": "1234",
  "totalCount": 100,
  "failedCount": 1,
  "failedRecords": [
    {
      "phoneNumber": "10086",
      "errorMessage": "号码格式不支持",
      "ext": {
        "verify_code": "123306"
      }
    }
  ]
}

响应示例

{
	"success": true
}