---
title: "Hangup dialog"
method: POST
path: "/calls/1/dialogs/{dialogId}/hangup"
tags: ["channels", "voice", "calls", "dialog-calls", "dialog-operations"]
---

# Hangup dialog

`POST /calls/1/dialogs/{dialogId}/hangup`

## Request

- Base URL: `https://api.infobip.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.infobip.com/calls/1/dialogs/{dialogId}/hangup`
- Auth: one of:
  - API key in header `Authorization`
  - API key in header `Authorization`
  - HTTP basic
  - OAuth 2
    - Client credentials
    - Token URL: `https://api.infobip.com/auth/1/oauth2/token`

Hang up a dialog. This action also hangs up all calls in the dialog.

## Path parameters

- `dialogId` string, required

## Response `200`

Success

- 5fc49137a7b003ca1d8c4957601417b8ed884356b7fbc49afe416dd5c098a0bdDialogResponse
  - `id` string: Unique dialog ID.
  - `callsConfigurationId` string: Calls Configuration ID.
  - `platform` 4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611Platform: Platform options. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
    - `entityId` string: Required to use entity in a send request for outbound traffic. Returned in notification events. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
    - `applicationId` string: Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
  - `state` 'CREATED' | 'PRE_ESTABLISHED' | 'ESTABLISHED' | 'FINISHED' | 'FAILED' | 'TRANSFERRING': Dialog state.
  - `startTime` string, date-time: Date and time for when the dialog has been created.
  - `establishTime` string, date-time: Date and time for when the dialog has been established.
  - `endTime` string, date-time: Date and time for when the dialog has been finished.
  - `parentCall` 431fb79b0e816230968e14ba1e1c6fadb75cfde9cb3c381f4217b2777f48153fCall
    - `id` string: Unique call ID.
    - `endpoint` 4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611CallEndpoint, required: Call endpoint. Represents a caller for the inbound calls and a callee for the outbound calls.
      - `type` 'PHONE' | 'SIP' | 'WEBRTC' | 'VIBER' | 'WHATSAPP' | 'WEBSOCKET'
    - `from` string: Caller ID.
    - `to` string: Callee ID.
    - `direction` 'INBOUND' | 'OUTBOUND': Call direction.
    - `state` 'CALLING' | 'RINGING' | 'PRE_ESTABLISHED' | 'ESTABLISHED' | 'FINISHED' | 'FAILED' | 'CANCELLED' | 'NO_ANSWER' | 'BUSY': Call state.
    - `media` 4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611MediaProperties
      - `audio` 4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611AudioMediaProperties: Audio media properties.
        - `muted` boolean: Indicates whether the end user can speak.
        - `userMuted` boolean: Indicates whether the end user muted himself.
        - `deaf` boolean: Indicates whether the end user can hear.
      - `video` 4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611VideoMediaProperties: Video media properties.
        - `camera` boolean: Indicates whether there is a video feed.
        - `screenShare` boolean: Indicates whether the end user is sharing their screen.
        - `blind` boolean: Indicates whether the end user can receive remote videos.
    - `startTime` string, date-time: Date and time for when the call has been created.
    - `answerTime` string, date-time: Date and time for when the call has been answered.
    - `endTime` string, date-time: Date and time for when the call has been finished.
    - `parentCallId` string: Parent call ID.
    - `machineDetection` 4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611MachineDetectionProperties: Properties of the events that provide Answering Machine Detection result.
      - `detectionResult` 'HUMAN' | 'MACHINE': Detected class during analysis of the call. Always returns either HUMAN or MACHINE. Use confidenceRating for a finer grained analysis result
      - `confidenceRating` object: A map representing the confidence rating for each detection class. The key is a tag indicating the detection class, and the value is a float between `0.0` and `1.0` representing the confidence rating. Possible classes are: `HUMAN`, `MACHINE`, `MUSIC`, `RINGING`, `NOISE`, `SILENCE` and `OTHER`. Each class confidence rating is independent from the other, thereby the sum of all confidence values may not equal 1.0.
      - `customData` object: Custom data.
    - `ringDuration` integer: Ringing duration in seconds.
    - `callsConfigurationId` string: Current calls configuration ID.
    - `platform` 4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611Platform: Platform options. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
      - `entityId` string: Required to use entity in a send request for outbound traffic. Returned in notification events. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
      - `applicationId` string: Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
    - `conferenceId` string: Current conference ID.
    - `customData` object: Custom data.
    - `dialogId` string: Dialog ID.
    - `externalId` string: Client defined call ID.
  - `childCall` 431fb79b0e816230968e14ba1e1c6fadb75cfde9cb3c381f4217b2777f48153fCall
    - `id` string: Unique call ID.
    - `endpoint` 4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611CallEndpoint, required: Call endpoint. Represents a caller for the inbound calls and a callee for the outbound calls.
      - `type` 'PHONE' | 'SIP' | 'WEBRTC' | 'VIBER' | 'WHATSAPP' | 'WEBSOCKET'
    - `from` string: Caller ID.
    - `to` string: Callee ID.
    - `direction` 'INBOUND' | 'OUTBOUND': Call direction.
    - `state` 'CALLING' | 'RINGING' | 'PRE_ESTABLISHED' | 'ESTABLISHED' | 'FINISHED' | 'FAILED' | 'CANCELLED' | 'NO_ANSWER' | 'BUSY': Call state.
    - `media` 4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611MediaProperties
      - `audio` 4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611AudioMediaProperties: Audio media properties.
        - `muted` boolean: Indicates whether the end user can speak.
        - `userMuted` boolean: Indicates whether the end user muted himself.
        - `deaf` boolean: Indicates whether the end user can hear.
      - `video` 4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611VideoMediaProperties: Video media properties.
        - `camera` boolean: Indicates whether there is a video feed.
        - `screenShare` boolean: Indicates whether the end user is sharing their screen.
        - `blind` boolean: Indicates whether the end user can receive remote videos.
    - `startTime` string, date-time: Date and time for when the call has been created.
    - `answerTime` string, date-time: Date and time for when the call has been answered.
    - `endTime` string, date-time: Date and time for when the call has been finished.
    - `parentCallId` string: Parent call ID.
    - `machineDetection` 4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611MachineDetectionProperties: Properties of the events that provide Answering Machine Detection result.
      - `detectionResult` 'HUMAN' | 'MACHINE': Detected class during analysis of the call. Always returns either HUMAN or MACHINE. Use confidenceRating for a finer grained analysis result
      - `confidenceRating` object: A map representing the confidence rating for each detection class. The key is a tag indicating the detection class, and the value is a float between `0.0` and `1.0` representing the confidence rating. Possible classes are: `HUMAN`, `MACHINE`, `MUSIC`, `RINGING`, `NOISE`, `SILENCE` and `OTHER`. Each class confidence rating is independent from the other, thereby the sum of all confidence values may not equal 1.0.
      - `customData` object: Custom data.
    - `ringDuration` integer: Ringing duration in seconds.
    - `callsConfigurationId` string: Current calls configuration ID.
    - `platform` 4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611Platform: Platform options. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
      - `entityId` string: Required to use entity in a send request for outbound traffic. Returned in notification events. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
      - `applicationId` string: Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
    - `conferenceId` string: Current conference ID.
    - `customData` object: Custom data.
    - `dialogId` string: Dialog ID.
    - `externalId` string: Client defined call ID.

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not found
- `429`: Too Many Requests
- `500`: Internal Server Error

---

[API](https://skmtc.dev/infobip/apis/infobip-openapi-specification.md) - [All operations](https://skmtc.dev/infobip/apis/infobip-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/infobip/apis/infobip-openapi-specification/revisions/9dcbbaf902de?raw)