查詢智能外呼業務實例列表。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數
名稱 |
類型 |
是否必選 |
示例值 |
描述 |
Action | String | 是 | ListInstances | 系統規定參數。取值:ListInstances。 |
ResourceGroupId | String | 否 | rg-acfm3iugit3uw7a | 資源組ID。 |
Tag.N.Key | String | 否 | name | 資源組標簽Key。 |
Tag.N.Value | String | 否 | xxx | 資源組標簽值。 |
Name | String | 否 | xxx | 智能外呼實例名稱 |
PageNumber | Integer | 否 | 1 | 頁號 |
PageSize | Integer | 否 | 10 | 分頁大小 |
返回數據
名稱 |
類型 |
示例值 |
描述 |
HttpStatusCode | Integer | 200 | HTTP狀態碼。 |
Code | String | OK | 響應碼。 |
Message | String | Success | 接口提示消息。 |
RequestId | String | 254EB995-DEDF-48A4-9101-9CA5B72FFBCC | 請求ID。 |
Success | Boolean | true | 是否成功。 |
Instances | Array of Instance | 業務實例列表。 |
|
CreationTime | Long | 1578469042851 | 創建時間。 |
InstanceId | String | 90515b5-6115-4ccf-83e2-52d5bfaf2ddf | 業務實例ID。 |
OwnerName | String | xxx | 主賬號名稱。 |
CreatorId | Long | 34234 | 創建者ID。 |
InstanceDescription | String | 這是一個實例 | 智能外呼業務實例描述。 |
InstanceName | String | 回訪 | 智能外呼業務實例名稱。 |
ResourceGroupId | String | 90515b5-6115-4ccf-83e2-52d5bfaf2ddf | 資源組ID。 |
CreatorName | String | xxx | 創建者姓名。 |
MaxConcurrentConversation | Integer | 10 | 允許的最大外呼并發數量。 |
ResourceTags | Array of ResourceTag | 標簽信息。 |
|
Key | String | age | 標簽Key。 |
Value | String | 20 | 標簽值。 |
IsPreset | Boolean | false | 是否是預置實例。 |
TotalCount | Integer | 1 | 實例數量 |
PageNumber | Integer | 1 | 頁號 |
PageSize | Integer | 10 | 分頁大小 |
示例
請求示例
http(s)://[Endpoint]/?Action=ListInstances
&ResourceGroupId=rg-acfm3iugit3uw7a
&Tag=[{"Key":"name","Value":"xxx"}]
&Name=xxx
&PageNumber=1
&PageSize=10
&公共請求參數
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<ListInstancesResponse>
<HttpStatusCode>200</HttpStatusCode>
<Code>OK</Code>
<Message>Success</Message>
<RequestId>254EB995-DEDF-48A4-9101-9CA5B72FFBCC</RequestId>
<Success>true</Success>
<Instances>
<InstanceId>90515b5-6115-4ccf-83e2-52d5bfaf2ddf</InstanceId>
<OwnerName>xxx</OwnerName>
<CreatorId>34234</CreatorId>
<InstanceDescription>這是一個實例</InstanceDescription>
<InstanceName>回訪</InstanceName>
<ResourceGroupId>90515b5-6115-4ccf-83e2-52d5bfaf2ddf</ResourceGroupId>
<CreatorName>xxx</CreatorName>
<MaxConcurrentConversation>10</MaxConcurrentConversation>
<ResourceTags>
<Key>age</Key>
<Value>20</Value>
</ResourceTags>
<IsPreset>false</IsPreset>
</Instances>
<TotalCount>1</TotalCount>
<PageNumber>1</PageNumber>
<PageSize>10</PageSize>
</ListInstancesResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"HttpStatusCode" : 200,
"Code" : "OK",
"Message" : "Success",
"RequestId" : "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
"Success" : true,
"Instances" : [ {
"InstanceId" : "90515b5-6115-4ccf-83e2-52d5bfaf2ddf",
"OwnerName" : "xxx",
"CreatorId" : 34234,
"InstanceDescription" : "這是一個實例",
"InstanceName" : "回訪",
"ResourceGroupId" : "90515b5-6115-4ccf-83e2-52d5bfaf2ddf",
"CreatorName" : "xxx",
"MaxConcurrentConversation" : 10,
"ResourceTags" : [ {
"Key" : "age",
"Value" : "20"
} ],
"IsPreset" : false
} ],
"TotalCount" : 1,
"PageNumber" : 1,
"PageSize" : 10
}
錯誤碼
HttpCode |
錯誤碼 |
錯誤信息 |
描述 |
500 | InternalError | An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists. | 內部錯誤。建議重試,如果多次重試報錯請提交工單。 |
訪問錯誤中心查看更多錯誤碼。
文檔內容是否對您有幫助?