DescribeJob
Retrieves the conversation data of a job.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
outboundbot:DescribeJob |
get |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| InstanceId |
string |
Yes |
The instance ID. |
af81a389-91f0-4157-8d82-720edd02b66a |
| JobId |
string |
Yes |
The job ID. |
c8a2b7f2-ad1a-4865-b872-d0080d9802d9 |
| WithScript |
boolean |
No |
Specifies whether to return the task scenario information. |
false |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| HttpStatusCode |
integer |
The HTTP status code. |
200 |
| Code |
string |
The API status code. |
OK |
| Message |
string |
The API message. |
Success |
| RequestId |
string |
The request ID. |
254EB995-DEDF-48A4-9101-9CA5B72FFBCC |
| Success |
boolean |
Indicates whether the request is successful. |
true |
| Job |
object |
The job information. |
{} |
| Status |
string |
The job status.
|
Succeeded |
| ActualTime |
integer |
[Deprecated] The actual execution time of the job. The value is a UNIX timestamp in milliseconds. |
1640068026385 |
| Priority |
integer |
The priority of the job. |
5 |
| DsReport |
string |
[Deprecated] The tag hit status of the task. |
- |
| NextExecutionTime |
integer |
The next execution time of the task. The value is a UNIX timestamp in milliseconds. |
1640068026385 |
| FailureReason |
string |
The reason why the job failed. |
NoAnswer |
| SystemPriority |
integer |
The system priority of the job. |
1 |
| InstanceId |
string |
The instance ID. |
d5971d98-7312-4f0e-a918-a17d67133e28 |
| CalledNumber |
string |
The called number. |
137****7777 |
| ReferenceId |
string |
The business ID of the job, which is customized by the business side. Note
The value is the uploaded ContactId. |
d5971d98-7312-4f0e-a918-a17d67133e28 |
| JobGroupId |
string |
The job group ID. |
fce6c599-8ede-40e3-9f78-0928eda7b4e8 |
| ScenarioId |
string |
The scenario ID. |
ade80092-03d9-4f4d-ad4f-ab8a247d3150 |
| StrategyId |
string |
The strategy ID. |
c8a2b7f2-ad1a-4865-b872-d0080d9802d9 |
| EndReason |
integer |
[Deprecated] The completion reason. |
1 |
| JobId |
string |
The job ID. |
b72425bd-7871-4050-838e-033d80d754b7 |
| Contacts |
array<object> |
The contact information. |
[] |
|
object |
|||
| PhoneNumber |
string |
The phone number. |
1358****8888 |
| State |
string |
[Deprecated] The contact status. |
Available |
| ContactId |
string |
The contact ID. The value is generated by the system. |
db3db762-e421-44c9-9a01-cb423470757c |
| Honorific |
string |
The honorific of the contact. The value is consistent with the contact name. |
Mr. Zhang |
| JobId |
string |
The job ID. |
72dcd26b-f12d-4c27-b3af-18f6aed5b160 |
| ContactName |
string |
The name of the contact. |
Zhang San |
| Role |
string |
[Deprecated] The role of the contact. |
* |
| ReferenceId |
string |
The business ID of the contact. |
2fa6bac3-06da-4315-82ab-72d6fd3a6f34 |
| Extras |
array<object> |
The business parameters. Note
TenantId and ServiceId are generated by the system. Other parameters are custom and passed as references. |
[] |
|
object |
|||
| Key |
string |
The name of the business parameter. |
djrq |
| Value |
string |
The value of the business parameter. |
2019-08-21 09:49:59.0 |
| Summary |
array<object> |
The dialogue business tag data:
|
[] |
|
object |
|||
| SummaryName |
string |
The tag name. |
score |
| Category |
string |
[Deprecated] The dialogue summary category. This is a historical field and is no longer used. |
{} |
| Content |
string |
The tag value. |
5 |
| Tasks |
array<object> |
The call list. |
[] |
|
array<object> |
|||
| Status |
string |
The task status. Valid values: (Note: The Succeeded status has been subdivided into specific reasons. The Succeeded: 1 (connected) status is no longer displayed. Subsequent responses return specific subdivided reason types.)
|
SucceededTransferByIntent |
| PlanedTime |
integer |
The planned call time. The value is a UNIX timestamp in milliseconds. |
1579068424883 |
| ChatbotId |
string |
The ID of the chatbot for the dialogue. |
1234 |
| ActualTime |
integer |
The actual execution time. The value is a UNIX timestamp in milliseconds. |
1579068424883 |
| CalledNumber |
string |
The called number. |
135****8888 |
| EndTime |
integer |
The actual end time. The value is a UNIX timestamp in milliseconds. |
1579068424883 |
| ScenarioId |
string |
The scenario ID. |
ade80092-03d9-4f4d-ad4f-ab8a247d3150 |
| EndReason |
string |
The call completion reason. Valid values:
|
FINISHED |
| JobId |
string |
The job ID. |
b72425bd-7871-4050-838e-033d80d754b7 |
| CallId |
string |
The SIP call ID. |
1528189846043 |
| CallingNumber |
string |
The calling number. |
0571****3106 |
| Brief |
string |
The business result. This is a historical field and is no longer used. |
1 |
| Duration |
integer |
The dialogue duration. This field is not returned. Note
This data is returned in the ActionParams parameter of the last dictionary in the Conversation list. |
120 |
| TaskId |
string |
The call ID. |
ff44709e-39a6-43ba-959b-20fcabe3e496 |
| Conversation |
array<object> |
The dialogue text list of the task. |
[] |
|
array<object> |
|||
| ActionParams |
string |
The action parameters.
|
{} |
| Action |
string |
The action. |
Broadcast |
| Timestamp |
integer |
The summary creation time. The value is a UNIX timestamp in milliseconds. |
1579068424883 |
| Speaker |
string |
The speaker of the dialogue. Valid values: Robot (chatbot) and Contact (contact). |
Robot |
| Script |
string |
The dialogue text. |
Hello, I am the **customer service representative |
| Summary |
array<object> |
[Deprecated] The dialogue summary data. This is historical data and is no longer used. |
[] |
|
object |
|||
| SummaryName |
string |
The summary name. |
score |
| Category |
string |
The dialogue summary category. This is a historical field and is no longer used. |
{} |
| Content |
string |
The summary content. |
5 |
| SequenceId |
string |
The session ID. |
fd279983-93b9-b13b-9a34-64e5df473225 |
| Contact |
object |
The contact information. |
{} |
| PhoneNumber |
string |
The phone number. |
1351****8888 |
| State |
string |
[Deprecated] The contact status. |
Available |
| ContactId |
string |
The contact ID. The value is generated by the system. |
db3db762-e421-44c9-9a01-cb423470757c |
| Honorific |
string |
The honorific of the contact. The value is consistent with the contact name. |
Mr. Zhang |
| JobId |
string |
[Deprecated] The job ID. |
b72425bd-7871-4050-838e-033d80d754b7 |
| ContactName |
string |
The name of the contact. |
Zhang San |
| Role |
string |
[Deprecated] The role of the contact. |
* |
| ReferenceId |
string |
The business system ID of the contact. Note
The value is customized and uploaded by the customer through the ContactId parameter. |
2fa6bac3-06da-4315-82ab-72d6fd3a6f34 |
| HangUpDirection |
string |
The party that hung up. Valid values:
|
client |
| RingingDuration |
integer |
The ringing duration. |
25 |
| SipCode |
string |
The SIP status code of the call task. |
200 |
| RealRingingDuration |
integer |
The actual ringing duration. |
25 |
| SipDuration |
integer |
The SIP signaling duration. |
25 |
| TotalDuration |
integer |
The total call duration. |
10 |
| CallingNumbers |
array |
The list of calling numbers. |
["057126883106"] |
|
string |
The calling number. |
["0571****3106"] |
|
| Script |
object |
The script scenario. |
|
| Status |
string |
The status. Valid values:
|
DRAFTED |
| UpdateTime |
integer |
The update time. The value is a UNIX timestamp in milliseconds. |
1578881227000 |
| ChatbotId |
string |
The chatbot ID. |
chatbot-cn-EJfqqa*** |
| ScriptId |
string |
The script ID. |
810b5872-57f0-4b27-80ab-7b3f4d8a6374 |
| IsDebugDrafted |
boolean |
Indicates whether the debug version is in the draft state. |
true |
| Industry |
string |
The industry. |
Finance |
| ScriptDescription |
string |
The script description. |
Collection script |
| MiniPlaybackConfigEnabled |
boolean |
[Deprecated] Specifies whether the tone continuation feature is enabled. No value is returned. |
true |
| IsDrafted |
boolean |
Indicates whether the script is in the draft state. |
true |
| TtsConfig |
string |
[Deprecated] The TTS configuration of the script. |
{\"voice\":\"xiaobei\",\"volume\":\"50\",\"speechRate\":\"-150\",\"pitchRate\":\"0\"} |
| DebugStatus |
string |
The debug status. |
DRAFTED |
| AsrConfig |
string |
[Deprecated] The ASR configuration of the script. |
{\"AppKey\":\"3GHttnsvir1FeWWb\"} |
| Scene |
string |
The scenario. |
Collection |
| Name |
string |
The script name. |
Collection script |
Examples
Success response
JSON format
{
"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": "Mr. Zhang",
"JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5b160",
"ContactName": "Zhang San",
"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": "SucceededTransferByIntent",
"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": "Hello, I am **customer service",
"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": "Mr. Zhang",
"JobId": "b72425bd-7871-4050-838e-033d80d754b7",
"ContactName": "Zhang San",
"Role": "*",
"ReferenceId": "2fa6bac3-06da-4315-82ab-72d6fd3a6f34"
},
"HangUpDirection": "client",
"RingingDuration": 25,
"SipCode": "200",
"RealRingingDuration": 25,
"SipDuration": 25,
"TotalDuration": 10
}
],
"CallingNumbers": [
"[\"0571****3106\"]"
],
"Script": {
"Status": "DRAFTED",
"UpdateTime": 1578881227000,
"ChatbotId": "chatbot-cn-EJfqqa***",
"ScriptId": "810b5872-57f0-4b27-80ab-7b3f4d8a6374",
"IsDebugDrafted": true,
"Industry": "Finance",
"ScriptDescription": "Collection script",
"MiniPlaybackConfigEnabled": true,
"IsDrafted": true,
"TtsConfig": "{\\\"voice\\\":\\\"xiaobei\\\",\\\"volume\\\":\\\"50\\\",\\\"speechRate\\\":\\\"-150\\\",\\\"pitchRate\\\":\\\"0\\\"}",
"DebugStatus": "DRAFTED",
"AsrConfig": "{\\\"AppKey\\\":\\\"3GHttnsvir1FeWWb\\\"}",
"Scene": "Collection",
"Name": "Collection script"
}
}
}
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. | |
| 404 | NotExist.Instance | The specified Instance does not exist. | |
| 404 | NotExist.Job | The specified Job does not exist. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.