|
| 1 | +--- |
| 2 | +external help file: Microsoft.Rtc.Management.dll-Help.xml |
| 3 | +online version: https://learn.microsoft.com/powershell/module/teams/new-csmainlineattendantquestionanswerflowknowledgebaseJSON |
| 4 | +applicable: Microsoft Teams |
| 5 | +title: New-CsMainlineAttendantQuestionAnswerFlowKnowledgeBaseJSON |
| 6 | +author: tomkau |
| 7 | +ms.author: tomkau |
| 8 | +manager: bulenteg |
| 9 | +ms.reviewer: |
| 10 | +schema: 2.0.0 |
| 11 | +--- |
| 12 | + |
| 13 | +# New-CsMainlineAttendantQuestionAnswerFlow -KnowledgeBase JSON Example |
| 14 | + |
| 15 | +## SYNOPSIS |
| 16 | +The [New-CsMainlineAttendantQuestionAnswerFlow](./New-CsMainlineAttendantQuestionAnswerFlow.md) -Knowledge requires a path to a JSON formatted response. |
| 17 | + |
| 18 | +## SYNTAX |
| 19 | + |
| 20 | +``` |
| 21 | +[ |
| 22 | + { |
| 23 | + "address_type" : "local_file", |
| 24 | + "document_address" : "<local_address>", // provide full path to the local address |
| 25 | + "description" : "<description>" |
| 26 | + |
| 27 | + }, |
| 28 | + { |
| 29 | + "address_type" : "webpage", |
| 30 | + "document_address" : "<web_address>", // provide full path to the webpage |
| 31 | + "description" : "<description>" |
| 32 | + |
| 33 | + }, |
| 34 | + { |
| 35 | + "address_type" : "api_endpoint", |
| 36 | + "description" : "<description>", |
| 37 | + "api_specification" : { |
| 38 | + "generateAuthToken" : { // Must be specified for "bearer_token_dynamic" |
| 39 | + "endpoint" : "<endpoint>", // For example, https://www.contoso.com/home?parameter1=<parameter1>¶meter2=<parameter2> |
| 40 | + "method_type": "GET" or "PUT" or "POST", |
| 41 | + "description" : "<description>", |
| 42 | + "query_strings" : { // Description of the query string parameters in the endpoint |
| 43 | + "parameter1" : "<parameter1>", |
| 44 | + "parameter2" : "<parameter2>" |
| 45 | + }, |
| 46 | + "headers" : { |
| 47 | + "Authorization" : "Basic <constant>" or "api-key <constant>" or "Bearer <constant>", // replace <constant> with an expected value |
| 48 | + "X-API-Key" : "API-Key" // Only applicable for "api_key" auth type. |
| 49 | + }, |
| 50 | + "response" : { // Response to 200 range of codes |
| 51 | + "token" : "<token>" // this token will be used for APIs with "bearer_token_dynamic" auth type |
| 52 | + } |
| 53 | + }, |
| 54 | + "getResults1" : { |
| 55 | + "endpoint" : "<endpoint>", // For example, https://www.contoso.com/home?parameter1=<parameter1>¶meter2=<parameter2> |
| 56 | + "method_type": "GET" or "PUT" or "POST", |
| 57 | + "description" : "<description>", |
| 58 | + "query_strings" : { // Definition of the query string parameters in the endpoint |
| 59 | + "parameter1" : "<parameter1>", |
| 60 | + "parameter2" : "<parameter2>" |
| 61 | + }, |
| 62 | + "headers" : { |
| 63 | + "Authorization" : "Basic <constant>" or "api-key <constant>" or "Bearer <constant>" or "Bearer <token>", // replace <constant> with an expected value. <token> will be replaced by the response to generateAuthToken() |
| 64 | + "X-API-Key" : "API-Key" // Only applicable for "api_key" auth type. |
| 65 | + }, |
| 66 | + "body" : { // Sent as JSON payload |
| 67 | + "in_parameter1" : "<in_parameter1>", |
| 68 | + "in_parameter2" : "<in_parameter2>" |
| 69 | + }, |
| 70 | + "response" : { // Response to 200 range of codes |
| 71 | + "out_parameter1" : "<out_parameter1>", |
| 72 | + "out_parameter2" : "<out_parameter2>", |
| 73 | + "out_parameter3" : "<out_parameter3>" |
| 74 | + } |
| 75 | + }, |
| 76 | + "getResults2" : { |
| 77 | + "endpoint" : "<endpoint>", // For example, https://www.contoso.com/home?parameter1=<parameter1>¶meter2=<parameter2> |
| 78 | + "method_type": "GET" or "PUT" or "POST" |
| 79 | + "description" : "<description>", |
| 80 | + "query_strings" : { // Definition of the query string parameters in the endpoint |
| 81 | + "parameter1" : "<parameter1>", |
| 82 | + "parameter2" : "<parameter2>" |
| 83 | + }, |
| 84 | + "headers" : { |
| 85 | + "Authorization" : "Basic <constant>" or "api-key <constant>" or "Bearer <constant>" or "Bearer <token>", // replace <constant> with an expected value. <token> will be replaced by the response to generateAuthToken() |
| 86 | + "X-API-Key" : "API-Key" // Only applicable for "api_key" auth type. |
| 87 | + }, |
| 88 | + "body" : { // Sent as JSON payload |
| 89 | + "in_parameter1" : "<in_parameter1>", |
| 90 | + "in_parameter2" : "<in_parameter2>" |
| 91 | + }, |
| 92 | + "response" : { // Response to 200 range of codes |
| 93 | + "out_parameter1" : "<out_parameter1>", |
| 94 | + "out_parameter2" : "<out_parameter2>", |
| 95 | + "out_parameter3" : "<out_parameter3>" |
| 96 | + } |
| 97 | + } |
| 98 | + } |
| 99 | + } |
| 100 | +] |
| 101 | +``` |
| 102 | + |
| 103 | +## PARAMETERS |
| 104 | + |
| 105 | +### -Knowledgebase |
| 106 | +The parameters used by the Knowledgebase - see the JSON example above. |
| 107 | + |
| 108 | +```yaml |
| 109 | +Type: String |
| 110 | +Parameter Sets: (All) |
| 111 | +Aliases: |
| 112 | + |
| 113 | +Required: Yes |
| 114 | +Position: 0 |
| 115 | +Default value: None |
| 116 | +Accept pipeline input: False |
| 117 | +Accept wildcard characters: False |
| 118 | +``` |
| 119 | +
|
| 120 | +### CommonParameters |
| 121 | +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). |
| 122 | +
|
| 123 | +## INPUTS |
| 124 | +
|
| 125 | +## OUTPUTS |
| 126 | +
|
| 127 | +### Microsoft.Rtc.Management.Hosted.CallQueue.Models.CallQueue |
| 128 | +
|
| 129 | +## NOTES |
| 130 | +
|
| 131 | +## RELATED LINKS |
| 132 | +
|
| 133 | +
|
| 134 | +
|
0 commit comments