DescribeJob - 返回一个作业的对话数据

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

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String DescribeJob

系统规定参数。取值:DescribeJob

InstanceId String af81a389-91f0-4157-8d82-720edd02b66a

实例ID。

JobId String c8a2b7f2-ad1a-4865-b872-d0080d9802d9

作业ID。

WithScript Boolean false

是否返回任务场景信息。

返回数据

名称

类型

示例值

描述

HttpStatusCode Integer 200

HTTP状态码。

Code String OK

接口状态码。

Message String Success

接口提示信息。

RequestId String 254EB995-DEDF-48A4-9101-9CA5B72FFBCC

请求ID。

Success Boolean true

是否成功。

Job Object

作业信息。

Status String Succeeded

作业状态。

  • Scheduling(调度中),
  • Executing(执行中),
  • Succeeded(成功),
  • Paused(暂停),
  • Failed(失败),
  • Cancelled(已取消),
  • Drafted(草稿态,文件导入时的临时状态);
ActualTime Long 1640068026385

作业实际执行时间。

Priority Integer 5

作业优先级。

DsReport String -

任务命中标签情况。

NextExecutionTime Long 1640068026385

任务下次执行的时间。

FailureReason String NoAnswer

作业失败原因。

SystemPriority Integer 1

作业系统优先级。

InstanceId String d5971d98-7312-4f0e-a918-a17d67133e28

实例ID。

CalledNumber String 137****7777

被叫号码。

ReferenceId String d5971d98-7312-4f0e-a918-a17d67133e28

作业的业务ID,有业务方自定义。

JobGroupId String fce6c599-8ede-40e3-9f78-0928eda7b4e8

任务ID。

ScenarioId String ade80092-03d9-4f4d-ad4f-ab8a247d3150

场景ID。

StrategyId String c8a2b7f2-ad1a-4865-b872-d0080d9802d9

策略ID。

EndReason Integer 1

通话完结原因,取值范围

  • 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(系统异常中断)。
JobId String b72425bd-7871-4050-838e-033d80d754b7

作业ID。

Contacts Array of Contact

联系人信息。

PhoneNumber String 1358****8888

电话号码。

State String Available

联系人状态。

ContactId String db3db762-e421-44c9-9a01-cb423470757c

联系人ID。

Honorific String 张先生

联系人尊称。

JobId String 72dcd26b-f12d-4c27-b3af-18f6aed5b160

作业ID。

ContactName String 张三

联系人名字。

Role String *

联系人角色。

ReferenceId String 2fa6bac3-06da-4315-82ab-72d6fd3a6f34

联系人的业务ID。

Extras Array of KeyValuePair

业务参数。

Key String djrq

业务参数名字。

Value String 2019-08-21 09:49:59.0

业务参数值。

Summary Array of Summary

对话摘要数据。

SummaryName String score

摘要名字。

Category String {}

对话摘要类别(历史字段,不再使用)。

Content String 5

摘要内容。

Tasks Array of Task

通话列表。

Status String Succeeded

通话状态。

PlanedTime Long 1579068424883

计划拨打时间。

ChatbotId String 1234

对话的机器人ID。

ActualTime Long 1579068424883

实际执行时间。

CalledNumber String 135****8888

被叫号码。

EndTime Long 1579068424883

实际结束的时间。

ScenarioId String ade80092-03d9-4f4d-ad4f-ab8a247d3150

场景ID。

EndReason String FINISHED

完结原因。

JobId String b72425bd-7871-4050-838e-033d80d754b7

作业ID。

CallId String 1528189846043

SIP call id。

CallingNumber String 0571****3106

主叫号码。

Brief String 1

业务结果(历史字段,不再使用)。

Duration Integer 120

对话持续时间。

TaskId String ff44709e-39a6-43ba-959b-20fcabe3e496

通话ID。

Conversation Array of ConversationDetail

任务的对话文本列表

ActionParams String {}

指令参数。

Action String Broadcast

指令。

Timestamp Long 1579068424883

摘要创建时间。

Speaker String Robot

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

Script String 你好,我是**客服

对话文本。

Summary Array of Summary

对话摘要数据(历史数据,不再使用)。

SummaryName String score

摘要名字。

Category String {}

对话摘要类别(历史字段,不再使用)。

Content String 5

摘要内容。

SequenceId String fd279983-93b9-b13b-9a34-64e5df473225

会话ID。

Contact Object

联系人信息。

PhoneNumber String 1351****8888

电话号码。

State String Available

联系人状态。

ContactId String db3db762-e421-44c9-9a01-cb423470757c

联系人ID。

Honorific String 张先生

联系人尊称。

JobId String b72425bd-7871-4050-838e-033d80d754b7

作业id

ContactName String 张三

联系人名字

Role String *

联系人角色

ReferenceId String 2fa6bac3-06da-4315-82ab-72d6fd3a6f34

联系人业务系统ID。

HangUpDirection String client

挂断方。

RingingDuration Long 25

响铃持续时间。

SipCode String 200

呼叫任务的SIP状态码。

RealRingingDuration Long 25

真实振铃持续时长。

SipDuration Long 25

sip信令时长 。

CallingNumbers Array of String ["0571****3106"]

主叫号码。

Script Object

话术场景。

Status String DRAFTED

状态。

UpdateTime Long 1578881227000

更新时间。

ChatbotId String chatbot-cn-EJfqqa***

对话机器人ID。

ScriptId String 810b5872-57f0-4b27-80ab-7b3f4d8a6374

话术ID。

IsDebugDrafted Boolean true

调试版本是否为草稿态。

Industry String 金融

行业。

ScriptDescription String 催收话术

话术描述。

MiniPlaybackConfigEnabled Boolean true

语气承接功能开关。

IsDrafted Boolean true

是否是草稿状态。

TtsConfig String {\"voice\":\"xiaobei\",\"volume\":\"50\",\"speechRate\":\"-150\",\"pitchRate\":\"0\"}

话术的TTS配置。

DebugStatus String DRAFTED

调试状态。

AsrConfig String {\"AppKey\":\"3GHttnsvir1FeWWb\"}

话术的ASR配置。

Scene String 催收

场景。

Name String 催收话术

话术名字。

示例

请求示例

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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" : "催收话术"
    }
  }
}

错误码

HttpCode

错误码

错误信息

描述

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. 内部错误。建议重试,如果多次重试报错请提交工单。

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