CreateTaskExportTask

Updated at:

Creates an asynchronous task to export outbound call history.

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:CreateTaskExportTask

create

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

InstanceId

string

Yes

The instance ID.

1dcb09c5-d5db-4397-bf65-db854463beea

TaskCreateTimeGte

integer

No

The start time for searching by task creation time.

1646496000000

TaskCreateTimeLte

integer

No

The end time for searching by task creation time.

1646582400000

JobGroupId

string

No

The job group ID.

cb731aee-0a5b-4c2b-924c-d9e82eb1d8d7

HasAnswered

boolean

No

Specifies whether the call was answered.

true

HasHangUpByRejection

boolean

No

Specifies whether the call was hung up due to rejection.

true

HasReachedEndOfFlow

boolean

No

Specifies whether the conversation was completed.

true

JobGroupNameQuery

string

No

The task name.

测试_20220217_160147

JobId

string

No

The job ID.

82097dd5-54df-475f-beba-eec8f4b7a3e1

CalledNumber

string

No

The called number.

11111111111

UserIdMatch

string

No

The user ID.

82097dd5-54df-475f-beba-eec8f4b7a3e1

TaskId

string

No

The task ID.

64ebe700-91b4-49cb-b457-0b7c0b598a86

ActualTimeGte

integer

No

The start time (inclusive) for searching by call time.

1646496000000

ActualTimeLte

integer

No

The end time (inclusive) for searching by call time.

1646582400000

RecordingDurationGte

integer

No

The minimum ringing duration for the search.

10

RecordingDurationLte

integer

No

The maximum ringing duration for the search.

20

PageIndex

integer

No

The page number. Pages start from 0.

0

PageSize

integer

No

The number of entries per page.

10

OtherId

string

No

The other ID.

64ebe700-91b4-49cb-b457-0b7c0b598a86

SortBy

string

No

The field by which to sort the results.

actualTime

SortOrder

string

No

The sort order. Valid values:

  • asr: ascending order

  • desc: descending order

desc

CallDurationGte

integer

No

The minimum call duration for the search.

10

CallDurationLte

integer

No

The maximum call duration for the search.

20

JobStatusStringList

string

No

The job status.

Succeeded

TaskStatusStringList

string

No

The call status.

Succeeded,Failed

ScriptNameQuery

string

No

The scenario name.

测试

CallingNumber

string

No

Response elements

Element

Type

Description

Example

object

Schema of Response

HttpStatusCode

integer

The HTTP status code.

200

RequestId

string

The request ID.

C377C5FF-4F94-1B23-89D0-50C560623EE4

Success

boolean

Indicates whether the request was successful.

true

Code

string

The status code.

OK

Message

string

The response message.

[]

TaskId

string

The export task ID.

a7d6dcff1b8b40f4a8b769a9c24e7852

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "RequestId": "C377C5FF-4F94-1B23-89D0-50C560623EE4",
  "Success": true,
  "Code": "OK",
  "Message": "[]",
  "TaskId": "a7d6dcff1b8b40f4a8b769a9c24e7852"
}

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 TaskExport.ExceedExportMaxLimit exceed export max limit 500000, Please reselect the query conditions. The number is too large, more than 500000, please re-screen and download

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.