# Get Call Log GET https://services.leadconnectorhq.com/voice-ai/dashboard/call-logs/{callId} Returns a call log by callId. ## Authentication Send `Authorization: Bearer ` using: - **Sub-Account token: OAuth access token or Private Integration Token.** Scopes: `voice-ai-dashboard.readonly` ## Parameters ### Header Parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `Version` | string | Yes | API Version | ### Path Parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `callId` | string | Yes | Call ID | ### Query Parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `locationId` | string | Yes | Location ID | ## OpenAPI Specification ```json { "openapi": "3.0.0", "info": { "title": "LeadConnector API", "version": "v3" }, "servers": [ { "url": "https://services.leadconnectorhq.com" } ], "paths": { "/voice-ai/dashboard/call-logs/{callId}": { "get": { "summary": "Get Call Log", "operationId": "getCallLog", "description": "Returns a call log by callId.", "parameters": [ { "name": "Version", "in": "header", "description": "API Version", "required": true, "schema": { "type": "string", "enum": [ "v3" ] } }, { "name": "callId", "required": true, "in": "path", "description": "Call ID", "schema": { "example": "507f1f77bcf86cd799439011", "type": "string" } }, { "name": "locationId", "required": true, "in": "query", "description": "Location ID", "schema": { "example": "LOC123456789ABCDEF", "type": "string" } } ], "responses": { "200": { "description": "Successfully retrieved call log", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallLogDTO" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestDTO" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedDTO" } } } } }, "security": [ { "bearer": [ "voice-ai-dashboard.readonly" ] } ] } } }, "components": { "securitySchemes": { "bearer": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.", "type": "http" }, "Location-Access": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.", "type": "http" }, "Location-Access-Only": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Sub-Account.", "type": "http" }, "Agency-Access": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Agency (OR) Private Integration Token of Agency.", "type": "http" }, "Agency-Access-Only": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Agency.", "type": "http" } }, "schemas": { "CallLogDTO": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the call", "example": "507f1f77bcf86cd799439011" }, "contactId": { "type": "string", "description": "Associated contact ID", "example": "507f1f77bcf86cd799439012" }, "agentId": { "type": "string", "description": "Agent ID associated with the call", "example": "507f1f77bcf86cd799439013" }, "isAgentDeleted": { "type": "boolean", "description": "Whether the agent is deleted", "example": false }, "fromNumber": { "type": "string", "description": "Caller phone number", "example": "+1234567890" }, "createdAt": { "format": "date-time", "type": "string", "description": "Timestamp when the call was created", "example": "2024-01-15T10:30:00.000Z" }, "duration": { "type": "number", "description": "Call duration in seconds", "example": 180 }, "trialCall": { "type": "boolean", "description": "Whether this call was a trial call", "example": false }, "executedCallActions": { "description": "Actions performed during the call. Note: The APPOINTMENT_BOOKING action will only be visible in executedCallActions from Sep 9th 2025.", "example": [ { "actionId": "507f1f77bcf86cd799439015", "actionType": "CALL_TRANSFER", "actionName": "Transfer to Manager", "actionParameters": { "transferToType": "number", "transferToValue": "+12345678901", "triggerMessage": "Let me transfer you to a manager right away", "hearWhisperMessage": true }, "executedAt": "2024-01-15T10:32:00.000Z", "triggerReceivedAt": "2024-01-15T10:31:45.000Z" }, { "actionId": "507f1f77bcf86cd799439016", "actionType": "SMS", "actionName": "Send Confirmation SMS", "actionParameters": { "triggerPrompt": "When caller asks for booking confirmation", "triggerMessage": "I'll send you a confirmation text", "messageBody": "Your appointment is confirmed for tomorrow at 2 PM" }, "executedAt": "2024-01-15T10:33:30.000Z", "triggerReceivedAt": "2024-01-15T10:33:15.000Z" }, { "actionId": "507f1f77bcf86cd799439017", "actionType": "DATA_EXTRACTION", "actionName": "Extract Phone Number", "actionParameters": { "contactFieldId": "507f1f77bcf86cd799439018", "description": "Customer's phone number", "examples": [ "+1234567890", "+9876543210" ], "overwriteExistingValue": false }, "executedAt": "2024-01-15T10:34:15.000Z", "triggerReceivedAt": "2024-01-15T10:34:00.000Z" }, { "actionId": "507f1f77bcf86cd799439019", "actionType": "WORKFLOW_TRIGGER", "actionName": "Start Follow-up Workflow", "actionParameters": { "triggerPrompt": "When caller requests a quote", "triggerMessage": "Let me start that process for you", "workflowId": "507f1f77bcf86cd799439020" }, "executedAt": "2024-01-15T10:35:00.000Z", "triggerReceivedAt": "2024-01-15T10:34:45.000Z" }, { "actionId": "507f1f77bcf86cd799439021", "actionType": "APPOINTMENT_BOOKING", "actionName": "Book Consultation", "actionParameters": { "calendarId": "507f1f77bcf86cd799439022", "daysOfOfferingDates": 3, "slotsPerDay": 3, "hoursBetweenSlots": 1 }, "executedAt": "2024-01-15T10:36:45.000Z", "triggerReceivedAt": "2024-01-15T10:36:30.000Z" }, { "actionId": "507f1f77bcf86cd799439023", "actionType": "CUSTOM_ACTION", "actionName": "Check Order Status", "actionParameters": { "triggerPrompt": "When caller provides order number", "triggerMessage": "Let me check that order status", "apiDetails": { "url": "https://api.example.com/orders", "method": "GET", "authenticationRequired": true, "authenticationValue": "token123", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "parameters": [ { "name": "orderId", "description": "Order ID to look up", "type": "string", "example": "ORD-12345" } ] }, "responsePathsToExtract": [ "data.orderId", "status" ] }, "executedAt": "2024-01-15T10:37:20.000Z", "triggerReceivedAt": "2024-01-15T10:37:05.000Z" }, { "actionId": "507f1f77bcf86cd799439024", "actionType": "IN_CALL_DATA_EXTRACTION", "actionName": "Extract Email During Call", "actionParameters": { "contactFieldId": "507f1f77bcf86cd799439025", "description": "Customer's email address", "examples": [ "john@example.com", "jane@company.com" ], "overwriteExistingValue": true }, "executedAt": "2024-01-15T10:31:45.000Z", "triggerReceivedAt": "2024-01-15T10:31:30.000Z" }, { "actionId": "507f1f77bcf86cd799439026", "actionType": "KNOWLEDGE_BASE", "actionName": "Query Product Info", "actionParameters": { "triggerPrompt": "When caller asks about pricing", "triggerMessage": "Let me look that up for you", "knowledgeBaseId": "507f1f77bcf86cd799439027", "parameters": [ { "name": "category", "description": "Product category to search", "type": "string", "example": "pricing" } ] }, "executedAt": "2024-01-15T10:38:10.000Z", "triggerReceivedAt": "2024-01-15T10:37:55.000Z" } ], "type": "array", "items": { "type": "object", "properties": { "actionId": { "type": "string", "description": "Action ID reference", "example": "507f1f77bcf86cd799439015" }, "actionType": { "type": "string", "description": "Action type", "enum": [ "CALL_TRANSFER", "DATA_EXTRACTION", "IN_CALL_DATA_EXTRACTION", "WORKFLOW_TRIGGER", "SMS", "APPOINTMENT_BOOKING", "CUSTOM_ACTION", "KNOWLEDGE_BASE" ], "example": "SMS" }, "actionName": { "type": "string", "description": "Action name", "example": "Send SMS Confirmation" }, "actionParameters": { "description": "Action parameters - structure varies by actionType", "oneOf": [ { "type": "object", "properties": { "triggerPrompt": { "type": "string", "description": "When to trigger this action during the call", "example": "When the caller asks to speak to a manager" }, "transferToType": { "type": "string", "description": "Type of transfer destination (currently only \"number\" is supported)", "enum": [ "number" ], "example": "number" }, "transferToValue": { "type": "string", "description": "Phone number to transfer to. Must start with +, include country code, contain only numbers, and be 11-16 characters long (e.g., +12345678901).", "example": "+12345678901" }, "triggerMessage": { "type": "string", "description": "Message to tell the caller before transferring", "example": "Let me transfer you to a manager right away" }, "hearWhisperMessage": { "type": "boolean", "description": "Whether to play whisper message to the receiving party", "example": true } }, "required": [ "triggerPrompt", "transferToType", "transferToValue", "triggerMessage" ], "title": "CallTransferActionParameters" }, { "type": "object", "properties": { "contactFieldId": { "type": "string", "description": "ID of the contact field to be updated with the extracted data", "example": "507f1f77bcf86cd799439011" }, "description": { "type": "string", "description": "Description of what data to extract", "example": "Caller's phone number" }, "examples": { "description": "Example values to help Agent understand the expected format. At least one example is required, maximum 5 examples allowed.", "example": [ "+1234567890", "+9876543210" ], "type": "array", "items": { "type": "string" } }, "overwriteExistingValue": { "type": "boolean", "description": "Whether to overwrite existing field value if already set, default is false", "example": false, "default": false } }, "required": [ "contactFieldId", "description", "examples" ], "title": "DataExtractionActionParameters" }, { "type": "object", "properties": { "contactFieldId": { "type": "string", "description": "ID of the contact field to be updated with the extracted data", "example": "507f1f77bcf86cd799439011" }, "description": { "type": "string", "description": "Description of what data to extract", "example": "Caller's phone number" }, "examples": { "description": "Example values to help Agent understand the expected format. At least one example is required, maximum 5 examples allowed.", "example": [ "+1234567890", "+9876543210" ], "type": "array", "items": { "type": "string" } }, "overwriteExistingValue": { "type": "boolean", "description": "Whether to overwrite existing field value if already set, default is false", "example": false, "default": false } }, "required": [ "contactFieldId", "description", "examples" ], "title": "InCallDataExtractionActionParameters" }, { "type": "object", "properties": { "triggerPrompt": { "type": "string", "description": "When to trigger this workflow", "example": "When caller requests a quote" }, "triggerMessage": { "type": "string", "description": "Message to tell the caller", "example": "Let me start that process for you" }, "workflowId": { "type": "string", "description": "Workflow ID to trigger", "example": "507f1f77bcf86cd799439011" } }, "required": [ "triggerPrompt", "triggerMessage", "workflowId" ], "title": "WorkflowTriggerParameters" }, { "type": "object", "properties": { "triggerPrompt": { "type": "string", "description": "When to send the SMS", "example": "When caller asks for booking confirmation" }, "triggerMessage": { "type": "string", "description": "Message to tell the caller", "example": "I'll send you a confirmation text" }, "messageBody": { "type": "string", "description": "SMS message content to send", "example": "Your appointment is confirmed for tomorrow at 2 PM" } }, "required": [ "triggerPrompt", "triggerMessage", "messageBody" ], "title": "SMSParameters" }, { "type": "object", "properties": { "calendarId": { "type": "string", "description": "Calendar ID to book appointments in", "example": "507f1f77bcf86cd799439011" }, "daysOfOfferingDates": { "type": "number", "description": "Number of days ahead to offer booking dates", "example": 3 }, "slotsPerDay": { "type": "number", "description": "Number of available slots per day", "example": 3 }, "hoursBetweenSlots": { "type": "number", "description": "Hours between available slots", "example": 1 } }, "required": [ "calendarId", "daysOfOfferingDates", "slotsPerDay", "hoursBetweenSlots" ], "title": "AppointmentBookingActionParameters" }, { "type": "object", "properties": { "triggerPrompt": { "type": "string", "description": "When to call the custom API", "example": "When caller provides order number" }, "triggerMessage": { "type": "string", "description": "Message to tell the caller", "example": "Let me check that order status" }, "apiDetails": { "description": "API endpoint configuration", "allOf": [ { "type": "object", "properties": { "url": { "type": "string", "description": "API endpoint URL", "example": "https://api.example.com/orders" }, "method": { "type": "string", "description": "HTTP method", "example": "GET", "enum": [ "POST", "GET" ] }, "authenticationRequired": { "type": "boolean", "description": "Whether authentication is required", "example": true }, "authenticationValue": { "type": "string", "description": "Authentication token or API key (required if authenticationRequired is true)", "example": "token123" }, "headers": { "description": "HTTP headers to include", "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "HTTP header name", "example": "id" }, "value": { "type": "string", "description": "HTTP header value", "example": "1234567890" } }, "required": [ "key", "value" ], "title": "CustomActionHeaderDTO" } }, "parameters": { "description": "API parameters to send", "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Parameter name", "example": "orderId" }, "description": { "type": "string", "description": "Parameter description", "example": "Order ID to look up" }, "type": { "type": "string", "description": "Parameter type", "example": "string" }, "example": { "type": "string", "description": "Example parameter value", "example": "ORD-12345" } }, "required": [ "name" ], "title": "CustomActionParameterDTO" } } }, "required": [ "url", "method" ], "title": "CustomActionApiDetailsDTO" } ] }, "selectedPaths": { "description": "Selected response paths to extract from API response. Required: at least 1 value if the method is GET. Should be empty if the method is POST.", "example": [ "data.orderId", "status" ], "type": "array", "items": { "type": "string" } } }, "required": [ "triggerPrompt", "triggerMessage", "apiDetails" ], "title": "CustomActionParameters" }, { "type": "object", "properties": { "triggerPrompt": { "type": "string", "description": "When to query the knowledge base", "example": "When caller asks about pricing" }, "knowledgeBaseId": { "type": "string", "description": "Knowledge base ID to query", "example": "507f1f77bcf86cd799439011" } }, "required": [ "triggerPrompt", "knowledgeBaseId" ], "title": "KnowledgeBaseParameters" } ], "examples": { "callTransfer": { "summary": "Call Transfer Action Parameters", "value": { "transferToType": "number", "transferToValue": "+12345678901", "triggerMessage": "Let me transfer you to a manager right away", "hearWhisperMessage": true } }, "sms": { "summary": "SMS Action Parameters", "value": { "triggerPrompt": "When caller asks for booking confirmation", "triggerMessage": "I'll send you a confirmation text", "messageBody": "Your appointment is confirmed for tomorrow at 2 PM" } }, "dataExtraction": { "summary": "Data Extraction Action Parameters", "value": { "contactFieldId": "507f1f77bcf86cd799439011", "description": "Customer's email address", "examples": [ "john@example.com", "jane@company.com" ], "overwriteExistingValue": false } }, "workflowTrigger": { "summary": "Workflow Trigger Action Parameters", "value": { "triggerPrompt": "When caller requests a quote", "triggerMessage": "Let me start that process for you", "workflowId": "507f1f77bcf86cd799439020" } }, "appointmentBooking": { "summary": "Appointment Booking Action Parameters", "value": { "calendarId": "507f1f77bcf86cd799439022", "daysOfOfferingDates": 3, "slotsPerDay": 3, "hoursBetweenSlots": 1 } }, "customAction": { "summary": "Custom Action Parameters", "value": { "triggerPrompt": "When caller provides order number", "triggerMessage": "Let me check that order status", "apiDetails": { "url": "https://api.example.com/orders", "method": "GET", "authenticationRequired": true, "authenticationValue": "token123", "parameters": [ { "name": "orderId", "description": "Order ID to look up", "type": "string", "example": "ORD-12345" } ] }, "responsePathsToExtract": [ "data.orderId", "status" ] } }, "knowledgeBase": { "summary": "Knowledge Base Action Parameters", "value": { "triggerPrompt": "When caller asks about pricing", "triggerMessage": "Let me look that up for you", "knowledgeBaseId": "507f1f77bcf86cd799439027", "parameters": [ { "name": "category", "description": "Product category to search", "type": "string", "example": "pricing" } ] } } } }, "executedAt": { "format": "date-time", "type": "string", "description": "When the action was executed", "example": "2024-01-15T10:32:00.000Z" }, "triggerReceivedAt": { "format": "date-time", "type": "string", "description": "When the trigger was received", "example": "2024-01-15T10:31:45.000Z" } }, "required": [ "actionType", "actionName" ], "title": "CallActionSchema" } }, "summary": { "type": "string", "description": "Call summary", "example": "Customer called to inquire about product pricing and was transferred to sales team." }, "transcript": { "type": "string", "description": "Call transcript", "example": "bot: Hello, how can I help you today?\nhuman: I would like to know about your pricing..." }, "translation": { "description": "Transcript translation details", "example": { "translatedTranscript": "Translated version of the call transcript" }, "allOf": [ { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether translation is enabled", "example": false }, "language": { "type": "string", "description": "Translation language code", "example": "es" } }, "title": "TranslationSchema" } ] }, "extractedData": { "description": "Dynamic data extracted from the call based on agent configuration", "example": { "phoneNumber": "+1234567890", "customerName": "John Doe", "email": "john.doe@example.com", "companyName": "Acme Corp", "customField1": "Custom value", "customField2": "Another value" }, "additionalProperties": true, "allOf": [ { "type": "object", "properties": {}, "title": "ExtractedDataSchema" } ] }, "messageId": { "type": "string", "description": "Message identifier associated with the call", "example": "507f1f77bcf86cd799439014" } }, "required": [ "id", "agentId", "isAgentDeleted", "createdAt", "duration", "trialCall", "executedCallActions", "summary", "transcript" ], "title": "CallLogDTO" }, "BadRequestDTO": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "message": { "type": "string", "example": "Bad Request" } }, "title": "BadRequestDTO" }, "UnauthorizedDTO": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "message": { "type": "string", "example": "Invalid token: access token is invalid" }, "error": { "type": "string", "example": "Unauthorized" } }, "title": "UnauthorizedDTO" } } } } ``` ## Code Examples **cURL** ```bash curl -L -X GET 'https://services.leadconnectorhq.com/voice-ai/dashboard/call-logs/?locationId=' \ -H 'Authorization: Bearer ' \ -H 'Version: v3' ``` **Node.js** ```javascript const options = { method: 'GET', headers: { Authorization: 'Bearer ', Version: 'v3' } }; try { const response = await fetch('https://services.leadconnectorhq.com/voice-ai/dashboard/call-logs/?locationId=', options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` **Python** ```python import requests url = "https://services.leadconnectorhq.com/voice-ai/dashboard/call-logs/{callId}" headers = { "Authorization": "Bearer ", "Version": "v3" } params = { "locationId": "" } response = requests.get(url, params=params, headers=headers) print(response.json()) ``` **PHP** ```php 'https://services.leadconnectorhq.com/voice-ai/dashboard/call-logs/?locationId=', CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'GET', CURLOPT_HTTPHEADER => [ 'Authorization: Bearer ', 'Version: v3', ], ]); $response = curl_exec($curl); curl_close($curl); echo $response; ``` **Java** ```java HttpResponse response = Unirest .get("https://services.leadconnectorhq.com/voice-ai/dashboard/call-logs/?locationId=") .header("Authorization", "Bearer ") .header("Version", "v3") .asString(); ``` **Go** ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://services.leadconnectorhq.com/voice-ai/dashboard/call-logs/?locationId=" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Version", "v3") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(string(body)) } ``` **Ruby** ```ruby require 'uri' require 'net/http' url = URI("https://services.leadconnectorhq.com/voice-ai/dashboard/call-logs/?locationId=") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = "Bearer " request["Version"] = "v3" response = http.request(request) puts response.read_body ``` **PowerShell** ```powershell $headers = @{ "Authorization" = "Bearer " "Version" = "v3" } $response = Invoke-RestMethod -Uri 'https://services.leadconnectorhq.com/voice-ai/dashboard/call-logs/?locationId=' -Method 'GET' -Headers $headers $response | ConvertTo-Json ```