Provide feedback.

Create a feedback event with the full and updated summary. Each event is associated with a specific summary id.

The event must contain the final summary, in the form of text.

POST /autosummary/v1/feedback/free-text-summaries/{conversationId}

Provide feedback.

cURL

curl --request POST \
  --url https://api.sandbox.asapp.com/autosummary/v1/feedback/free-text-summaries/{conversationId} \
  --header 'Content-Type: application/json' \
  --header 'asapp-api-id: <api-key>' \
  --header 'asapp-api-secret: <api-key>' \
  --data '
{
  "externalConversationId": "01GCS2XA9447BCQANJF2SXXVA0",
  "summaryId": "0083d936-ff70-49fc-ac19-74f1246d8b27",
  "summaryText": "The customer has issues with his symmetric internet service.\nThe customer explained the service has not enough bandwidth.\nThe customer explained the service has not enough bandwidth.\nThe agent explained how to run a diagnosis.\nThe customer ran the diagnosis.\n"
}
'

import requests

url = "https://api.sandbox.asapp.com/autosummary/v1/feedback/free-text-summaries/{conversationId}"

payload = {
    "externalConversationId": "01GCS2XA9447BCQANJF2SXXVA0",
    "summaryId": "0083d936-ff70-49fc-ac19-74f1246d8b27",
    "summaryText": "The customer has issues with his symmetric internet service.
The customer explained the service has not enough bandwidth.
The customer explained the service has not enough bandwidth.
The agent explained how to run a diagnosis.
The customer ran the diagnosis.
"
}
headers = {
    "asapp-api-id": "<api-key>",
    "asapp-api-secret": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'asapp-api-id': '<api-key>',
    'asapp-api-secret': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    externalConversationId: '01GCS2XA9447BCQANJF2SXXVA0',
    summaryId: '0083d936-ff70-49fc-ac19-74f1246d8b27',
    summaryText: 'The customer has issues with his symmetric internet service.\nThe customer explained the service has not enough bandwidth.\nThe customer explained the service has not enough bandwidth.\nThe agent explained how to run a diagnosis.\nThe customer ran the diagnosis.\n'
  })
};

fetch('https://api.sandbox.asapp.com/autosummary/v1/feedback/free-text-summaries/{conversationId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.asapp.com/autosummary/v1/feedback/free-text-summaries/{conversationId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'externalConversationId' => '01GCS2XA9447BCQANJF2SXXVA0',
    'summaryId' => '0083d936-ff70-49fc-ac19-74f1246d8b27',
    'summaryText' => 'The customer has issues with his symmetric internet service.
The customer explained the service has not enough bandwidth.
The customer explained the service has not enough bandwidth.
The agent explained how to run a diagnosis.
The customer ran the diagnosis.
'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "asapp-api-id: <api-key>",
    "asapp-api-secret: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.asapp.com/autosummary/v1/feedback/free-text-summaries/{conversationId}"

	payload := strings.NewReader("{\n  \"externalConversationId\": \"01GCS2XA9447BCQANJF2SXXVA0\",\n  \"summaryId\": \"0083d936-ff70-49fc-ac19-74f1246d8b27\",\n  \"summaryText\": \"The customer has issues with his symmetric internet service.\\nThe customer explained the service has not enough bandwidth.\\nThe customer explained the service has not enough bandwidth.\\nThe agent explained how to run a diagnosis.\\nThe customer ran the diagnosis.\\n\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("asapp-api-id", "<api-key>")
	req.Header.Add("asapp-api-secret", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sandbox.asapp.com/autosummary/v1/feedback/free-text-summaries/{conversationId}")
  .header("asapp-api-id", "<api-key>")
  .header("asapp-api-secret", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"externalConversationId\": \"01GCS2XA9447BCQANJF2SXXVA0\",\n  \"summaryId\": \"0083d936-ff70-49fc-ac19-74f1246d8b27\",\n  \"summaryText\": \"The customer has issues with his symmetric internet service.\\nThe customer explained the service has not enough bandwidth.\\nThe customer explained the service has not enough bandwidth.\\nThe agent explained how to run a diagnosis.\\nThe customer ran the diagnosis.\\n\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.asapp.com/autosummary/v1/feedback/free-text-summaries/{conversationId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["asapp-api-id"] = '<api-key>'
request["asapp-api-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"externalConversationId\": \"01GCS2XA9447BCQANJF2SXXVA0\",\n  \"summaryId\": \"0083d936-ff70-49fc-ac19-74f1246d8b27\",\n  \"summaryText\": \"The customer has issues with his symmetric internet service.\\nThe customer explained the service has not enough bandwidth.\\nThe customer explained the service has not enough bandwidth.\\nThe agent explained how to run a diagnosis.\\nThe customer ran the diagnosis.\\n\"\n}"

response = http.request(request)
puts response.read_body

400

{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "400-01",
    "message": "Bad request"
  }
}

{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "401-01",
    "message": "Unauthorized"
  }
}

{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "403-01",
    "message": "Forbidden Response"
  }
}

{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "404-01",
    "message": "Not Found"
  }
}

{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "409-01",
    "message": "Conflict"
  }
}

{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "413-01",
    "message": "Request Entity Too Large"
  }
}

{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "422-01",
    "message": "Unprocessable Entity"
  }
}

{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "429-01",
    "message": "Too Many Requests"
  }
}

{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "503-01",
    "message": "Service Unavailable"
  }
}

{
  "error": {
    "requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
    "code": "500-01",
    "message": "Internal server error"
  }
}

Authorizations

asapp-api-id · string · header · required

asapp-api-secret · string · header · required

Path Parameters

conversationId · string · required

The identifier for a conversation.

Pattern: ^[A-Z0-9]+$

Query Parameters

agentExternalId · string

Your unique identifier for the agent.

Body

application/json

Information regarding the updated free-text summary. It must contain the full updated summary as a string.

summaryId · string · required

The identifier of the summary you are providing feedback on.

summaryText · string · required

The full text of the final summary.

externalConversationId · string

Your unique identifier for the conversation. This must match to the externalConversationId you used in the Conversations API.

Response

202

Successfully accepted a feedback event for the summary.