Outbound tasks

Get task details

GET/openapi/tasks/{taskID}

Request

Parameters

taskIDstringrequired

Path parameter · Task ID

Response

200 OK

idintegerrequired

任务ID

createdAtstringrequired

任务创建时间

updatedAtstringrequired

任务更新时间

namestringrequired

任务名称

statusstringrequired

任务状态

pendingrunningstop.operatestop.timeoutstop.abnormaldone

totalintegerrequired

任务号码总数

progressintegerrequired

Percentage

collectionRateintegerrequired

Percentage

optionobjectrequired

任务选项

numberFileMetaobjectrequired

号码integerrequired

备注integerrequired

姓名integerrequired

numbersinteger[]required

startDatestringrequired

开始日期

startTimestring[][]required

任务执行时间段

retryCountintegerrequired

重试次数

retryIntervalintegerrequired

重试间隔时间

summarystringrequired

任务总结

suggestionstringrequired

任务建议

assistantVidintegerrequired

使用的助手版本ID

assistantobjectrequired

使用的助手

idintegerrequired

projectIdintegerrequired

namestringrequired

versionIdintegerrequired

scenestringrequired

speakerIdintegerrequired

websocketUrlstringrequired

websocketTokenstringrequired

listenerIdintegerrequired

welcomestringrequired

promptstringrequired

collectobject[]required

[].questionstring

[].answersstring[]

knowledgestringrequired

createdAtstringrequired

updatedAtstringrequired

creatorobjectrequired

emailstringrequired

deletedAtnullrequired

idOldVersionbooleanrequired

usageCountintegerrequired

creatorIdintegerrequired

Sample code

curl -X GET 'https://openapi.voicefox.ai/openapi/tasks/{taskID}' \
  -H 'Authorization: Bearer <YOUR_TOKEN>' \
  -H 'Content-Type: application/json'

Response example

{
  "id": 0,
  "createdAt": "任务创建时间",
  "updatedAt": "任务更新时间",
  "name": "任务名称",
  "status": "pending",
  "total": 0,
  "progress": 0,
  "collectionRate": 0,
  "option": {
    "numberFileMeta": {
      "号码": 0,
      "备注": 0,
      "姓名": 0
    },
    "numbers": [
      0
    ],
    "startDate": "开始日期",
    "startTime": [
      [
        "string"
      ]
    ],
    "retryCount": 0,
    "retryInterval": 0
  },
  "summary": "任务总结",
  "suggestion": "任务建议",
  "assistantVid": 0,
  "assistant": {
    "id": 0,
    "projectId": 0,
    "name": "string",
    "versionId": 0,
    "scene": "string",
    "speakerId": 0,
    "websocketUrl": "string",
    "websocketToken": "string",
    "listenerId": 0,
    "welcome": "string",
    "prompt": "string",
    "collect": [
      {
        "question": "string",
        "answers": [
          "string"
        ]
      }
    ],
    "knowledge": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "creator": {
      "email": "string"
    },
    "deletedAt": null,
    "idOldVersion": false,
    "usageCount": 0,
    "creatorId": 0
  }
}