DocsICP FilingConsole
Documentation

DescribeJobGroup

Updated at:
Copy as MD
Product
My Favorites

Retrieves data for intelligent outbound call job groups.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

outboundbot:GetJobGroup

get

*All Resource

*

 None None

Request parameters

Parameter

Type

Required

Description

Example
InstanceId

string

Yes

Instance ID.

af81a389-91f0-4157-8d82-720edd02b66a
JobGroupId

string

Yes

Job group ID.

46a9ad0c-3e11-44da-a9a7-2c21bf5ce185
BriefTypes

array

No

Filter condition. This parameter is deprecated.

string

No

Filter condition. Business result.

回访成功

Response elements

Element

Type

Description

Example

object

HttpStatusCode

integer

HTTP status code.

200
Code

string

API status code.

OK
Message

string

API message.

Success
RequestId

string

Request ID.

254EB995-DEDF-48A4-9101-9CA5B72FFBCC
Success

boolean

Indicates whether the operation succeeded.

true
JobGroup

object

Job information.

CreationTime

integer

Creation time.

1578881227404
Status

string

Job status.

Completed
JobGroupName

string

Job group name.

催收作业组
ScriptId

string

Script scenario ID.

49f00b0d-78ac-4d51-91de-a9e8e92b8470
JobGroupId

string

Job group ID.

46a9ad0c-3e11-44da-a9a7-2c21bf5ce185
ScenarioId

string

Scenario ID. This is a legacy canvas parameter. For new canvases, this value is the same as ScriptId.

fce6c599-8ede-40e3-9f78-0928eda7b4e8
JobFilePath

string

OSS file key for the uploaded job list. This parameter is deprecated.

da37319b-6c83-4268-9f19-814aed62e401/a5a9a310-b902-4674-a6e1-29975cbaa312_100.xlsx
JobGroupDescription

string

Job description.

催收作业组
JobDataParsingTaskId

string

Job list parsing task ID. This parameter is deprecated.

da37319b-6c83-4268-9f19-814aed62e401/a5a9a310-b902-4674-a6e1-29975cbaa312_100.xlsx
ScriptName

string

Script scenario name.

催收话术
ModifyTime

string

Modification time.

1578881227404
ScriptVersion

string

Script scenario version number.

49f00b0d-78ac-4d51-91de-a9e8e92b8470
CallingNumbers

array

Caller number list.

string

Caller number list.

["1****6"]
ExportProgress

object

Export progress. This field is deprecated.

Note

Get this information from the ListJobGroups API instead.

Status

string

Export status. This field is deprecated.

FINISHED
FileHttpUrl

string

File URL. This field is deprecated.

https://oss-cn-shanghai.aliyuncs.com/xx.zip
Progress

string

Export progress. This field is deprecated.

1
Progress

object

Job progress.

TotalNotAnswered

integer

This field is deprecated.

1
Status

string

Overall job execution status. This field is deprecated.

Executing
StartTime

integer

Start time of execution. This field is deprecated.

1578881227404
Failed

integer

Number of failed jobs.

0
Executing

integer

Number of jobs in execution.

2
TotalJobs

integer

Total number of jobs.

10
TotalCompleted

integer

Total number of completed jobs.

2
Duration

integer

Job execution time. This field is deprecated.

1000
Scheduling

integer

Number of jobs being scheduled.

5
Paused

integer

Number of paused jobs.

0
Cancelled

integer

Number of cancelled jobs.

0
Briefs

array<object>

Business result information. This field is deprecated.

object

Key

string

Business result name.

score
Value

string

Business result value.

5
Categories

array<object>

Statistics in key-value format. This field is deprecated.

object

Key

string

Custom statistics field name.

success
Value

string

Custom statistics value.

10
Strategy

object

Job execution strategy.

Type

string

Strategy type.

Repeatable
StrategyName

string

Strategy name.

催收策略名字
MaxAttemptsPerDay

integer

Maximum number of calls per day when the call is not answered.

2
FollowUpStrategy

string

Action to take after the execution period ends. This is a legacy parameter and is no longer used.

NONE
EndTime

integer

End time of the scheduling strategy.

1579881227404
Customized

string

Custom data for the strategy. This is a legacy parameter and is no longer used.

{}
IsTemplate

boolean

Indicates whether this is a template.

false
StartTime

integer

Start time of the strategy.

1578881227404
StrategyId

string

Strategy ID.

a2bff22c-2604-4df2-83d6-5952e2438c5a
RoutingStrategy

string

Phone number routing policy.

LocalFirst
MinAttemptInterval

integer

Minimum interval between retry attempts.

10
StrategyDescription

string

Strategy description.

催收策略
RepeatBy

string

Job repetition method.

Once
WorkingTime

array<object>

Working hours.

object

EndTime

string

End time.

12:00:00
BeginTime

string

End time

09:00:00
RepeatDays

array

Days on which the job repeats. Use with RepeatBy.

  • If the recurrence is weekly, 0 means Sunday, and 1–6 mean Monday through Saturday.

  • If the recurrence is monthly, 1–31 mean the 1st through 31st days of the month. Months without the specified day skip the job. For example, if you select the 30th, February skips it.

string

Day on which the job repeats.

[1,2,3,4,5]
Repeatable

boolean

Indicates whether this is a recurring job.

false
RecallStrategy

object

Redial strategy.

EmptyNumberIgnore

boolean

Do not dial nonexistent numbers.

false
InArrearsIgnore

boolean

Do not dial numbers with overdue payments.

false
OutOfServiceIgnore

boolean

Do not dial out-of-service numbers.

false
Result

object

Statistics. This is a legacy parameter and is no longer provided. This field is deprecated.

TimeoutHangupNum

integer

Number of calls hung up due to timeout. This field is deprecated.

1
FinishedNum

integer

Number of completed jobs. This field is deprecated.

1
NoInteractNum

integer

Number of calls with no interaction. This field is deprecated.

1
ClientHangupNum

integer

Number of calls hung up by the customer. This field is deprecated.

1
UnrecognizedNum

integer

Number of unrecognized responses. This field is deprecated.

1
RingingDuration

integer

Ringing duration.

30
Priority

string

Priority.

1
MinConcurrency

integer

Minimum concurrency.

1
FlashSmsExtras

object

Configuration parameters for flash SMS delivery. This is a JSON object that contains third-party flash SMS configuration details.

ConfigId

string

Flash SMS configuration ID.

bebe23e6e2604f50bbeb12900c07703d
TemplateId

string

Flash SMS template ID.

e080d737-5c0b-4350-b7d4-1162530579e7
RecallCallingNumbers

array

Caller number list for redials. These numbers are used only when the first call fails. If not specified, the system uses the main caller number list.

string

Caller number list for redials.

["1****6"]
ScriptNluEngine

string

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "Success",
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Success": true,
  "JobGroup": {
    "CreationTime": 1578881227404,
    "Status": "Completed",
    "JobGroupName": "催收作业组",
    "ScriptId": "49f00b0d-78ac-4d51-91de-a9e8e92b8470",
    "JobGroupId": "46a9ad0c-3e11-44da-a9a7-2c21bf5ce185",
    "ScenarioId": "fce6c599-8ede-40e3-9f78-0928eda7b4e8",
    "JobFilePath": "da37319b-6c83-4268-9f19-814aed62e401/a5a9a310-b902-4674-a6e1-29975cbaa312_100.xlsx",
    "JobGroupDescription": "催收作业组",
    "JobDataParsingTaskId": "da37319b-6c83-4268-9f19-814aed62e401/a5a9a310-b902-4674-a6e1-29975cbaa312_100.xlsx",
    "ScriptName": "催收话术",
    "ModifyTime": "1578881227404",
    "ScriptVersion": "49f00b0d-78ac-4d51-91de-a9e8e92b8470",
    "CallingNumbers": [
      "[\"1****6\"]"
    ],
    "ExportProgress": {
      "Status": "FINISHED",
      "FileHttpUrl": "https://oss-cn-shanghai.aliyuncs.com/xx.zip",
      "Progress": "1"
    },
    "Progress": {
      "TotalNotAnswered": 1,
      "Status": "Executing",
      "StartTime": 1578881227404,
      "Failed": 0,
      "Executing": 2,
      "TotalJobs": 10,
      "TotalCompleted": 2,
      "Duration": 1000,
      "Scheduling": 5,
      "Paused": 0,
      "Cancelled": 0,
      "Briefs": [
        {
          "Key": "score",
          "Value": "5"
        }
      ],
      "Categories": [
        {
          "Key": "success",
          "Value": "10"
        }
      ]
    },
    "Strategy": {
      "Type": "Repeatable",
      "StrategyName": "催收策略名字",
      "MaxAttemptsPerDay": 2,
      "FollowUpStrategy": "NONE",
      "EndTime": 1579881227404,
      "Customized": "{}",
      "IsTemplate": false,
      "StartTime": 1578881227404,
      "StrategyId": "a2bff22c-2604-4df2-83d6-5952e2438c5a",
      "RoutingStrategy": "LocalFirst",
      "MinAttemptInterval": 10,
      "StrategyDescription": "催收策略",
      "RepeatBy": "Once",
      "WorkingTime": [
        {
          "EndTime": "12:00:00",
          "BeginTime": "09:00:00"
        }
      ],
      "RepeatDays": [
        "[1,2,3,4,5]"
      ],
      "Repeatable": false
    },
    "RecallStrategy": {
      "EmptyNumberIgnore": false,
      "InArrearsIgnore": false,
      "OutOfServiceIgnore": false
    },
    "Result": {
      "TimeoutHangupNum": 1,
      "FinishedNum": 1,
      "NoInteractNum": 1,
      "ClientHangupNum": 1,
      "UnrecognizedNum": 1
    },
    "RingingDuration": 30,
    "Priority": "1",
    "MinConcurrency": 1,
    "FlashSmsExtras": {
      "ConfigId": "bebe23e6e2604f50bbeb12900c07703d",
      "TemplateId": "e080d737-5c0b-4350-b7d4-1162530579e7"
    },
    "RecallCallingNumbers": [
      "[\"1****6\"]"
    ],
    "ScriptNluEngine": ""
  }
}

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.JobGroup The specified JobGroup does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.