DescribeJob - 返回一个作业的对话数据_智能外呼机器人(Outbound Bot)-阿里云帮助中心

返回一个作业的对话数据。

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例 ID。	af81a389-91f0-4157-8d82-720edd02b66a
JobId	string	是	作业 ID。	c8a2b7f2-ad1a-4865-b872-d0080d9802d9
WithScript	boolean	否	是否返回任务场景信息。	false

返回参数

名称	类型	描述	示例值
	object
HttpStatusCode	integer	HTTP 状态码。	200
Code	string	接口状态码。	OK
Message	string	接口提示信息。	Success
RequestId	string	请求 ID。	254EB995-DEDF-48A4-9101-9CA5B72FFBCC
Success	boolean	是否成功。	true
Job	object	作业信息。
Status	string	作业状态。 Scheduling（调度中）， Executing（执行中）， Succeeded（成功）， Paused（暂停）， Failed（失败）， Cancelled（已取消）， Drafted（草稿态,文件导入时的临时状态）；	Succeeded
ActualTime	long	作业实际执行时间。	1640068026385
Priority	integer	作业优先级。	5
DsReport	string	任务命中标签情况。	-
NextExecutionTime	long	任务下次执行的时间。	1640068026385
FailureReason	string	作业失败原因。	NoAnswer
SystemPriority	integer	作业系统优先级。	1
InstanceId	string	实例 ID。	d5971d98-7312-4f0e-a918-a17d67133e28
CalledNumber	string	被叫号码。	137****7777
ReferenceId	string	作业的业务 ID，有业务方自定义。	d5971d98-7312-4f0e-a918-a17d67133e28
JobGroupId	string	任务 ID。	fce6c599-8ede-40e3-9f78-0928eda7b4e8
ScenarioId	string	场景 ID。	ade80092-03d9-4f4d-ad4f-ab8a247d3150
StrategyId	string	策略 ID。	c8a2b7f2-ad1a-4865-b872-d0080d9802d9
EndReason	integer	通话完结原因，取值范围 1：FINISHED（正常完结）。 2：CHATBOT_HANGUP_AFTER_NOANSWER（拒识后机器人挂机）。 3：CHATBOT_HANGUP_AFTER_SILENCE（静默超时挂机）。 4：CLIENT_HANGUP_AFTER_NOANSWER（拒识后用户挂机）。 5：CLIENT_HANGUP（用户无理由挂机）。 6：TRANSFER_BY_INTENT（命中意图转人工）。 7：TRANSFER_AFTER_NOANSWER（拒识转人工）。 8：INO_INTERACTION（用户侧无交互）。 9：ERROR（系统异常中断）。	1
JobId	string	作业 ID。	b72425bd-7871-4050-838e-033d80d754b7
Contacts	array<object>	联系人信息。	[]
Contact	object
PhoneNumber	string	电话号码。	1358****8888
State	string	联系人状态。	Available
ContactId	string	联系人 ID。	db3db762-e421-44c9-9a01-cb423470757c
Honorific	string	联系人尊称。	张先生
JobId	string	作业 ID。	72dcd26b-f12d-4c27-b3af-18f6aed5b160
ContactName	string	联系人名字。	张三
Role	string	联系人角色。	*
ReferenceId	string	联系人的业务 ID。	2fa6bac3-06da-4315-82ab-72d6fd3a6f34
Extras	array<object>	业务参数。	[]
KeyValuePair	object
Key	string	业务参数名字。	djrq
Value	string	业务参数值。	2019-08-21 09:49:59.0
Summary	array<object>	对话摘要数据。	[]
Summary	object
SummaryName	string	摘要名字。	score
Category	string	对话摘要类别（历史字段，不再使用）。	{}
Content	string	摘要内容。	5
Tasks	array<object>	通话列表。	[]
Task	object
Status	string	通话状态。	Succeeded
PlanedTime	long	计划拨打时间。	1579068424883
ChatbotId	string	对话的机器人 ID。	1234
ActualTime	long	实际执行时间。	1579068424883
CalledNumber	string	被叫号码。	135****8888
EndTime	long	实际结束的时间。	1579068424883
ScenarioId	string	场景 ID。	ade80092-03d9-4f4d-ad4f-ab8a247d3150
EndReason	string	完结原因。	FINISHED
JobId	string	作业 ID。	b72425bd-7871-4050-838e-033d80d754b7
CallId	string	SIP call id。	1528189846043
CallingNumber	string	主叫号码。	0571****3106
Brief	string	业务结果（历史字段，不再使用）。	1
Duration	integer	对话持续时间。	120
TaskId	string	通话 ID。	ff44709e-39a6-43ba-959b-20fcabe3e496
Conversation	array<object>	任务的对话文本列表	[]
ConversationDetail	object
ActionParams	string	指令参数。	{}
Action	string	指令。	Broadcast
Timestamp	long	摘要创建时间。	1579068424883
Speaker	string	对话是谁说的，Robot 机器人，Contact 联系人。	Robot
Script	string	对话文本。	你好，我是**客服
Summary	array<object>	对话摘要数据（历史数据，不再使用）。	[]
Summary	object
SummaryName	string	摘要名字。	score
Category	string	对话摘要类别（历史字段，不再使用）。	{}
Content	string	摘要内容。	5
SequenceId	string	会话 ID。	fd279983-93b9-b13b-9a34-64e5df473225
Contact	object	联系人信息。
PhoneNumber	string	电话号码。	1351****8888
State	string	联系人状态。	Available
ContactId	string	联系人 ID。	db3db762-e421-44c9-9a01-cb423470757c
Honorific	string	联系人尊称。	张先生
JobId	string	作业 id	b72425bd-7871-4050-838e-033d80d754b7
ContactName	string	联系人名字	张三
Role	string	联系人角色	*
ReferenceId	string	联系人业务系统 ID。	2fa6bac3-06da-4315-82ab-72d6fd3a6f34
HangUpDirection	string	挂断方。	client
RingingDuration	long	响铃持续时间。	25
SipCode	string	呼叫任务的 SIP 状态码。	200
RealRingingDuration	long	真实振铃持续时长。	25
SipDuration	long	sip 信令时长。	25
CallingNumbers	array	主叫号码列表。
String	string	主叫号码。	["0571****3106"]
Script	object	话术场景。
Status	string	状态。	DRAFTED
UpdateTime	long	更新时间。	1578881227000
ChatbotId	string	对话机器人 ID。	chatbot-cn-EJfqqa***
ScriptId	string	话术 ID。	810b5872-57f0-4b27-80ab-7b3f4d8a6374
IsDebugDrafted	boolean	调试版本是否为草稿态。	true
Industry	string	行业。	金融
ScriptDescription	string	话术描述。	催收话术
MiniPlaybackConfigEnabled	boolean	语气承接功能开关。	true
IsDrafted	boolean	是否是草稿状态。	true
TtsConfig	string	话术的 TTS 配置。	{\"voice\":\"xiaobei\",\"volume\":\"50\",\"speechRate\":\"-150\",\"pitchRate\":\"0\"}
DebugStatus	string	调试状态。	DRAFTED
AsrConfig	string	话术的 ASR 配置。	{\"AppKey\":\"3GHttnsvir1FeWWb\"}
Scene	string	场景。	催收
Name	string	话术名字。	催收话术

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "Success",
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Success": true,
  "Job": {
    "Status": "Succeeded",
    "ActualTime": 1640068026385,
    "Priority": 5,
    "DsReport": "-",
    "NextExecutionTime": 1640068026385,
    "FailureReason": "NoAnswer",
    "SystemPriority": 1,
    "InstanceId": "d5971d98-7312-4f0e-a918-a17d67133e28",
    "CalledNumber": "137****7777",
    "ReferenceId": "d5971d98-7312-4f0e-a918-a17d67133e28",
    "JobGroupId": "fce6c599-8ede-40e3-9f78-0928eda7b4e8",
    "ScenarioId": "ade80092-03d9-4f4d-ad4f-ab8a247d3150",
    "StrategyId": "c8a2b7f2-ad1a-4865-b872-d0080d9802d9",
    "EndReason": 1,
    "JobId": "b72425bd-7871-4050-838e-033d80d754b7",
    "Contacts": [
      {
        "PhoneNumber": "1358****8888",
        "State": "Available",
        "ContactId": "db3db762-e421-44c9-9a01-cb423470757c",
        "Honorific": "张先生",
        "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5b160",
        "ContactName": "张三",
        "Role": "*",
        "ReferenceId": "2fa6bac3-06da-4315-82ab-72d6fd3a6f34"
      }
    ],
    "Extras": [
      {
        "Key": "djrq",
        "Value": "2019-08-21 09:49:59.0"
      }
    ],
    "Summary": [
      {
        "SummaryName": "score",
        "Category": "{}",
        "Content": "5"
      }
    ],
    "Tasks": [
      {
        "Status": "Succeeded",
        "PlanedTime": 1579068424883,
        "ChatbotId": "1234",
        "ActualTime": 1579068424883,
        "CalledNumber": "135****8888",
        "EndTime": 1579068424883,
        "ScenarioId": "ade80092-03d9-4f4d-ad4f-ab8a247d3150",
        "EndReason": "FINISHED",
        "JobId": "b72425bd-7871-4050-838e-033d80d754b7",
        "CallId": "1528189846043",
        "CallingNumber": "0571****3106",
        "Brief": "1",
        "Duration": 120,
        "TaskId": "ff44709e-39a6-43ba-959b-20fcabe3e496",
        "Conversation": [
          {
            "ActionParams": "{}",
            "Action": "Broadcast",
            "Timestamp": 1579068424883,
            "Speaker": "Robot",
            "Script": "你好，我是**客服",
            "Summary": [
              {
                "SummaryName": "score",
                "Category": "{}",
                "Content": "5"
              }
            ],
            "SequenceId": "fd279983-93b9-b13b-9a34-64e5df473225"
          }
        ],
        "Contact": {
          "PhoneNumber": "1351****8888",
          "State": "Available",
          "ContactId": "db3db762-e421-44c9-9a01-cb423470757c",
          "Honorific": "张先生",
          "JobId": "b72425bd-7871-4050-838e-033d80d754b7",
          "ContactName": "张三",
          "Role": "*",
          "ReferenceId": "2fa6bac3-06da-4315-82ab-72d6fd3a6f34"
        },
        "HangUpDirection": "client",
        "RingingDuration": 25,
        "SipCode": "200",
        "RealRingingDuration": 25,
        "SipDuration": 25
      }
    ],
    "CallingNumbers": [
      "[\"0571****3106\"]"
    ],
    "Script": {
      "Status": "DRAFTED",
      "UpdateTime": 1578881227000,
      "ChatbotId": "chatbot-cn-EJfqqa***",
      "ScriptId": "810b5872-57f0-4b27-80ab-7b3f4d8a6374",
      "IsDebugDrafted": true,
      "Industry": "金融",
      "ScriptDescription": "催收话术",
      "MiniPlaybackConfigEnabled": true,
      "IsDrafted": true,
      "TtsConfig": "{\\\"voice\\\":\\\"xiaobei\\\",\\\"volume\\\":\\\"50\\\",\\\"speechRate\\\":\\\"-150\\\",\\\"pitchRate\\\":\\\"0\\\"}",
      "DebugStatus": "DRAFTED",
      "AsrConfig": "{\\\"AppKey\\\":\\\"3GHttnsvir1FeWWb\\\"}",
      "Scene": "催收",
      "Name": "催收话术"
    }
  }
}

错误码

HTTP status code	错误码	错误信息	描述
404	NotExist.Instance	The specified Instance does not exist.	指定的实例不存在。
404	NotExist.Job	The specified Job does not exist.	指定的任务不存在。
500	InternalError	An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.	内部错误。建议重试，如果多次重试报错请提交工单。

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

变更历史

变更时间	变更内容概要	操作
2024-07-22	OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-04-25	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情