Calls
Get Call
Calls
Get Call
GET
/
call
/
{id}
curl --request GET \
--url https://api.vapi.ai/call/{id} \
--header 'Authorization: Bearer <token>'
{
"type": "inboundPhoneCall",
"phoneCallProvider": "twilio",
"phoneCallTransport": "sip",
"status": "queued",
"endedReason": "assistant-error",
"maxDurationSeconds": 1800,
"id": "<string>",
"orgId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"startedAt": "2023-11-07T05:31:56Z",
"endedAt": "2023-11-07T05:31:56Z",
"cost": 123,
"costBreakdown": {
"transport": 123,
"stt": 123,
"llm": 123,
"tts": 123,
"vapi": 123,
"total": 123,
"llmPromptTokens": 123,
"llmCompletionTokens": 123,
"ttsCharacters": 123
},
"transcript": "<string>",
"recordingUrl": "<string>",
"stereoRecordingUrl": "<string>",
"summary": "<string>",
"messages": [
{}
],
"phoneCallProviderId": "<string>",
"phoneCallProviderBypassEnabled": true,
"phoneCallProviderDetails": {
"statusCallbackEvent": "initiated",
"machineDetection": "Enable",
"to": "<string>",
"from": "<string>",
"twiml": "<string>",
"statusCallback": "<string>",
"asyncAmd": "<string>",
"asyncAmdStatusCallback": "<string>",
"record": true
},
"webCallUrl": "<string>",
"webCallSipUri": "<string>",
"forwardedPhoneNumber": "<string>",
"assistantId": "<string>",
"assistant": {
"transcriber": {
"provider": "deepgram",
"model": "nova-2",
"language": "cs",
"keywords": [
"<string>"
]
},
"model": {
"messages": [
{
"content": "<string>",
"role": "assistant",
"function_call": {},
"tool_calls": [
{}
]
}
],
"provider": "openai",
"model": "gpt-4-1106-preview",
"fallbackModels": [
"gpt-4-0125-preview",
"gpt-4-0613"
],
"semanticCachingEnabled": true,
"temperature": 1,
"functions": [
{
"name": "<string>",
"async": true,
"description": "<string>",
"parameters": {
"type": "object",
"properties": {},
"required": [
"<string>"
]
},
"serverUrl": "<string>",
"serverUrlSecret": "<string>"
}
],
"maxTokens": 525
},
"voice": {
"provider": "azure",
"voiceId": "andrew",
"speed": 1.25
},
"forwardingPhoneNumber": null,
"recordingEnabled": true,
"endCallFunctionEnabled": false,
"dialKeypadFunctionEnabled": null,
"hipaaEnabled": false,
"clientMessages": [
"transcript",
"hang",
"function-call",
"speech-update",
"metadata",
"conversation-update"
],
"serverMessages": [
"end-of-call-report",
"status-update",
"hang",
"function-call"
],
"silenceTimeoutSeconds": 30,
"responseDelaySeconds": 0.4,
"llmRequestDelaySeconds": 0.1,
"numWordsToInterruptAssistant": 2,
"maxDurationSeconds": 1800,
"backgroundSound": "office",
"name": "<string>",
"forwardingPhoneNumbers": [
{
"number": "<string>",
"sipUri": "<string>",
"message": "<string>"
}
],
"firstMessage": "<string>",
"voicemailDetectionEnabled": true,
"voicemailMessage": "<string>",
"endCallMessage": "<string>",
"endCallPhrases": [
"<string>"
],
"metadata": {},
"serverUrl": "<string>",
"serverUrlSecret": "<string>"
},
"customerId": "<string>",
"customer": {
"number": "<string>",
"name": "<string>",
"extension": "<string>"
},
"phoneNumberId": "<string>",
"phoneNumber": {
"twilioPhoneNumber": "<string>",
"twilioAccountSid": "<string>",
"twilioAuthToken": "<string>",
"name": "<string>",
"assistantId": "<string>",
"serverUrl": "<string>",
"serverUrlSecret": "<string>"
},
"metadata": {}
}
Path Parameters
Response
200 - application/json
The response is of type object
.
Was this page helpful?
curl --request GET \
--url https://api.vapi.ai/call/{id} \
--header 'Authorization: Bearer <token>'
{
"type": "inboundPhoneCall",
"phoneCallProvider": "twilio",
"phoneCallTransport": "sip",
"status": "queued",
"endedReason": "assistant-error",
"maxDurationSeconds": 1800,
"id": "<string>",
"orgId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"startedAt": "2023-11-07T05:31:56Z",
"endedAt": "2023-11-07T05:31:56Z",
"cost": 123,
"costBreakdown": {
"transport": 123,
"stt": 123,
"llm": 123,
"tts": 123,
"vapi": 123,
"total": 123,
"llmPromptTokens": 123,
"llmCompletionTokens": 123,
"ttsCharacters": 123
},
"transcript": "<string>",
"recordingUrl": "<string>",
"stereoRecordingUrl": "<string>",
"summary": "<string>",
"messages": [
{}
],
"phoneCallProviderId": "<string>",
"phoneCallProviderBypassEnabled": true,
"phoneCallProviderDetails": {
"statusCallbackEvent": "initiated",
"machineDetection": "Enable",
"to": "<string>",
"from": "<string>",
"twiml": "<string>",
"statusCallback": "<string>",
"asyncAmd": "<string>",
"asyncAmdStatusCallback": "<string>",
"record": true
},
"webCallUrl": "<string>",
"webCallSipUri": "<string>",
"forwardedPhoneNumber": "<string>",
"assistantId": "<string>",
"assistant": {
"transcriber": {
"provider": "deepgram",
"model": "nova-2",
"language": "cs",
"keywords": [
"<string>"
]
},
"model": {
"messages": [
{
"content": "<string>",
"role": "assistant",
"function_call": {},
"tool_calls": [
{}
]
}
],
"provider": "openai",
"model": "gpt-4-1106-preview",
"fallbackModels": [
"gpt-4-0125-preview",
"gpt-4-0613"
],
"semanticCachingEnabled": true,
"temperature": 1,
"functions": [
{
"name": "<string>",
"async": true,
"description": "<string>",
"parameters": {
"type": "object",
"properties": {},
"required": [
"<string>"
]
},
"serverUrl": "<string>",
"serverUrlSecret": "<string>"
}
],
"maxTokens": 525
},
"voice": {
"provider": "azure",
"voiceId": "andrew",
"speed": 1.25
},
"forwardingPhoneNumber": null,
"recordingEnabled": true,
"endCallFunctionEnabled": false,
"dialKeypadFunctionEnabled": null,
"hipaaEnabled": false,
"clientMessages": [
"transcript",
"hang",
"function-call",
"speech-update",
"metadata",
"conversation-update"
],
"serverMessages": [
"end-of-call-report",
"status-update",
"hang",
"function-call"
],
"silenceTimeoutSeconds": 30,
"responseDelaySeconds": 0.4,
"llmRequestDelaySeconds": 0.1,
"numWordsToInterruptAssistant": 2,
"maxDurationSeconds": 1800,
"backgroundSound": "office",
"name": "<string>",
"forwardingPhoneNumbers": [
{
"number": "<string>",
"sipUri": "<string>",
"message": "<string>"
}
],
"firstMessage": "<string>",
"voicemailDetectionEnabled": true,
"voicemailMessage": "<string>",
"endCallMessage": "<string>",
"endCallPhrases": [
"<string>"
],
"metadata": {},
"serverUrl": "<string>",
"serverUrlSecret": "<string>"
},
"customerId": "<string>",
"customer": {
"number": "<string>",
"name": "<string>",
"extension": "<string>"
},
"phoneNumberId": "<string>",
"phoneNumber": {
"twilioPhoneNumber": "<string>",
"twilioAccountSid": "<string>",
"twilioAuthToken": "<string>",
"name": "<string>",
"assistantId": "<string>",
"serverUrl": "<string>",
"serverUrlSecret": "<string>"
},
"metadata": {}
}