AIRUDDER API
  1. Workflow 工作流
AIRUDDER API
  • API 文档介绍
  • Introductions
  • 快速上手
  • Quick Start
  • 鉴权方法
    • 验证并获取令牌
  • Get the Authorization token
    • Token Authentication and Obtain
  • 全局错误代码
    • 全局错误代码
  • Error Codes
    • Error Codes
  • 催收
    • 快速上手
    • 调用任务相关 API
      • 创建外呼拨打任务
      • 列出已创建的任务
      • 停止一个呼叫任务
      • 取消指定任务中的某个电话的拨打
      • 任务结束状态通知
      • 任务电话维度拨打结束状态通知
      • 获取任务详细信息
      • 获取单个案件通话录音
      • 获取任务录音文件
      • 获取机器人列表
      • 根据callid获取电话信息和录音链接
    • 调用计划相关的API
      • 获取策略列表
      • 创建策略计划拨打任务
      • 获取计划状态信息
      • 获取计划内任务轮次信息
      • 列出已创建的任务
      • 停止一个呼叫任务
      • 取消计划中的某个电话的拨打
      • 计划结束状态通知
      • 任务结束状态通知
      • 任务电话维度拨打结束状态通知
      • 获取任务详细信息
      • 获取单个案件通话录音
      • 获取任务录音文件
      • 获取计划内某个电话所有的通话录音
      • 根据callid获取电话信息和录音链接 Copy
  • Collection
    • Quick Start
    • APIs Related to Calling Tasks
      • Create a Calling Task
      • List the Task Created
      • Cancel a Calling Task
      • Cancel a Certain Call in a Specific Task
      • Webhook of Task
      • Webhook of Call
      • Obtain the Detailed Information of Tasks
      • Obtain a Call Recording
      • Obtain Call Recordings
      • Fetch robot list
      • 根据callid获取电话信息和录音链接 Copy
    • APIs Related to Calling Plans
      • Obtain the List of Strategies
      • Create a Dialing Plan with Strategy
      • Obtain the Information of Plan Status
      • Obtain the Information of Each Round of the Plan
      • List the Task Created
      • Cancel a Calling Task
      • Cancel a Certain Call in a Plan
      • Webhook of Plan
      • Webhook of Task
      • Webhook of Call
      • Obtain the Detailed Information of Tasks
      • Obtain a Call Recording
      • Obtain Task Recordings
      • Obtain All Call Recordings of a Number in the Plan
  • 营销&电商
    • 快速上手
    • 调用任务相关的API
      • 创建拨打任务
      • 列出已创建的任务
      • 停止一个呼叫任务
      • 取消某个任务电话拨打
      • 获取任务详细信息
      • 任务结束状态通知
      • 任务电话维度拨打结束状态通知
      • 获取单个案件通话录音
      • 获取任务录音文件
      • 获取机器人列表
      • 根据callid获取电话信息和录音链接
    • 调用计划相关的API
      • 获取策略列表
      • 创建策略计划拨打任务
      • 获取计划状态信息
      • 获取计划内任务轮次信息
      • 列出已创建的任务
      • 取消一个呼叫任务
      • 取消计划中的某个电话的拨打
      • 计划结束状态通知
      • 任务结束状态通知
      • 任务电话维度拨打结束状态通知
      • 获取任务详细信息
      • 获取单个案件通话录音
      • 获取任务录音文件
      • 获取计划内某个电话所有的通话录音
  • Telemarketing & E-commerce
    • Quick Start
    • APIs Related to Calling Tasks
      • Create a Calling Task
      • List the Task Created
      • Cancel a Calling Task
      • Cancel a Certain Call in a Specific Task
      • Webhook of task
      • Webhook of Call
      • Obtain the Detailed Information of Tasks
      • Obtain a Call Recording
      • Obtain Task Recordings
      • Fetch robot list
    • APIs Related to Calling Plans
      • Obtain the List of Strategies
      • Create a Dialing Plan with Strategy
      • Obtain the Information of Plan Status
      • Obtain the Information of Each Round of the Plan
      • List the Task Created
      • Cancel a Calling Task
      • Cancel a Certain Call in a Plan
      • Webhook of Plan
      • Webhook of Task
      • Webhook of Call
      • Obtain the Detailed Information of Tasks
      • Obtain a Call Recording
      • Obtain Call Recordings
      • Obtain All Call Records of a Number in the Plan
  • 信审
    • 快速上手
    • 调用任务相关的API
      • 创建拨打任务
      • 列出已创建的任务
      • 停止一个任务拨打
      • 取消某个任务电话拨打
      • 任务结束状态通知
      • 任务电话维度拨打结束状态通知
      • 获取任务详细信息
      • 获取单个案件通话录音
      • 获取任务录音文件
      • 获取机器人列表
      • 根据callid获取电话信息和录音链接
    • 调用计划相关的API
      • 获取策略列表
      • 创建策略计划拨打任务
      • 获取计划状态信息
      • 获取计划内任务轮次信息
      • 列出已创建的任务
      • 停止一个任务拨打
      • 取消计划中的某个电话的拨打
      • 计划结束状态通知
      • 任务结束状态通知
      • 任务电话维度拨打结束状态通知
      • 获取任务详细信息
      • 获取单个案件通话录音
      • 获取任务录音文件
      • 获取计划内某个电话所有的通话录音
  • Info Check
    • Quick Start
    • APIs Related to Calling Tasks
      • Create a Calling Task
      • List the Task Created
      • Cancel a Calling Task
      • Cancel a Certain Call in a Specific Task
      • Webhook of task
      • Webhook of Call
      • Obtain the Detailed Information of Tasks
      • Obtain a Call Recording
      • Obtain Task Recordings
      • Fetch robot list
    • APIs Related to Calling Plans
      • Obtain the List of Strategies
      • Create a Dialing Plan with Strategy
      • Obtain the Information of Plan Status
      • Obtain the Information of Each Round of the Plan
      • List the Task Created
      • Cancel a Calling Task
      • Cancel a Certain Call in a Plan
      • Webhook of Plan
      • Webhook of Task
      • Webhook of Call
      • Obtain the Detailed Information of Tasks
      • Obtain a Call Recording
      • Obtain Call Recordings
      • Obtain All Call Records of a Number in the Plan
  • Workflow 工作流
    • 预测式外呼信息回调
      • PDS 任务状态更改回调
      • PDS 联系人状态更改回调
      • PDS 坐席状态更改回调
    • 创建一个新的Workflow任务
      POST
    • 获取workflow模板列表
      GET
    • 为workflow任务新增名单
      POST
    • 更新workflow任务内的名单信息
      POST
    • 取消workflow任务内某个电话的后续流程
      POST
    • Workflow外呼电话拨打结束通知 (催收/营销/电商示例)
      POST
    • Workflow外呼电话拨打结束通知 (信审示例)
      POST
    • 自定义API 节点数据推送
      POST
    • 验证 自定义API 节点数据推送
      POST
    • 停止workflow任务
      POST
    • 获取workflow任务列表
      GET
    • 获取workflow实例的子任务列表信息
      GET
    • 获取workflow节点运行的外呼任务
      POST
    • 获取workflow外呼任务明细 (催收/营销/电商示例)
      POST
    • 获取workflow外呼任务明细(信审示例)
      POST
    • 根据callee/caseid和taskid/workflow_id获取电话信息和录音链接
      GET
    • 根据callid获取电话信息和录音链接
      GET
    • 获取workflow里单个电话的所有录音
      GET
    • 通过 case_id/callee 查询 workflow_id
      POST
    • workflow 名单结束通知
      POST
    • workflow 状态变更通知
      POST
    • 获取workflow节点运行的WABA任务
      GET
    • 获取workflow内WABA任务明细
      GET
    • Workflow内WABA Template消息状态变更通知
      POST
    • Workflow内Chatbot会话结束通知
      POST
  • Workflow
    • Webhooks of the Info of Predictive Dialer System
      • Webhook of Predictive Dialer Task Status Changes
      • Webhook of Predictive Dialer Contacts Status Changes
      • Webhook of Predictive Dialer Agents Status Changes
    • Create a New WorkFlow Task
    • Obtain the List of Workflow Templates
    • Add lists to an workflow task
    • Update the List Info of Workflow Task
    • Cancel the processes for a specific list
    • Notification of Call Completion in Workflow (Debt Collection/Marketing/E-commerce)
    • Notification of Call Completion in Workflow(Info Check)
    • Custom API Node Data Push
    • Verify the Custom API Node Data Push
    • Stop the Workflow Task
    • Obtain the Workflow Task List
    • Obtain the Subtask List of the Workflow
    • Obtain the Outbound Task List of Workflow
    • Obtain the Outbound Task Details of Workflow(Collection/Telemarketing/E-commerce)
    • Obtain the Outbound Task Details of Workflow(Info Check)
    • Obtain Call Information and Recording Links by callee/caseid and taskid/workflow_id
    • Obtian Call Information and Recording Link by Call ID
    • Obtain All the Recordings of a Single Number in the Workflow
    • Query workflow_id using case_id/callee
    • Notification for Workflow List Completion
    • Notification of Workflow Status Change
    • Obtain the WABA Tasks List of Workflow
    • Obtain the WABA Task Details of Workflow
    • Notification of WABA Message Status Alteration in Workflow
    • Chatbot Session End Notification in Workflow
  • 传输过程中加解密
    • API接口使用AES加解密对接
    • API接口使用AES加解密对接-示例
  • Encryption and decryption during the transmission process
    • API Integration with AES Encryption/Decryption
    • API Interface with AES Encryption/Decryption - Example
  • WorkFlow_LeadsGeneration
    • Webhooks of the Info of Predictive Dialer System
      • Webhook of Predictive Dialer Task Status Changes
      • Webhook of Predictive Dialer Agents Status Changes
      • Webhook of Predictive Dialer Contacts Status Changes
    • Create a New WorkFlow Task
    • Obtain the List of Workflow Templates
    • Add Workflow Contacts
    • Update the List Info of Workflow
    • Cancel a Call
    • End Status Notification from the Dimension of Phone Call
    • Stop the Workflow Task
    • Custom API Data Push
    • Verify the Custom API Data Push
    • Obtain the Task List of Workflow
    • Obtain the Subtask List of the Workflow
    • Obtain All the Recordings of a Single Number in the Workflow
  • Flex_Route
    • LendSwift-Outbound-Push-Data-to-AI-Rudder
    • SDR-Webpage-Push-Data-to-Workflow
    • Talmarket Debt-Consolidation Push Data to Make Outboud Call
    • Use AI Rudder Make Outbound Call
  • API_Store
    • Push-Data-to-Boberdoo-After-EnablementData-Inbound-Call
    • AI Rudder Ping Doucet Before Transfer
  • DIDI营销定制
    • 获取机器人列表
    • 获取机器人详情
    • 创建外呼拨打任务
  • Chatbot
    • 接入准备
    • 错误码
    • HSB关于custom字段使用说明
    • 华为
      • api
        • 用户发送消息
        • 转人工结果
      • webhook
        • 回调机器人回复消息
        • 回调转人工申请
        • 结束会话
    • bot
      • 用户发送消息
      • 回调机器人回复消息
      • 回调转人工申请
      • 回调结束会话
    • 查询可用WABA账号
    • 查询模版列表
    • 查询模版详情
    • 发送模版消息
    • 查询模版消息发送结果
    • 回调模版消息发送结果
    • 发送单个模版消息接口
    • 回调单个模版消息用户响应
    • 回调转人工申请
    • 回调坐席消息发送之后的状态变更
    • 回调转人工后用户发送的消息
    • 回调会话结束事件
    • 转人工结果
    • 查询会话列表
    • 查询消息列表
    • 将用户消息标记为已读
    • 发送普通消息
    • 结束会话
    • 上传文件
    • 上传文件(谷歌地图缩略图)
    • 会话结束后上报
    • 查询公司所有渠道信息
    • 用户发送的消息事件上报
    • 渠道发送的消息事件上报
    • 渠道发送的消息状态变更事件上报
    • 获取公司信息
    • 查询运单号物流轨迹
    • 重开会话
  • Chatbot English
    • Quick Start
    • Error Code
    • bot
      • User send message
      • Callback bot reply message
      • Callback transfer to agent request
      • Callback for ended session
    • Query available WABA accounts
    • Query the template list
    • Template details
    • Send template message
    • Query the template message sending result
    • Callback template message sending result
    • Send single template message
    • Callback single template message user response
    • Callback agent transfer request
    • Callback status change after the message is sent
    • Callback message sent by user
    • *Callback agent transfer request
    • *Callback for status change after the agent message is sent
    • *Callback for messages sent by the user after transferring to agent
    • Callback for session end event
    • Agent transfer result
    • Query conversation list
    • Query message list
    • *Query message list
    • Mark user message as read
    • Send regular message
    • End session
    • Upload file
    • Upload file (Google maps thumbnail)
    • Report after session ends
  • 呼入机器人业务
    • inbound业务对接介绍
    • 验证并获取令牌
    • 根据callid获取通话信息和录音链接
    • 转人工成功后通知
    • 电话结束后通知
  • Inbound
    • Inbound Business Integration Guide
    • Token Authentication and Obtain
    • Notification after Successful Transfer to an Agent
    • Notification after the Call Ends
  • J&T
    • 【J&T】Workflow内电话拨打完成&WABA状态变更&Chatbot会话结束通知
  • TICTOK OCIC
    • 机器人信息查询
    • 查询ASR转译数据
  • MAYBANK
    • Token Authentication and Obtain
    • Upload List
    • Update List
  1. Workflow 工作流

Workflow外呼电话拨打结束通知 (催收/营销/电商示例)

POST
对接方提供此url交给我方配置
当任务的电话拨打结束时(接通或者完成拨打次数),不管接通还是未接通,主动通知对接方该任务的此电话拨打数据。其中接通的电话会在完成后立即通知;完成拨打次数但仍未接通的所有电话,会在任务结束后聚合通知。
例如:任务task1中含有3个号码(number1、number2、number3)。
当任务开始拨打时,number1被接通,则此时number1进行电话信息回调; number2、number3未接通,则按照任务中配置的重拨次数进行拨打,直到接通或者完成重拨次数后进行回调。
如果此url响应异常,我方会间隔1分钟进行重试,最多5次重试失败后不再进行通知。请在收到数据10s内响应,同时异步处理数据存储及后续逻辑。
对接方需要提供两个参数给我方配置:
URL 回调地址
KEY 参数签名用的KEY,默认使用airudder签名。

请求参数

Header 参数

Body 参数application/json

示例
{
  "workflow_id": "16e0660e6cxxxxxxxxxxxxxxxx0abfe0e191",
  "workflow_name": "test_wf_call_webhook1",
  "nodetask_id": "4d308b4ed6xxxxxxxxed6a76e15d",
  "nodetask_name": "Voicebot Call1_f405f7",
  "TaskID": "490d5ec3c1xxxxxxxx2b759b5b",
  "TaskName": "wf_test_wf_call_webhook_Voicebot Call1_26bcf0",
  "Sign": "a395ce1acxxxxxxxx7bab53f5",
  "Details": [
    {
      "id": 2123875204,
      "RobotID": "4585",
      "CalleeName": "WILL SMITH",
      "CalleeGender": "",
      "CalleeNumber": "+86xxxxxxxx721",
      "CallStartTime": "2024-03-11T03:20:30Z",
      "CallEndTime": "2024-03-11T03:20:56Z",
      "Status": "finished",
      "Intention": "E",
      "CallID": "cad907xxxxxxxx35644a",
      "CallTimes": 2,
      "Comments": "7777777.0",
      "BorrowedDate": "2024-02-01",
      "DueDate": "2024-03-02",
      "BorrowedAmount": "20000.00",
      "TotalOwingAmount": "20310.00",
      "CurrencyUnit": "USD",
      "PlatformName": "AIRUDDER",
      "RingType": "normal",
      "HangupType": "ByRobot",
      "ExtraA": "",
      "ExtraB": "",
      "ExtraC": "",
      "AsrResult": [
        {
          "time": "00:00:00",
          "robottext": "halo (jeda 1-2 detik) selamat pagi",
          "text": ""
        },
        {
          "time": "00:00:03",
          "robottext": "Apa boleh minta waktunya sebentar?",
          "text": ""
        },
        {
          "time": "00:00:11",
          "robottext": "",
          "text": ""
        },
        {
          "time": "00:00:11",
          "robottext": "Halo",
          "text": ""
        },
        {
          "time": "00:00:13",
          "robottext": "",
          "text": ""
        },
        {
          "time": "00:00:13",
          "robottext": "mengapa tidak berbicara?",
          "text": ""
        },
        {
          "time": "00:00:18",
          "robottext": "",
          "text": ""
        },
        {
          "time": "00:00:18",
          "robottext": "Halo? Apa suara saya terdengar?",
          "text": ""
        }
      ],
      "RingTime": 5,
      "TalkRound": 0,
      "RedailCall": [
        {
          "CallID": "cb035452180xxxxxxxxb2c7db",
          "CallStartTime": "2024-03-11 10:19:27",
          "RingType": "normal",
          "RingTime": 2,
          "HangupType": "ByCallee",
          "ResultLabel": "F",
          "callee_number": "+86xxxxxxxx01",
          "caller_number": "+950xxxxxxxx88"
        }
      ],
      "NerSlots": {
        "PaymentMethod": "Transfer",
        "PaymentTime": "Time_0"
      },
      "intention_description": "Needs Follow Up",
      "EventLabel": {
        "A0": "A0",
        "Correct_Person": "identity_correct_person",
        "Request_Installment": "action_item_request_installment"
      },
      "caller_number": "+95xxxxxxxx88",
      "CaseID": "7777777.0",
      "Variables": {
        "var1": "aaa",
        "var2": "bbb",
        "var3": "ccc"
      }
    }
  ]
}

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '对接方提供此url交给我方配置' \
--header 'User-Agent: Airudder' \
--header 'Content-Type: application/json' \
--data-raw '{
  "workflow_id": "16e0660e6cxxxxxxxxxxxxxxxx0abfe0e191",
  "workflow_name": "test_wf_call_webhook1",
  "nodetask_id": "4d308b4ed6xxxxxxxxed6a76e15d",
  "nodetask_name": "Voicebot Call1_f405f7",
  "TaskID": "490d5ec3c1xxxxxxxx2b759b5b",
  "TaskName": "wf_test_wf_call_webhook_Voicebot Call1_26bcf0",
  "Sign": "a395ce1acxxxxxxxx7bab53f5",
  "Details": [
    {
      "id": 2123875204,
      "RobotID": "4585",
      "CalleeName": "WILL SMITH",
      "CalleeGender": "",
      "CalleeNumber": "+86xxxxxxxx721",
      "CallStartTime": "2024-03-11T03:20:30Z",
      "CallEndTime": "2024-03-11T03:20:56Z",
      "Status": "finished",
      "Intention": "E",
      "CallID": "cad907xxxxxxxx35644a",
      "CallTimes": 2,
      "Comments": "7777777.0",
      "BorrowedDate": "2024-02-01",
      "DueDate": "2024-03-02",
      "BorrowedAmount": "20000.00",
      "TotalOwingAmount": "20310.00",
      "CurrencyUnit": "USD",
      "PlatformName": "AIRUDDER",
      "RingType": "normal",
      "HangupType": "ByRobot",
      "ExtraA": "",
      "ExtraB": "",
      "ExtraC": "",
      "AsrResult": [
        {
          "time": "00:00:00",
          "robottext": "halo (jeda 1-2 detik) selamat pagi",
          "text": ""
        },
        {
          "time": "00:00:03",
          "robottext": "Apa boleh minta waktunya sebentar?",
          "text": ""
        },
        {
          "time": "00:00:11",
          "robottext": "",
          "text": ""
        },
        {
          "time": "00:00:11",
          "robottext": "Halo",
          "text": ""
        },
        {
          "time": "00:00:13",
          "robottext": "",
          "text": ""
        },
        {
          "time": "00:00:13",
          "robottext": "mengapa tidak berbicara?",
          "text": ""
        },
        {
          "time": "00:00:18",
          "robottext": "",
          "text": ""
        },
        {
          "time": "00:00:18",
          "robottext": "Halo? Apa suara saya terdengar?",
          "text": ""
        }
      ],
      "RingTime": 5,
      "TalkRound": 0,
      "RedailCall": [
        {
          "CallID": "cb035452180xxxxxxxxb2c7db",
          "CallStartTime": "2024-03-11 10:19:27",
          "RingType": "normal",
          "RingTime": 2,
          "HangupType": "ByCallee",
          "ResultLabel": "F",
          "callee_number": "+86xxxxxxxx01",
          "caller_number": "+950xxxxxxxx88"
        }
      ],
      "NerSlots": {
        "PaymentMethod": "Transfer",
        "PaymentTime": "Time_0"
      },
      "intention_description": "Needs Follow Up",
      "EventLabel": {
        "A0": "A0",
        "Correct_Person": "identity_correct_person",
        "Request_Installment": "action_item_request_installment"
      },
      "caller_number": "+95xxxxxxxx88",
      "CaseID": "7777777.0",
      "Variables": {
        "var1": "aaa",
        "var2": "bbb",
        "var3": "ccc"
      }
    }
  ]
}'

返回响应

🟢200success
application/json
Body

示例
{}
修改于 2025-07-25 02:36:22
上一页
取消workflow任务内某个电话的后续流程
下一页
Workflow外呼电话拨打结束通知 (信审示例)
Built with