AIRUDDER API
  1. Chatbot
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任务
    • 获取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账号
      POST
    • 查询模版列表
      POST
    • 查询模版详情
      POST
    • 发送模版消息
      POST
    • 查询模版消息发送结果
      POST
    • 回调模版消息发送结果
      POST
    • 发送单个模版消息接口
      POST
    • 回调单个模版消息用户响应
      POST
    • 回调转人工申请
      POST
    • 回调坐席消息发送之后的状态变更
      POST
    • 回调转人工后用户发送的消息
      POST
    • 回调会话结束事件
      POST
    • 转人工结果
      POST
    • 查询会话列表
      POST
    • 查询消息列表
      POST
    • 将用户消息标记为已读
      POST
    • 发送普通消息
      POST
    • 结束会话
      POST
    • 上传文件
      POST
    • 上传文件(谷歌地图缩略图)
      POST
    • 会话结束后上报
      POST
    • 查询公司所有渠道信息
      POST
    • 用户发送的消息事件上报
      POST
    • 渠道发送的消息事件上报
      POST
    • 渠道发送的消息状态变更事件上报
      POST
    • 获取公司信息
      POST
    • 查询运单号物流轨迹
      POST
  • 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. Chatbot

渠道发送的消息事件上报

开发中
POST
https://api.airudder.com

请求参数

Header 参数
X-AIRudder-Sign
string 
必需
Body 参数application/json
event
enum<string> 
事件名
必需
枚举值:
channel.message.sent
company
string 
公司名
必需
channel
string 
渠道名
必需
channel_id
string 
必需
公司在渠道唯一标识号
user
object 
用户信息
必需
id
string 
必需
用户在渠道的唯一标识
call_id
string 
所属会话id
必需
messages
array [object {4}] 
消息内容
必需
msg_id
string 
消息唯一标识
必需
sender_type
enum<string> 
发送人
必需
枚举值:
chatbotrobotagent
timestamp
integer 
消息发送时间戳
必需
content
object 
消息内容
必需
custom
string 
自定义内容
必需
示例
{
  "event": "channel.message.sent",
  "company": "Chat_test",
  "channel": "WhatsApp",
  "channel_id": "6583753709",
  "user": {
    "id": "62895402190807"
  },
  "call_id": "66b4d7507d5a6618497600326f7b064b",
  "messages": [
    {
      "msg_id": "05b1de120372baaf13c7b23864432e9a",
      "sender_type": "chatbot",
      "timestamp": 1720159500,
      "content": {
        "type": "template",
        "template": {
          "type": "WhatsApp",
          "content": {
            "header": {
              "type": "image",
              "media": {
                "origin_url": "https://www.planetware.com/wpimages/2020/02/france-in-pictures-beautiful-places-to-photograph-eiffel-tower.jpg"
              }
            },
            "body": "Hi, tom, we will hold a party from 2024-03-07, welcome to join us",
            "footer": "welcome",
            "button": [
              {
                "type": "QUICK_REPLY",
                "text": "no"
              },
              {
                "type": "OPT_OUT",
                "text": "yes"
              }
            ]
          },
          "info": {
            "id": 35,
            "name": "opt_out_02_27_english",
            "language": "en"
          }
        }
      }
    },
    {
      "msg_id": "9fd6d067308944449c2ad4e9fb476a1e",
      "sender_type": "robot",
      "timestamp": 1720159548,
      "content": {
        "type": "text",
        "text": "一位来自WhatsApp的朋友 ,欢迎使用 AIRudder 客户服务"
      }
    },
    {
      "msg_id": "9fd6d067308944449c2ad4e9fb476a1e",
      "sender_type": "robot",
      "timestamp": 1720159549,
      "content": {
        "type": "image",
        "media": {
          "origin_url": "https://test-airudder-dmrobot.oss-cn-hongkong.aliyuncs.com/upload%2F20240327%2F79a5ef5ba61b410c9b418d513eb48924_KrKRsV0DWY.jpeg?Expires=1743062224&OSSAccessKeyId=LTAI5tR3sabN9jtvhHDgMoxA&Signature=agKUyWeiSkwQd0ussZ5bUJuKmDM%3D"
        }
      }
    },
    {
      "msg_id": "9fd6d067308944449c2ad4e9fb476a1e",
      "sender_type": "robot",
      "timestamp": 1720159549,
      "content": {
        "type": "file",
        "media": {
          "origin_url": "https://test-airudder-dmrobot.oss-cn-hongkong.aliyuncs.com/upload%2F20240327%2F0ca8b6c9e76f49f081e709a5b821e87c_welcome_to_Earth.pdf?Expires=1743064081&OSSAccessKeyId=LTAI5tR3sabN9jtvhHDgMoxA&Signature=yHRWceK6eJOhwcUKA%2BPuGtYfrAg%3D",
          "name": "welcome_to_Earth.pdf"
        }
      }
    },
    {
      "msg_id": "e39f5aaba04e4d54b7a2852e17383206",
      "sender_type": "robot",
      "timestamp": 1720160208,
      "content": {
        "type": "interactive",
        "interactive": {
          "type": "button",
          "body": {
            "text": "请选择您的性别(button)👉👉👉"
          },
          "footer": {
            "text": ""
          },
          "action": {
            "buttons": [
              {
                "type": "reply",
                "reply": {
                  "id": "9ceb8dbe7773ea3e951f5dd38d965b44-2-1-button-0-",
                  "title": "男"
                }
              },
              {
                "type": "reply",
                "reply": {
                  "id": "9ceb8dbe7773ea3e951f5dd38d965b44-2-1-button-1-",
                  "title": "女"
                }
              },
              {
                "type": "reply",
                "reply": {
                  "id": "9ceb8dbe7773ea3e951f5dd38d965b44-2-1-button-2-",
                  "title": "其他"
                }
              }
            ]
          }
        }
      }
    },
    {
      "msg_id": "ecc6f3501c1c4ddf8289b94bccf0f603",
      "sender_type": "robot",
      "timestamp": 1720159575,
      "content": {
        "type": "interactive",
        "interactive": {
          "type": "list",
          "body": {
            "text": "请选择你要咨询的业务类(本次通过list展示)"
          },
          "footer": {
            "text": ""
          },
          "action": {
            "button": "请选择",
            "sections": [
              {
                "title": "查询类",
                "rows": [
                  {
                    "id": "8893ba3fdfb6995dcdc587b07915c6eb-3-1-list-0-0-",
                    "title": "物流查询",
                    "description": ""
                  },
                  {
                    "id": "8893ba3fdfb6995dcdc587b07915c6eb-3-1-list-0-1-",
                    "title": "网点查询",
                    "description": ""
                  }
                ]
              },
              {
                "title": "寄件类",
                "rows": [
                  {
                    "id": "8893ba3fdfb6995dcdc587b07915c6eb-3-1-list-1-0-",
                    "title": "大件快递",
                    "description": ""
                  },
                  {
                    "id": "8893ba3fdfb6995dcdc587b07915c6eb-3-1-list-1-1-",
                    "title": "小件快递",
                    "description": ""
                  }
                ]
              }
            ]
          }
        }
      }
    },
    {
      "msg_id": "30754f2269a440e3b7206c88971f86eb",
      "sender_type": "agent",
      "timestamp": 1720160324,
      "content": {
        "type": "text",
        "text": "hi"
      }
    }
  ]
}

示例代码

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' \
--header 'X-AIRudder-Sign;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "event": "channel.message.sent",
  "company": "Chat_test",
  "channel": "WhatsApp",
  "channel_id": "6583753709",
  "user": {
    "id": "62895402190807"
  },
  "call_id": "66b4d7507d5a6618497600326f7b064b",
  "messages": [
    {
      "msg_id": "05b1de120372baaf13c7b23864432e9a",
      "sender_type": "chatbot",
      "timestamp": 1720159500,
      "content": {
        "type": "template",
        "template": {
          "type": "WhatsApp",
          "content": {
            "header": {
              "type": "image",
              "media": {
                "origin_url": "https://www.planetware.com/wpimages/2020/02/france-in-pictures-beautiful-places-to-photograph-eiffel-tower.jpg"
              }
            },
            "body": "Hi, tom, we will hold a party from 2024-03-07, welcome to join us",
            "footer": "welcome",
            "button": [
              {
                "type": "QUICK_REPLY",
                "text": "no"
              },
              {
                "type": "OPT_OUT",
                "text": "yes"
              }
            ]
          },
          "info": {
            "id": 35,
            "name": "opt_out_02_27_english",
            "language": "en"
          }
        }
      }
    },
    {
      "msg_id": "9fd6d067308944449c2ad4e9fb476a1e",
      "sender_type": "robot",
      "timestamp": 1720159548,
      "content": {
        "type": "text",
        "text": "一位来自WhatsApp的朋友 ,欢迎使用 AIRudder 客户服务"
      }
    },
    {
      "msg_id": "9fd6d067308944449c2ad4e9fb476a1e",
      "sender_type": "robot",
      "timestamp": 1720159549,
      "content": {
        "type": "image",
        "media": {
          "origin_url": "https://test-airudder-dmrobot.oss-cn-hongkong.aliyuncs.com/upload%2F20240327%2F79a5ef5ba61b410c9b418d513eb48924_KrKRsV0DWY.jpeg?Expires=1743062224&OSSAccessKeyId=LTAI5tR3sabN9jtvhHDgMoxA&Signature=agKUyWeiSkwQd0ussZ5bUJuKmDM%3D"
        }
      }
    },
    {
      "msg_id": "9fd6d067308944449c2ad4e9fb476a1e",
      "sender_type": "robot",
      "timestamp": 1720159549,
      "content": {
        "type": "file",
        "media": {
          "origin_url": "https://test-airudder-dmrobot.oss-cn-hongkong.aliyuncs.com/upload%2F20240327%2F0ca8b6c9e76f49f081e709a5b821e87c_welcome_to_Earth.pdf?Expires=1743064081&OSSAccessKeyId=LTAI5tR3sabN9jtvhHDgMoxA&Signature=yHRWceK6eJOhwcUKA%2BPuGtYfrAg%3D",
          "name": "welcome_to_Earth.pdf"
        }
      }
    },
    {
      "msg_id": "e39f5aaba04e4d54b7a2852e17383206",
      "sender_type": "robot",
      "timestamp": 1720160208,
      "content": {
        "type": "interactive",
        "interactive": {
          "type": "button",
          "body": {
            "text": "请选择您的性别(button)👉👉👉"
          },
          "footer": {
            "text": ""
          },
          "action": {
            "buttons": [
              {
                "type": "reply",
                "reply": {
                  "id": "9ceb8dbe7773ea3e951f5dd38d965b44-2-1-button-0-",
                  "title": "男"
                }
              },
              {
                "type": "reply",
                "reply": {
                  "id": "9ceb8dbe7773ea3e951f5dd38d965b44-2-1-button-1-",
                  "title": "女"
                }
              },
              {
                "type": "reply",
                "reply": {
                  "id": "9ceb8dbe7773ea3e951f5dd38d965b44-2-1-button-2-",
                  "title": "其他"
                }
              }
            ]
          }
        }
      }
    },
    {
      "msg_id": "ecc6f3501c1c4ddf8289b94bccf0f603",
      "sender_type": "robot",
      "timestamp": 1720159575,
      "content": {
        "type": "interactive",
        "interactive": {
          "type": "list",
          "body": {
            "text": "请选择你要咨询的业务类(本次通过list展示)"
          },
          "footer": {
            "text": ""
          },
          "action": {
            "button": "请选择",
            "sections": [
              {
                "title": "查询类",
                "rows": [
                  {
                    "id": "8893ba3fdfb6995dcdc587b07915c6eb-3-1-list-0-0-",
                    "title": "物流查询",
                    "description": ""
                  },
                  {
                    "id": "8893ba3fdfb6995dcdc587b07915c6eb-3-1-list-0-1-",
                    "title": "网点查询",
                    "description": ""
                  }
                ]
              },
              {
                "title": "寄件类",
                "rows": [
                  {
                    "id": "8893ba3fdfb6995dcdc587b07915c6eb-3-1-list-1-0-",
                    "title": "大件快递",
                    "description": ""
                  },
                  {
                    "id": "8893ba3fdfb6995dcdc587b07915c6eb-3-1-list-1-1-",
                    "title": "小件快递",
                    "description": ""
                  }
                ]
              }
            ]
          }
        }
      }
    },
    {
      "msg_id": "30754f2269a440e3b7206c88971f86eb",
      "sender_type": "agent",
      "timestamp": 1720160324,
      "content": {
        "type": "text",
        "text": "hi"
      }
    }
  ]
}'

返回响应

🟢200成功
application/json
Body
object {0}
示例
{}
上一页
用户发送的消息事件上报
下一页
渠道发送的消息状态变更事件上报
Built with