Create Phone Number

1 from vapi import Vapi 2 from vapi import CreateByoPhoneNumberDto 3 client = Vapi(token="YOUR_TOKEN", ) 4 client.phone_numbers.create(request=CreateByoPhoneNumberDto(credential_id='credentialId', ), )

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

Request

This endpoint expects an object.

ByoPhoneNumberobjectRequired

TwilioPhoneNumberobjectRequired

VonagePhoneNumberobjectRequired

VapiPhoneNumberobjectRequired

TelnyxPhoneNumberobjectRequired

Response

ByoPhoneNumberobject

TwilioPhoneNumberobject

VonagePhoneNumberobject

VapiPhoneNumberobject

TelnyxPhoneNumberobject