POST api/Fulfillment/Post
Request Information
URI Parameters
None.
Body Parameters
ApiAiRequestDto| Name | Description | Type | Additional information |
|---|---|---|---|
| id | string |
None. |
|
| timestamp | string |
None. |
|
| lang | string |
None. |
|
| result | ApiAiResultDto |
None. |
|
| status | ApiAiStatusDto |
None. |
|
| sessionId | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"id": "sample string 1",
"timestamp": "sample string 2",
"lang": "sample string 3",
"result": {
"source": "sample string 1",
"resolvedQuery": "sample string 2",
"speech": "sample string 3",
"action": "sample string 4",
"actionIncomplete": true,
"parameters": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
},
"contexts": [
{
"name": "sample string 1",
"lifespan": 2,
"parameters": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
}
},
{
"name": "sample string 1",
"lifespan": 2,
"parameters": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
}
}
],
"fulfillment": {
"speech": "sample string 1",
"messages": [
{
"Type": 1
},
{
"Type": 1
}
]
},
"score": 6.1,
"metadata": {
"intentId": "sample string 1",
"webhookUsed": true,
"webhookForSlotFillingUsed": "sample string 3",
"webhookResponseTime": 4,
"intentName": "sample string 5"
}
},
"status": {
"errorType": "sample string 1",
"errorId": "sample string 2",
"errorDetails": "sample string 3",
"code": 1
},
"sessionId": "sample string 4"
}
application/xml, text/xml
Sample:
<ApiAiRequestDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StudyTree.Core.Dtos.IntegrationsNs.ApiAiNs">
<id>sample string 1</id>
<lang>sample string 3</lang>
<result>
<action>sample string 4</action>
<actionIncomplete>true</actionIncomplete>
<contexts>
<ApiAiContextDto>
<lifespan>2</lifespan>
<name>sample string 1</name>
<parameters xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>sample string 1</d5p1:Key>
<d5p1:Value>sample string 2</d5p1:Value>
</d5p1:KeyValueOfstringstring>
<d5p1:KeyValueOfstringstring>
<d5p1:Key>sample string 3</d5p1:Key>
<d5p1:Value>sample string 4</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</parameters>
</ApiAiContextDto>
<ApiAiContextDto>
<lifespan>2</lifespan>
<name>sample string 1</name>
<parameters xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>sample string 1</d5p1:Key>
<d5p1:Value>sample string 2</d5p1:Value>
</d5p1:KeyValueOfstringstring>
<d5p1:KeyValueOfstringstring>
<d5p1:Key>sample string 3</d5p1:Key>
<d5p1:Value>sample string 4</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</parameters>
</ApiAiContextDto>
</contexts>
<fulfillment>
<messages xmlns:d4p1="http://schemas.datacontract.org/2004/07/StudyTree.Core.Dtos.IntegrationsNs.ApiAiNs.MessageNs">
<d4p1:ApiAiMessageDto>
<d4p1:Type>1</d4p1:Type>
</d4p1:ApiAiMessageDto>
<d4p1:ApiAiMessageDto>
<d4p1:Type>1</d4p1:Type>
</d4p1:ApiAiMessageDto>
</messages>
<speech>sample string 1</speech>
</fulfillment>
<metadata>
<intentId>sample string 1</intentId>
<intentName>sample string 5</intentName>
<webhookForSlotFillingUsed>sample string 3</webhookForSlotFillingUsed>
<webhookResponseTime>4</webhookResponseTime>
<webhookUsed>true</webhookUsed>
</metadata>
<parameters xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>sample string 1</d3p1:Key>
<d3p1:Value>sample string 2</d3p1:Value>
</d3p1:KeyValueOfstringstring>
<d3p1:KeyValueOfstringstring>
<d3p1:Key>sample string 3</d3p1:Key>
<d3p1:Value>sample string 4</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</parameters>
<resolvedQuery>sample string 2</resolvedQuery>
<score>6.1</score>
<source>sample string 1</source>
<speech>sample string 3</speech>
</result>
<sessionId>sample string 4</sessionId>
<status>
<code>1</code>
<errorDetails>sample string 3</errorDetails>
<errorId>sample string 2</errorId>
<errorType>sample string 1</errorType>
</status>
<timestamp>sample string 2</timestamp>
</ApiAiRequestDto>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |