Skip to content

Commit a6ed125

Browse files
committed
updated ended-reason doc
1 parent 2074d9b commit a6ed125

File tree

1 file changed

+31
-3
lines changed

1 file changed

+31
-3
lines changed

fern/calls/call-ended-reason.mdx

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,19 @@ You can find these under the **"Ended Reason"** section of your [call logs](http
1616

1717
- `assistant-ended-call`: The assistant intentionally ended the call based on the user's response.
1818
- `assistant-ended-call-after-message-spoken`: The assistant intentionally ended the call after speaking a pre-defined message.
19+
- `assistant-ended-call-with-hangup-task`: The assistant ended the call using a hangup task.
1920
- `assistant-error`: This general error occurs within the assistant's logic or processing due to bugs, misconfigurations, or unexpected inputs.
2021
- `assistant-forwarded-call`: The assistant successfully transferred the call to another number or service.
2122
- `assistant-join-timed-out`: The assistant failed to join the call within the expected timeframe.
2223
- `assistant-not-found`: The specified assistant cannot be located or accessed, possibly due to an incorrect assistant ID or configuration issue.
23-
- `assistant-not-invalid`: The assistant ID provided is not valid or recognized by the system.
24+
- `assistant-not-valid`: The assistant ID provided is not valid or recognized by the system.
2425
- `assistant-not-provided`: No assistant ID was specified in the request, causing the system to fail.
26+
- `assistant-request-failed`: The request to the assistant failed to complete successfully.
2527
- `assistant-request-returned-error`: Communicating with the assistant resulted in an error, possibly due to network issues or problems with the assistant itself.
2628
- `assistant-request-returned-forwarding-phone-number`: The assistant triggered a call forwarding action, ending the current call.
2729
- `assistant-request-returned-invalid-assistant`: The assistant returned an invalid response or failed to fulfill the request properly.
2830
- `assistant-request-returned-no-assistant`: The assistant didn't provide any response or action to the request.
31+
- `assistant-request-returned-unspeakable-error`: The assistant returned an error that cannot be spoken to the user.
2932
- `assistant-said-end-call-phrase`: The assistant recognized a phrase or keyword triggering call termination.
3033

3134
#### Pipeline and LLM
@@ -36,27 +39,52 @@ These relate to issues within the AI processing pipeline or the Large Language M
3639
- `call.in-progress.error-providerfault-*`: Similar to `call.in-progress.error-vapifault-*`. However, these error codes are surfaced when Vapi receives an error that has occured on the provider's side. Examples include internal server errors, or service unavailability.
3740
- `pipeline-error-*`: Similar to `call.in-progress.error-vapifault-*`. However, these error codes are surfaced when you are using your own provider keys.
3841
- `pipeline-no-available-llm-model`: No suitable LLM was available to process the request. Previously `pipeline-no-available-model`.
42+
- `call.in-progress.error-pipeline-no-available-llm-model`: No suitable LLM was available to process the request during the call.
3943

4044
#### Phone Calls and Connectivity
4145

4246
- `customer-busy`: The customer's line was busy.
4347
- `customer-ended-call`: The customer (end human user) ended the call for both inbound and outbound calls.
4448
- `customer-did-not-answer`: The customer didn't answer the call. If you're looking to build a use case where you need the bot to talk to automated IVRs, set `assistant.voicemailDetectionEnabled=false`.
4549
- `customer-did-not-give-microphone-permission`: The user didn't grant the necessary microphone access for the call.
46-
- `assistant-did-not-receive-customer-audio`: Similar to `customer-did-not-give-microphone-permission`, but more generalized to situations where no customer audio was received.
50+
- `call.in-progress.error-assistant-did-not-receive-customer-audio`: Similar to `customer-did-not-give-microphone-permission`, but more generalized to situations where no customer audio was received.
4751
- `phone-call-provider-closed-websocket`: The connection with the call provider was unexpectedly closed.
52+
- `phone-call-provider-bypass-enabled-but-no-call-received`: The phone call provider bypass was enabled but no call was received.
4853
- `twilio-failed-to-connect-call`: The Twilio service, responsible for managing calls, failed to establish a connection.
4954
- `twilio-reported-customer-misdialed`: Twilio reported that the customer dialed an invalid or incomplete number.
5055
- `vonage-disconnected`: The call was disconnected by Vonage, another call management service.
5156
- `vonage-failed-to-connect-call`: Vonage failed to establish the call connection.
5257
- `vonage-rejected`: The call was rejected by Vonage due to an issue or configuration problem.
53-
- `sip-telephony-provider-failed-to-connect-call`: The SIP telephony provider failed to establish the call connection. Previously `sip-gateway-failed-to-connect-call`.
58+
- `vonage-completed`: The call was completed successfully by Vonage.
59+
- `call.in-progress.error-sip-telephony-provider-failed-to-connect-call`: The SIP telephony provider failed to establish the call connection.
60+
61+
#### Call Start Errors
62+
63+
- `call-start-error-neither-assistant-nor-server-set`: Neither an assistant nor server was configured for the call.
64+
- `call.start.error-get-org`: Error retrieving organization information during call start.
65+
- `call.start.error-get-subscription`: Error retrieving subscription information during call start.
66+
- `call.start.error-get-assistant`: Error retrieving assistant information during call start.
67+
- `call.start.error-get-phone-number`: Error retrieving phone number information during call start.
68+
- `call.start.error-get-customer`: Error retrieving customer information during call start.
69+
- `call.start.error-get-resources-validation`: Error validating resources during call start.
70+
- `call.start.error-vapi-number-international`: Error with international Vapi number during call start.
71+
- `call.start.error-vapi-number-outbound-daily-limit`: Outbound daily limit reached for Vapi number.
72+
- `call.start.error-get-transport`: Error retrieving transport information during call start.
73+
74+
#### Call Forwarding and Hooks
75+
76+
- `call.forwarding.operator-busy`: The operator was busy during call forwarding.
77+
- `call.ringing.hook-executed-say`: A say hook was executed during the ringing phase.
78+
- `call.ringing.hook-executed-transfer`: A transfer hook was executed during the ringing phase.
5479

5580
#### Other Reasons
5681

82+
- `database-error`: A database error occurred during the call.
5783
- `exceeded-max-duration`: The call reached its maximum allowed duration and was automatically terminated.
84+
- `manually-canceled`: The call was manually canceled.
5885
- `silence-timed-out`: The call was ended due to prolonged silence, indicating inactivity.
5986
- `voicemail`: The call was diverted to voicemail.
87+
- `worker-shutdown`: The worker handling the call was shut down.
6088

6189
#### Unknown
6290

0 commit comments

Comments
 (0)