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 response code.	OK
Message	string	The 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. Valid values: Scheduling: the job is being scheduled. Executing: the job is being executed. Succeeded: the job succeeded. Paused: the job is paused. Failed: the job failed. Cancelled: the job is cancelled. Drafted: the job is in draft state, which is a temporary state during file import.	Succeeded
ActualTime	integer	The actual execution time of the job. This parameter is deprecated.	1640068026385
Priority	integer	The job priority.	5
DsReport	string	The tag hit information of the task. This parameter is deprecated.	-
NextExecutionTime	integer	The next execution time of the task.	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, which is custom-defined by the business side. Note This is the ContactId value that was uploaded.	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 policy ID.	c8a2b7f2-ad1a-4865-b872-d0080d9802d9
EndReason	integer	The reason why the call ended. Valid values: 1: FINISHED. The call ended normally. 2: CHATBOT_HANGUP_AFTER_NOANSWER. The robot hung up after unrecognized input. 3: CHATBOT_HANGUP_AFTER_SILENCE. The robot hung up due to silence timeout. 4: CLIENT_HANGUP_AFTER_NOANSWER. The user hung up after unrecognized input. 5: CLIENT_HANGUP. The user hung up without reason. 6: TRANSFER_BY_INTENT. The call was transferred to a human agent because an intent was matched. 7: TRANSFER_AFTER_NOANSWER. The call was transferred to a human agent after unrecognized input. 8: INO_INTERACTION. No interaction from the user side. 9: ERROR. The call was interrupted due to a system error.	1
JobId	string	The job ID.	b72425bd-7871-4050-838e-033d80d754b7
Contacts	array<object>	The contact information.	[]
	object
PhoneNumber	string	The contact's phone number.	1358****8888
State	string	The status of the contact. [Deprecated]	Available
ContactId	string	The ID of the contact. This ID is generated by the system.	db3db762-e421-44c9-9a01-cb423470757c
Honorific	string	The honorific of the contact.	张先生
JobId	string	The job ID.	72dcd26b-f12d-4c27-b3af-18f6aed5b160
ContactName	string	The name of the contact.	张三
Role	string	The role of the contact. [Deprecated]	*
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-defined and passed in by the user.	[]
	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: In large model scenarios: the tag hit data after the conversation ends. In small model scenarios: the variable value data after the conversation ends.	[]
	object
SummaryName	string	The tag name.	score
Category	string	The category of the conversation summary. [Deprecated]	{}
Content	string	The tag value.	5
Tasks	array<object>	The call list.	[]
	array<object>
Status	string	The status of the task. Valid values: Note: The generic `Succeeded` status (1) is deprecated and has been replaced by more specific success statuses (20 to 31). Executing: 0 - Dialing. Succeeded: 1 - Connected. NoAnswer: 2 - Not connected: No answer. NotExist: 3 - Not connected: Invalid number. Busy: 4 - Not connected: Busy. Cancelled: 5 - Not dialed: Task stopped. Failed: 6 - Failed. NotConnected: 7 - Not connected: Unable to connect. PoweredOff: 8 - Not connected: Powered off. OutOfService: 9 - Not connected: Called number is out of service. InArrears: 10 - Not connected: Called number has an overdue payment. EmptyNumber: 11 - Not dialed: Empty number. PerDayCallCountLimit: 12 - Not dialed: Daily limit exceeded. ContactBlockList: 13 - Not dialed: Blocklisted. CallerNotRegistered: 14 - Not dialed: Calling number not registered. Terminated: 15 - Not dialed: Terminated. VerificationCancelled: 16 - Not dialed: Canceled due to pre-call verification failure. OutOfServiceNoCall: 17 - Not dialed: Called number is out of service. InArrearsNoCall: 18 - Not dialed: Called number has an overdue payment. CallingNumberNotExist: 19 - Not dialed: Calling number does not exist. SucceededFinish: 20 - Connected: Ended normally. SucceededChatbotHangUpAfterNoAnswer: 21 - Connected: Chatbot hung up after failing to recognize user intent. SucceededChatbotHangUpAfterSilence: 22 - Connected: Chatbot hung up due to a silence timeout. SucceededClientHangUpAfterNoAnswer: 23 - Connected: User hung up after the chatbot failed to recognize intent. SucceededClientHangUp: 24 - Connected: User hung up. SucceededTransferByIntent: 25 - Connected: Transferred to a human agent by intent. SucceededTransferAfterNoAnswer: 26 - Connected: Transferred to a human agent after the chatbot failed to recognize intent. SucceededInoInterAction: 27 - Connected: No user interaction. SucceededError: 28 - Connected: System error. SucceededSpecialInterceptVoiceAssistant: 29 - Connected: Special intercept - voice assistant. SucceededSpecialInterceptExtensionNumberTransfer: 30 - Connected: Special intercept - extension number transfer. SucceededSpecialInterceptCustomSpecialIntercept: 31 - Connected: Special intercept - custom. HighRiskSipCode: 32 - Not dialed: High-risk number.	SucceededTransferByIntent
PlanedTime	integer	The scheduled dial time.	1579068424883
ChatbotId	string	The ID of the chatbot used in 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 task ended.	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. [Deprecated]	1
Duration	integer	The duration of the conversation. This parameter is deprecated and its value should be ignored. Note The conversation duration is now provided in the `ActionParams` of the final object in the `Conversation` array.	120
TaskId	string	The task ID.	ff44709e-39a6-43ba-959b-20fcabe3e496
Conversation	array<object>	The conversation transcripts for the task.	[]
	array<object>
ActionParams	string	Action-specific parameters. For example, if barge-in occurs, this parameter contains details about the interrupted speech, such as the text in the `answer` field.	{}
Action	string	The action.	Broadcast
Timestamp	integer	The timestamp for this event in the conversation.	1579068424883
Speaker	string	The speaker in the conversation. `Robot` indicates the chatbot, and `Contact` indicates the contact.	Robot
Script	string	The conversation transcript.	你好，我是**客服
Summary	array<object>	The conversation summary data. [Deprecated]	[]
	object
SummaryName	string	The name of the summary.	score
Category	string	The category of the conversation summary. [Deprecated]	{}
Content	string	The content of the summary.	5
SequenceId	string	The conversation ID.	fd279983-93b9-b13b-9a34-64e5df473225
Contact	object	The contact information.	{}
PhoneNumber	string	The phone number.	1351****8888
State	string	The status of the contact. [Deprecated]	Available
ContactId	string	The ID of the contact. This ID is generated by the system.	db3db762-e421-44c9-9a01-cb423470757c
Honorific	string	The honorific of the contact.	张先生
JobId	string	The job ID. [Deprecated]	b72425bd-7871-4050-838e-033d80d754b7
ContactName	string	The name of the contact.	张三
Role	string	The role of the contact. [Deprecated]	*
ReferenceId	string	The business ID of the contact. Note This is the `ContactId` that you specified for the contact.	2fa6bac3-06da-4315-82ab-72d6fd3a6f34
HangUpDirection	string	The party that hung up. `client`: The contact. `ivr`: The chatbot.	client
RingingDuration	integer	The ringing duration.	25
SipCode	string	The SIP status code for the call task.	200
RealRingingDuration	integer	The actual ringing duration.	25
SipDuration	integer	The duration of the SIP signaling. [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 timestamp of the last script update.	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 a draft.	true
Industry	string	The industry.	金融
ScriptDescription	string	The script description.	催收话术
MiniPlaybackConfigEnabled	boolean	Indicates whether continuation speech is enabled. This parameter is deprecated and its value should be ignored.	true
IsDrafted	boolean	Indicates whether the script is a draft.	true
TtsConfig	string	The TTS configuration for the script. [Deprecated]	{\"voice\":\"xiaobei\",\"volume\":\"50\",\"speechRate\":\"-150\",\"pitchRate\":\"0\"}
DebugStatus	string	The debug status.	DRAFTED
AsrConfig	string	The ASR configuration for the script. [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.