CreateInstance - 创建业务实例

更新时间:
复制 MD 格式

创建一个智能外呼业务实例。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

outboundbot:CreateInstance

create

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

InstanceName

string

是

实例名字。

第一个实例

InstanceDescription

string

否

实例描述。

这个是第一的实例

MaxConcurrentConversation

integer

是

实例最大并发。

枚举值:

  • 14 :

    14

4

NluServiceType

string

否

服务类型。

说明

若不填入,默认为 Managed

  • DialogStudio:对话引擎 3.0。

  • Authorized:公有云版本对话机器人,公有云客户自己购买的智能语音交互产品服务(客户私有服务),通过场景管理-编辑-调用服务-自定义服务完成授权。

  • Provided:独立部署版本对话机器人。

  • Managed:旧版外呼画布,智能外呼产品默认智能语音交互产品服务(公共服务)。

枚举值:

  • DialogStudio :

    对话引擎 3.0

  • Authorized :

    公有云版本对话机器人

  • Provided :

    独立部署版本对话机器人

  • Managed :

    旧版画布

DialogStudio

ResourceGroupId

string

否

资源组 ID。

说明

可通过资源管理文档获取来源 api,相关链接:https://api.aliyun.com/document/ResourceManager/2020-03-31/ListResourceGroups

rg-acfmwd4qr3z773y

CallingNumber

array

否

主叫号码列表。

说明

默认不填

string

否

主叫号码。

说明

默认不填

4008013260

返回参数

名称

类型

描述

示例值

object

HttpStatusCode

integer

HTTP 状态码。

200

Code

string

状态码。

OK

Message

string

接口提示信息。

无

RequestId

string

请求 ID。

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

Success

boolean

是否成功。

true

Instance

object

业务实例信息。

CreationTime

integer

创建时间,单位毫秒

1578469042851

InstanceId

string

业务实例 ID。

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

CreatorId

integer

创建者 ID。

435986

OwnerName

string

所有者名称。

xxxx

InstanceDescription

string

业务实例描述。

这个是第一个实例

InstanceName

string

业务实例名字。

第一个实例

CreatorName

string

创建者名字。

xxx

ResourceGroupId

string

资源组 ID。

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

MaxConcurrentConversation

integer

实例最大并发。

4

示例

正常返回示例

JSON格式

{
  "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
  }
}

错误码

HTTP status code

错误码

错误信息

描述

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. 内部错误。建议重试,如果多次重试报错请提交工单。

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。