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
      • 获取策略列表
      • 创建策略计划拨打任务
      • 获取计划状态信息
      • 获取计划内任务轮次信息
      • 列出已创建的任务
      • 停止一个呼叫任务
      • 取消计划中的某个电话的拨打
      • 计划结束状态通知
      • 任务结束状态通知
      • 任务电话维度拨打结束状态通知
      • 获取任务详细信息
      • 获取单个案件通话录音
      • 获取任务录音文件
      • 获取计划内某个电话所有的通话录音
      • 根据callid获取电话信息和录音链接
      • 获取机器人列表
  • 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
      • Obtain call information and recording link by callid
    • 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
      • Fetch robot list
      • Obtain call information and recording link by callid
  • 营销&电商
    • 快速上手
    • 调用任务相关的API
      • 创建拨打任务
      • 列出已创建的任务
      • 停止一个呼叫任务
      • 取消某个任务电话拨打
      • 获取任务详细信息
      • 任务结束状态通知
      • 任务电话维度拨打结束状态通知
      • 获取单个案件通话录音
      • 获取任务录音文件
      • 获取机器人列表
      • 根据callid获取电话信息和录音链接
    • 调用计划相关的API
      • 获取策略列表
      • 创建策略计划拨打任务
      • 获取计划状态信息
      • 获取计划内任务轮次信息
      • 列出已创建的任务
      • 取消一个呼叫任务
      • 取消计划中的某个电话的拨打
      • 计划结束状态通知
      • 任务结束状态通知
      • 任务电话维度拨打结束状态通知
      • 获取任务详细信息
      • 获取单个案件通话录音
      • 获取任务录音文件
      • 获取计划内某个电话所有的通话录音
      • 获取机器人列表
      • 根据callid获取电话信息和录音链接
  • 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
      • Obtain call information and recording link by callid
    • 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
      • Fetch robot list
      • Obtain call information and recording link by callid
  • 信审
    • 快速上手
    • 调用任务相关的API
      • 创建拨打任务
        POST
      • 列出已创建的任务
        GET
      • 停止一个任务拨打
        POST
      • 取消某个任务电话拨打
        POST
      • 任务结束状态通知
        POST
      • 任务电话维度拨打结束状态通知
        POST
      • 获取任务详细信息
        GET
      • 获取单个案件通话录音
        GET
      • 获取任务录音文件
        GET
      • 获取机器人列表
        GET
      • 根据callid获取电话信息和录音链接
        GET
    • 调用计划相关的API
      • 获取策略列表
      • 创建策略计划拨打任务
      • 获取计划状态信息
      • 获取计划内任务轮次信息
      • 列出已创建的任务
      • 停止一个任务拨打
      • 取消计划中的某个电话的拨打
      • 计划结束状态通知
      • 任务结束状态通知
      • 任务电话维度拨打结束状态通知
      • 获取任务详细信息
      • 获取单个案件通话录音
      • 获取任务录音文件
      • 获取计划内某个电话所有的通话录音
      • 获取机器人列表
      • 根据callid获取电话信息和录音链接
  • 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
      • Obtain call information and recording link by callid
    • 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
      • Fetch robot list
      • Obtain call information and recording link by callid
  • 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 Template消息状态变更通知
    • Workflow内Chatbot会话结束通知
    • 获取Workflow内SMS message记录
    • Workflow内SMS message状态变更通知
  • 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
    • Obtain SMS message records within the workflow
    • Notification of SMS message status change within the 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
  • Chatbot
    • 接入准备
    • 错误码
    • HSB关于custom字段使用说明
    • 华为
      • api
        • 用户发送消息
        • 转人工结果
      • webhook
        • 回调机器人回复消息
        • 回调转人工申请
        • 结束会话
    • bot
      • 用户发送消息
      • 回调机器人回复消息
      • 回调转人工申请
      • 回调结束会话
      • 回调会话总结
      • 关闭对话
    • Omnichannel
      • 查询可用WABA账号
      • 创建Template
      • 删除Template
      • 查询模版列表
      • 查询模版详情
      • 发送模版消息
      • 发送普通消息
      • 回调消息状态变更
      • 回调用户消息
      • 回调WABA状态变更
      • 回调phone number质量变更
      • 回调phone number name变更
      • 回调Template质量变更
      • 回调Template状态变更
    • 查询可用WABA账号
    • 查询模版列表
    • 查询模版详情
    • 发送模版消息
    • 查询模版消息发送结果
    • 回调模版消息发送结果
    • 发送单个模版消息接口
    • 回调单个模版消息用户响应
    • 回调转人工申请
    • 回调坐席消息发送之后的状态变更
    • 回调转人工后用户发送的消息
    • 回调会话结束事件
    • 转人工结果
    • 查询会话列表
    • 查询消息列表
    • 将用户消息标记为已读
    • 发送普通消息
    • 结束会话
    • 上传文件
    • 上传文件(谷歌地图缩略图)
    • 会话结束后上报
    • 查询公司所有渠道信息
    • 用户发送的消息事件上报
    • 渠道发送的消息事件上报
    • 渠道发送的消息状态变更事件上报
    • 获取公司信息
    • 查询运单号物流轨迹
    • 重开会话
    • 回调模版消息状态及计费
  • Chatbot English
    • Quick Start
    • Error Code
    • bot
      • User send message
      • Callback bot reply message
      • Callback transfer to agent request
      • Callback for ended session
    • Omnichannel
      • Error Code
      • Query available WABA accounts
      • Create Template
      • Update Template
      • Delete Template
      • Query Template List
      • Query Template Details
      • Send Template Message
      • Send Message
      • Callback message status change
      • Callback user message
      • Callback for WABA Status Change
      • Callback phone number quality change
      • Callback phone number name change
      • Callback Template Quality Change
      • Callback Template Status Change
    • 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
    • Mark user message as read
    • Send regular message
    • End session
    • Upload file
    • Upload file (Google maps thumbnail)
    • Report after session ends
    • Callback WABA Template Message Status & Billing
  • 呼入机器人业务
    • inbound业务对接介绍
    • 验证并获取令牌
    • 根据callid获取通话信息和录音链接
    • 转人工成功后通知
    • 电话结束后通知
    • 查询统计数据
    • 转人工成功后通知 v2
    • 电话结束后通知 v2
  • Inbound
    • Inbound Business Integration Guide
    • Token Authentication and Obtain
    • Notification after Successful Transfer to an Agent
    • Notification after the Call Ends
  • 数据模型
    • 英语
      • hang up type
      • WABA message status
      • ring type
      • hang up by
      • call status
      • transfer status
      • Intention
      • reason code
      • plan status
      • task status
      • TaskID
      • error code
      • question answer
      • strategy model
      • gender
      • date_format
    • 中文
      • http code
      • ring type
      • hang up type
      • task status
      • call status
      • plan status
      • Intention
      • WABA message status
      • sender type
      • hang up by
      • transfer status
      • reason code
      • question answer
      • question status
      • whether answer
      • question type
  1. 调用任务相关的API

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

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

请求参数

Header 参数

Body 参数application/json

示例
{
    "task_id": "taskid38a0b923820dcc509a6f75849b",
    "task_name": "taskname20240601",
    "status": "finished",
    "created_at": "2024-06-01 10:11:12",
    "repeat_interval": 1,
    "repeat_number": 2,
    "robot_hash": "00c2a19f37ea4361f490af9237590ac5",
    "robot_method": "single",
    "sip_line": "test_sip_line",
    "schedule_start_time": "2024-06-02 10:11:12",
    "schedule_end_time": "2024-06-02 11:11:12",
    "details": [
        {
            "id": 1,
            "callee": "+6212345678",
            "result": "finished",
            "result_label": "E",
            "duration": 32,
            "hangup_type": "ByCallee",
            "hangup_by": "ByAgent",
            "ring_type": "normal",
            "question_answer": [
                {
                    "question_name": "Q1",
                    "answer": "Yes",
                    "answer_text": "es correcto",
                    "status": "Completed",
                    "answer_text_slot": "-",
                    "var": "-",
                    "verification_results": "-",
                    "question_content": "NameCheck",
                    "question_type": "whether",
                    "whether_answer": "Answered"
                }
            ],
            "EventLabel": {
                "ConclusionReceive": "A1"
            },
            "Multi_intention": "{}",
            "Slots": "slots",
            "NerSlots": {
                "payment_method": "AutoDebet"
            },
            "variables": {
                "receiver_name": "MAI HOA"
            },
            "robot_hash": "00c2a19f37ea4361f490af9237590ac5",
            "call_id": "callid38a0b923820dcc509a6f75849b",
            "call_times": 2,
            "call_start_time": "2024-06-01 10:11:12",
            "call_end_time": "2024-06-01 10:11:12",
            "call_dial_time": "2024-06-01 10:11:12",
            "call_connect_time": "2024-06-01 10:11:12",
            "robot_end_time": "2024-06-01 10:11:12",
            "ring_time": 5,
            "talk_round": 1,
            "redail_call": [
                {
                    "call_id": "callid38a0b923820dcc509a6f75849b",
                    "call_start_time": "2024-06-10 12:13:14",
                    "ring_type": "outofarea",
                    "ring_time": 5,
                    "hangup_type": "ByRobot",
                    "result_label": "F",
                    "callee_number": "+6212345678",
                    "caller_number": "+85111111",
                    "reason_code": "Null"
                }
            ],
            "intention_description": "Unwilling",
            "caller_number": "+85111111",
            "asr_result": [
                {
                    "time": "00:00:00",
                    "robottext": "Hello, i am robot",
                    "text": "hello robot"
                }
            ],
            "human_robot_summary": "xxxxxxxxxxxxxxxxxxxxxxxxx",
            "emotion": "xxxxxxxxxxxx",
            "recording_link": "https://api.airudder.com/b53c405fd1a2*******c6b_3263a688977108becdccf010aacec2b3.mp3",
            "transfer": {
                "TransferStatus": 2,
                "TransferFailureReason": "",
                "TransferTime": "2024-02-02 01:48:51",
                "TransferRingTime": "2024-02-02 01:48:52",
                "TransferSuccessTime": "2024-02-02 01:48:52",
                "TransferReason": "",
                "TransferCallId": "artificial_fd964********be3252519"
            },
            "reason_code": "Null"
        }
    ]
}

请求示例代码

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": "taskid38a0b923820dcc509a6f75849b",
    "task_name": "taskname20240601",
    "status": "finished",
    "created_at": "2024-06-01 10:11:12",
    "repeat_interval": 1,
    "repeat_number": 2,
    "robot_hash": "00c2a19f37ea4361f490af9237590ac5",
    "robot_method": "single",
    "sip_line": "test_sip_line",
    "schedule_start_time": "2024-06-02 10:11:12",
    "schedule_end_time": "2024-06-02 11:11:12",
    "details": [
        {
            "id": 1,
            "callee": "+6212345678",
            "result": "finished",
            "result_label": "E",
            "duration": 32,
            "hangup_type": "ByCallee",
            "hangup_by": "ByAgent",
            "ring_type": "normal",
            "question_answer": [
                {
                    "question_name": "Q1",
                    "answer": "Yes",
                    "answer_text": "es correcto",
                    "status": "Completed",
                    "answer_text_slot": "-",
                    "var": "-",
                    "verification_results": "-",
                    "question_content": "NameCheck",
                    "question_type": "whether",
                    "whether_answer": "Answered"
                }
            ],
            "EventLabel": {
                "ConclusionReceive": "A1"
            },
            "Multi_intention": "{}",
            "Slots": "slots",
            "NerSlots": {
                "payment_method": "AutoDebet"
            },
            "variables": {
                "receiver_name": "MAI HOA"
            },
            "robot_hash": "00c2a19f37ea4361f490af9237590ac5",
            "call_id": "callid38a0b923820dcc509a6f75849b",
            "call_times": 2,
            "call_start_time": "2024-06-01 10:11:12",
            "call_end_time": "2024-06-01 10:11:12",
            "call_dial_time": "2024-06-01 10:11:12",
            "call_connect_time": "2024-06-01 10:11:12",
            "robot_end_time": "2024-06-01 10:11:12",
            "ring_time": 5,
            "talk_round": 1,
            "redail_call": [
                {
                    "call_id": "callid38a0b923820dcc509a6f75849b",
                    "call_start_time": "2024-06-10 12:13:14",
                    "ring_type": "outofarea",
                    "ring_time": 5,
                    "hangup_type": "ByRobot",
                    "result_label": "F",
                    "callee_number": "+6212345678",
                    "caller_number": "+85111111",
                    "reason_code": "Null"
                }
            ],
            "intention_description": "Unwilling",
            "caller_number": "+85111111",
            "asr_result": [
                {
                    "time": "00:00:00",
                    "robottext": "Hello, i am robot",
                    "text": "hello robot"
                }
            ],
            "human_robot_summary": "xxxxxxxxxxxxxxxxxxxxxxxxx",
            "emotion": "xxxxxxxxxxxx",
            "recording_link": "https://api.airudder.com/b53c405fd1a2*******c6b_3263a688977108becdccf010aacec2b3.mp3",
            "transfer": {
                "TransferStatus": 2,
                "TransferFailureReason": "",
                "TransferTime": "2024-02-02 01:48:51",
                "TransferRingTime": "2024-02-02 01:48:52",
                "TransferSuccessTime": "2024-02-02 01:48:52",
                "TransferReason": "",
                "TransferCallId": "artificial_fd964********be3252519"
            },
            "reason_code": "Null"
        }
    ]
}'

返回响应

🟢200success
application/json
Body

示例
{}
修改于 2026-01-20 11:32:24
上一页
任务结束状态通知
下一页
获取任务详细信息
Built with