文档

SendCcoSmartCall - 发起智能外呼

更新时间:

调用SendCcoSmartCall接口发起智能语音交互通话。

接口说明

说明 以下字符不可以在智能语音交互 SendCcoSmartCall 回调中出现:@ = : "" $ { } ^ * ¥

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
ProdCodestring

产品名称。默认取值:aiccs

aiccs
CalledShowNumberstring

被叫显号,必须是已购买的号码。

您可以登录联络中心控制台,查看已购买的号码。

0571****0000
CalledNumberstring

被叫号码。仅支持中国内地号码。

137****0000
VoiceCodestring

智能外呼放音文件,支持网络文件和 TTS 方式。其中,支持使用多个文件和 TTS 参数混播,之间用英文逗号(,)分隔。TTS 参数的替换值在 VoiceCodeParam 中指定。

  • 放音文件为网络文件时:参数 VoiceCode 指定为可被公网访问的语音文件 URL,建议您使用采样频率为 8000Hz 或 16000Hz 且为 wav 格式的语音文件。
  • 放音文件为 TTS 时:参数 VoiceCode 指定为变量名称如$name$,需要在 VoiceCodeParam 中设置变量对应的内容。
2d4c-4e78-8d2a-afbb06cf****.wav,$name$
OutIdstring

预留给调用方使用的 ID,最终会通过在回执消息中将此 ID 带回给调用方。 字符串类型,长度为 1~15 个字节。

222356****
PlayTimesinteger

参数暂不支持使用。

1
Volumeinteger

播放用户音频的音量,取值范围为**-4~4**,建议设置为 1

1
Speedinteger

参数暂不支持使用。

1
AsrModelIdstring

ASR 模型 ID。请在 ASR 模型管理页面查看 ASR 模型 ID。

bf71664d30d2478fb8cb8c39c6b6****
AsrBaseIdstring

SR 基础模型。

  • customer_service_8k:普通话。
  • dialect_customer_service_8k:重口音。
说明
  • 调用接口 SendCcoSmartCall 时,需要指定使用的 ASR 模型,建议参数 asrModelIdAsrBaseId 二者选填一个。
    • 如果仅设置 asrModelId,表示使用指定的 ASR 模型。
    • 如果仅设置 AsrBaseId,表示使用指定的 ASR 基础模型。
    • 如果二者均未设置,则使用默认的 ASR 基础模型,即参数 AsrBaseId 默认为customer_service_8k,表示使用 ASR 普通话基础模型。
    • 如果二者同时设置,请确认二者是正确对应的。
    customer_service_8k
    AsrAlsAmIdstring

    声学模型 ID。

    123456
    AsrVocabularyIdstring

    热词 ID。请在 ASR 热词管理页面查看 ASR 热词 ID。

    123456
    RecordFlagboolean

    通话过程中是否录音。

    • true:是。
    • false:否。
    true
    PauseTimeinteger

    停顿时长。用于设置用户停顿多久表示一句话结束。单位为毫秒。取值范围为300~1200,如果指定值不在参数范围中,则默认 PauseTime 为 800

    说明 首次设置有效,后续设置无效。
    800
    MuteTimeinteger

    静音时长,用于设置用户多久不说话通话结束。单位为:毫秒,取值范围为1000~20000

    • 如果指定值不在参数范围中,则默认 MuteTime 为 10000
    • 通话过程中可动态设置,以最后一次设置为准。
    10000
    ActionCodeBreakboolean

    开场放音文件是否可打断。默认为 true,即开场放音文件可打断。

    true
    DynamicIdstring

    预留给调用方使用的动态扩展 ID,在回调地址中带回,用于客户的开发标识。

    123456
    EarlyMediaAsrboolean

    早媒体语音识别标识。设为 true 会记录通话未接听的原因。默认为 fasle,即关闭状态。

    说明 如果需要启用早媒体语音识别标识,请手动设为 true
    fasle
    VoiceCodeParamstring

    TTS 参数传递字符串,格式为 JSON。必须与 VoiceCode 的 TTS 参数对应。

    “{\”name\”:\”喂,你好\”}”
    SessionTimeoutinteger

    最大通话时长,单位为秒,超时后自动挂断。

    120
    ActionCodeTimeBreakinteger

    基于用户持续说话时长打断,在 ActionCodeBreak 为 true 时生效。单位为毫秒。

    120
    TtsConfboolean

    是否设置 TTS 声音参数。

    • 指定为 true:需要通过 TtsStyle、TtsColume、TtsSpeed 三个参数来设置声音风格。
    • 定为 false:不需要设置相关参数,即便设置了也不生效。
    true
    TtsStylestring

    TTS 变量播放时的声音风格,默认为 xiaoyun,具体风格请参见声音风格列表。

    xiaoyun
    TtsVolumeinteger

    TTS 变量播放的音量,取值范围为0~100,默认为 0

    10
    TtsSpeedinteger

    TTS 变量播放时的声音速度,取值范围为**-200~200**,默认为 0

    100
    BackgroundFileCodestring

    用户和机器人对话时播放的背景语音文件 ID。您可以登录智能联络中心控制台,选择智能交互 > 语音文件管理,单击详情,查看对应的语音 ID。

    2d4c-4e78-8d2a-afbb06cf****.wav
    BackgroundVolumeinteger

    参数暂不支持使用。

    1
    BackgroundSpeedinteger

    参数暂不支持使用。

    1
    EnableITNboolean

    是否在后处理中执行 ITN。

    说明 设置为 true 时,中文数字将转为阿拉伯数字输出,默认为 false
    true

    声音风格列表

    • 小云标准女声:xiaoyun
    • 小刚标准男声:xiaogang
    • 若兮温柔女声:ruoxi
    • 小梦标准女声:xiaomeng
    • 小威标准男声:xiaowei
    • 阿美甜美女声:amei
    • 小雪温柔女声:xiaoxue
    • 思琪温柔女声:siqi
    • 思佳标准女声:sijia
    • 思诚标准男声:sicheng
    • 思悦温柔女声:siyue
    • 小美甜美女声:xiaomei
    • 思彤标准童声:sitong
    • 宁儿标准女声:ninger
    • 小北萝莉女声:xiaobei
    • 伊娜浙普女声:yina

    返回参数

    名称类型描述示例值
    object

    返回数据。

    Messagestring

    状态码的描述。

    OK
    RequestIdstring

    请求 ID。

    A90E4451-FED7-49D2-87C8-00700A8C4D0D
    Datastring

    请求状态码。返回 OK 代表请求成功。

    OK
    Codestring

    此次通话的唯一回执 ID。

    16012854210^10281427****

    示例

    正常返回示例

    JSON格式

    {
      "Message": "OK",
      "RequestId": "A90E4451-FED7-49D2-87C8-00700A8C4D0D",
      "Data": "OK",
      "Code": "16012854210^10281427****"
    }

    错误码

    HTTP status code错误码错误信息描述
    400Permission.NotAuthorizedInsufficient permissions. Please contact the primary account administrator.权限不足,请联系主账号管理员
    400Parameter.ErrorParameter error.参数错误

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    暂无变更历史
    • 本页导读
    文档反馈