創建一個智能外呼業務實例。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數
名稱 |
類型 |
是否必選 |
示例值 |
描述 |
Action | String | 是 | CreateInstance | 系統規定參數。取值:CreateInstance。 |
InstanceName | String | 是 | 第一個實例 | 實例名字。 |
InstanceDescription | String | 否 | 這個是第一的實例 | 實例描述。 |
MaxConcurrentConversation | Integer | 是 | 4 | 實例最大并發。 |
NluServiceType | String | 否 | Provided | 服務類型。
|
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. | 內部錯誤。建議重試,如果多次重試報錯請提交工單。 |
訪問錯誤中心查看更多錯誤碼。
文檔內容是否對您有幫助?