Skip to main content
POST
/
get-call
Get call information
curl --request POST \
  --url https://app.phonely.ai/api/get-call \
  --header 'Content-Type: application/json' \
  --header 'X-Authorization: <api-key>' \
  --data '{
  "uid": "<string>",
  "agentId": "<string>",
  "callId": "<string>"
}'
[
  {
    "agentName": "<string>",
    "mentionedEmail": "<string>",
    "unansweredQuestions": [
      "<string>"
    ],
    "actionItems": [
      "<string>"
    ],
    "followUpReason": "<string>",
    "followUp": "<string>",
    "recordingUrl": "<string>",
    "dashboardUrl": "<string>",
    "purpose": "<string>",
    "sentiment": "<string>",
    "transcriptText": "<string>",
    "transcript": [
      {
        "content": "<string>",
        "role": "<string>"
      }
    ],
    "mentionedDate": "<string>",
    "businessPhoneNumber": "<string>",
    "keyPoints": [
      "<string>"
    ],
    "topic": "<string>",
    "longSummary": "<string>",
    "callId": "<string>",
    "ai_success": "<string>",
    "customerPhoneNumber": "<string>",
    "callStarted": "2023-11-07T05:31:56Z",
    "callEnded": "2023-11-07T05:31:56Z",
    "duration": 123,
    "callerName": "<string>",
    "callDirection": "<string>",
    "mentionedTime": "<string>",
    "summary": "<string>",
    "endedReason": "<string>"
  }
]
Retrieves detailed information about a specific call made to an agent.

​
Request

Method: POST
Endpoint: /api/get-call
Headers:
  • X-Authorization: Your API key (required)
  • Content-Type: application/json
Request Body: 
{
  "uid": "string",
  "agentId": "string",
  "callId": "string"
}
Parameters:
  • uid (string, required): Your user ID
  • agentId (string, required): The ID of the agent that received the call
  • callId (string, required): The ID of the call to retrieve

​
Response

Success Response (200): 
{
  "callId": "string",
  "agentName": "string",
  "businessPhoneNumber": "string",
  "callerPhoneNumber": "string",
  "startTime": "string",
  "endTime": "string",
  "duration": number,
  "status": "string",
  "transcript": "string",
  "recordingUrl": "string"
}
Error Responses:
  • 400 Bad Request: Invalid request body
  • 401 Unauthorized: Invalid or missing API key, or insufficient permissions
  • 404 Not Found: Call not found or invalid call ID
  • 500 Internal Server Error: Server error

​
Example

curl -X POST https://app.phonely.ai/api/get-call \
  -H "X-Authorization: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "uid": "user123",
    "agentId": "agent456",
    "callId": "call789"
  }'

Authorizations

​
X-Authorization
string
header
required

Body

application/json
​
uid
string
required

User ID (can be retrieved from the user settings page)

​
agentId
string
required

Agent ID (can be retrieved from the agent settings page)

​
callId
string
required

Call ID (can be retrieved from the call history page)

Response

Successful response

​
agentName
string

Name of the agent handling the call

​
mentionedEmail
string | null

Email address mentioned during the call

​
unansweredQuestions
string[]

List of questions that were not answered during the call

​
actionItems
string[]

List of action items identified during the call

​
followUpReason
string

Reason for any required follow-up

​
followUp
string

Indicator if follow-up is required

​
recordingUrl
string

URL to access the call recording

​
dashboardUrl
string

URL to access the call dashboard

​
purpose
string

Main purpose or topic of the call

​
sentiment
string

Overall sentiment of the call

​
transcriptText
string

Full text transcript of the call

​
transcript
object[]

Structured transcript of the call

​
mentionedDate
string | null

Any specific date mentioned during the call

​
businessPhoneNumber
string

Phone number of the agent

​
keyPoints
string[]

Key points or highlights from the call

​
topic
string

Main topic or category of the call

​
longSummary
string | null

Detailed summary of the call

​
callId
string

Unique identifier for the call

​
ai_success
string

Indicator of AI's success in handling the call

​
customerPhoneNumber
string

Phone number of the customer

​
callStarted
string<date-time>

Date string when the call started

​
callEnded
string<date-time>

Date string when the call ended

​
duration
number

Duration of the call in seconds

​
callerName
string

Name of the caller

​
callDirection
string

Direction of the call (inbound/outbound)

​
mentionedTime
string | null

Any specific time mentioned during the call

​
summary
string

Brief summary of the call

​
endedReason
string

Reason for the call ending

⌘I