This is the fallback destination an inbound call will be transferred to if:
assistantId
is not setsquadId
is not setassistant-request
message to the serverUrl
failsIf this is not set and above conditions are met, the inbound call is hung up with an error message.
This is the name of the phone number. This is just for your own reference.
This is the assistant that will be used for incoming calls to this phone number.
If neither assistantId
nor squadId
is set, assistant-request
will be sent to your Server URL. Check ServerMessage
and ServerMessageResponse
for the shape of the message and response that is expected.
This is the squad that will be used for incoming calls to this phone number.
If neither assistantId
nor squadId
is set, assistant-request
will be sent to your Server URL. Check ServerMessage
and ServerMessageResponse
for the shape of the message and response that is expected.
This is the server URL where messages will be sent for calls on this number. This includes the assistant-request
message.
You can see the shape of the messages sent in ServerMessage
.
This overrides the org.serverUrl
. Order of precedence: tool.server.url > assistant.serverUrl > phoneNumber.serverUrl > org.serverUrl.
This is the secret Vapi will send with every message to your server. It’s sent as a header called x-vapi-secret.
Same precedence logic as serverUrl.