DocsICP FilingConsole
Documentation
Home Page Artificial Intelligence Cloud Call Service Developer Reference API Reference (2019-10-15) API catalog Foundation model communication call task ImportTaskNumberDatas

ImportTaskNumberDatas

Updated at:
Copy as MD
Product
My Favorites

Imports callee data for a voice call task.

Operation description

  • You can call this operation to import callee data, or import callee data on the Call Task Management page by clicking Import Callee Data, downloading the template, and uploading the file.

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

  • Before calling this operation, make sure that you have a successfully created call task.

  • If you do not have a successfully created call task, create one on the Call Task Management page or by calling 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

API calls do not currently support the Excel data type. Therefore, uploading an OSS file path is currently unavailable.

123dsdfsdfsdf.xlsx
TaskId

string

Yes

The task ID.

119181071278******
PhoneNumberList

array<object>

No

If DataType is set to JSON, upload data through this field. A maximum of 1000 records can be uploaded at a time.

object

No

The data structure is as follows:

{
    "calleeNumber":"Callee number",
    "outId":"Reserved key. This field can carry an external transaction unique ID. The ID is included in the receipt content and can be used as a unique call record to associate with receipts. The maximum length is 128 characters.",
    "calledPhoneNumber.extension":"Extension number. Specify this field when the callee number is a switchboard number and a further extension needs to be dialed. If this field is empty or not specified, the system makes an outbound call to a regular number.",
    "variable1":"value",
    "variable2":"value",//Fields other than calleeNumber are passed through as variables to the outbound call link. They can be used in scenarios such as agent prompts and opening remarks. If the agent uses call variables, variable1 and variable2 represent the key of each variable, and value is the variable value.
  }
Note

View call variables on the Communication Agent Management > Details > Call Variable Configuration page. Extension number description: For batch import, include the calledPhoneNumber.extension field in the element. For single import (ImportOnePhoneNumber), the top-level Extension parameter is supported with the same effect. The Excel template has added the calledPhoneNumber.extension column. During outbound calls, the system automatically identifies this field and passes it through to the intelligent outbound call gateway, initiating the call using the switchboard number + extension number format. The agent can read the extension number through the system variable calledPhoneNumber.extension. Example of call variable configuration for an engine call task: { "calleeNumber": "Callee number", "calledPhoneNumber.extension": "122121", "outId": "", "startWordParam.variableKey1": "xxx", "promptParam.variableKey2": "xx", "bizParam.variableKey3": "xx" }

{ "calleeNumber": "0534556****", "calledPhoneNumber.extension": "12213", "outId": "CFC2F07E-F763-7C48-1A32-6EFFB6EA344E", "name": "Tom", "age": "18" } For an example of call variable configuration for an engine call task, see the description
DataType

string

Yes

The data type. Valid values:

  • EXCEL

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

Valid values:

  • EXCEL :

    Excel data.

  • JSON :

    JSON data.

JSON

Response elements

Element

Type

Description

Example

object

AccessDeniedDetail

string

The detailed reason why access was denied.

None
Message

string

The description of the status code.

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 call was successful. Valid values:

  • true: Successful.

  • false: 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.

Previous：QueryAiCallTaskDetailNext：CreateAiCallTask