修改外呼实例

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ModifyInstance

系统规定参数。取值:ModifyInstance。

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

外呼实例id

MaxConcurrentConversation Integer 5

最大并发

InstanceName String 新实例

实例名字

InstanceDescription String 这是新的实例

实例描述

返回数据

名称 类型 示例值 描述
Code String OK

接口状态码

HttpStatusCode Integer 200

http 状态码

Instance Struct

实例信息

CreationTime Long 1578469042851

创建时间

InstanceDescription String 这是第一个实例

实例描述

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

实例id

InstanceName String 第一个实例

实例名字

MaxConcurrentConversation Integer 5

最大并发

Message String Success

接口提示消息

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

请求id

Success Boolean true

是否成功

示例

请求示例

http(s)://[Endpoint]/?Action=ModifyInstance
&InstanceId=90515b5-6115-4ccf-83e2-52d5bfaf2ddf
&MaxConcurrentConversation=5
&<公共请求参数>

正常返回示例

XML 格式

<Code>OK</Code>
<HttpStatusCode>200</HttpStatusCode>
<Instance>
    <InstanceDescription>这个是新的实例</InstanceDescription>
    <creationTime>1578469042851</creationTime>
    <InstanceId>90515b5-6115-4ccf-83e2-52d5bfaf2ddf</InstanceId>
    <InstanceName>新实例</InstanceName>
    <MaxConcurrentConversation>5</MaxConcurrentConversation>
</Instance>
<requestId>254EB995-DEDF-48A4-9101-9CA5B72FFBCC</requestId>
<success>true</success>

JSON 格式

{
    "Code": "OK",
    "HttpStatusCode": 200,
    "Instance": {
        "InstanceDescription": "这个是新的实例",
        "creationTime":1578469042851,
        "InstanceId": "90515b5-6115-4ccf-83e2-52d5bfaf2ddf",
        "InstanceName": "新实例",
        "MaxConcurrentConversation": 5
    },
    "requestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
    "success": true
}

错误码

HttpCode 错误码 错误信息 描述
500 InternalError An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists. 内部错误。建议重试,如果多次重试报错请提交工单。
400 InvalidInstanceName.Duplicated The specified InstanceName already exists. 实例名称已经存在。请您更换一个名字。
400 LimitExceeded.ConcurrentConversation The maximum number of concurrent conversations is exceeded. 并发数已经超限,请重新设置。
404 NotExist.Instance The specified Instance does not exist. 指定的实例不存在。

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