DocsICP FilingConsole
Documentation

CreateInstance

Updated at:
Copy as MD
Product
My Favorites

Creates an outbound call instance.

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

create

*All Resource

*

 None None

Request parameters

Parameter

Type

Required

Description

Example
InstanceName

string

Yes

The name of the instance.

第一个实例
InstanceDescription

string

No

The description of the instance.

这个是第一的实例
MaxConcurrentConversation

integer

Yes

The maximum number of concurrent conversations for the instance.

Valid values:

  • 14 :

    14

4
NluServiceType

string

No

The service type.

Note

If you do not specify this parameter, the default value is Managed.

  • DialogStudio: Conversation Engine 3.0.

  • Authorized: A chatbot for the public cloud. This value is used when a public cloud customer purchases a private Intelligent Speech Interaction service and grants authorization. To grant authorization, go to Scenario Management, click Edit, and then select Custom Service in the Invoke Service section.

  • Provided: A chatbot for on-premises deployment.

  • Managed: The legacy outbound call canvas. This is the default public Intelligent Speech Interaction service for the outbound call product.

Valid values:

  • Authorized :

    A chatbot for the public cloud.

  • Provided :

    A chatbot for on-premises deployment.

DialogStudio
ResourceGroupId

string

No

The ID of the resource group.

Note

You can call the ListResourceGroups operation to obtain this ID. For more information, see the Resource Management documentation at https://api.aliyun.com/document/ResourceManager/2020-03-31/ListResourceGroups

rg-acfmwd4qr3z773y
CallingNumber

array

No

The list of calling numbers.

Note

This parameter is optional.

string

No

A calling number.

Note

This parameter is optional.

4008013260

Response elements

Element

Type

Description

Example

object

HttpStatusCode

integer

The HTTP status code.

200
Code

string

The status code.

OK
Message

string

The message returned for the request.

无
RequestId

string

The ID of the request.

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

boolean

Indicates whether the request was successful.

true
Instance

object

The information about the instance.

CreationTime

integer

The time when the instance was created. This value is a UNIX timestamp in milliseconds.

1578469042851
InstanceId

string

The ID of the instance.

90515b5-6115-4ccf-83e2-52d5bfaf2ddf
CreatorId

integer

The ID of the user who created the instance.

435986
OwnerName

string

The name of the instance owner.

xxxx
InstanceDescription

string

The description of the instance.

这个是第一个实例
InstanceName

string

The name of the instance.

第一个实例
CreatorName

string

The name of the user who created the instance.

xxx
ResourceGroupId

string

The ID of the resource group.

90515b5-6115-4ccf-83e2-52d5bfaf2ddf
MaxConcurrentConversation

integer

The maximum number of concurrent conversations for the instance.

4

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "无",
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Success": true,
  "Instance": {
    "CreationTime": 1578469042851,
    "InstanceId": "90515b5-6115-4ccf-83e2-52d5bfaf2ddf",
    "CreatorId": 435986,
    "OwnerName": "xxxx",
    "InstanceDescription": "这个是第一个实例",
    "InstanceName": "第一个实例",
    "CreatorName": "xxx",
    "ResourceGroupId": "90515b5-6115-4ccf-83e2-52d5bfaf2ddf",
    "MaxConcurrentConversation": 4
  }
}

Error codes

HTTP status code

Error code

Error message

Description
400 InvalidInstanceName.Duplicated The specified InstanceName already exists.
400 LimitExceeded.ConcurrentConversation The maximum number of concurrent conversations is exceeded.
500 InternalError An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.