AIRUDDER 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
        • 创建拨打任务
        • 列出已创建的任务
        • 停止一个任务拨打
        • 取消某个任务电话拨打
        • 任务结束状态通知
        • 任务电话维度拨打结束状态通知
        • 获取任务详细信息
        • 获取单个案件通话录音
        • 获取任务录音文件
        • 获取机器人列表
        • 根据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任务
      • 获取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. 如何使用文档进行调试

    1. 获取令牌

    域名:https://api.airudder.com。
    您需要通过调用 验证并获取令牌 获取令牌并将其添加到其他API的请求标头中。令牌将在24小时后过期,令牌有效期内再次请求接口,会在原令牌有效期基础上重新计算24小时。

    点击调试按钮,进入在线调试状态,选择Production生产环境,填写您在生产环境的 Appkey 和 AppSecret ,点击发送即可获取令牌。

    2. 进行鉴权

    当您获取令牌后,需要进行其他API请求时,需要在header中添加一个Authorization字段,字段值为Token Token值。

    例如,您的令牌是“abcdefghijklmn”,则您的Authorization是Token abcdefghijklmn,不同账号拥有不同的Token,注意Token 和您的令牌内容需要间隔一个空格。

    如果令牌错误或缺失,您将无法向其他API发送请求。 

    3. 使用对应的 api 进行调用

    将您的鉴权Authorization添加到header字段中,填写其他 api 所需要的字段进行调试。

    2. iCall平台名词解释

    任务:呼叫任务是iCall平台对名单进行呼叫的载体,对一批名单进行外呼时,需要创建一个呼叫任务,任务内含需要呼叫的电话等信息。当每次呼叫时仅需要对名单进行单次跟进,且不需要对该次呼叫产生的结果进行自动跟进时,推荐使用任务相关接口。

    计划:呼叫计划是通过呼叫策略进行创建的有序任务合集,可以实现对同一批待呼叫名单进行多次跟进,如需要对当天产生的不同标签的名单进行跟进时,推荐使用计划任务相关接口。其中,使用的策略需在iCAll web端进行创建。

    Workflow :Workflow是将机器人外呼、外呼策略、多种渠道触达等结合在一起的自动化工作流程,在iCall平台中,可以非常灵活的创建任意一种workflow模板用来进行复杂的工作流转。如需要对同一批待呼叫名单进行跟进,如不同标签的名单用不同机器人拨打、跨天拨打、多渠道触达、人机结合等,推荐使用 Workflow 。 其中,使用的workflow模板需在iCALL web端进行创建。

    上一页
    Introductions
    下一页
    Quick Start
    Built with