AIRUDDER API
  1. 调用任务相关的API
AIRUDDER API
  • API 文档介绍
  • Introductions
  • 快速上手
  • Quick Start
  • 鉴权方法
    • 验证并获取令牌
      POST
  • Get the Authorization token
    • Token Authentication and Obtain
      POST
  • 全局错误代码
    • 全局错误代码
  • Error Codes
    • Error Codes
  • 催收
    • 快速上手
    • 调用任务相关 API
      • 创建外呼拨打任务
      • 列出已创建的任务
      • 停止一个呼叫任务
      • 取消指定任务中的某个电话的拨打
      • 任务结束状态通知
      • 任务电话维度拨打结束状态通知
      • 获取任务详细信息
      • 获取单个案件通话录音
      • 获取任务录音文件
      • 获取机器人列表
      • 根据callid获取电话信息和录音链接
    • 调用计划相关的API
      • 获取策略列表
      • 创建策略计划拨打任务
      • 获取计划状态信息
      • 获取计划内任务轮次信息
      • 列出已创建的任务
      • 停止一个呼叫任务
      • 取消计划中的某个电话的拨打
      • 计划结束状态通知
      • 任务结束状态通知
      • 任务电话维度拨打结束状态通知
      • 获取任务详细信息
      • 获取单个案件通话录音
      • 获取任务录音文件
      • 获取计划内某个电话所有的通话录音
  • 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
    • 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
      • 创建拨打任务
        POST
      • 列出已创建的任务
        GET
      • 停止一个任务拨打
        POST
      • 取消某个任务电话拨打
        POST
      • 任务结束状态通知
        POST
      • 任务电话维度拨打结束状态通知
        POST
      • 获取任务详细信息
        GET
      • 获取单个案件通话录音
        GET
      • 获取任务录音文件
        GET
      • 获取机器人列表
        GET
      • 根据callid获取电话信息和录音链接
        GET
    • 调用计划相关的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任务
    • 获取workflow模板列表
    • 为workflow任务新增名单
    • 更新workflow任务内的名单信息
    • 取消workflow任务内某个电话的后续流程
    • Workflow外呼电话拨打结束通知 (催收/营销/电商示例)
    • Workflow外呼电话拨打结束通知 (信审示例)
    • 自定义API 节点数据推送
    • 验证 自定义API 节点数据推送
    • 停止workflow任务
    • 获取workflow任务列表
    • 获取workflow实例的子任务列表信息
    • 获取workflow节点运行的外呼任务
    • 获取workflow外呼任务明细 (催收/营销/电商示例)
    • 获取workflow外呼任务明细(信审示例)
    • 根据callee/caseid和taskid/workflow_id获取电话信息和录音链接
    • 根据callid获取电话信息和录音链接
    • 获取workflow里单个电话的所有录音
    • 通过 case_id/callee 查询 workflow_id
    • workflow 名单结束通知
    • workflow 状态变更通知
    • 获取workflow节点运行的WABA任务
    • 获取workflow内WABA任务明细
    • Workflow内WABA消息状态变更通知
    • Workflow内Chatbot会话结束通知
  • 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加解密对接-示例
  • 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 Callback
    • inbound业务对接介绍
    • Inbound Business Integration Guide
    • 转人工成功后通知
    • Notification after Successful Transfer to an Agent
    • 电话结束后通知
    • Notification after the Call Ends
  1. 调用任务相关的API

任务电话维度拨打结束状态通知

POST
对接方提供此url交给我方配置
任务的电话拨打结束时(接通或者完成拨打次数),不管接通还是未接通,主动通知对接方该任务的此电话拨打数据,接通的电话会在完成后立即通知;完成拨打次数但仍未接通的所有电话,会聚合通知。
如果此url 响应异常(http状态码非200),我方会间隔1 分钟进行重试,最多5 次重试,失败后不再进行通知。请在收到数据后进行异步处理,尽快返回响应。
对接方需要提供一个 回调URL 地址给我方配置。

请求参数

Header 参数
Content-Type
string 
必需
默认值:
application/json
User-Agent
string 
可选
默认值:
Airudder
Body 参数application/json
task_id
string 
必需
task_name
string 
必需
status
enum<string> 
必需
枚举值:
createdpendingfinishedcallingcanceledpaused
created_at
string 
必需
repeat_interval
integer 
必需
repeat_number
integer 
必需
robot_hash
string 
必需
robot_method
string 
必需
sip_line
string 
必需
schedule_start_time
string 
必需
任务调度开始时间。 时区为客户所在地区时间。
schedule_end_time
string 
必需
任务调度结束时间。 时区为客户所在地区时间。
details
array [object {22}] 
必需
1.这里是一个数组,之所以采用数组结构,是因为电话并发拨打,会存在电话拨打同时结束的情况,这里会聚合通知,具体看下面的示例 2.时区为客户所在地区时间。
id
integer 
必需
callee
string 
必需
result
enum<string> 
必需
枚举值:
createdpendingfinishedcancelledfailed
result_label
string 
必需
通话结果标签,根据机器人不同通话结果有不同的含义。
duration
integer 
必需
该通电话的通话时长,单位是s
hangup_type
enum<string> 
必需
枚举值:
ByCalleeByRobotCanceled
ring_type
enum<string> 
必需
枚举值:
busycantuseholdlineswitchoffoutofareaunregisterwrongnum notmatchnormalnull
question_answer
array [object {10}] 
必需
EventLabel
object 
可选
呼叫结果多标签。 (此字段因国家/地区而异。如果您需要更多信息,请联系我们。)
Slots
object 
可选
该通电话命中的NER槽位和槽值(此字段将废弃,由NerSlots取代)
NerSlots
object 
可选
该通电话命中的NER槽位和槽值(此字段因国家/地区而异。如果您需要更多信息,请联系我们。)
variables
object 
可选
用户上传的变量信息。 (此字段因国家/地区而异。如果您需要更多信息,请联系我们。)
robot_hash
string 
可选
此字段因国家/地区而异。如果您需要更多信息,请联系我们。)
call_id
string 
可选
此字段因国家/地区而异。如果您需要更多信息,请联系我们。
call_times
integer 
可选
拨打次数, 当前轮次内名单的拨打总次数。(此字段因国家/地区而异。如果您需要更多信息,请联系我们。)
call_start_time
string 
可选
该通电话的用户接通时间,不包含响铃时长。 时区为客户所在地区时间。
call_end_time
string 
可选
该通电话的拨打结束时间。时区为客户所在地区时间。此字段因国家/地区而异。如果您需要更多信息,请联系我们。)
ring_time
integer 
可选
呼叫的振铃持续时间。 (此字段因国家/地区而异。如果您需要更多信息,请联系我们。)
talk_round
integer 
可选
通话回合。 (此字段因国家/地区而异。如果您需要更多信息,请联系我们。)
redail_call
array [object {8}] 
可选
本轮通话重拨的详细信息。 (此字段因国家/地区而异。如果您需要更多信息,请联系我们。)
intention_description
string 
必需
意图描述,不同的机器人的不同意图描述均不一样。(此字段因国家/地区而异。如果您需要更多信息,请联系我们。)
caller_number
string 
必需
此次呼叫的主叫号码(此字段因国家/地区而异。如果您需要更多信息,请联系我们。)
示例
{
  "task_id": "ic1a7a8f2bxxx9f5e343a2ec25a9b2",
  "task_name": "xxxxxxxxxxc25a9b2_ic_task",
  "status": "finished",
  "created_at": "2022-12-19 15:14:52",
  "repeat_interval": 0,
  "repeat_number": 0,
  "robot_hash": "f3298554xxxxxxx88aa595674",
  "robot_method": "single",
  "sip_line": "TEST_LINE",
  "schedule_start_time": "2022-12-19 15:14:52",
  "schedule_end_time": "2022-12-19 15:24:52",
  "details": [
    {
      "id": 931888898,
      "callee": "+8612345678",
      "result": "finished",
      "result_label": "A",
      "intention_description": "xxxx",
      "duration": 0,
      "hangup_type": "ByCallee",
      "ring_type": "normal",
      "question_answer": [
        {
          "question_name": "Q1",
          "answer": "rba1",
          "answer_text": "yes it is  rba1",
          "status": "Completed",
          "answer_text_slot": "rba1",
          "var": "RBA1",
          "verification_results": "Match",
          "question_content": "ABCD Reverification",
          "question_type": "open",
          "whether_answer": "Answered"
        },
        {
          "question_name": "Q2",
          "answer": "Yes",
          "answer_text": "yes i will",
          "status": "Completed",
          "answer_text_slot": "-",
          "var": "-",
          "verification_results": "-",
          "question_content": " Willingness Check",
          "question_type": "whether",
          "whether_answer": "Answered"
        },
        {
          "question_name": "Q3",
          "answer": "06",
          "answer_text": "",
          "status": "Completed",
          "answer_text_slot": "06",
          "var": "SN06",
          "verification_results": "Match",
          "question_content": " ABCD Verification for 2 character",
          "question_type": "open",
          "whether_answer": "Answered"
        }
      ],
      "EventLabel": {
        "VerifyPass": "VerifyPass"
      },
      "NerSlots": {
        "PaymentMethod": "ATM",
        "PaymentTime": "Time_0"
      },
      "variables": {
        "birthday": "1224",
        "var2": "03",
        "creditnumber": "1234"
      },
      "robot_hash": "f3298554be9xxxxxxxxaa595674",
      "call_id": "ic9adfe00d474bxxxxxxxx5351bc0",
      "call_times": 1,
      "call_start_time": "2022-12-19 15:17:14",
      "call_end_time": "2022-12-19 15:17:14",
      "ring_time": 0,
      "talk_round": 0,
      "redail_call": [
        {
          "CallID": "7c5a79bd5c5ac93cbe6fa6b5a0b0412c",
          "CallStartTime": "2023-03-29 14:24:28",
          "RingType": "",
          "RingTime": 5,
          "HangupType": "ByCallee",
          "ResultLabel": "F",
          "caller_number": "+62777888888",
          "callee_number": "+6212345678"
        }
      ],
      "caller_number": "+62777888888"
    }
  ]
}

示例代码

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 '{
    "task_id": "ic1a7a8f2bxxx9f5e343a2ec25a9b2",
    "task_name": "xxxxxxxxxxc25a9b2_ic_task",
    "status": "finished",
    "created_at": "2022-12-19 15:14:52",
    "repeat_interval": 0,
    "repeat_number": 0,
    "robot_hash": "f3298554xxxxxxx88aa595674",
    "robot_method": "single",
    "sip_line": "TEST_LINE",
    "schedule_start_time": "2022-12-19 15:14:52",
    "schedule_end_time": "2022-12-19 15:24:52",
    "details": [
        {
            "id": 931888898,
            "callee": "+8612345678",
            "result": "finished",
            "result_label": "A",
            "intention_description": "xxxx",
            "duration": 0,
            "hangup_type": "ByCallee",
            "ring_type": "normal",
            "question_answer": [
                {
                    "question_name": "Q1",
                    "answer": "rba1",
                    "answer_text": "yes it is  rba1",
                    "status": "Completed",
                    "answer_text_slot": "rba1",
                    "var": "RBA1",
                    "verification_results": "Match",
                    "question_content": "ABCD Reverification",
                    "question_type": "open",
                    "whether_answer": "Answered"
                },
                {
                    "question_name": "Q2",
                    "answer": "Yes",
                    "answer_text": "yes i will",
                    "status": "Completed",
                    "answer_text_slot": "-",
                    "var": "-",
                    "verification_results": "-",
                    "question_content": " Willingness Check",
                    "question_type": "whether",
                    "whether_answer": "Answered"
                },
                {
                    "question_name": "Q3",
                    "answer": "06",
                    "answer_text": "",
                    "status": "Completed",
                    "answer_text_slot": "06",
                    "var": "SN06",
                    "verification_results": "Match",
                    "question_content": " ABCD Verification for 2 character",
                    "question_type": "open",
                    "whether_answer": "Answered"
                }
            ],
            "EventLabel": {
                "VerifyPass": "VerifyPass"
            },
            "NerSlots": {
                    "PaymentMethod": "ATM",
                    "PaymentTime": "Time_0"
                },
            "variables": {
                "birthday": "1224",
                "var2": "03",
                "creditnumber": "1234"
            },
            "robot_hash": "f3298554be9xxxxxxxxaa595674",
            "call_id": "ic9adfe00d474bxxxxxxxx5351bc0",
            "call_times": 1,
            "call_start_time": "2022-12-19 15:17:14",
            "call_end_time": "2022-12-19 15:17:14",
            "ring_time": 0,
            "talk_round": 0,
            "redail_call": [
                {
                    "CallID": "7c5a79bd5c5ac93cbe6fa6b5a0b0412c",
                    "CallStartTime": "2023-03-29 14:24:28",
                    "RingType": "",
                    "RingTime": 5,
                    "HangupType": "ByCallee",
                    "ResultLabel": "F",
                    "caller_number": "+62777888888" ,
                    "callee_number": "+6212345678"  
                }
            ],
            "caller_number": "+62777888888"
        }
    ]
}'

返回响应

🟢200success
application/json
Body
object {0}
示例
{}
上一页
任务结束状态通知
下一页
获取任务详细信息
Built with