DescribeJob-阿里云帮助中心

Returns the conversation data of a job.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

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 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 response message.	Success
RequestId	string	The request ID.	254EB995-DEDF-48A4-9101-9CA5B72FFBCC
Success	boolean	Indicates whether the request was successful.	true
Job	object	The job information.	{}
Status	string	The job status.	Succeeded
ActualTime	integer	[Deprecated] The actual execution time of the job.	1640068026385
Priority	integer	The job priority.	5
DsReport	string	[Deprecated] The tag hit information of the node.	-
NextExecutionTime	integer	The next execution time of the node.	1640068026385
FailureReason	string	The reason for the job failure.	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, custom-defined by the business side.	d5971d98-7312-4f0e-a918-a17d67133e28
JobGroupId	string	The task 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 end 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	The contact state. This parameter is deprecated.	Available
ContactId	string	The contact ID. This value is generated by the system.	db3db762-e421-44c9-9a01-cb423470757c
Honorific	string	The honorific of the contact. This value is the same as the contact name.	张先生
JobId	string	The job ID.	72dcd26b-f12d-4c27-b3af-18f6aed5b160
ContactName	string	The contact name.	张三
Role	string	The contact role. This parameter is deprecated.	*
ReferenceId	string	The business ID of the contact.	2fa6bac3-06da-4315-82ab-72d6fd3a6f34
Extras	array<object>	The business parameters.	[]
	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 conversation business tag data.	[]
	object
SummaryName	string	The tag name.	score
Category	string	The conversation summary category. This parameter is deprecated.	{}
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 returned. Instead, the specific sub-reason type is returned.) Executing: 0. The call is being made. Succeeded: 1. The call is connected. NoAnswer: 2. Not connected - no answer. NotExist: 3. Not connected - nonexistent number. Busy: 4. Not connected - busy. Cancelled: 5. Not dialed - task stopped. Failed: 6. Failed. NotConnected: 7. Not connected - unreachable. PoweredOff: 8. Not connected - powered off. OutOfService: 9. Not connected - callee out of service. InArrears: 10. Not connected - callee has overdue payment. EmptyNumber: 11. Not dialed - nonexistent number, no outbound call. PerDayCallCountLimit: 12. Not dialed - daily limit exceeded. ContactBlockList: 13. Not dialed - blacklisted. CallerNotRegistered: 14. Not dialed - caller number not registered. Terminated: 15. Not dialed - terminated. VerificationCancelled: 16. Not dialed - cancelled due to pre-call verification failure. OutOfServiceNoCall: 17. Not dialed - callee out of service, no outbound call. InArrearsNoCall: 18. Not dialed - callee has overdue payment, no outbound call. CallingNumberNotExist: 19. Not dialed - caller number does not exist. SucceededFinish: 20. Connected - ended normally. SucceededChatbotHangUpAfterNoAnswer: 21. Connected - robot hung up after unrecognized input. SucceededChatbotHangUpAfterSilence: 22. Connected - robot hung up due to silence timeout. SucceededClientHangUpAfterNoAnswer: 23. Connected - user hung up after unrecognized input. SucceededClientHangUp: 24. Connected - user hung up without reason. SucceededTransferByIntent: 25. Connected - transferred to human agent by intent match. SucceededTransferAfterNoAnswer: 26. Connected - transferred to human agent after unrecognized input. SucceededInoInterAction: 27. Connected - no interaction from user side. SucceededError: 28. Connected - interrupted due to system error. SucceededSpecialInterceptVoiceAssistant: 29. Connected - special interception by voice assistant. SucceededSpecialInterceptExtensionNumberTransfer: 30. Connected - special interception by extension number transfer. SucceededSpecialInterceptCustomSpecialIntercept: 31. Connected - special interception by custom interception. HighRiskSipCode: 32. Not dialed - high risk, no outbound call.	SucceededTransferByIntent
PlanedTime	integer	The planned call time.	1579068424883
ChatbotId	string	The chatbot ID for the conversation.	1234
ActualTime	integer	The actual execution time.	1579068424883
CalledNumber	string	The called number.	135****8888
EndTime	integer	The actual end time.	1579068424883
ScenarioId	string	The scenario ID.	ade80092-03d9-4f4d-ad4f-ab8a247d3150
EndReason	string	The reason why the call ended.	FINISHED
JobId	string	The job ID.	b72425bd-7871-4050-838e-033d80d754b7
CallId	string	SIP call id。	1528189846043
CallingNumber	string	The calling number.	0571****3106
Brief	string	The business result. This parameter is deprecated.	1
Duration	integer	The conversation duration. This field is not returned. Note This data is returned in the ActionParams parameter of the last element in the Conversation list.	120
TaskId	string	The call ID.	ff44709e-39a6-43ba-959b-20fcabe3e496
Conversation	array<object>	The conversation text list of the task.	[]
	array<object>
ActionParams	string	The action parameters. When the interruption feature is enabled, you can retrieve the text that the robot has already played back from the answer value in the robot conversation text. Example: {"abortDialogueInfo":{"abortDialogueType":"Interrupted","answer":"这是打断文本信息","sequenceId":"xxxxx"},"streamEnd":true}",	{}
Action	string	The action.	Broadcast
Timestamp	integer	The time when the summary was created.	1579068424883
Speaker	string	The speaker of the conversation. Valid values: Robot (robot) and Contact (contact).	Robot
Script	string	The conversation text.	你好，我是**客服
Summary	array<object>	The conversation summary data. This parameter is deprecated.	[]
	object
SummaryName	string	The summary name.	score
Category	string	The conversation summary category. This parameter is deprecated.	{}
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	The contact state. This parameter is deprecated.	Available
ContactId	string	The contact ID. This value is generated by the system.	db3db762-e421-44c9-9a01-cb423470757c
Honorific	string	The honorific of the contact. This value is the same as the contact name.	张先生
JobId	string	The job ID. This parameter is deprecated.	b72425bd-7871-4050-838e-033d80d754b7
ContactName	string	The contact name.	张三
Role	string	The contact role. This parameter is deprecated.	*
ReferenceId	string	The business system ID of the contact. Note This value is custom-uploaded by the customer through the ContactId parameter.	2fa6bac3-06da-4315-82ab-72d6fd3a6f34
HangUpDirection	string	The party that hung up. Valid values: client: the customer. ivr: the robot.	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. This parameter is deprecated.	25
TotalDuration	integer		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: IMPORT_FAILED : Import failed. PUBLISHED : Published. EXAMINE_IN_PROGRESS : Pending review. IMPORT_IN_PROGRESS : Importing. ROLLBACK_IN_PROGRESS : Rolling back. PUBLISH_IN_PROGRESS : Publishing. DRAFTED : Draft. INITIALIZE_IN_PROGRESS : Initializing. ROLLBACK_FAILED : Rollback failed. PUBLISH_FAILED : Publish failed. PUBLISHED_AND_EXAMINE_IN_PROGRESS : Published and pending review.	DRAFTED
UpdateTime	integer	The update time.	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 draft state.	true
Industry	string	The industry.	金融
ScriptDescription	string	The script description.	催收话术
MiniPlaybackConfigEnabled	boolean	Specifies whether the tone bridging feature is enabled. This parameter is not returned. This parameter is deprecated.	true
IsDrafted	boolean	Indicates whether the script is in draft state.	true
TtsConfig	string	The TTS configuration of the script. This parameter is deprecated.	{\"voice\":\"xiaobei\",\"volume\":\"50\",\"speechRate\":\"-150\",\"pitchRate\":\"0\"}
DebugStatus	string	The debug status.	DRAFTED
AsrConfig	string	The ASR configuration of the script. This parameter is deprecated.	{\"AppKey\":\"3GHttnsvir1FeWWb\"}
Scene	string	The scene.	催收
Name	string	The script name.	催收话术

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": "张先生",
        "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",
        "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": "你好，我是**客服",
            "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": "张先生",
          "JobId": "b72425bd-7871-4050-838e-033d80d754b7",
          "ContactName": "张三",
          "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": "金融",
      "ScriptDescription": "催收话术",
      "MiniPlaybackConfigEnabled": true,
      "IsDrafted": true,
      "TtsConfig": "{\\\"voice\\\":\\\"xiaobei\\\",\\\"volume\\\":\\\"50\\\",\\\"speechRate\\\":\\\"-150\\\",\\\"pitchRate\\\":\\\"0\\\"}",
      "DebugStatus": "DRAFTED",
      "AsrConfig": "{\\\"AppKey\\\":\\\"3GHttnsvir1FeWWb\\\"}",
      "Scene": "催收",
      "Name": "催收话术"
    }
  }
}

Error codes

HTTP status code	Error code	Error message
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.