SIP Client icon

SIP Client

SIP Client for Asterisk/Starface PBX integration

Actions8

Call → Hang Up

AI-generated

Summary

Hang up an active SIP call specified by its Call ID, terminating the call session on the SIP server.

Inputs

  • Call ID (required) — The unique identifier of the call to hang up.
  • Additional Options — Optional parameters including Timeout (seconds) for operation timeout, Auto Answer to automatically answer incoming calls, Record Call to enable call recording, and Custom Headers as key-value pairs for SIP message customization.

Output shape

a single JSON object describing the result of the hangup operation including success status, a message, and call details indicating the call was disconnected.

If the specified Call ID does not correspond to an active call, the operation will raise an error. Optional Additional Options do not affect the core hang-up behavior but can be used for advanced call controls if supported by the SIP server.

Examples

Example 1: Terminate a call in progress by providing its Call ID.

Set 'Call ID' to the target call's identifier with no additional options, triggering the node to send a BYE request to end the call.

Links

Discussion