ImportTaskNumberDatas - 导入被叫数据

更新时间:
复制 MD 格式

呼叫任务导入被叫数据。

接口说明

  • 您可调用此接口导入被叫数据,也可在呼叫任务管理界面单击导入被叫数据,下载模板并上传文件的方式导入被叫数据。

  • 此接口在导入被叫数据时,暂仅支持 JSON 数据类型导入。

  • 在调用此接口之前,请确保您已有创建成功的呼叫任务。

  • 若您没有已创建成功的呼叫任务,可在呼叫任务管理界面点击创建呼叫任务或通过 CreateAiCallTask 接口创建呼叫任务。

调试

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

调试

授权信息

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

请求参数

名称

类型

必填

描述

示例值

OssFileName

string

否

OSS 文件路径,非必填。

说明

API 调用暂时不支持 Excel 数据类型。因此上传 OSS 文件路径的方式暂不可用。

123dsdfsdfsdf.xlsx

TaskId

string

是

任务 ID。

119181071278******

PhoneNumberList

array<object>

否

如果 DataType 采用 JSON 列表,则需要通过该字段上传数据,且单次不能超过 1000 条。

object

否

数据结构如下:

{
    "calleeNumber":"被叫号码",
    "outId":"保留 key,该字段可用于携带外部流水唯一 ID,回执内容中会将该字段携带回来,可以用这个作为唯一呼叫记录,方便关联回执,限制长度 128",
    "calledPhoneNumber.extension":"分机号,当被叫号码为总机、需要进一步拨打分机时传入;为空或不传时按普通号码外呼",
    "variable1":"value",
    "variable2":"value",//除 calleeNumber 外的字段均作为变量透传至外呼链路,可用于智能体提示词、开场白等场景;如果智能体中有用到通话变量,则这里 variable1、variable2 代表每个变量的 key,value 就是变量的值
  }
说明

通话变量在通信智能体管理>详情>通话变量配置界面查看。 分机号说明:批量导入时在元素中携带 calledPhoneNumber.extension 字段即可;单条导入(ImportOnePhoneNumber)支持顶层 Extension 参数,效果相同;Excel 模板已新增 calledPhoneNumber.extension 列。外呼时系统自动识别该字段并透传给智能外呼网关,按「总机 + 分机」发起呼叫,智能体侧可通过系统变量 calledPhoneNumber.extension 读取分机号。 引擎呼叫任务通话变量配置示例: { "calleeNumber": "被叫号码", "calledPhoneNumber.extension": "122121", "outId": "", "startWordParam.变量 key1": "xxx", "promptParam.变量 key2": "xx", "bizParam.变量 key3": "xx" }

{ "calleeNumber": "0534556****", "calledPhoneNumber.extension": "12213", "outId": "CFC2F07E-F763-7C48-1A32-6EFFB6EA344E", "name": "Tom", "age": "18" } 引擎通话任务通话变量配置示例请看描述中说明

DataType

string

是

数据类型。取值:

  • EXCEL

  • JSON
    重要 API 调用暂时仅支持 JSON 数据类型。

枚举值:

  • EXCEL :

    Excel 数据

  • JSON :

    JSON 数据

JSON

返回参数

名称

类型

描述

示例值

object

AccessDeniedDetail

string

访问被拒绝的详细原因。

None

Message

string

状态码描述。

OK

RequestId

string

请求 ID。

CFC2F07E-F763-7C48-1A32-6EFFB6EA344E

Data

integer

导入批次 ID。

123497836486******

Code

string

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

OK

Success

boolean

调用接口是否成功。取值:

  • true:成功。

  • false:失败。

true

示例

正常返回示例

JSON格式

{
  "AccessDeniedDetail": "None",
  "Message": "OK",
  "RequestId": "CFC2F07E-F763-7C48-1A32-6EFFB6EA344E",
  "Data": 0,
  "Code": "OK",
  "Success": true
}

错误码

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

变更历史

更多信息,参考变更详情。