QueryJobsWithResult
Queries tasks based on task results.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
outboundbot:QueryJobsWithResult |
get |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| PageNumber |
integer |
No |
The page number. Important This parameter is required. |
1 |
| PageSize |
integer |
No |
The number of entries per page. Important This parameter is required. |
10 |
| JobGroupId |
string |
Yes |
The ID of the job group. |
ad16fc35-d824-4102-a606-2be51c1aa6dd |
| QueryText |
string |
No |
The search content. You can search by phone number. |
1882020**** |
| JobStatusFilter |
string |
No |
The job status filter. Valid values:
|
Succeeded |
| HasAnsweredFilter |
boolean |
No |
Specifies whether the call is answered. |
true |
| HasHangUpByRejectionFilter |
boolean |
No |
Specifies whether the call is hung up due to unrecognized intent. |
false |
| HasReachedEndOfFlowFilter |
boolean |
No |
Specifies whether the call flow is completed. |
true |
| InstanceId |
string |
Yes |
The instance ID. |
9d53cd72-4050-4419-8c17-acc0bf158147 |
| TaskStatusFilter |
string |
No |
The call status. Separate multiple values with commas, such as ["Executing","Succeeded"]. Valid values: (Note: The Succeeded status is subdivided into specific causes. The general Succeeded: 1 (Connected) status is not returned. All returned values are specific subdivided causes.)
|
["Executing"] |
| JobFailureReasonsFilter |
string |
No |
The list of job failure reasons. Valid values:
|
["NoAnswer"] |
| StartActualTimeFilter |
integer |
No |
The filter condition for the call start time. |
1579055782000 |
| EndActualTimeFilter |
integer |
No |
The filter condition for the call end time. |
1579055783000 |
| LabelsJson |
array |
No |
The filter condition for call labels. Note
This condition can only filter by labels that are configured with specific enumerated label values, which means labels configured with specific label values in large language model scenarios. |
|
|
string |
No |
The labels to filter and their corresponding label values. Note
Filters all calls that have a specific label and corresponding specific label values. For example, {"ValueList":["Satisfied","Unsatisfied"],"Name":"Satisfaction"} filters the information of all calls where the "Satisfaction" label has the value "Satisfied" or "Unsatisfied". |
{ "ValueList": [ "Satisfied", "Unsatisfied" ], "Name": "Satisfaction" } |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response object. |
||
| HttpStatusCode |
integer |
The HTTP status code. |
200 |
| Code |
string |
Code |
OK |
| Message |
string |
The message returned by the API. |
Success |
| RequestId |
string |
The request ID. |
9bdaa1d1-a036-4451-ab11-ca0373679091 |
| Success |
boolean |
Indicates whether the request is successful. |
true |
| VariableNames |
array |
The names of the tags to be collected. |
|
|
string |
The full set of tag keys. |
Whether the call is connected |
|
| Jobs |
object |
The jobs. |
|
| PageNumber |
integer |
The page number. |
1 |
| PageSize |
integer |
The page size. |
10 |
| PageCount |
integer |
The total number of pages. |
1 |
| RowCount |
integer |
The total number of entries. |
1 |
| List |
array<object> |
The list of jobs. |
|
|
array<object> |
The job object. |
||
| Status |
string |
The job status. Valid values:
|
Succeeded |
| StatusName |
string |
The name of the job status. |
Completed and reached |
| JobFailureReason |
string |
The reason for the job failure. |
- Unknown: Unknown error. - NoAnswer: No answer. - InvalidStrategy: Invalid strategy or incorrect strategy configuration. - TimeUp: Timeout during scheduling. - NoStrategy: Strategy is empty or not found. - CallFailed: Call failed. - PerDayCallCountLimit: Daily call count limit for the phone number reached. - ContactBlockList: Contact is on the outbound call blacklist. - EmptyNumber: Nonexistent number, no further outbound calls. - JobPerDayCallCountLimit: Daily call count limit for the phone number reached. - VerificationCancelled: Canceled due to pre-call verification failure. - ContactSuspended: Call suspended. - InArrears: Overdue payment. - OutOfService: Service suspended. - NoneRepeatableJobMaxAttemptCountLimit: Maximum retry count for the job reached. This takes effect when RepeatBy is set to None |
| Id |
string |
The job ID. |
cc231a1d-3c05-4739-8926-193ecf4097ba |
| LatestTask |
object |
The latest call. |
|
| Status |
string |
The call status. |
Succeeded |
| TaskEndReason |
string |
The call result. |
FINISHED |
| HasAnswered |
boolean |
Indicates whether the call is answered. |
true |
| CallDuration |
integer |
The call duration. |
40000 |
| HasReachedEndOfFlow |
boolean |
Specifies whether the call flow is completed. |
true |
| StatusName |
string |
The name of the call status. |
Not dialed - Daily limit exceeded |
| CallTime |
integer |
The call time. The value is a UNIX timestamp in milliseconds. |
1615363297000 |
| CallDurationDisplay |
string |
The call duration. |
40 |
| HasHangUpByRejection |
boolean |
Specifies whether the call is hung up due to unrecognized intent. |
false |
| Extras |
array<object> |
The names of the tags to be collected. |
|
|
object |
The pass-through parameter object. |
||
| Key |
string |
The tag key. |
Whether the call is connected |
| Value |
string |
The tag value. |
Yes |
| TagHits |
array<object> |
The tag hit information. This field is returned for the legacy canvas. |
|
|
object |
The tag hit object for the legacy canvas. |
||
| TagName |
string |
The tag name. |
Kitten,Kitten |
| TagGroup |
string |
The tag group to which the tag belongs. |
Animal |
| Contact |
object |
The contact. |
|
| Round |
integer |
The conversation round. |
151 |
| JobUuid |
string |
The job ID. |
cc231a1d-3c05-4739-8926-193ecf4097ba |
| PreferredPhoneNumber |
string |
The phone number specified by the callee during the conversation. If this field is specified, the system calls this number. Note
This is a custom field. You can pass it in JSON format when you call the API operation to execute the outbound call task. |
134123**** |
| PhoneNumber |
string |
The phone number of the contact. |
1882020**** |
| State |
string |
The status of the contact. Valid values: Available, WrongNumber, and DoesNotExist. Note
This is a custom field. You can pass it in JSON format when you call the API operation to execute the outbound call task. |
Available |
| Honorific |
string |
The honorific of the contact. If this field is not specified, the default value is the same as the name. Note
This is a custom field. You can pass it in JSON format when you call the API operation to execute the outbound call task. |
Mr. Zhang |
| Name |
string |
The name of the contact, such as Zhang San. |
Zhang San |
| Role |
string |
The role of the contact in the outbound call business. If this field is not specified, roles are not distinguished. For example, in debt collection scenarios, contact roles can be borrower, co-borrower, or guarantor. Note
This is a custom field. You can pass it in JSON format when you call the API operation. |
Borrower |
| Id |
string |
The contact ID. A unique identifier generated by the system when the outbound call list is uploaded. |
63860deb-6218-45df-b1e0-76f2b166e790 |
| ReferenceId |
string |
The custom contact ID uploaded by the customer. This ID must be provided by the business side to avoid duplicate names. |
C01 |
| HasLastPlaybackCompleted |
boolean |
Indicates whether the playback is completed when the call is hung up. |
true |
| DialExceptionCodes |
array<object> |
The call exception codes. |
|
|
object |
The call exception codes. |
||
| Code |
string |
The error code. |
0 |
| Hint |
string |
The error message. |
None |
| HangUpDirection |
string |
The party that hung up the call. |
Callee |
| VoiceName |
string |
The name of the voice used in this call. |
|
| Labels |
array<object> |
The tag information that can be used as filter conditions. Note
This field displays all tag information with enumeration values in the task group. |
|
|
object |
The tag object. |
||
| Name |
string |
The tag name. |
Whether satisfied |
| ValueList |
array |
The list of tag values. |
|
|
string |
The tag value. |
["No","Yes"] |
Examples
Success response
JSON format
{
"HttpStatusCode": 200,
"Code": "OK",
"Message": "Success",
"RequestId": "9bdaa1d1-a036-4451-ab11-ca0373679091",
"Success": true,
"VariableNames": [
"Is connected"
],
"Jobs": {
"PageNumber": 1,
"PageSize": 10,
"PageCount": 1,
"RowCount": 1,
"List": [
{
"Status": "Succeeded",
"StatusName": "Completed - Reached",
"JobFailureReason": "- Unknown (Unknown error)\n- NoAnswer (No answer)\n- InvalidStrategy (Invalid strategy, incorrect strategy configuration)\n- TimeUp (Timeout during scheduling)\n- NoStrategy (Strategy is empty or not found)\n- CallFailed (Call failed)\n- PerDayCallCountLimit (Daily call count limit for the phone number)\n- ContactBlockList (Outbound call blocklist)\n- EmptyNumber (Nonexistent number, no outbound calls)\n- JobPerDayCallCountLimit (Daily call count limit for the phone number)\n- VerificationCancelled (Canceled due to pre-call verification failure)\n- ContactSuspended (Call suspended)\n- InArrears (Overdue payment)\n- OutOfService (Service suspended)\n- NoneRepeatableJobMaxAttemptCountLimit (Maximum attempt count for the job, effective when RepeatBy is None)",
"Id": "cc231a1d-3c05-4739-8926-193ecf4097ba",
"LatestTask": {
"Status": "Succeeded",
"TaskEndReason": "FINISHED",
"HasAnswered": true,
"CallDuration": 40000,
"HasReachedEndOfFlow": true,
"StatusName": "Not dialed - Exceeded daily limit",
"CallTime": 1615363297000,
"CallDurationDisplay": "40",
"HasHangUpByRejection": false,
"Extras": [
{
"Key": "Is connected",
"Value": "Yes"
}
],
"TagHits": [
{
"TagName": "Kitten,Kitten",
"TagGroup": "Animal"
}
],
"Contact": {
"Round": 151,
"JobUuid": "cc231a1d-3c05-4739-8926-193ecf4097ba\n",
"PreferredPhoneNumber": "134123****",
"PhoneNumber": "1882020****",
"State": "Available",
"Honorific": "Mr. Zhang",
"Name": "Zhang San",
"Role": "Borrower",
"Id": "63860deb-6218-45df-b1e0-76f2b166e790",
"ReferenceId": "C01"
},
"HasLastPlaybackCompleted": true,
"DialExceptionCodes": [
{
"Code": "0",
"Hint": "None"
}
],
"HangUpDirection": "Callee",
"VoiceName": ""
}
}
]
},
"Labels": [
{
"Name": "Is satisfied",
"ValueList": [
"[\"No\",\"Yes\"]"
]
}
]
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 500 | InternalError | An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.