Get Phone Number

curl https://api.vapi.ai/phone-number/id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json"

{
  "provider": "byo-phone-number",
  "createdAt": "2024-01-15T09:30:00Z",
  "credentialId": "cred-abcdef1234567890",
  "id": "a1b2c3d4-e5f6-7890-abcd-1234567890ef",
  "orgId": "org-9876543210",
  "updatedAt": "2024-01-15T09:30:00Z",
  "assistantId": "assistant-1234abcd5678efgh",
  "fallbackDestination": {
    "message": "Please hold while we transfer your call.",
    "type": "number",
    "numberE164CheckEnabled": true,
    "number": "+14155552671",
    "extension": "101",
    "callerId": "+14155551234",
    "transferPlan": {
      "mode": "blind-transfer",
      "message": "Connecting you now.",
      "timeout": 60,
      "sipVerb": "refer",
      "dialTimeout": 60,
      "holdAudioUrl": "https://example.com/audio/hold-music.mp3",
      "transferCompleteAudioUrl": "https://example.com/audio/transfer-complete-beep.wav",
      "contextEngineeringPlan": {
        "type": "lastNMessages",
        "maxMessages": 5
      },
      "twiml": "<Say voice=\"alice\" language=\"en-US\">Hello, transferring your call now.</Say><Pause length=\"2\"/>",
      "summaryPlan": {
        "messages": [
          {
            "role": "system",
            "content": "You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary."
          },
          {
            "role": "user",
            "content": "Here is the transcript:\n\n{{transcript}}\n\n. Here is the ended reason of the call:\n\n{{endedReason}}\n\n"
          }
        ],
        "enabled": true,
        "timeoutSeconds": 5
      },
      "sipHeadersInReferToEnabled": true,
      "fallbackPlan": {
        "message": "Sorry, the transfer failed. Please try again later.",
        "endCallEnabled": true
      }
    },
    "description": "Main office line fallback"
  },
  "hooks": [
    {
      "on": "call.ringing",
      "filters": [
        {
          "type": "startsWith",
          "key": "number",
          "startsWith": [
            "91",
            "86",
            "7"
          ]
        }
      ],
      "do": [
        {
          "type": "transfer",
          "destination": {
            "message": "Please wait while we connect your call.",
            "type": "number",
            "numberE164CheckEnabled": true,
            "number": "+14155559876",
            "extension": "202",
            "callerId": "+14155551234",
            "transferPlan": {
              "mode": "blind-transfer",
              "message": "Forwarding your call now.",
              "timeout": 60,
              "sipVerb": "refer",
              "dialTimeout": 60,
              "holdAudioUrl": "https://example.com/audio/hold-music.mp3",
              "transferCompleteAudioUrl": "https://example.com/audio/transfer-complete-beep.wav",
              "contextEngineeringPlan": {
                "type": "lastNMessages",
                "maxMessages": 3
              },
              "twiml": "<Say voice=\"alice\" language=\"en-US\">Forwarding your call.</Say><Pause length=\"1\"/>",
              "summaryPlan": {
                "messages": [
                  {
                    "role": "system",
                    "content": "You are an expert note-taker. You will be given a transcript of a call. Summarize the call in 2-3 sentences. DO NOT return anything except the summary."
                  },
                  {
                    "role": "user",
                    "content": "Here is the transcript:\n\n{{transcript}}\n\n. Here is the ended reason of the call:\n\n{{endedReason}}\n\n"
                  }
                ],
                "enabled": true,
                "timeoutSeconds": 5
              },
              "sipHeadersInReferToEnabled": true,
              "fallbackPlan": {
                "message": "The transfer could not be completed. Please try again later.",
                "endCallEnabled": true
              }
            },
            "description": "Support team transfer"
          }
        }
      ]
    }
  ],
  "name": "Main Office Line",
  "number": "+14155551234",
  "numberE164CheckEnabled": true,
  "server": {
    "timeoutSeconds": 20,
    "credentialId": "550e8400-e29b-41d4-a716-446655440000",
    "staticIpAddressesEnabled": false,
    "encryptedPaths": [
      "/call.details",
      "/call.transcript"
    ],
    "url": "https://webhook.example.com/vapi",
    "headers": {
      "X-Custom-Header": "VapiWebhook"
    },
    "backoffPlan": {
      "type": "fixed",
      "maxRetries": 3,
      "baseDelaySeconds": 2,
      "excludedStatusCodes": [
        400,
        401,
        403,
        404
      ]
    }
  },
  "squadId": "squad-1122334455",
  "status": "active",
  "workflowId": "workflow-4321dcba8765hgfe"
}

Authentication

AuthorizationBearer

Retrieve your API Key from Dashboard.

Path parameters

idstringRequired

Response

byo-phone-numberobject

twilioobject

vonageobject

vapiobject

telnyxobject