Create Phone Number

POST

https://api.vapi.ai/phone-number

POST

/phone-number

1 from vapi import CreateByoPhoneNumberDto, Vapi
2 
3 client = Vapi(
4     token="YOUR_TOKEN",
5 )
6 client.phone_numbers.create(
7     request=CreateByoPhoneNumberDto(
8         credential_id="credentialId",
9     ),
10 )

Try it

201Created

1 {
2   "fallbackDestination": {
3     "message": "string",
4     "type": "number",
5     "numberE164CheckEnabled": true,
6     "number": "string",
7     "extension": "string",
8     "callerId": "string",
9     "transferPlan": {
10       "mode": "blind-transfer",
11       "message": "string",
12       "timeout": 60,
13       "sipVerb": "refer",
14       "holdAudioUrl": "string",
15       "transferCompleteAudioUrl": "string",
16       "twiml": "string",
17       "summaryPlan": {
18         "messages": [
19           {}
20         ],
21         "enabled": true,
22         "timeoutSeconds": 1.1
23       },
24       "sipHeadersInReferToEnabled": true,
25       "fallbackPlan": {
26         "message": "string",
27         "endCallEnabled": true
28       }
29     },
30     "description": "string"
31   },
32   "hooks": [
33     {
34       "on": "call.ringing",
35       "do": [
36         {
37           "type": "transfer",
38           "destination": {
39             "message": "string",
40             "type": "number",
41             "numberE164CheckEnabled": true,
42             "number": "string",
43             "extension": "string",
44             "callerId": "string",
45             "transferPlan": {
46               "mode": "blind-transfer",
47               "message": "string",
48               "timeout": 60,
49               "sipVerb": "refer",
50               "holdAudioUrl": "string",
51               "transferCompleteAudioUrl": "string",
52               "twiml": "string",
53               "summaryPlan": {
54                 "messages": [
55                   {}
56                 ],
57                 "enabled": true,
58                 "timeoutSeconds": 1.1
59               },
60               "sipHeadersInReferToEnabled": true,
61               "fallbackPlan": {
62                 "message": {},
63                 "endCallEnabled": true
64               }
65             },
66             "description": "string"
67           }
68         }
69       ]
70     }
71   ],
72   "provider": "byo-phone-number",
73   "numberE164CheckEnabled": true,
74   "id": "string",
75   "orgId": "string",
76   "createdAt": "2024-01-15T09:30:00Z",
77   "updatedAt": "2024-01-15T09:30:00Z",
78   "status": "active",
79   "name": "string",
80   "assistantId": "string",
81   "workflowId": "string",
82   "squadId": "string",
83   "server": {
84     "timeoutSeconds": 20,
85     "credentialId": "550e8400-e29b-41d4-a716-446655440000",
86     "url": "string",
87     "headers": {},
88     "backoffPlan": {
89       "type": "fixed",
90       "maxRetries": 0,
91       "baseDelaySeconds": 1,
92       "excludedStatusCodes": [
93         400,
94         401,
95         403,
96         404
97       ]
98     }
99   },
100   "number": "string",
101   "credentialId": "string"
102 }

Request

This endpoint expects an object.

ByoPhoneNumberobjectRequired

TwilioPhoneNumberobjectRequired

VonagePhoneNumberobjectRequired

VapiPhoneNumberobjectRequired

TelnyxPhoneNumberobjectRequired

Response

ByoPhoneNumberobject

TwilioPhoneNumberobject

VonagePhoneNumberobject

VapiPhoneNumberobject

TelnyxPhoneNumberobject