Get Phone Number

GET

Path parameters

idstringRequired

Headers

Auth

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

Byo Phone Number

Twilio

Vonage

Vapi

GET

1 curl https://api.vapi.ai/phone-number/id \
2      -H "Authorization: Bearer <token>"

200Retrieved

1 {
2   "provider": "vapi",
3   "createdAt": "2024-01-15T09:30:00Z",
4   "id": "string",
5   "orgId": "string",
6   "updatedAt": "2024-01-15T09:30:00Z",
7   "assistantId": "string",
8   "authentication": {
9     "username": "username",
10     "password": "password",
11     "realm": "realm"
12   },
13   "fallbackDestination": {
14     "type": "sip",
15     "sipUri": "string",
16     "description": "string",
17     "message": "string",
18     "sipHeaders": {
19       "key": "value"
20     },
21     "transferPlan": {
22       "mode": "blind-transfer",
23       "message": "message",
24       "sipVerb": {
25         "key": "value"
26       }
27     }
28   },
29   "name": "string",
30   "number": "string",
31   "numberDesiredAreaCode": "string",
32   "server": {
33     "url": "url",
34     "timeoutSeconds": 20,
35     "secret": "secret",
36     "headers": {
37       "key": "value"
38     },
39     "backoffPlan": {
40       "maxRetries": 0,
41       "type": {
42         "key": "value"
43       },
44       "baseDelaySeconds": 1
45     }
46   },
47   "sipUri": "string",
48   "squadId": "string"
49 }

Delete Phone Number

Up Next

Built with

1	curl https://api.vapi.ai/phone-number/id \
2	-H "Authorization: Bearer <token>"

1	{
2	"provider": "vapi",
3	"createdAt": "2024-01-15T09:30:00Z",
4	"id": "string",
5	"orgId": "string",
6	"updatedAt": "2024-01-15T09:30:00Z",
7	"assistantId": "string",
8	"authentication": {
9	"username": "username",
10	"password": "password",
11	"realm": "realm"
12	},
13	"fallbackDestination": {
14	"type": "sip",
15	"sipUri": "string",
16	"description": "string",
17	"message": "string",
18	"sipHeaders": {
19	"key": "value"
20	},
21	"transferPlan": {
22	"mode": "blind-transfer",
23	"message": "message",
24	"sipVerb": {
25	"key": "value"
26	}
27	}
28	},
29	"name": "string",
30	"number": "string",
31	"numberDesiredAreaCode": "string",
32	"server": {
33	"url": "url",
34	"timeoutSeconds": 20,
35	"secret": "secret",
36	"headers": {
37	"key": "value"
38	},
39	"backoffPlan": {
40	"maxRetries": 0,
41	"type": {
42	"key": "value"
43	},
44	"baseDelaySeconds": 1
45	}
46	},
47	"sipUri": "string",
48	"squadId": "string"
49	}