Webhook

Outbound task finished

POST/taskend

Request

Request body

event_namestringrequired

事件名称

event_dataobjectrequired

事件数据

task_idintegerrequired

Outbound task ID

task_start_atstringrequired

Task start time

task_progressobjectrequired

Task progress

total_numintegerrequired

Total number of phone numbers

called_numintegerrequired

Number of phone numbers dialed (including retries)

called_answered_numintegerrequired

Number of answered calls

called_un_answered_numintegerrequired

Number of unanswered calls

pending_numintegerrequired

Number of phone numbers not yet dialed

task_overviewobject[]required

Statistics of data collection conclusions for the task

[].questionstringrequired

Question

[].totalintegerrequired

Count

[].optionbooleanrequired

Whether the question is an enum-type question

[].resultsobject[]required

Result statistics

[].resultstringrequired

Conclusion

[].totalintegerrequired

Conclusion count

[].percentstringrequired

Share (%)

Response

200 OK

No fields

Sample code

curl -X POST 'https://openapi.voicefox.ai/taskend' \
  -H 'Authorization: Bearer <YOUR_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "event_name": "事件名称",
  "event_data": {
    "task_id": 0,
    "task_start_at": "string",
    "task_progress": {
      "total_num": 0,
      "called_num": 0,
      "called_answered_num": 0,
      "called_un_answered_num": 0,
      "pending_num": 0
    },
    "task_overview": [
      {
        "question": "string",
        "total": 0,
        "option": false,
        "results": [
          {
            "result": "string",
            "total": 0,
            "percent": "string"
          }
        ]
      }
    ]
  }
}'

Response example

{}