ImportTaskNumberDatas

更新时间:
复制 MD 格式

Imports callee data for a call task.

Operation description

  • You can import callee data by calling this operation. Alternatively, go to the call task management page, click Import Callee Data, download the template, and then upload your file.

  • This API operation currently supports only the JSON data type for importing callee data.

  • Ensure that you have created a call task before you call this operation.

  • To create a call task, go to the call task management page and click Create Call Task, or call the CreateAiCallTask operation.

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

OssFileName

string

No

The OSS file path. This parameter is optional.

Note

Importing data by specifying an OSS file path is not available because API calls currently support only the JSON data type.

123dsdfsdfsdf.xlsx

TaskId

string

Yes

The ID of the call task.

119181071278******

PhoneNumberList

array<object>

No

If DataType is set to JSON, you must use this parameter to upload the data. You can import up to 1,000 records per request.

object

No

The data structure is as follows:

{
    "calleeNumber":"callee number",
    "outId":"A unique external transaction ID used to associate an external record with this call. This ID is returned in the receipt message. Maximum length: 128 characters.",
    "variable1":"value",
    "variable2":"value",// When using call variables, 'variable1' and 'variable2' are example keys, and 'value' is the variable's value.
  }
Note

You can view the call variables on the communication agent management > Details > call variable configuration page. Example of call variable configuration for an engine-based call task: { "calleeNumber": "callee number", "outId": "", "startWordParam.variable key1": "xxx", "promptParam.variable key2": "xx", "bizParam.variable key3": "xx" }

{ "calleeNumber": "0534556****", "outId": "CFC2F07E-F763-7C48-1A32-6EFFB6EA344E", "name": "Tom", "age": "18" } 引擎通话任务通话变量配置示例请看描述中说明

DataType

string

Yes

The data type. Valid values:

  • EXCEL

  • JSON
    Important API calls currently support only the JSON data type.

JSON

Response elements

Element

Type

Description

Example

object

AccessDeniedDetail

string

The detailed reason why access was denied.

None

Message

string

The response message.

OK

RequestId

string

The request ID.

CFC2F07E-F763-7C48-1A32-6EFFB6EA344E

Data

integer

The import batch ID.

123497836486******

Code

string

The request status code. OK indicates that the request was successful.

OK

Success

boolean

Indicates whether the request was successful. Valid values:

  • true: The request succeeded.

  • false: The request failed.

true

Examples

Success response

JSON format

{
  "AccessDeniedDetail": "None",
  "Message": "OK",
  "RequestId": "CFC2F07E-F763-7C48-1A32-6EFFB6EA344E",
  "Data": 0,
  "Code": "OK",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.