查询多个作业

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ListJobs

系统规定参数。取值:ListJobs。

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

实例id

JobId.N RepeatList 24fb9a8d-f20e-4ee2-a11c-094dda68c5cc

作业id

返回数据

名称 类型 示例值 描述
Code String OK

接口状态码

HttpStatusCode Integer 200

http 状态码

Jobs Array of Job

作业数组

CallingNumbers List ["057126883106"]

主叫号码列表

Contacts Array of Contact

联系人列表

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

联系人id

ContactName String 张三

联系人名字

Honorific String 张先生

尊称

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

作业id

PhoneNumber String 13581588888

电话号码

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

联系人第三方系统id

Role String *

联系人角色

State String Available

状态

Extras Array of KeyValuePair

业务参数列表

Key String djrq
Value String 2019-08-21 09:49:59.0
FailureReason String NoAnswer

作业失败原因

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

作业组id

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

作业id

Priority Integer 5

作业优先级

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

作业第三方系统id

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

作业状态

Status String Succeeded

作业状态,取值范围

  • Scheduling:调度中。
  • Executing:执行中。
  • Succeeded:成功。
  • Paused:挂起。
  • Failed:失败。
  • Cancelled:已取消。
  • Drafted:草稿态。
StrategyId String c8a2b7f2-ad1a-4865-b872-d0080d9802d9

策略id

Summary Array of Summary

对话摘要信息

Category String {}

对话摘要类别

Content String 5

对话摘要内容

SummaryName String score

对话摘要名字

SystemPriority Integer 1

系统优先级

Tasks Array of Task

任务列表

ActualTime Long 1579068424883

实际执行时间

Brief String 1

业务结果

CallId String 1528189846043

呼叫id

CalledNumber String 13512345678

被叫号码

CallingNumber String 057126883106

主叫号码

ChatbotId String 1234

对话机器人id

Contact Struct

任务的联系人

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

联系人id

ContactName String 张三

联系人名字

Honorific String 张先生

联系人尊称

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

作业id

PhoneNumber String 13512345678

电话号码

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

联系人第三方系统id

Role String *

角色

State String Available

状态

Conversation Array of ConversationDetail

对话列表

Script String 你好,我是**客服

对话文本

Speaker String Robot

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

Summary Array of Summary

摘要信息

Category String {}
Content String 5
SummaryName String score
Timestamp Long 1579068424883

对话文本入库时间戳

Duration Integer 120

持续时间

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

作业id

PlanedTime Long 1579068424883

任务计划执行时间

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

场景id

Status String Succeeded

任务状态,取值范围

  • Executing:正在拨打。
  • Succeeded:已接通。
  • NoAnswer:未接通-无人接听。
  • NotExist:未接通-空号。
  • Busy:未接通-占线。
  • Cancelled:未呼出-任务停止。
  • Failed:失败。
  • NotConnected:未接通-无法接通。
  • PoweredOff:未接通-关机。
  • OutOfService:未接通-被叫停机。
  • InArrears:未接通-被叫欠费。
  • EmptyNumber:未呼出-空号不外呼。
  • PerDayCallCountLimit:未呼出-超出每日上限。
  • ContactBlockList:未呼出-黑名单。
  • CallerNotRegistered:未呼出-主叫号码未注册。
  • Terminated:未呼出-被终止。
  • VerificationCancelled:未呼出-呼叫前验证不通过取消。
  • OutOfServiceNoCall:未呼出-被叫停机不外呼。
  • InArrearsNoCall:未呼出-被叫欠费不外呼。
  • CallingNumberNotExist:未呼出-主叫号码不存在。
TaskId String ff44709e-39a6-43ba-959b-20fcabe3e496

任务id

Message String Success

接口提示消息

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

请求id

Success Boolean true

是否成功

示例

请求示例

http(s)://[Endpoint]/?Action=ListJobs
&InstanceId=af81a389-91f0-4157-8d82-720edd02b66a
&JobId.1=24fb9a8d-f20e-4ee2-a11c-094dda68c5cc
&<公共请求参数>

正常返回示例

XML格式

<Message>Success</Message>
<RequestId>254EB995-DEDF-48A4-9101-9CA5B72FFBCC</RequestId>
<Jobs>
    <Status>Succeeded</Status>
    <JobGroupId>fce6c599-8ede-40e3-9f78-0928eda7b4e8</JobGroupId>
    <ScenarioId>ade80092-03d9-4f4d-ad4f-ab8a247d3150</ScenarioId>
    <ReferenceId>d5971d98-7312-4f0e-a918-a17d67133e28</ReferenceId>
    <Priority>5</Priority>
    <FailureReason>NoAnswer</FailureReason>
    <SystemPriority>1</SystemPriority>
    <StrategyId>c8a2b7f2-ad1a-4865-b872-d0080d9802d9</StrategyId>
    <JobId>b72425bd-7871-4050-838e-033d80d754b7</JobId>
    <Summary>
        <Category>{}</Category>
        <Content>5</Content>
        <SummaryName>score</SummaryName>
    </Summary>
    <Tasks>
        <Status>Succeeded</Status>
        <PlanedTime>1579068424883</PlanedTime>
        <ChatbotId>1234</ChatbotId>
        <CalledNumber>13512345678</CalledNumber>
        <ScenarioId>ade80092-03d9-4f4d-ad4f-ab8a247d3150</ScenarioId>
        <TaskId>ff44709e-39a6-43ba-959b-20fcabe3e496</TaskId>
        <ActualTime>1579068424883</ActualTime>
        <CallId>1528189846043</CallId>
        <Duration>120</Duration>
        <Brief>1</Brief>
        <CallingNumber>057126883106</CallingNumber>
        <JobId>b72425bd-7871-4050-838e-033d80d754b7</JobId>
        <Conversation>
            <Script>你好,我是**客服</Script>
            <Timestamp>1579068424883</Timestamp>
            <Speaker>Robot</Speaker>
            <Summary>
                <Category>{}</Category>
                <Content>5</Content>
                <SummaryName>score</SummaryName>
            </Summary>
        </Conversation>
        <Contact>
            <Role>*</Role>
            <Honorific>张先生</Honorific>
            <ReferenceId>2fa6bac3-06da-4315-82ab-72d6fd3a6f34</ReferenceId>
            <State>Available</State>
            <PhoneNumber>13512345678</PhoneNumber>
            <ContactId>db3db762-e421-44c9-9a01-cb423470757c</ContactId>
            <ContactName>张三</ContactName>
            <JobId>b72425bd-7871-4050-838e-033d80d754b7</JobId>
        </Contact>
    </Tasks>
    <Contacts>
        <Role>*</Role>
        <Honorific>张先生</Honorific>
        <ReferenceId>2fa6bac3-06da-4315-82ab-72d6fd3a6f34</ReferenceId>
        <State>Available</State>
        <PhoneNumber>13581588888</PhoneNumber>
        <ContactId>db3db762-e421-44c9-9a01-cb423470757c</ContactId>
        <ContactName>张三</ContactName>
        <JobId>72dcd26b-f12d-4c27-b3af-18f6aed5b160</JobId>
    </Contacts>
    <Extras>
        <Value>2019-08-21 09:49:59.0</Value>
        <Key>djrq</Key>
    </Extras>
    <CallingNumbers>["057126883106"]</CallingNumbers>
</Jobs>
<HttpStatusCode>200</HttpStatusCode>
<Code>OK</Code>
<Success>true</Success>

JSON格式

{
    "Message": "Success",
    "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
    "Jobs": {
        "Status": "Succeeded",
        "JobGroupId": "fce6c599-8ede-40e3-9f78-0928eda7b4e8",
        "ScenarioId": "ade80092-03d9-4f4d-ad4f-ab8a247d3150",
        "ReferenceId": "d5971d98-7312-4f0e-a918-a17d67133e28",
        "Priority": 5,
        "FailureReason": "NoAnswer",
        "SystemPriority": 1,
        "StrategyId": "c8a2b7f2-ad1a-4865-b872-d0080d9802d9",
        "JobId": "b72425bd-7871-4050-838e-033d80d754b7",
        "Summary": {
            "Category": "{}",
            "Content": 5,
            "SummaryName": "score"
        },
        "Tasks": {
            "Status": "Succeeded",
            "PlanedTime": 1579068424883,
            "ChatbotId": 1234,
            "CalledNumber": 13512345678,
            "ScenarioId": "ade80092-03d9-4f4d-ad4f-ab8a247d3150",
            "TaskId": "ff44709e-39a6-43ba-959b-20fcabe3e496",
            "ActualTime": 1579068424883,
            "CallId": 1528189846043,
            "Duration": 120,
            "Brief": 1,
            "CallingNumber": 57126883106,
            "JobId": "b72425bd-7871-4050-838e-033d80d754b7",
            "Conversation": {
                "Script": "你好,我是**客服",
                "Timestamp": 1579068424883,
                "Speaker": "Robot",
                "Summary": {
                    "Category": "{}",
                    "Content": 5,
                    "SummaryName": "score"
                }
            },
            "Contact": {
                "Role": "*",
                "Honorific": "张先生",
                "ReferenceId": "2fa6bac3-06da-4315-82ab-72d6fd3a6f34",
                "State": "Available",
                "PhoneNumber": 13512345678,
                "ContactId": "db3db762-e421-44c9-9a01-cb423470757c",
                "ContactName": "张三",
                "JobId": "b72425bd-7871-4050-838e-033d80d754b7"
            }
        },
        "Contacts": {
            "Role": "*",
            "Honorific": "张先生",
            "ReferenceId": "2fa6bac3-06da-4315-82ab-72d6fd3a6f34",
            "State": "Available",
            "PhoneNumber": 13581588888,
            "ContactId": "db3db762-e421-44c9-9a01-cb423470757c",
            "ContactName": "张三",
            "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5b160"
        },
        "Extras": {
            "Value": "2019-08-21 09:49:59.0",
            "Key": "djrq"
        },
        "CallingNumbers": "[\"057126883106\"]"
    },
    "HttpStatusCode": 200,
    "Code": "OK",
    "Success": true
}

错误码

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