Retrieve Conversation Details Endpoint

Overview

This API endpoint is designed to retrieve the details of a specific conversation, including transcriptions, agent rating, and customer confirmation status.

Endpoint Details

URL: https://oxhkwywu00.execute-api.us-east-1.amazonaws.com/production/outbound/otp/retrieveconversation/:conversationId
Method: GET
Format: JSON

Request Path Parameters

conversationId: The unique identifier for the conversation you wish to retrieve.

Headers:

Key: x-api-key
Value: [Provide your API key here]

Response:

Upon a successful request, the API will return a JSON response containing the transcription of the conversation, the agent's rating, and the customer confirmation status.

{
    "transcription": "string",
    "agentRating": "number",
    "customerConfirmation": "boolean"
}

Example:

{
    "transcription": "Thank you.",
    "agentRating": 0,
    "customerConfirmation": false
}

Code Examples:

JavaScript:

const fetch = require('node-fetch');
 
const conversationId = "[your-conversation-id]";
const apiKey = "[Provide your API key here]";
 
fetch(`https://oxhkwywu00.execute-api.us-east-1.amazonaws.com/dev/outbound/otp/retrieveconversation/${conversationId}`, {
  method: 'GET',
  headers: {
    'x-api-key': apiKey
  }
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));

Python:

import requests
 
url = "https://oxhkwywu00.execute-api.us-east-1.amazonaws.com/dev/outbound/otp/retrieveconversation/[your-conversation-id]"
headers = {
    "x-api-key": "[Provide your API key here]"
}
 
response = requests.get(url, headers=headers)
print(response.json())

cURL:

curl -X GET \
  https://oxhkwywu00.execute-api.us-east-1.amazonaws.com/dev/outbound/otp/retrieveconversation/[your-conversation-id] \
  -H 'x-api-key: [Provide your API key here]'

We hope this documentation provides clarity on how to use the "Retrieve Conversation Details" endpoint. If you have any questions or need further assistance, please don't hesitate to contact us.

Initialize outbound call