修改智能外呼业务实例。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
Action | String | 是 | ModifyInstance | 系统规定参数。取值:ModifyInstance。 |
InstanceId | String | 是 | 90515b5-6115-4ccf-83e2-52d5bfaf2ddf | 业务实例ID。 |
InstanceName | String | 否 | 新实例 | 业务实例名字。 |
InstanceDescription | String | 否 | 这是新的实例 | 业务实例描述。 |
MaxConcurrentConversation | Integer | 是 | 5 | 最大并发。 |
CallingNumber.N | String | 否 | 1********** | 主叫号码。 |
返回数据
名称 |
类型 |
示例值 |
描述 |
HttpStatusCode | Integer | 200 | HTTP状态码。 |
Code | String | OK | 状态码。 |
Message | String | Success | 接口提示消息。 |
RequestId | String | 254EB995-DEDF-48A4-9101-9CA5B72FFBCC | 请求ID。 |
Success | Boolean | true | 是否成功。 |
Instance | Object | 业务实例信息。 |
|
CreationTime | Long | 1578469042851 | 创建时间。 |
InstanceName | String | 第一个实例 | 业务实例名字 |
CreatorName | String | xxx | 创建者名字。 |
MaxConcurrentConversation | Integer | 5 | 最大并发。 |
OwnerName | String | xxx | 所有者名字。 |
CreatorId | Long | 123123 | 创建者ID。 |
InstanceId | String | 90515b5-6115-4ccf-83e2-52d5bfaf2ddf | 业务实例ID。 |
InstanceDescription | String | 这是第一个实例 | 业务实例描述。 |
示例
请求示例
http(s)://[Endpoint]/?Action=ModifyInstance
&InstanceId=90515b5-6115-4ccf-83e2-52d5bfaf2ddf
&InstanceName=新实例
&InstanceDescription=这是新的实例
&MaxConcurrentConversation=5
&CallingNumber=["1**********"]
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<ModifyInstanceResponse>
<HttpStatusCode>200</HttpStatusCode>
<Code>OK</Code>
<Message>Success</Message>
<RequestId>254EB995-DEDF-48A4-9101-9CA5B72FFBCC</RequestId>
<Success>true</Success>
<Instance>
<CreationTime>1578469042851</CreationTime>
<InstanceName>第一个实例</InstanceName>
<CreatorName>xxx</CreatorName>
<MaxConcurrentConversation>5</MaxConcurrentConversation>
<OwnerName>xxx</OwnerName>
<CreatorId>123123</CreatorId>
<InstanceId>90515b5-6115-4ccf-83e2-52d5bfaf2ddf</InstanceId>
<InstanceDescription>这是第一个实例</InstanceDescription>
</Instance>
</ModifyInstanceResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"HttpStatusCode" : 200,
"Code" : "OK",
"Message" : "Success",
"RequestId" : "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
"Success" : true,
"Instance" : {
"CreationTime" : 1578469042851,
"InstanceName" : "第一个实例",
"CreatorName" : "xxx",
"MaxConcurrentConversation" : 5,
"OwnerName" : "xxx",
"CreatorId" : 123123,
"InstanceId" : "90515b5-6115-4ccf-83e2-52d5bfaf2ddf",
"InstanceDescription" : "这是第一个实例"
}
}
错误码
HttpCode |
错误码 |
错误信息 |
描述 |
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. | 指定的实例不存在。 |
500 | InternalError | An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists. | 内部错误。建议重试,如果多次重试报错请提交工单。 |
访问错误中心查看更多错误码。
文档内容是否对您有帮助?