1.1. 查询异步导入客户结果接口

1.2. 请求地址

  • GET /v1/autoCallTasks/syncNumberResult

1.3. 请求参数

参数 类型 是否可空 描述
timestamp Long false 时间戳(例:当前秒数，1533092860)
sign String false 签名:身份认证签名(DigestUtils.sha1Hex(email&secretKey&timestamp))
email String false 邮箱
outboundTaskId int false 任务ID
batchId String false 批次号(yyyyMMddhhmmssSSS,例:20190401101010123)

1.4. 响应参数

参数 类型 是否可空 描述
code String false 返回码
message String false 返回消息
visible boolean false 是否可见(暂不使用)
data Object true 结果
data.execStatus int false 执行状态(1等待2导入中3导入完成)
data.successCount int false 成功导入的号码数量
data.failedCount int false 导入失败的号码数量
data.failedNumberList Array true 导入失败的号码数组
data.failedNumberList[].name String true 姓名
data.failedNumberList[].mobile String true 号码
data.failedNumberList[].remark String true 备注
data.failedNumberList[].variates Array true 自定义变量(格式:[{"key":"天气","type":"string","value":"北京"}])
data.failedNumberList[].failedReason String true 失败原因

1.5. 请求示例

$ curl 'http://localhost:8080/v1/autoCallTasks/syncNumberResult?email=1@test.cn&timestamp=1542187160&sign=123&outboundTaskId=1&batchId=20190401101010123' -i -X GET -H 'Content-Type: application/json'

1.6. 响应示例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 522

{
  "code" : 200,
  "message" : "OK",
  "visible" : false,
  "data": {
           "execStatus":1,
          "successCount": 2,
          "failedCount": 0,
          "failedNumberList": null
        }
}

1.7. 设置异步导入客户回调webhook地址

1.8. 请求地址

  • POST /v1/targetUrls

1.9. 请求参数

参数 类型 是否可空 描述
timestamp Long false 时间戳(例:当前秒数，1533092860)
sign String false 签名:身份认证签名(DigestUtils.sha1Hex(email&secretKey&timestamp))
email String false 邮箱
id int true payloadUrl对应编码(更新时使用)
payloadUrl String false 回调地址

1.10. 响应参数

参数 类型 是否可空 描述
code String false 返回码
message String false 返回消息
visible boolean false 是否可见(暂不使用)
data Array true 结果
data[].id int false 模版ID
data[].name String false 任务ID
data[].enabled int false 是否启用
data[].remark String true 描述
data[].itemList Array true 结果
data[].itemList[].id int false 自定义字段ID
data[].itemList[].name String false 自定义字段名称
data[].itemList[].enabled int false 是否启用
data[].itemList[].contentType String true 类型
data[].itemList[].remark String true 描述

1.11. 请求示例

$ curl 'http://localhost:8080/v1/targetUrls?email=1@test.cn&timestamp=1542187160&sign=123' -i -X POST -H 'Content-Type: application/json' -d '{
    "id": 1,
    "payloadUrl": "http://localhost:8081/v1/targetUrlsCallBack"
  }'

1.12. 响应示例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 522

{
  "code" : 200,
  "message" : "OK",
  "visible" : false,
  "data": {
          "id": 1,
          "payloadUrl": "http://localhost:8081/v1/targetUrlsCallBack"
        }
}

results matching ""

    No results matching ""