Sign in
calls

End Call

post/v1/calls/end

Query parameters

idstring uuid required

Response

Successful Response

idstring uuid required
user_idstring uuid required
status'not_started' | 'in_progress' | 'error' | 'ended'
error_messagestring nullable
recording_availableboolean
transcriptstring nullable
human_detection_result'human' | 'no_human' nullable
do_not_call_resultboolean nullable
telephony_idstring nullable
stage'created' | 'picked_up' | 'transfer_started' | 'transfer_successful' nullable
stage_outcome'human_unanswered' | 'call_did_not_connect' | 'human_disconnected' | 'bot_disconnected' | 'transfer_unanswered' | 'transfer_disconnected' nullable
start_timestring nullable
end_timestring nullable
to_numberstring required
from_numberstring required
telephony_provider'vonage' | 'twilio' required
agent_phone_numberstring required
hipaa_compliantboolean
on_no_human_answer'continue' | 'hangup' nullable
contextobject nullable
run_do_not_call_detectionboolean nullable
telephony_paramsobject nullable

Changes

Changed in 23 of the 31 revisions of this API.7118118

  • ffca17c004e21See the full diff
    • ○

      added the optional property agent/idle_time_seconds to the response with the 200 status

      response-optional-property-added

  • 63991d99e2e164461See the full diff
    • ▲

      response property agent/context_endpoint list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property agent/initial_message list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property agent/name list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property agent/openai_model_name_override list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property agent/prompt/collect_fields list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property agent/prompt/context_endpoint list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property agent/voice/oneOf[subschema #2: RimeVoice]/speed_alpha list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property agent/voice/oneOf[subschema #3: ElevenLabsVoice]/api_key list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property agent/voice/oneOf[subschema #3: ElevenLabsVoice]/model_id list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property agent/voice/oneOf[subschema #3: ElevenLabsVoice]/optimize_streaming_latency list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property agent/voice/oneOf[subschema #3: ElevenLabsVoice]/similarity_boost list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property agent/voice/oneOf[subschema #3: ElevenLabsVoice]/stability list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property agent/voice/oneOf[subschema #4: PlayHtVoice]/api_key list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property agent/voice/oneOf[subschema #4: PlayHtVoice]/api_user_id list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property agent/voice/oneOf[subschema #4: PlayHtVoice]/quality list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property agent/voice/oneOf[subschema #4: PlayHtVoice]/speed list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property agent/voice/oneOf[subschema #4: PlayHtVoice]/temperature list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property agent/voice/oneOf[subschema #4: PlayHtVoice]/text_guidance list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property agent/voice/oneOf[subschema #4: PlayHtVoice]/top_p list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property agent/voice/oneOf[subschema #4: PlayHtVoice]/voice_guidance list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property context list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property do_not_call_result list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property end_time list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property error_message list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property human_detection_result list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property on_no_human_answer list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property run_do_not_call_detection list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property stage list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property stage_outcome list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property start_time list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property telephony_id list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property telephony_params list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property transcript list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      added PhraseBasedActionTrigger-Output to the agent/actions/items/oneOf[subschema #1: TransferCallAction]/action_trigger response property oneOf list for the response status 200

      response-property-one-of-added

    • ▲

      added PhraseBasedActionTrigger-Output to the agent/actions/items/oneOf[subschema #2: EndConversationAction]/action_trigger response property oneOf list for the response status 200

      response-property-one-of-added

    • ▲

      added PhraseBasedActionTrigger-Output to the agent/actions/items/oneOf[subschema #4: AddToConferenceAction]/action_trigger response property oneOf list for the response status 200

      response-property-one-of-added

    • ▲

      added PhraseBasedActionTrigger-Output to the agent/actions/items/oneOf[subschema #5: SetHoldAction]/action_trigger response property oneOf list for the response status 200

      response-property-one-of-added

    • ▲

      added VocodeVoice to the agent/voice response property oneOf list for the response status 200

      response-property-one-of-added

    • ▲

      the agent/openai_account_connection response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ▲

      the agent/prompt/prompt_template response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ▲

      the agent/vector_database response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ▲

      the agent/webhook response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ▲

      the telephony_account_connection response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ▲

      removed the required property agent/openai_account_connection/credentials from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property agent/openai_account_connection/id from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property agent/openai_account_connection/type from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property agent/openai_account_connection/user_id from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property agent/prompt/prompt_template/id from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property agent/prompt/prompt_template/required_context_keys from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property agent/prompt/prompt_template/user_id from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property agent/vector_database/api_environment from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property agent/vector_database/api_key from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property agent/vector_database/id from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property agent/vector_database/index from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property agent/vector_database/type from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property agent/vector_database/user_id from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property agent/webhook/id from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property agent/webhook/subscriptions from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property agent/webhook/url from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property agent/webhook/user_id from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property telephony_account_connection/credentials from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property telephony_account_connection/id from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property telephony_account_connection/type from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property telephony_account_connection/user_id from the response with the 200 status

      response-required-property-removed

    • ●

      removed the optional property agent/prompt/prompt_template/label from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property agent/webhook/method from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property telephony_account_connection/account_supports_any_caller_id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property telephony_account_connection/steering_pool from the response with the 200 status

      response-optional-property-removed

    • ○

      added the optional property agent/actions/items/oneOf[subschema #6: ExternalAction]/config/signature_secret to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property agent/deepgram_keywords to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property agent/llm_fallback to the response with the 200 status

      response-optional-property-added

    • ○

      added FunctionCallActionTrigger to the agent/actions/items/oneOf[subschema #3: DTMFAction]/action_trigger response property allOf list for the response status 200

      response-property-all-of-added

    • ○

      added FunctionCallActionTrigger to the agent/actions/items/oneOf[subschema #6: ExternalAction]/action_trigger response property allOf list for the response status 200

      response-property-all-of-added

    • ○

      added OpenAIAccountConnection subschema #2 to the agent/openai_account_connection response property anyOf list for the response status 200

      response-property-any-of-added

    • ○

      added PineconeVectorDatabase subschema #2 to the agent/vector_database response property anyOf list for the response status 200

      response-property-any-of-added

    • ○

      added PromptTemplate subschema #2 to the agent/prompt/prompt_template response property anyOf list for the response status 200

      response-property-any-of-added

    • ○

      added TwilioAccountConnection subschema #2 to the telephony_account_connection response property anyOf list for the response status 200

      response-property-any-of-added

    • ○

      added Webhook subschema #2 to the agent/webhook response property anyOf list for the response status 200

      response-property-any-of-added

    • ○

      added subschema #1 subschema #2 to the telephony_metadata response property anyOf list for the response status 200

      response-property-any-of-added

    • ○

      added subschema #3 to the agent/voice/oneOf[subschema #2: RimeVoice]/model_id response property anyOf list for the response status 200

      response-property-any-of-added

    • ○

      removed VonageTelephonyMetadata TwilioTelephonyMetadata from the telephony_metadata response property anyOf list for the response status 200

      response-property-any-of-removed

    • ○

      the processing_mode response property const value muted was added for the status 200

      response-property-const-added

    • ○

      the type response property const value action_add_to_conference was added for the status 200

      response-property-const-added

    • ○

      the type response property const value action_dtmf was added for the status 200

      response-property-const-added

    • ○

      the type response property const value action_end_conversation was added for the status 200

      response-property-const-added

    • ○

      the type response property const value action_external was added for the status 200

      response-property-const-added

    • ○

      the type response property const value action_set_hold was added for the status 200

      response-property-const-added

    • ○

      the type response property const value action_transfer_call was added for the status 200

      response-property-const-added

    • ○

      the type response property const value action_trigger_function_call was added for the status 200

      response-property-const-added

    • ○

      the type response property const value action_trigger_function_call was added for the status 200

      response-property-const-added

    • ○

      the type response property const value action_trigger_function_call was added for the status 200

      response-property-const-added

    • ○

      the type response property const value action_trigger_function_call was added for the status 200

      response-property-const-added

    • ○

      the type response property const value voice_azure was added for the status 200

      response-property-const-added

    • ○

      the type response property const value voice_eleven_labs was added for the status 200

      response-property-const-added

    • ○

      the type response property const value voice_play_ht was added for the status 200

      response-property-const-added

    • ○

      the type response property const value voice_rime was added for the status 200

      response-property-const-added

    • ○

      added voice_vocode discriminator mapping keys to the agent/voice response property for the response status 200

      response-property-discriminator-mapping-added

    • ○

      mapped value for discriminator key action_trigger_phrase_based changed from PhraseBasedActionTrigger to PhraseBasedActionTrigger-Output for agent/actions/items/oneOf[subschema #1: TransferCallAction]/action_trigger response property for the response status 200

      response-property-discriminator-mapping-changed

    • ○

      mapped value for discriminator key action_trigger_phrase_based changed from PhraseBasedActionTrigger to PhraseBasedActionTrigger-Output for agent/actions/items/oneOf[subschema #2: EndConversationAction]/action_trigger response property for the response status 200

      response-property-discriminator-mapping-changed

    • ○

      mapped value for discriminator key action_trigger_phrase_based changed from PhraseBasedActionTrigger to PhraseBasedActionTrigger-Output for agent/actions/items/oneOf[subschema #4: AddToConferenceAction]/action_trigger response property for the response status 200

      response-property-discriminator-mapping-changed

    • ○

      mapped value for discriminator key action_trigger_phrase_based changed from PhraseBasedActionTrigger to PhraseBasedActionTrigger-Output for agent/actions/items/oneOf[subschema #5: SetHoldAction]/action_trigger response property for the response status 200

      response-property-discriminator-mapping-changed

    • ○

      removed discriminator from agent/actions/items/oneOf[subschema #3: DTMFAction]/action_trigger response property for the response status 200

      response-property-discriminator-removed

    • ○

      removed discriminator from agent/actions/items/oneOf[subschema #6: ExternalAction]/action_trigger response property for the response status 200

      response-property-discriminator-removed

    • ○

      removed the bot_disconnected enum value from the stage_outcome response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the call_did_not_connect enum value from the stage_outcome response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the continue enum value from the on_no_human_answer response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the created enum value from the stage response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the draft enum value from the agent/voice/oneOf[subschema #4: PlayHtVoice]/quality response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the faster enum value from the agent/voice/oneOf[subschema #4: PlayHtVoice]/quality response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the hangup enum value from the on_no_human_answer response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the high enum value from the agent/voice/oneOf[subschema #4: PlayHtVoice]/quality response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the human enum value from the human_detection_result response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the human_disconnected enum value from the stage_outcome response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the human_unanswered enum value from the stage_outcome response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the low enum value from the agent/voice/oneOf[subschema #4: PlayHtVoice]/quality response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the medium enum value from the agent/voice/oneOf[subschema #4: PlayHtVoice]/quality response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the no_human enum value from the human_detection_result response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the picked_up enum value from the stage response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the premium enum value from the agent/voice/oneOf[subschema #4: PlayHtVoice]/quality response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the transfer_disconnected enum value from the stage_outcome response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the transfer_started enum value from the stage response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the transfer_successful enum value from the stage response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the transfer_unanswered enum value from the stage_outcome response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed FunctionCallActionTrigger PhraseBasedActionTrigger from the agent/actions/items/oneOf[subschema #3: DTMFAction]/action_trigger response property oneOf list for the response status 200

      response-property-one-of-removed

    • ○

      removed FunctionCallActionTrigger PhraseBasedActionTrigger from the agent/actions/items/oneOf[subschema #6: ExternalAction]/action_trigger response property oneOf list for the response status 200

      response-property-one-of-removed

    • ○

      removed PhraseBasedActionTrigger from the agent/actions/items/oneOf[subschema #1: TransferCallAction]/action_trigger response property oneOf list for the response status 200

      response-property-one-of-removed

    • ○

      removed PhraseBasedActionTrigger from the agent/actions/items/oneOf[subschema #2: EndConversationAction]/action_trigger response property oneOf list for the response status 200

      response-property-one-of-removed

    • ○

      removed PhraseBasedActionTrigger from the agent/actions/items/oneOf[subschema #4: AddToConferenceAction]/action_trigger response property oneOf list for the response status 200

      response-property-one-of-removed

    • ○

      removed PhraseBasedActionTrigger from the agent/actions/items/oneOf[subschema #5: SetHoldAction]/action_trigger response property oneOf list for the response status 200

      response-property-one-of-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 55ae0e0bb01f1See the full diff
    • ○

      added the optional property telephony_metadata to the response with the 200 status

      response-optional-property-added

  • 47ab17602d6415See the full diff
    • ▲

      added ExternalAction to the agent/actions/items/ response property oneOf list for the response status 200

      response-property-one-of-added

    • ○

      added the optional property agent/name to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property agent/voice/oneOf[subschema #2: RimeVoice]/model_id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property telephony_account_connection/account_supports_any_caller_id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property telephony_account_connection/steering_pool to the response with the 200 status

      response-optional-property-added

    • ○

      added action_external discriminator mapping keys to the agent/actions/items/ response property for the response status 200

      response-property-discriminator-mapping-added

  • 3dbe7b5c464d1See the full diff
    • ○

      added the optional property agent/llm_temperature to the response with the 200 status

      response-optional-property-added

  • 500a519452b026See the full diff
    • ●

      added the new call_did_not_connect enum value to the stage_outcome response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new event_phone_call_did_not_connect enum value to the agent/webhook/subscriptions/items/ response property for the response status 200

      response-property-enum-value-added

    • ○

      added the optional property agent/voice/oneOf[subschema #3: ElevenLabsVoice]/experimental_input_streaming to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property agent/voice/oneOf[subschema #4: PlayHtVoice]/experimental_remove_silence to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property agent/voice/oneOf[subschema #4: PlayHtVoice]/text_guidance to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property agent/voice/oneOf[subschema #4: PlayHtVoice]/top_p to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property agent/voice/oneOf[subschema #4: PlayHtVoice]/voice_guidance to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property telephony_params to the response with the 200 status

      response-optional-property-added

  • 5086814bf16a16See the full diff
    • ▲

      added AddToConferenceAction SetHoldAction to the agent/actions/items/ response property oneOf list for the response status 200

      response-property-one-of-added

    • ○

      added the optional property agent/actions/items/oneOf[subschema #1: TransferCallAction]/action_trigger to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property agent/actions/items/oneOf[subschema #2: EndConversationAction]/action_trigger to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property agent/actions/items/oneOf[subschema #3: DTMFAction]/action_trigger to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property stage to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property stage_outcome to the response with the 200 status

      response-optional-property-added

    • ○

      added action_add_to_conference action_set_hold discriminator mapping keys to the agent/actions/items/ response property for the response status 200

      response-property-discriminator-mapping-added

  • 1111aff32f0a81See the full diff
    • ●

      added the new fr enum value to the agent/language/allOf[subschema #1: Language]/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new hi enum value to the agent/language/allOf[subschema #1: Language]/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new id enum value to the agent/language/allOf[subschema #1: Language]/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new it enum value to the agent/language/allOf[subschema #1: Language]/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new ja enum value to the agent/language/allOf[subschema #1: Language]/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new ko enum value to the agent/language/allOf[subschema #1: Language]/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new nl enum value to the agent/language/allOf[subschema #1: Language]/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new pt enum value to the agent/language/allOf[subschema #1: Language]/ response property for the response status 200

      response-property-enum-value-added

    • ○

      added the optional property agent/ask_if_human_present_on_idle to the response with the 200 status

      response-optional-property-added

  • 5d83963279c92See the full diff
    • ○

      added the optional property agent/voice/oneOf[subschema #4: PlayHtVoice]/quality to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property agent/voice/oneOf[subschema #4: PlayHtVoice]/temperature to the response with the 200 status

      response-optional-property-added

  • 17fa3c507aa211See the full diff
    • ●

      added the new sensitive enum value to the agent/endpointing_sensitivity response property for the response status 200

      response-property-enum-value-added

    • ○

      added the optional property agent/run_do_not_call_detection to the response with the 200 status

      response-optional-property-added