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
      • 获取策略列表
      • 创建策略计划拨打任务
      • 获取计划状态信息
      • 获取计划内任务轮次信息
      • 列出已创建的任务
      • 停止一个呼叫任务
      • 取消计划中的某个电话的拨打
      • 计划结束状态通知
      • 任务结束状态通知
      • 任务电话维度拨打结束状态通知
      • 获取任务详细信息
      • 获取单个案件通话录音
      • 获取任务录音文件
      • 获取计划内某个电话所有的通话录音
  • 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
      • 创建拨打任务
      • 列出已创建的任务
      • 停止一个任务拨打
      • 取消某个任务电话拨打
      • 任务结束状态通知
      • 任务电话维度拨打结束状态通知
      • 获取任务详细信息
      • 获取单个案件通话录音
      • 获取任务录音文件
      • 获取机器人列表
      • 根据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消息状态变更通知
      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加解密对接-示例
  • 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. Workflow 工作流

验证 自定义API 节点数据推送

POST
https://api.airudder.com/service/cloud/workflow/apinoticeinfo
使用自定义API 数据推送的部分参数查询,验证自定API节点的推送数据是否正确。 也可以用来查询历史数据,最多支持查询三个月前的历史数据。
(仅适用于自定义API 数据推送的验证,不适用于任务电话维度拨打结束状态通知的验证。 )

请求参数

Header 参数
Authorization
string 
必需
默认值:
Token 3Ksb9EkFDQHBhAbvYDTq4+pGGjNRAuLtPF9MMt9E97hX+OgLWTmeZtdGZyjR+YqU
Content-Type
string 
必需
默认值:
application/json
User-Agent
string 
可选
默认值:
Airudder
Body 参数application/json
workflow_id
string 
必需
workflow id,可以从自定义API数据推送的数据中获取 workflow id 。
node_id
string 
必需
workflow API 节点 id,该节点的唯一标识。可以从自定义API数据推送的数据中进行获取 node_id 。
callee
string 
必需
名单号码,可以从自定义API数据推送的 数据中进行获取 名单号码 。
case_id
string 
可选
caseid,可以从从自定义API数据推送的 数据中进行获取 caseid。
示例
{
    "workflow_id": "0ca6e3a59cf74630906683882aa5111",
    "callee": "+8610086",
    "node_id": "1d78b96d74c24737b186da7bcb23a2f8",
    "case_id": "caseid"
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.airudder.com/service/cloud/workflow/apinoticeinfo' \
--header 'Authorization;' \
--header 'User-Agent: Airudder' \
--header 'Content-Type: application/json' \
--data-raw '{
    "workflow_id": "0ca6e3a59cf74630906683882aa5111",
    "callee": "+8610086",
    "node_id": "1d78b96d74c24737b186da7bcb23a2f8",
    "case_id": "caseid"
}'

返回响应

🟢200成功
application/json
Body
data
object 
必需
所有字段均与自定义API 节点数据推送 的字段含义一致。
workflow_id
string 
必需
workflow_name
string 
必需
node_id
string 
必需
node_name
string 
必需
callee
object 
必需
custom_attribute
object 
必需
call
object 
必需
status
string 
必需
code
integer 
必需
示例
{
    "data": {
        "workflow_id": "b761cdd784294xxxxxx869f85c",
        "workflow_name": "test_api_action4",
        "node_id": "6ade9e4443xxxxxx43a54b58",
        "node_name": "API1",
        "callee": {
            "case_id": "123456.0",
            "callee_name": "WILL SMITH",
            "callee_gender": "",
            "callee_number": "+861xxxxxx721",
            "platform_name": "AIRUDDER",
            "extra_a": "",
            "extra_b": "",
            "extra_c": "",
            "extra": [
                {
                    "Content": "+861xxxxxx795,+861xxxxxx721",
                    "Question": "extend_callees"
                }
            ],
            "extend": {
                "variables": {},
                "detail_source": "web",
                "pds_variables": {}
            },
            "comments": "123456.0",
            "borrowed_date": "2024-02-01",
            "due_date": "2024-03-07",
            "borrowed_amount": "20000.00",
            "total_owing_amount": "20310.00",
            "currency_unit": "USD"
        },
        "custom_attribute": {
            "a": "1",
            "b": "2"
        },
        "call": {
            "task_id": "459acf3df0ecxxxxxx9679dc208ad96",
            "call_id": "cd878f6611adxxxxxx1a5a3ec5525b",
            "callee_number": "+8618717905721",
            "robot_id": "4585",
            "call_start_time": "2024-03-12 14:54:26",
            "call_end_time": "2024-03-12 14:54:52",
            "call_times": 4,
            "ring_type": "normal",
            "hangup_type": "ByRobot",
            "intention": "E",
            "slots": "",
            "ner_slots": {
                "item_name": "da",
                "receivetime": "2"
            },
            "redial_call": [
                {
                    "call_id": "ef1a7953b0cxxxxxxab653217cd24",
                    "call_start_time": "2024-03-12 14:51:15",
                    "ring_type": "normal",
                    "ring_time": 0,
                    "hangup_type": "ByCallee",
                    "result_label": "F",
                    "callee_number": "+861xxxxxx795",
                    "caller_number": "+950xxxxxx0088"
                },
                {
                    "call_id": "df831fc0491xxxxxx7f1114605f9de",
                    "call_start_time": "2024-03-12 14:51:24",
                    "ring_type": "normal",
                    "ring_time": 7,
                    "hangup_type": "ByCallee",
                    "result_label": "F",
                    "callee_number": "+8618xxxxxx721",
                    "caller_number": "+950xxxxxx088"
                },
                {
                    "call_id": "f27a2d3c1dxxxxxx693ed0cfe93d77aa",
                    "call_start_time": "2024-03-12 14:52:23",
                    "ring_type": "normal",
                    "ring_time": 0,
                    "hangup_type": "ByCallee",
                    "result_label": "F",
                    "callee_number": "+861xxxxxx1795",
                    "caller_number": "+950xxxxxx088"
                }
            ],
            "talk_round": 0,
            "ring_time": 2,
            "question_answer": [
                {
                    "question_name": "Q1",
                    "answer": "ss02",
                    "answer_text": "s s cero dos",
                    "status": "Completed",
                    "answer_text_slot": "s02;02",
                    "var": "S02",
                    "verification_results": "Match",
                    "question_content": "CURP Verification",
                    "question_type": "open",
                    "whether_answer": "Answered"
                }
            ],
            "multi_label": {
                "A0": "A0",
                "Correct_Person": "identity_correct_person",
                "Request_Installment": "action_item_request_installment"
            },
            "intention_description": "Needs Follow Up",
            "asr_ptp": "",
            "asr_result": [
                {
                    "time": "00:00:00",
                    "robottext": "halo (jeda 1-2 detik) selamat siang",
                    "text": ""
                },
                {
                    "time": "00:00:03",
                    "robottext": "Apa boleh minta waktunya sebentar?",
                    "text": ""
                },
                {
                    "time": "00:00:10",
                    "robottext": "",
                    "text": ""
                },
                {
                    "time": "00:00:10",
                    "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": ""
                }
            ],
            "caller_number": "+95xxxxxx0088"
        }
    },
    "status": "OK",
    "code": 200
}
🟢200异常
上一页
自定义API 节点数据推送
下一页
停止workflow任务
Built with