文档首页/ 云客服/ API参考/ 语音通知/ 创建语音通知（V1.0.0）（createVoiceNotification）
更新时间：2023-09-27 GMT+08:00
查看PDF
分享

创建语音通知（V1.0.0）（createVoiceNotification）

场景描述

使用语音通知功能时，调用此API，将请求语音通话平台给指定用户播放语音通知。

接口方法

POST

接口URI

https://域名/apiaccess/rest/voiceNotification/v1/createVoiceNotification，例如域名是service.besclouds.com

请求说明

表1 请求头参数

序号

名称

参数类型

是否必选

说明

1

X-APP-Key

string

True

appKey字段，用户标识，请联系运营人员获取appKey

2

Authorization

string

True

鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格）。

生成方式参见C1 系统配置类接口鉴权方式。
表2 请求体参数

序号

名称

参数类型

是否必选

说明

1

reqBody

object

True

-

1.1

voiceContent

string

True

总长度限制1000字符。

  • 支持传录音id，录音id以"~"分隔，录音id可以通过/rest/voiceNotification/v1/queryVoiceNotificationRecording接口查询。若您是通过客户服务云界面上传的语音文件，录音id即为IVR语音界面的“语音标识”。
  • 支持传纯文本，格式为：$文本$，以"~"相连，例如："$李先生$~$王先生$"。
  • 支持传录音id与文本混合，格式为：录音id~$文本$~录音id，例如："1133*********999~$李先生$~2225*********149"。

1.2

callerPresent

string

False

用户侧主叫显示号码，用户看到的主叫号码，不携带的情况下默认采用租间的接入码，携带的情况下该号码必须传接入码。如果需要传非接入码号码，请联系运维人员开通主叫透显特性，该特性开通后号码校验规则为：接入码或者11-14位的数字。

1.3

called

string

True

被叫号码

1.4

callBackUrl

string

False

此参数请采用BASE64编码以UTF_8标准字符集进行加密。

此字段用于设置客户接收状态上报的URL。

AICC将业务触发过程中通话的状态信息推送至此服务器，客户服务器根据通话状态信息确定用户状态。

URL可填写为https://IP:Port或域名，推荐使用域名，支持http和https。该域名可以对应多个服务器，避免单点故障无法接收通知。

http有安全风险，不推荐使用。

URL只能由大小写字母（a-z、A-Z），数字（0-9）， - : . / _ # ? &组成，不支持其它字符。

URL的域名或IP端口已通过系统管理员加入手机客服回调的地址白名单中。

1.5

priority

string

False

播放语音通知优先级参数。

取值范围1-9整数，默认值为9。

数字越小优先级越高。

涉及文本放音时，使用系统管理员登录客户服务云，在“配置中心 > 流程配置 > 智能IVR > 系统管理 > TTS/ASR管理”页面指定TTS厂家，配置后一分钟生效。

响应说明

  • 响应状态码: 200
    表3 响应体参数

    序号

    名称

    参数类型

    是否必选

    说明

    1

    schema

    object

    True

    -

    1.1

    retCode

    string

    True

    返回码，0 成功

    1 有未完成的任务，请稍后重试

    2 callData长度超出1024

    3 创建失败，未生成呼叫流水号

    4 softPhone格式与规则不匹配

    5 caller或者called未传递，或者格式与规则不匹配

    6 vdn未启用

    7 callerPresent或者agentPresent校验失败

    8 voiceContent为空或者超出限制或者不存在该录音数据

    9 callBackUrl不符合条件

    16 租户为试商用状态，被叫号码不在白名单中

    36 priority字段值格式不符合要求

    1.2

    retMsg

    string

    False

    返回描述

    1.3

    result

    object

    False

    retCode为0时，必返回

    1.3.1

    callSerialNo

    string

    True

    呼叫流水号
  • 响应状态码: 400

    错误的请求：请检查请求路径及参数

  • 响应状态码: 401

    未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态

  • 响应状态码: 403

    鉴权失败

  • 响应状态码: 404

    请求的内容未找到：请检查请求的路径

  • 响应状态码: 500

    业务失败：请依次确认您请求中各参数的取值

错误码

无。

报文样例

请求头:

{
"Content-Type": application/json
"x-app-key": *****
"Authorization": Bearer ****
}

请求参数:

{
    "voiceContent": "1133*********999~$李先生$~2225*********149",
    "callerPresent": null,
    "called": "88880000"
}

响应参数:

{
    "result": {
        "callSerialNo": "11827********7090"
    },
    "retCode": "0",
    "retMsg": "Created successfully."
}

父主题： 语音通知