GetTaskByUuid - 根据任务ID获取任务

根据UUID获取任务。

调试

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

授权信息

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

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

请求参数

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

实例 ID

024f8cf0-c842-4c01-b74b-c8667e4579c7
TaskIdstring

任务 ID

15160071061
WithConversationsboolean

是否需要对话信息

说明 不填默认为 false
false

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID

254EB995-DEDF-48A4-9101-9CA5B72FFBCC
Taskobject

任务信息

JobGroupIdstring

作业组 ID

254EB995-DEDF-48A4-9101-9CA5B72FFBCC
EndTimelong

结束时间

1640090211434
EndReasoninteger

结束原因

  • FINISHED(1, "正常完结"),

  • CHATBOT_HANGUP_AFTER_NOANSWER(2, "拒识后机器人挂机"),

  • CHATBOT_HANGUP_AFTER_SILENCE(3, "静默超时挂机"),

  • CLIENT_HANGUP_AFTER_NOANSWER(4, "拒识后用户挂机"),

  • CLIENT_HANGUP(5, "用户无理由挂机"),

  • TRANSFER_BY_INTENT(6, "命中意图转人工"),

  • TRANSFER_AFTER_NOANSWER(7, "拒识转人工"),

  • INO_INTERACTION(8, "用户侧无交互"),

  • ERROR(9, "系统异常中断"),

  • SPECIAL_INTERCEPT_VOICE_ASSISTANT(10, "特殊情况拦截-语音助手"),

  • SPECIAL_INTERCEPT_EXTENSION_NUMBER_TRANSFER(11, "特殊情况拦截-分机号转接")

注意 该参数类型为 string,返回的为 FINISHED 之类的枚举值

FINISHED
PlannedTimelong

任务计划执行时间【废弃】

1640090211434
JobIdstring

作业 ID

254EB995-DEDF-48A4-9101-9CA5B72FFBCC
CallIdstring

呼叫 ID

254EB995-DEDF-48A4-9101-9CA5B72FFBCC
CallingNumberstring

主叫号码

057190294
ActualTimelong

实际执行时间

1640090211434
InstanceIdstring

实例 ID

254EB995-DEDF-48A4-9101-9CA5B72FFBCC
CalledNumberstring

被叫号码

13777777777
Idstring

任务 ID

2
Conversationsarray<object>

对话信息列表

conversationobject
Speakerstring

对话是谁说的,Robot 机器人 ,Contact 联系人。

Robot
Scriptstring

对话文本。

你好,我是**客服
Timestamplong

摘要创建时间。

1579068424883
Actionstring

指令

  • BeginDialogue:开始对话
  • Dialogue:对话
  • AbortDialogue:中止对话
  • SilenceTimeout:静音超时
  • CollectedNumber:已收集号码 -EndDialogue:结束对话
  • Broadcast:开场白
  • HangUp 挂断
  • Authorize:授权
  • TransferToAgent:转接坐席
  • TransferToIVR:转接 IVR
  • RedirectToPage:重定向页面
  • CollectNumber:收集号码
  • WaitOnAsyncTask:等待异步任务
  • Error:错误
Broadcast
SequenceIdstring

会话 ID。

fd279983-93b9-b13b-9a34-64e5df473225
Codestring

接口状态码

OK
Messagestring

返回信息。

Success
Successboolean

是否成功

True
HttpStatusCodeinteger

HTTP 状态码。

200

示例

正常返回示例

JSON格式

{
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Task": {
    "JobGroupId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
    "EndTime": 1640090211434,
    "EndReason": 0,
    "PlannedTime": 1640090211434,
    "JobId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
    "CallId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
    "CallingNumber": "057190294",
    "ActualTime": 1640090211434,
    "InstanceId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
    "CalledNumber": 13777777777,
    "Id": 2,
    "Conversations": [
      {
        "Speaker": "Robot",
        "Script": "你好,我是**客服",
        "Timestamp": 1579068424883,
        "Action": "Broadcast",
        "SequenceId": "fd279983-93b9-b13b-9a34-64e5df473225"
      }
    ]
  },
  "Code": "OK",
  "Message": "Success",
  "Success": true,
  "HttpStatusCode": 200
}

错误码

HTTP status code错误码错误信息描述
500InternalErrorAn error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.内部错误。建议重试,如果多次重试报错请提交工单。

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

变更历史

变更时间变更内容概要操作
2025-01-22OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情