- API 文档介绍
- Introductions
- 快速上手
- Quick Start
- 鉴权方法
- Get the Authorization token
- 全局错误代码
- Error Codes
- 催收
- Collection
- Quick Start
- APIs Related to Calling Tasks
- 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
- 营销&电商
- Telemarketing & E-commerce
- Quick Start
- APIs Related to Calling Tasks
- 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
- 信审
- Info Check
- Quick Start
- APIs Related to Calling Tasks
- 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 工作流
- 预测式外呼信息回调
- 创建一个新的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
- 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.
- 传输过程中加解密
- Encryption and decryption during the transmission process
- Chatbot
- 接入准备
- 错误码
- HSB关于custom字段使用说明
- 华为
- bot
- Omnichannel
- Mandiri
- 查询可用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
- 重开会话POST
- 回调模版消息状态及计费POST
- 回调渠道消息发送后状态变更POST
- 用户信息上报POST
- Chatbot English
- Quick Start
- Error Code
- bot
- 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
- Upload User Info
- 呼入机器人业务
- Inbound
- Inbound Business Integration Guide
- Token Authentication and Obtain
- Obtain Call Information and Recording Link by Callid
- Notification after Successful Transfer to an Agent v2
- Notification after the Call Ends v2
- Query Statistical Data
- Notification after Successful Transfer to an Agent
- Notification after the Call Ends
- 数据模型
HSB关于custom字段使用说明
背景#
Utility类型的模版，引导用户进行第一次回复，从而降低用户举报屏蔽的操作的概率操作方案#
1.
Utility类型的模版，在发送模版的参数custom中加入部分特别字段2.
HSBcustom使用说明#
custom字段必须是可解析为json的字符串
custom中添加reply_url字段，该字段内容为期望用户点击后的回调地址，如下：{
...
"custom": "{\"reply_url\": \"https://example.com\"}"
}回调说明#
custom字段中的 reply_url 地址进行回调，回调内容如下{
"event": "template.reply",
"channel_id": "6285211416775",
"content": "join",
"task_id": "cd9648d2daacce55cb97d69262e7dd23",
"user_id": "8613162890661"
}通过回调请求 header头中的X-AIRudder-Sign签名字段值判定是否是否有效请求
修改于 2024-01-30 10:19:10