Legs

Hang up a leg (asynchronous)

Changed on

Validates the leg exists and queues a hangup. The HTTP call returns 202 as soon as the leg is found; the SIP work and cleanup run in the background, and the eventual disconnection is observed via the leg.disconnected event.

Without a request body the leg ends with cdr.reason: "api_hangup": SIP BYE on connected legs, or, on unanswered inbound legs, the INVITE is dropped without any final SIP response.

With {"reason": "<value>"} and an unanswered SIP inbound leg (state ringing or early_media), VoiceBlender sends a final non-2xx response instead of BYE/cancel: busy→486, declined/rejected→603, unavailable→480, not_found→404, forbidden→403, server_error→500. The reason value is passed through to leg.disconnected's cdr.reason.

For connected legs the request body is ignored.

delete/legs/{id}

Request

  • Base URL
    http://localhost:8080/v1
  • URL
    http://localhost:8080/v1/legs/{id}
  • Auth
    none declared

Request body

reason'busy' | 'declined' | 'rejected' | 'unavailable' | 'not_found' | 'forbidden' | 'server_error'

Disconnect reason. Only honored for unanswered SIP inbound legs (state ringing or early_media); on connected legs the body is ignored and the leg is hung up with the legacy api_hangup reason. The value flows through to leg.disconnected's cdr.reason and selects the SIP final response: busy→486, declined/rejected→603, unavailable→480, not_found→404, forbidden→403, server_error→500.

Response

Hangup queued

Changes

  • 20957badcc90Revision changes
    • breaking

      removed the success response with the status

    • info

      added optional request body

    • info

      added the non-success response with the status

    • info

      added the success response with the status