POST
/
call
/
phone
curl --request POST \
  --url https://api.vapi.ai/call/phone \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "maxDurationSeconds": null,
  "assistantId": "<string>",
  "assistant": {
    "name": null,
    "transcriber": {
      "provider": "deepgram",
      "model": "nova-2",
      "keywords": [
        "<string>"
      ]
    },
    "model": {
      "provider": "openai",
      "model": "gpt-4",
      "systemPrompt": "<string>",
      "temperature": 1,
      "functions": [
        {
          "name": "<string>",
          "async": true,
          "description": "<string>",
          "parameters": {}
        }
      ]
    },
    "voice": {
      "provider": "11labs",
      "voiceId": "burt",
      "stability": null,
      "similarityBoost": null,
      "style": null,
      "useSpeakerBoost": null
    },
    "language": null,
    "forwardingPhoneNumber": "<string>",
    "firstMessage": "Hey there!",
    "voicemailMessage": null,
    "endCallMessage": null,
    "interruptionsEnabled": null,
    "recordingEnabled": null,
    "endCallFunctionEnabled": null,
    "fillersEnabled": null,
    "clientMessages": [
      "function-call"
    ],
    "serverMessages": [
      "end-of-call-report"
    ],
    "silenceTimeoutSeconds": null,
    "responseDelaySeconds": null
  },
  "customerId": "<string>",
  "customer": {
    "number": "<string>",
    "name": "<string>"
  },
  "phoneNumberId": "<string>",
  "phoneNumber": {
    "twilioPhoneNumber": "<string>",
    "twilioAccountSid": "<string>",
    "twilioAuthToken": "<string>",
    "name": "<string>",
    "assistantId": "<string>"
  }
}'
{
  "type": "inboundPhoneCall",
  "status": "queued",
  "endedReason": "assistant-ended-call",
  "maxDurationSeconds": null,
  "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,
  "transcript": "<string>",
  "recordingUrl": "<string>",
  "stereoRecordingUrl": "<string>",
  "summary": "<string>",
  "messages": [
    {}
  ],
  "twilioCallSid": "<string>",
  "webCallUrl": "<string>",
  "assistantId": "<string>",
  "assistant": {
    "name": null,
    "transcriber": {
      "provider": "deepgram",
      "model": "nova-2",
      "keywords": [
        "<string>"
      ]
    },
    "model": {
      "provider": "openai",
      "model": "gpt-4",
      "systemPrompt": "<string>",
      "temperature": 1,
      "functions": [
        {
          "name": "<string>",
          "async": true,
          "description": "<string>",
          "parameters": {}
        }
      ]
    },
    "voice": {
      "provider": "11labs",
      "voiceId": "burt",
      "stability": null,
      "similarityBoost": null,
      "style": null,
      "useSpeakerBoost": null
    },
    "language": null,
    "forwardingPhoneNumber": "<string>",
    "firstMessage": "Hey there!",
    "voicemailMessage": null,
    "endCallMessage": null,
    "interruptionsEnabled": null,
    "recordingEnabled": null,
    "endCallFunctionEnabled": null,
    "fillersEnabled": null,
    "clientMessages": [
      "function-call"
    ],
    "serverMessages": [
      "end-of-call-report"
    ],
    "silenceTimeoutSeconds": null,
    "responseDelaySeconds": null
  },
  "customerId": "<string>",
  "customer": {
    "number": "<string>",
    "name": "<string>"
  },
  "phoneNumberId": "<string>",
  "phoneNumber": {
    "twilioPhoneNumber": "<string>",
    "twilioAccountSid": "<string>",
    "twilioAuthToken": "<string>",
    "name": "<string>",
    "assistantId": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Retrieve your key from Dashboard.

Body

application/json

Response

201 - application/json

The response is of type object.