文档

CreateTask - 创建任务

更新时间:

根据任务名称、机器人ID、外呼主叫号码等创建任务。

接口说明

  • 您可以调用此接口创建任务,也可以在智能联络中心控制台>智能外呼机器人(标准版)>任务管理>单击创建任务进行创建。
  • 调用此接口后,返回参数的 Data 为机器人呼叫任务的唯一任务 ID。

QPS 限制

  • 单用户调用频率:不限流。
  • API 频率:500 次/秒。
说明 如果多个用户的总调用超过 API 频率也会触发流控。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
aiccs:CreateTaskWrite
  • 全部资源
    *

请求参数

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

任务名称。支持中文和英文,0~30 个字符。

测试任务
RobotIdstring

指定机器人 ID(话术 ID)。表示选择哪个机器人话术发起呼叫。

您可在控制台的话术管理页面,获取话术 ID。

12****
Callerstring

外呼主叫号码。

说明 必须是已购买的号码,多个号码用英文逗号(,)隔开。
0571****5678,0571****5679
CallStringstring

呼叫字符(被叫信息和参数列表)。取值:

  • LIST05715678****,05715679****
  • JSON{"ParamNames":["name","age"],"CalleeList":[{"Callee":"1810000****","Params":["张三","20"]},{"Callee":"1810001****","Params":["李四","21"]}]}。其中 ParamNames 代表参数名称列表;Params 代表参数值列表。
说明
  • 参数名称列表和参数值列表顺序需要对应。
    • 最多 1000 个被叫号码。
    {"ParamNames":["name","age"],"CalleeList":[{"Callee":"1810000****","Params":["张三","20"]},{"Callee":"1810001****","Params":["李四","21"]}]}
    CallStringTypestring

    呼叫字符串类型。取值:

    • LIST
    • JSON
    JSON
    RetryFlaginteger

    是否自动重拨。取值:

    • 1:重拨。
    • 0:不重拨。
    1
    RetryCountinteger

    重拨次数。

    2
    RetryIntervalinteger

    重拨间隔。单位:分钟,必须大于 1。

    2
    RetryStatusCodestring

    需要重拨的通话状态。多个状态使用英文逗号(,)分隔。取值:

    • 200010:关机。
    • 200011:停机。
    • 200002:占线。
    • 200012:呼损。
    • 200005:无法接通。
    • 200003:无应答。
    200010,200011
    StartNowboolean

    是否立即启动。

    • true:是。
    • false:否。
    WorkTimeListstring

    工作时间列表(精确到分钟)。

    10:00-12:00,13:00-14:00
    WorkDaystring

    工作日期。取值:

    • 1:星期一。
    • 2:星期二。
    • 3:星期三。
    • 4:星期四。
    • 5:星期五。
    • 6:星期六。
    • 7:星期天。
    1
    SeatCountstring

    并发数量(坐席数量)。

    3

    返回参数

    名称类型描述示例值
    object

    返回数据。

    RequestIdstring

    请求 ID。

    EE338D98-9BD3-4413-B165
    Datalong

    机器人呼叫任务的唯一任务 ID。

    12****
    Codestring

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

    OK
    Messagestring

    状态码描述。

    OK
    Successboolean

    接口调用是否成功。

    • true:成功。
    • false:失败。
    true

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "EE338D98-9BD3-4413-B165",
      "Data": 0,
      "Code": "OK",
      "Message": "OK",
      "Success": true
    }

    错误码

    HTTP status code错误码错误信息描述
    400PermissionInsufficientInsufficient permissions. Please contact the Alibaba Cloud account administrator.权限不足,请联系主账号管理员
    400ParameterErrorThe parameter is invalid.参数错误

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

    变更历史

    变更时间变更内容概要操作
    2021-05-19新增 OpenAPI看变更集