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

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

Aug 27, 2024ffca17c004e21See the full diff
- ○
  added the optional property / to the response with the status
  response-optional-property-added
Aug 14, 202463991d99e2e164461See 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 to the //// response property oneOf list for the response status
  response-property-one-of-added
- ▲
  added to the //// response property oneOf list for the response status
  response-property-one-of-added
- ▲
  added to the //// response property oneOf list for the response status
  response-property-one-of-added
- ▲
  added to the //// response property oneOf list for the response status
  response-property-one-of-added
- ▲
  added to the / response property oneOf list for the response status
  response-property-one-of-added
- ▲
  the / response's property type changed from object to no type for status
  response-property-type-changed
- ▲
  the // response's property type changed from object to no type for status
  response-property-type-changed
- ▲
  the / response's property type changed from object to no type for status
  response-property-type-changed
- ▲
  the / response's property type changed from object to no type for status
  response-property-type-changed
- ▲
  the response's property type changed from object to no type for status
  response-property-type-changed
- ▲
  removed the required property // from the response with the status
  response-required-property-removed
- ▲
  removed the required property // from the response with the status
  response-required-property-removed
- ▲
  removed the required property // from the response with the status
  response-required-property-removed
- ▲
  removed the required property // from the response with the status
  response-required-property-removed
- ▲
  removed the required property /// from the response with the status
  response-required-property-removed
- ▲
  removed the required property /// from the response with the status
  response-required-property-removed
- ▲
  removed the required property /// from the response with the status
  response-required-property-removed
- ▲
  removed the required property // from the response with the status
  response-required-property-removed
- ▲
  removed the required property // from the response with the status
  response-required-property-removed
- ▲
  removed the required property // from the response with the status
  response-required-property-removed
- ▲
  removed the required property // from the response with the status
  response-required-property-removed
- ▲
  removed the required property // from the response with the status
  response-required-property-removed
- ▲
  removed the required property // from the response with the status
  response-required-property-removed
- ▲
  removed the required property // from the response with the status
  response-required-property-removed
- ▲
  removed the required property // from the response with the status
  response-required-property-removed
- ▲
  removed the required property // from the response with the status
  response-required-property-removed
- ▲
  removed the required property // from the response with the status
  response-required-property-removed
- ▲
  removed the required property / from the response with the status
  response-required-property-removed
- ▲
  removed the required property / from the response with the status
  response-required-property-removed
- ▲
  removed the required property / from the response with the status
  response-required-property-removed
- ▲
  removed the required property / from the response with the status
  response-required-property-removed
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
- ●
  removed the optional property // from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added to the //// response property allOf list for the response status
  response-property-all-of-added
- ○
  added to the //// response property allOf list for the response status
  response-property-all-of-added
- ○
  added subschema #2 to the / response property anyOf list for the response status
  response-property-any-of-added
- ○
  added subschema #2 to the / response property anyOf list for the response status
  response-property-any-of-added
- ○
  added subschema #2 to the // response property anyOf list for the response status
  response-property-any-of-added
- ○
  added subschema #2 to the response property anyOf list for the response status
  response-property-any-of-added
- ○
  added subschema #2 to the / response property anyOf list for the response status
  response-property-any-of-added
- ○
  added subschema #1 subschema #2 to the response property anyOf list for the response status
  response-property-any-of-added
- ○
  added subschema #3 to the /// response property anyOf list for the response status
  response-property-any-of-added
- ○
  removed from the response property anyOf list for the response status
  response-property-any-of-removed
- ○
  the response property const value muted was added for the status
  response-property-const-added
- ○
  the response property const value action_add_to_conference was added for the status
  response-property-const-added
- ○
  the response property const value action_dtmf was added for the status
  response-property-const-added
- ○
  the response property const value action_end_conversation was added for the status
  response-property-const-added
- ○
  the response property const value action_external was added for the status
  response-property-const-added
- ○
  the response property const value action_set_hold was added for the status
  response-property-const-added
- ○
  the response property const value action_transfer_call was added for the status
  response-property-const-added
- ○
  the response property const value action_trigger_function_call was added for the status
  response-property-const-added
- ○
  the response property const value action_trigger_function_call was added for the status
  response-property-const-added
- ○
  the response property const value action_trigger_function_call was added for the status
  response-property-const-added
- ○
  the response property const value action_trigger_function_call was added for the status
  response-property-const-added
- ○
  the response property const value voice_azure was added for the status
  response-property-const-added
- ○
  the response property const value voice_eleven_labs was added for the status
  response-property-const-added
- ○
  the response property const value voice_play_ht was added for the status
  response-property-const-added
- ○
  the response property const value voice_rime was added for the status
  response-property-const-added
- ○
  added voice_vocode discriminator mapping keys to the / response property for the response status
  response-property-discriminator-mapping-added
- ○
  mapped value for discriminator key action_trigger_phrase_based changed from to for //// response property for the response status
  response-property-discriminator-mapping-changed
- ○
  mapped value for discriminator key action_trigger_phrase_based changed from to for //// response property for the response status
  response-property-discriminator-mapping-changed
- ○
  mapped value for discriminator key action_trigger_phrase_based changed from to for //// response property for the response status
  response-property-discriminator-mapping-changed
- ○
  mapped value for discriminator key action_trigger_phrase_based changed from to for //// response property for the response status
  response-property-discriminator-mapping-changed
- ○
  removed discriminator from //// response property for the response status
  response-property-discriminator-removed
- ○
  removed discriminator from //// response property for the response status
  response-property-discriminator-removed
- ○
  removed the bot_disconnected enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the call_did_not_connect enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the continue enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the created enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the draft enum value from the /// response property for the response status
  response-property-enum-value-removed
- ○
  removed the faster enum value from the /// response property for the response status
  response-property-enum-value-removed
- ○
  removed the hangup enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the high enum value from the /// response property for the response status
  response-property-enum-value-removed
- ○
  removed the human enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the human_disconnected enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the human_unanswered enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the low enum value from the /// response property for the response status
  response-property-enum-value-removed
- ○
  removed the medium enum value from the /// response property for the response status
  response-property-enum-value-removed
- ○
  removed the no_human enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the picked_up enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the premium enum value from the /// response property for the response status
  response-property-enum-value-removed
- ○
  removed the transfer_disconnected enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the transfer_started enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the transfer_successful enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the transfer_unanswered enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed from the //// response property oneOf list for the response status
  response-property-one-of-removed
- ○
  removed from the //// response property oneOf list for the response status
  response-property-one-of-removed
- ○
  removed from the //// response property oneOf list for the response status
  response-property-one-of-removed
- ○
  removed from the //// response property oneOf list for the response status
  response-property-one-of-removed
- ○
  removed from the //// response property oneOf list for the response status
  response-property-one-of-removed
- ○
  removed from the //// response property oneOf list for the response status
  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
Apr 19, 202455ae0e0bb01f1See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
Apr 15, 202447ab17602d6415See the full diff
- ▲
  added to the // response property oneOf list for the response status
  response-property-one-of-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added action_external discriminator mapping keys to the // response property for the response status
  response-property-discriminator-mapping-added
Mar 20, 20243dbe7b5c464d1See the full diff
- ○
  added the optional property / to the response with the status
  response-optional-property-added
Mar 18, 2024500a519452b026See the full diff
- ●
  added the new call_did_not_connect enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new event_phone_call_did_not_connect enum value to the /// response property for the response status
  response-property-enum-value-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
Jan 3, 20245086814bf16a16See the full diff
- ▲
  added to the // response property oneOf list for the response status
  response-property-one-of-added
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added action_add_to_conference action_set_hold discriminator mapping keys to the // response property for the response status
  response-property-discriminator-mapping-added
Dec 12, 20231111aff32f0a81See the full diff
- ●
  added the new fr enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new hi enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new id enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new it enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new ja enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new ko enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new nl enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new pt enum value to the // response property for the response status
  response-property-enum-value-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
Dec 8, 20235d83963279c92See the full diff
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
- ○
  added the optional property /// to the response with the status
  response-optional-property-added
Dec 3, 202317fa3c507aa211See the full diff
- ●
  added the new sensitive enum value to the / response property for the response status
  response-property-enum-value-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added

Full history (23 revisions)