文档

CreateInstance

更新时间:

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

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String CreateInstance

系统规定参数。取值:CreateInstance

InstanceName String 第一个实例

实例名字。

InstanceDescription String 这个是第一的实例

实例描述。

MaxConcurrentConversation Integer 4

实例最大并发。

NluServiceType String Provided

服务类型。

  • Managed:智能外呼产品默认智能语音交互产品服务(公共服务)
  • Authorized:公有云客户自己购买的智能语音交互产品服务(客户私有服务),通过场景管理-编辑-调用服务-自定义服务完成授权
ResourceGroupId String rg-acfmwd4qr3z773y

资源组ID。

CallingNumber.N String ["4008013260"]

主叫号码。

返回数据

名称

类型

示例值

描述

HttpStatusCode Integer 200

HTTP状态码。

Code String OK

状态码。

Message String

接口提示信息。

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

请求ID。

Success Boolean true

是否成功。

Instance Object

业务实例信息。

CreationTime Long 1578469042851

创建时间,单位毫秒

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

业务实例ID。

CreatorId Long 435986

创建者ID。

OwnerName String xxxx

所有者名称。

InstanceDescription String 这个是第一个实例

业务实例描述。

InstanceName String 第一个实例

业务实例名字。

CreatorName String xxx

创建者名字。

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

资源组ID。

MaxConcurrentConversation Integer 4

实例最大并发。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateInstance
&InstanceName=第一个实例
&InstanceDescription=这个是第一的实例
&MaxConcurrentConversation=4
&NluServiceType=Provided
&ResourceGroupId=rg-acfmwd4qr3z773y
&CallingNumber=["[\"4008013260\"]"]
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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
  }
}

错误码

HttpCode

错误码

错误信息

描述

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

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