查询作业列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
Action | String | 是 | QueryJobs | 系统规定参数。取值:QueryJobs。 |
InstanceId | String | 是 | af81a389-91f0-4157-8d82-720edd02b66a | 实例ID。 |
ScenarioId | String | 否 | b0f35dd1-0337-402e-9c4f-3a6c2426950a | 场景ID。 |
JobGroupId | String | 否 | 994b8baf-7ef8-480c-b141-b7b6db77c4df | 任务ID。 |
StartTime | Long | 否 | 1579068424883 | 过滤条件,开始时间,缺省为0, 代表从今天0时开始。 |
EndTime | Long | 否 | 1579077794665 | 过滤条件,截止时间,缺省为0,代表截止到当前时间。 |
TimeAlignment | String | 否 | start | 时间条件按照开始时间还是结束时间查询,有效值为:start、end、job_create。 |
ContactName | String | 否 | 张三 | 过滤条件,联系人名字。 |
PhoneNumber | String | 否 | 135****8888 | 过滤条件,联系人电话号码。 |
PageNumber | Integer | 是 | 1 | 分页序号。 |
PageSize | Integer | 是 | 10 | 分页大小。 |
返回数据
名称 |
类型 |
示例值 |
描述 |
HttpStatusCode | Integer | 200 | 响应码。 |
Code | String | OK | HTTP状态码。 |
Message | String | Success | 响应信息。 |
RequestId | String | 254EB995-DEDF-48A4-9101-9CA5B72FFBCC | 请求ID。 |
Success | Boolean | true | 是否成功。 |
Jobs | Object | 作业数据。 |
|
PageNumber | Integer | 1 | 分页序号。 |
PageSize | Integer | 10 | 分页大小。 |
TotalCount | Integer | 1 | 数据总数。 |
List | Array of Job | 作业数组 |
|
Status | String | Succeeded | 状态。 |
JobGroupId | String | fce6c599-8ede-40e3-9f78-0928eda7b4e8 | 任务ID。 |
ScenarioId | String | ade80092-03d9-4f4d-ad4f-ab8a247d3150 | 场景ID。 |
StrategyId | String | c8a2b7f2-ad1a-4865-b872-d0080d9802d9 | 策略ID。 |
JobId | String | fce6c599-8ede-40e3-9f78-0928eda7b4e8 | 作业ID。 |
Priority | 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 | djrq | 业务数据key |
Value | String | 2019-08-21 09:49:59.0 | 业务数据value |
Summary | Array of Summary | 对话小结。(历史字段,不再使用) |
|
SummaryName | String | score | 小结名称。 |
GroupId | String | ba1ba502-d044-48c0-b710-0f1f840a7c53 | 任务ID。 |
JobId | String | 994b8baf-7ef8-480c-b141-b7b6db77c4df | 作业ID。 |
Category | String | {} | 类别 |
TaskId | String | 9fdf7a81-6781-4ab8-92fb-1d4231ef365e | 通话ID。 |
Content | String | 5 | 内容 |
ConversationDetailId | String | 098b9b09-9223-4a8b-a422-99726f0457f3 | 通话记录ID |
SummaryId | String | dc67d544-df06-4625-ae48-13e3c9f72d8a | 摘要ID |
Tasks | Array of Task | 通话列表。 |
|
Status | String | Succeeded | 通话状态。
|
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 | SIP call ID。 |
CallingNumber | String | 0571****3106 | 主叫号码。 |
Brief | String | 1 | 总结(历史字段,不再使用) |
Duration | Integer | 120 | 通话时长。 |
TaskId | String | ff44709e-39a6-43ba-959b-20fcabe3e496 | 通话ID。 |
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"] | 主叫号码列表。 |
TagHits | Array of TagHit | 命中标签信息。 |
|
TagName | String | 有意向 | 标签名称。 |
TagGroup | String | 意向收集 | 标签组名称。 |
示例
请求示例
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<QueryJobsResponse>
<HttpStatusCode>200</HttpStatusCode>
<Code>OK</Code>
<Message>Success</Message>
<RequestId>254EB995-DEDF-48A4-9101-9CA5B72FFBCC</RequestId>
<Success>true</Success>
<Jobs>
<PageNumber>1</PageNumber>
<PageSize>10</PageSize>
<TotalCount>1</TotalCount>
<List>
<Status>Succeeded</Status>
<JobGroupId>fce6c599-8ede-40e3-9f78-0928eda7b4e8</JobGroupId>
<ScenarioId>ade80092-03d9-4f4d-ad4f-ab8a247d3150</ScenarioId>
<StrategyId>c8a2b7f2-ad1a-4865-b872-d0080d9802d9</StrategyId>
<JobId>fce6c599-8ede-40e3-9f78-0928eda7b4e8</JobId>
<Priority>1</Priority>
<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>djrq</Key>
<Value>2019-08-21 09:49:59.0</Value>
</Extras>
<Summary>
<SummaryName>score</SummaryName>
<GroupId>ba1ba502-d044-48c0-b710-0f1f840a7c53</GroupId>
<JobId>994b8baf-7ef8-480c-b141-b7b6db77c4df</JobId>
<Category>{}</Category>
<TaskId>9fdf7a81-6781-4ab8-92fb-1d4231ef365e</TaskId>
<Content>5</Content>
<ConversationDetailId>098b9b09-9223-4a8b-a422-99726f0457f3</ConversationDetailId>
<SummaryId>dc67d544-df06-4625-ae48-13e3c9f72d8a</SummaryId>
</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>
<Duration>120</Duration>
<TaskId>ff44709e-39a6-43ba-959b-20fcabe3e496</TaskId>
<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>
</List>
</Jobs>
</QueryJobsResponse>
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" : {
"PageNumber" : 1,
"PageSize" : 10,
"TotalCount" : 1,
"List" : [ {
"Status" : "Succeeded",
"JobGroupId" : "fce6c599-8ede-40e3-9f78-0928eda7b4e8",
"ScenarioId" : "ade80092-03d9-4f4d-ad4f-ab8a247d3150",
"StrategyId" : "c8a2b7f2-ad1a-4865-b872-d0080d9802d9",
"JobId" : "fce6c599-8ede-40e3-9f78-0928eda7b4e8",
"Priority" : 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" : "djrq",
"Value" : "2019-08-21 09:49:59.0"
} ],
"Summary" : [ {
"SummaryName" : "score",
"GroupId" : "ba1ba502-d044-48c0-b710-0f1f840a7c53",
"JobId" : "994b8baf-7ef8-480c-b141-b7b6db77c4df",
"Category" : "{}",
"TaskId" : "9fdf7a81-6781-4ab8-92fb-1d4231ef365e",
"Content" : "5",
"ConversationDetailId" : "098b9b09-9223-4a8b-a422-99726f0457f3",
"SummaryId" : "dc67d544-df06-4625-ae48-13e3c9f72d8a"
} ],
"Tasks" : [ {
"Status" : "Succeeded",
"PlanedTime" : 1579068424883,
"ChatbotId" : "1234",
"ActualTime" : 1579068424883,
"CalledNumber" : "135****8888",
"ScenarioId" : "ade80092-03d9-4f4d-ad4f-ab8a247d3150",
"JobId" : "b72425bd-7871-4050-838e-033d80d754b7",
"CallId" : "1528189846043",
"CallingNumber" : "0571****3106",
"Brief" : "1",
"Duration" : 120,
"TaskId" : "ff44709e-39a6-43ba-959b-20fcabe3e496",
"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\"]" ]
} ]
}
}
错误码
HttpCode |
错误码 |
错误信息 |
描述 |
400 | InvalidParameter | The specified parameter %s is invalid. | 参数值校验不通过。请使用请求参数构造规范化的请求字符串。 |
404 | NotExist.Instance | The specified Instance does not exist. | 指定的实例不存在。 |
404 | NotExist.JobGroup | The specified JobGroup does not exist. | 指定的任务组不存在。 |
500 | InternalError | An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists. | 内部错误。建议重试,如果多次重试报错请提交工单。 |
访问错误中心查看更多错误码。
文档内容是否对您有帮助?