- 最新动态
- 产品介绍
- 快速入门
-
用户指南
- 云控制台操作指南
-
租户管理员指南
- 认识您的租间
- 配置员工中心
- 启用人工服务
- 配置移动客服
- 配置多媒体渠道
-
机器人管理配置指南
- 快速入门
-
配置智能机器人
- 概述
- 配置一个预约挂号机器人(任务型对话机器人)
- 添加问答型对话机器人
- 其他操作
-
相关参考
- 图元
- 参数
-
TUC接口
- /chatbot/rest/tuc/v1/nlp/detectRegularEntity
- /chatbot/rest/tuc/v1/nlp/identify
- /chatbot/rest/tuc/v1/recommendFaq
- /chatbot/rest/tuc/v1/qualityInspection/qiOnline/recognize
- /chatbot/rest/tuc/v1/nlp/feedback
- /chatbot/rest/tuc/v1/nlp/textClassify
- /chatbot/rest/tuc/v1/nlp/detectEntity
- /chatbot/rest/tuc/v1/qualityInspection
- 内置函数
- 常见问题
- 操作员:配置普通IVR
- 配置预置流程
- IVR Journey分析
- 外呼风险监控
- 管理工单配置
- 质检管理
- 管理通知中心
- 管理客户中心
- 配置智能外呼
- 管理问卷
- 管理智能实训
- 配置知识库
- 配置公共资源
- 业务故障放通管理
- 护航浏览
- 社交媒体运营
- 绩效管理
- 客服座席指南
- 质检员指南
- 价格说明
-
开发指南
- 开发概述
- 用户接入——VOIP音视频接入
- 用户接入——网页版客户端集成 (RESTful)
- 用户接入——网页版轻量级客户端集成 (JS)
- 座席集成——座席轻量级接续块集成(JS)
- 座席集成——座席呼叫处理 (RESTful)
-
座席集成——Openeye H5 软电话接口集成
- 修订记录
- OpenEye H5软电话接口概述
- OpenEye软电话安装指导
- 座席侧集成H5软电话开发指导
- 音频呼叫接口
-
音视频呼叫接口扩展
- 音视频呼叫
-
设备管理
- getMediaDevices(获取设备列表)
- setMicIndex(设置麦克风)
- mediaGetMicIndex(查询当前使用的麦克风)
- setSpeakIndex (设置扬声器)
- mediaGetSpeakIndex (查询当前使用的扬声器)
- setMicVol(设置麦克风音量)
- getMicVol(查询麦克风当前音量)
- setSpkVol(设置扬声器音量)
- getSpkVol(查询扬声器当前音量)
- setVideoWindowParam(设置视频窗口位置和宽高)
- setVideoLayoutMode(设置视频窗口画面排列模式)
- setVideoDisplayMode(设置视频窗口画面裁剪模式)
- openCamera(打开摄像头)
- closeCamera(关闭摄像头)
- 屏幕共享
- 截屏
- 录屏
- 错误码列表
- 运营管理——座席工作台集成第三方Web页面
-
API参考
- 接口概述
- 相关术语
- 修改记录
- 接口鉴权方式
-
呼叫中心配置类
-
座席管理
- 单个创建座席业务账号(agentAccount/create)
- 单个删除指定座席业务账号(agentAccount/delete)
- 单个修改座席业务账号信息(agentAccount/update)
- 查询座席业务账号信息(agentAccount/query)
- 绑定座席和技能队列(addSkillsToAgent)
- 解绑座席某技能队列(releaseAgentBySkillId)
- 通过技能队列ID查询座席信息(queryAgentInfoBySkillId)
- 修改座席软电话号码登录密码(updateSipPhonePassword)
- 查询所有座席的软电话信息 (不包含业务账号) (querySysInfo)
- 查询所有座席的软电话信息 (包含业务账号) (queryAgentInfo)
- 查询账号登录结果 (queryAgentLoginParams)
- 根据登录账号查询座席信息 (queryAgentInfoByAccount)
- 按客户号码清理数据 (cleancustpersonaldata)
- 技能队列管理
- 号码管理
- IVR流程管理
-
座席管理
-
座席工作台
- 座席控制
-
座席双呼
- 创建双呼呼叫 (V1.0.0) (createCall)
- 创建双呼呼叫 (V3.0.0) (createCall)
- 查询呼叫历史记录 (queryCallDetailRecord)
- 查询呼叫状态 (queryCallState)
- 获取录音文件地址 (getRecordingAddress)
- 查询分配的软电话号码 (V1.0.0) (queryPhone)
- 查询分配的软电话号码 (V2.0.0) (queryPhone)
- 获取呼叫目的设备信息 (getCalledInfo)
- 创建语音外呼(V1.0.0)(createVoiceNotification)
- 创建语音外呼(V2.0.0)(createVoiceNotification)
- 查询当前会话客户的最近历史接触记录(queryUserContactLimit)
- 查询通话信息(queryCallInfoByCallId)
- ITA双呼结果通知(statusnotify)
- 回调接口
- 订阅语音识别结果接口
- App个人设置
- 附录
- 电销外呼
- 调查问卷
- 知识库管理
- 机器人管理
-
网页客户端接入
- 接口调用流程
- 第三方请求鉴权 (applyToken)
- 查询排队信息 (queryQueueInfo)
- 主动轮询座席侧发送的信息 (poll)
- 保存客户提交的满意度评价结果 (saveSatisfaction)
- 发送消息 (send)
- 客户发送文件 (uploadFileStream)
- 客户接收文件 (downloadFileStream)
- 根据客户输入联想常用语 (queryPhraseByKeyword)
- 检查当前租间是否支持点击通话 (checkClickToCallSupport)
- 创建点击通话 (createClickToCall)
- 获取点击通话事件 (getClickToCallEvents)
- 释放点击通话 (dropClickToCall)
- 创建匿名通话 (createcall)
- 客户提交留言 (doLeaveMessage)
- 提交客户对机器人满意度评价结果 (feedbacksatisfaction)
- 查询历史消息 (queryHistoryChatMessage)
- 丢弃邮件(chat_dropMail)
- 提供whatsapp发送下行消息(sendWhatsappMessage)
- 查询在线交谈工作台当前交谈的消息(getUserInfoBycallId)
- 查询满意度调查配置(getSatisfactionSurveyMode)
-
质检/监控/统计类
- 实时质检:qualitycontrol
-
智能质检
- 质检评分接口 (scoresetting)
- 句子管理接口 (sentencemanagement)
- 敏感词管理接口 (sensitiveWordManage)
- 话术接口 (conversationspecific)
- 句子、敏感词训练接口 (SemanticKeywordTraining)
- 对话逻辑接口 (conversationflow)
- 对话规则接口 (conversationrules)
- 抢插话规则接口 (interposalrules)
- 静默规则接口 (silencerule)
- 语速规则接口 (speedrule)
- 质检场景管理接口 (scenariomanage)
- 通话质检接口 (qualitycheckmanage)
- 人工抽检任务接口 (regularQualityTask)
- 质检任务接口 (qualitytask)
- 质检任务详情接口 (qualitytaskdetail)
- 质检申诉接口 (qualityitem)
- 第三方录音质检接口 (asrtrans)
-
监控/统计
-
实时数据查询类接口
-
VDN维度实时接口
- 查询指定VDN下的系统接入码信息
- 查询指定VDN下的座席休息情况
- 查询指定VDN下的座席电话号码
- 查询指定VDN下的所有座席信息
- 查询指定VDN下的所有座席的当前状态信息
- 查询指定VDN下的所有座席的静态配置信息
- 查询指定VDN下的IVR详细状态信息
- 查询指定VDN下的IVR流程接入码信息
- 查询指定VDN下的各技能队列相关信息
- 查询指定VDN所有休息原因码
- 查询指定接入码编号的呼叫信息
- 查询指定VDN下的呼叫信息
- 查询指定VDN下的呼叫信息(v2)
- 查询指定VDN下的通话轨迹数据
- 查询指定VDN下的所有座席的静态配置信息(CTI3.6版本不支持)
- 查询指定VDN下的所有座席信息(CTI3.6版本不支持)
- 获取VDN实时监控指标
- 技能队列维度实时接口
- 座席维度实时接口
- 呼叫明细维度实时接口
-
VDN维度实时接口
- 历史数据查询类接口
- 配置数据查询类接口
- 质检关系维护接口
- 外呼任务列表查询接口
- 系统指标查询接口
- 健康检查接口
- 附录
-
实时数据查询类接口
- 录音/话单类
- 语音通知
- OMA接口参考
- Case2.0接口参考
- DataProcess接口参考
- 其他类接口参考
- 常见问题
- 文档下载
- 通用参考
链接复制成功!
提供whatsapp发送下行消息(sendWhatsappMessage)
场景描述
提供whatsapp发送下行消息接口。
接口方法
POST
接口URI
https://域名/apiaccess/rest/ccmessaging/omni/1/advanced,例如域名是service.besclouds.com
请求说明
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
---|---|---|---|---|
1 |
Authorization |
string |
True |
鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) |
2 |
x-app-key |
string |
True |
appKey字段,用户标识,在ApiFabric工具上配置 |
3 |
Content-Type |
string |
True |
内容类型 |
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
---|---|---|---|---|
1.1 |
scenarioKey |
string |
False |
唯一标识发送消息时将使用的方案的方案密钥。如果未设置此字段,将使用默认方案。 AICC不会发送此字段。 |
1.2 |
bulkId |
string |
True |
唯一标识请求的ID。只有当您将消息发送到多个目标地址时,才会收到批量ID。 |
1.3 |
destinations |
array[object] |
True |
消息收件人列表。 |
1.3.1 |
messageId |
string |
True |
唯一标识已发送消息的ID |
1.3.2 |
to |
object |
True |
消息目的地地址 |
1.3.2.1 |
phoneNumber |
string |
True |
目标电话号码。电话号码必须是国际格式(例如:41793026727) |
1.4 |
|
True |
封装的whatsapp对象 |
|
1.5 |
sendAt |
string |
False |
要发送消息的日期和时间。用于计划的OMNI消息传递(OMNI流中的第一条消息不会立即发送,但会在计划的时间发送)。 |
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
---|---|---|---|---|
1.1 |
text |
string |
False |
将发送的消息的文本。 |
1.2 |
imageUrl |
string |
False |
WhatsApp消息中发送的图像的URL。最多2048个字符。支持的图像类型:jpg、jpeg、png。最大图像大小为2MB。 |
1.3 |
audioUrl |
string |
False |
WhatsApp消息中发送的音频文件的URL。最多2048个字符。支持的音频类型有AAC。最大音频大小为2MB。 |
1.4 |
videoUrl |
string |
False |
WhatsApp消息中发送的视频的URL。最多2048个字符。支持的视频类型为MP4。最大视频大小为10MB。 |
1.5 |
locationName |
string |
False |
最大长度为1000。 将发送的消息的文本。 |
1.6 |
address |
string |
False |
最大长度为1000。 地址位置,可选值。 |
1.7 |
longitude |
number |
False |
坐标的经度。该值必须介于-180和180之间。 |
1.8 |
latitude |
number |
False |
坐标的纬度。该值必须介于-90和90之间。 |
1.9 |
templateName |
string |
False |
模板名称 |
1.10 |
templateData |
array[string] |
False |
按模板中注册的顺序排序的模板参数值 |
1.11 |
language |
string |
False |
要使用的语言或区域设置的代码。需要与注册模板时使用的代码完全相同。 |
1.12 |
mediaTemplateData |
mediaTemplateData |
False |
mediaTemplateData封装对象 |
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
---|---|---|---|---|
1.1 |
header |
False |
媒体模板标题。对于包含标题的媒体模板是必需的。 |
|
1.2 |
body |
False |
媒体模板体 |
|
1.3 |
buttons |
array[object] |
False |
媒体模板按钮 |
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
---|---|---|---|---|
1.1 |
textPlaceholder |
string |
False |
文本占位符。对于包含文本标题的模板是必需的。 |
1.2 |
imageUrl |
string |
False |
图像URL。对于包含图像标题的模板是必需的。支持的图像类型:jpg、jpeg、png。最大图像大小为2MB。 |
1.3 |
videoUrl |
string |
False |
视频URL。对于包含视频标题的模板是必需的。支持的视频类型为MP4。最大视频大小为10MB。 |
1.4 |
latitude |
number |
False |
位置纬度。该值必须介于-90和90之间。对于包含位置标题的模板是必需的。 |
1.5 |
longitude |
number |
False |
位置经度。该值必须介于-180和180之间。对于包含位置标题的模板是必需的。 |
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
---|---|---|---|---|
1.1 |
placeholders |
array[string] |
False |
媒体模板正文占位符。该值不能为空,但可以是空数组。数组中的值不能为Null或空 |
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
---|---|---|---|---|
1.1 |
urlPlaceholder |
string |
False |
要发送消息的日期和时间。用于计划的OMNI消息传递(OMNI流中的第一条消息不会立即发送,但会在计划的时间发送)。 |
1.2 |
quickReplyPayload |
string |
False |
快速回复有效载荷。快速回复按钮需要 |
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
---|---|---|---|---|
1.1 |
messageId |
string |
True |
唯一标识已发送消息的ID |
1.2 |
to |
True |
消息目的地地址 |
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
---|---|---|---|---|
1.1 |
to |
False |
消息目的地地址 |
|
1.2 |
status |
False |
指示消息是否已成功发送、未发送、已传递、未传递、正在等待传递或任何其他可能的状态。 |
|
1.3 |
messageId |
string |
False |
唯一标识已发送消息的ID |
响应说明
- 响应状态码: 200
表12 响应体参数 序号
名称
参数类型
说明
1.1
messages
array[object]
已发送消息对象数组,每条消息一个对象
1.1.1
to
object
消息目的地地址
1.1.1.1
phoneNumber
string
目标电话号码。电话号码必须是国际格式(例如:41793026727)
1.1.2
status
object
status对象
1.1.2.1
groupId
number
状态组id
1.1.2.2
groupName
string
状态组名称
1.1.2.3
id
number
状态id
1.1.2.4
name
string
状态名称
1.1.2.5
description
string
状态的可读描述。
1.1.2.6
action
string
应采取的消除错误的操作。
1.1.3
messageId
string
唯一标识已发送消息的ID
1.2
bulkId
string
唯一标识请求的ID。
- 响应状态码: 400
错误的请求:请检查请求路径及参数。
- 响应状态码: 401
未授权:1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。
- 响应状态码: 404
请求的内容未找到:请检查请求的路径。
- 响应状态码: 500
错误的请求:请依次确认您请求中各参数的取值。
错误码
无。
报文样例
- 场景描述:WhatsAPP发送模板消息支持oAuth认证
URL:https://域名/apiaccess/rest/ccmessaging/omni/1/advanced
请求头:
{"x-app-key":"268e19b9-aae6-488a-bec6-5c9a67692946", "Authorization":"Bearer 2febd549********************b9daff1", "Content-Type":"application/json" }
请求参数:
{ "bulkId": "2853BC8B21D23F473AB9AE41B75F34FC18D322B91B01F60FAF206ACEBA9EF7BD", "whatsApp": { "templateName": "1", "templateData": [], "language": "zh_CN" }, "destinations": [ { "messageId": "46dbab11-f9cc-4d32-852b-cbba988b7d08", "to": { "phoneNumber": "155****8467" } } ] }
响应参数:
{ "messages": [ { "messageId": "10011", "to": { "phoneNumber": "173****6067" }, "status": { "groupName": "send-test", "groupId": 113, "name": "sendMessage", "description": "description", "id": 1 } } ], "bulkId": "20221025" }