POST
/
phone-number
curl --request POST \
  --url https://api.vapi.ai/phone-number \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "fallbackDestination": {
    "type": "number",
    "numberE164CheckEnabled": true,
    "number": "<string>",
    "extension": "<string>",
    "message": "<string>",
    "description": "<string>"
  },
  "provider": "byo-phone-number",
  "numberE164CheckEnabled": true,
  "number": "<string>",
  "credentialId": "<string>",
  "name": "<string>",
  "assistantId": "<string>",
  "squadId": "<string>",
  "serverUrl": "<string>",
  "serverUrlSecret": "<string>"
}'
{
  "fallbackDestination": {
    "type": "number",
    "numberE164CheckEnabled": true,
    "number": "<string>",
    "extension": "<string>",
    "message": "<string>",
    "description": "<string>"
  },
  "provider": "byo-phone-number",
  "numberE164CheckEnabled": true,
  "id": "<string>",
  "orgId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "assistantId": "<string>",
  "squadId": "<string>",
  "serverUrl": "<string>",
  "serverUrlSecret": "<string>",
  "number": "<string>",
  "credentialId": "<string>"
}

Authorizations

​
Authorization
string
header
required

Retrieve your API Key from Dashboard.

Body

application/json

Response

201 - application/json

The response is of type object.