查询多个作业。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
Action | String | 是 | ListJobs | 系统规定参数。取值:ListJobs。 |
InstanceId | String | 是 | af81a389-91f0-4157-8d82-720edd02b66a | 实例ID |
JobId.N | String | 否 | 24fb9a8d-f20e-4ee2-a11c-094dda68c5cc | 作业ID |
返回数据
名称 |
类型 |
示例值 |
描述 |
HttpStatusCode | Integer | 200 | HTTP状态码 |
Code | String | OK | 接口状态码 |
Message | String | Success | 接口提示消息 |
RequestId | String | 254EB995-DEDF-48A4-9101-9CA5B72FFBCC | 请求ID |
Success | Boolean | true | 是否成功 |
Jobs | Array of Job | 作业数组 |
|
Status | String | Succeeded | 作业状态,取值范围
|
ScenarioId | String | 254EB995-DEDF-48A4-9101-9CA5B72FFBCC | 业务ID |
JobGroupId | String | fce6c599-8ede-40e3-9f78-0928eda7b4e8 | 作业组ID |
StrategyId | String | c8a2b7f2-ad1a-4865-b872-d0080d9802d9 | 策略ID |
JobId | String | b72425bd-7871-4050-838e-033d80d754b7 | 作业ID |
Priority | Integer | 5 |
作业优先级 |
SystemPriority | Integer | 1 |
系统优先级 |
FailureReason | String | NoAnswer | 作业失败原因 |
ReferenceId | String | d5971d98-7312-4f0e-a918-a17d67133e28 | 作业第三方系统ID |
Contacts | Array of Contact | 联系人列表 |
|
PhoneNumber | String | 135****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 | name | 业务参数Key |
Value | String | 张三 | 业务参数Value |
Summary | Array of Summary | 对话摘要信息 |
|
SummaryName | String | score | 对话摘要名字 |
Category | String | {} |
对话摘要类别 |
Content | String | 5 | 对话摘要内容 |
Tasks | Array of Task | 任务列表 |
|
Status | String | Succeeded | 任务状态,取值范围 (注:Succeeded状态已细分原因,不会展示Succeeded:1(已接通)状态,之后返回均为具体细分原因类型。)
|
PlanedTime | Long | 1579068424883 | 任务计划执行时间 |
ChatbotId | String | 1234 | 对话机器人id |
ActualTime | Long | 1579068424883 | 实际执行时间 |
CalledNumber | String | 135****8888 | 被叫号码 |
ScenarioId | String | ade80092-03d9-4f4d-ad4f-ab8a247d3150 | 场景ID |
JobId | String | b72425bd-7871-4050-838e-033d80d754b7 | 作业ID |
CallId | String | 1528189846043 | 呼叫ID |
CallingNumber | String | 0571****3106 | 主叫号码 |
Brief | String | 1 | 业务结果 |
Duration | Integer | 120 | 持续时间 |
TaskId | String | ff44709e-39a6-43ba-959b-20fcabe3e496 | 任务ID |
Conversation | Array of ConversationDetail | 对话列表 |
|
Speaker | String | Robot | 是谁说的话,Robot 机器人, Contact 联系人 |
Timestamp | Long | 1579068424883 | 对话文本入库时间戳 |
Script | String | 你好,我是**客服 |
对话文本 |
Summary | Array of Summary | 摘要信息 |
|
SummaryName | String | 是本人 | 摘要名称 |
Category | String | 标签 | 类目 |
Content | String | 是 | 摘要内容 |
Contact | Object |
任务的联系人 |
|
PhoneNumber | String | 135****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 |
CallingNumbers | Array of String | ["0571****3106"] | 主叫号码列表 |
示例
请求示例
http(s)://[Endpoint]/?Action=ListJobs
&InstanceId=af81a389-91f0-4157-8d82-720edd02b66a
&JobId=["24fb9a8d-f20e-4ee2-a11c-094dda68c5cc"]
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<ListJobsResponse>
<HttpStatusCode>200</HttpStatusCode>
<Code>OK</Code>
<Message>Success</Message>
<RequestId>254EB995-DEDF-48A4-9101-9CA5B72FFBCC</RequestId>
<Success>true</Success>
<Jobs>
<Status>Succeeded</Status>
<ScenarioId>254EB995-DEDF-48A4-9101-9CA5B72FFBCC</ScenarioId>
<JobGroupId>fce6c599-8ede-40e3-9f78-0928eda7b4e8</JobGroupId>
<StrategyId>c8a2b7f2-ad1a-4865-b872-d0080d9802d9</StrategyId>
<JobId>b72425bd-7871-4050-838e-033d80d754b7</JobId>
<SystemPriority>1</SystemPriority>
<FailureReason>NoAnswer</FailureReason>
<ReferenceId>d5971d98-7312-4f0e-a918-a17d67133e28</ReferenceId>
<Contacts>
<PhoneNumber>135****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>name</Key>
<Value>张三</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>
<ScenarioId>ade80092-03d9-4f4d-ad4f-ab8a247d3150</ScenarioId>
<JobId>b72425bd-7871-4050-838e-033d80d754b7</JobId>
<CallId>1528189846043</CallId>
<CallingNumber>0571****3106</CallingNumber>
<Brief>1</Brief>
<TaskId>ff44709e-39a6-43ba-959b-20fcabe3e496</TaskId>
<Conversation>
<Speaker>Robot</Speaker>
<Timestamp>1579068424883</Timestamp>
<Script>你好,我是**客服</Script>
<Summary>
<SummaryName>是本人</SummaryName>
<Category>标签</Category>
<Content>是</Content>
</Summary>
</Conversation>
<Contact>
<PhoneNumber>135****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>
</Tasks>
<CallingNumbers>["0571****3106"]</CallingNumbers>
</Jobs>
</ListJobsResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"HttpStatusCode" : 200,
"Code" : "OK",
"Message" : "Success",
"RequestId" : "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
"Success" : true,
"Jobs" : [ {
"Status" : "Succeeded",
"ScenarioId" : "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
"JobGroupId" : "fce6c599-8ede-40e3-9f78-0928eda7b4e8",
"StrategyId" : "c8a2b7f2-ad1a-4865-b872-d0080d9802d9",
"JobId" : "b72425bd-7871-4050-838e-033d80d754b7",
"SystemPriority" : 1,
"FailureReason" : "NoAnswer",
"ReferenceId" : "d5971d98-7312-4f0e-a918-a17d67133e28",
"Contacts" : [ {
"PhoneNumber" : "135****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" : "name",
"Value" : "张三"
} ],
"Summary" : [ {
"SummaryName" : "score",
"Category" : "\t{}",
"Content" : "5"
} ],
"Tasks" : [ {
"Status" : "Succeeded",
"PlanedTime" : 1579068424883,
"ChatbotId" : "\t1234",
"ActualTime" : 1579068424883,
"CalledNumber" : "135****8888",
"ScenarioId" : "ade80092-03d9-4f4d-ad4f-ab8a247d3150",
"JobId" : "b72425bd-7871-4050-838e-033d80d754b7",
"CallId" : "1528189846043",
"CallingNumber" : "0571****3106",
"Brief" : "1",
"TaskId" : "ff44709e-39a6-43ba-959b-20fcabe3e496",
"Conversation" : [ {
"Speaker" : "Robot",
"Timestamp" : 1579068424883,
"Script" : "你好,我是**客服",
"Summary" : [ {
"SummaryName" : "是本人",
"Category" : "标签",
"Content" : "是"
} ]
} ],
"Contact" : {
"PhoneNumber" : "135****8888",
"State" : "Available",
"ContactId" : "db3db762-e421-44c9-9a01-cb423470757c",
"Honorific" : "张先生",
"JobId" : "b72425bd-7871-4050-838e-033d80d754b7",
"ContactName" : "张三",
"Role" : "*",
"ReferenceId" : "2fa6bac3-06da-4315-82ab-72d6fd3a6f34"
}
} ],
"CallingNumbers" : [ "[\"0571****3106\"]" ]
} ]
}
错误码
访问错误中心查看更多错误码。
文档内容是否对您有帮助?