INinfobip
channels
voice
calls
dialog-calls
dialog-operations

Hangup dialog

Hang up a dialog. This action also hangs up all calls in the 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)
  • Auth
    • API key in header Authorization
    • or API key in header Authorization
    • or HTTP basic
    • or OAuth 2
      Client credentials
      Token URL: https://api.infobip.com/auth/1/oauth2/token

Path parameters

dialogIdstring required

Dialog ID.

Response

Success

idstring

Unique dialog ID.

callsConfigurationIdstring

Calls Configuration ID.

state'CREATED' | 'PRE_ESTABLISHED' | 'ESTABLISHED' | 'FINISHED' | 'FAILED' | 'TRANSFERRING'

Dialog state.

startTimestring date-time

Date and time for when the dialog has been created.

establishTimestring date-time

Date and time for when the dialog has been established.

endTimestring date-time

Date and time for when the dialog has been finished.

Example response

{
  "id": "034e622a-cc7e-456d-8a10-0ba43b11aa5e",
  "callsConfigurationId": "dc5942707c704551a00cd2ea",
  "parentCall": {
    "id": "d8d84155-3831-43fb-91c9-bb897149a79d",
    "endpoint": {
      "phoneNumber": "41792030000",
      "type": "PHONE"
    },
    "from": "44790123456",
    "to": "44790987654",
    "parentCallId": "3ad8805e-d401-424e-9b03-e02a2016a5e2",
    "machineDetection": {
      "detectionResult": "HUMAN",
      "confidenceRating": {
        "HUMAN": 0.95,
        "MACHINE": 0,
        "MUSIC": 0,
        "RINGING": 0,
        "NOISE": 0.05,
        "SILENCE": 0.01,
        "OTHER": 0.02
      }
    },
    "ringDuration": 3,
    "callsConfigurationId": "dc5942707c704551a00cd2ea",
    "conferenceId": "034e622a-cc7e-456d-8a10-0ba43b11aa5e",
    "customData": {
      "key1": "value1",
      "key2": "value2"
    },
    "dialogId": "5aee53f4-72f8-484b-bfcc-10c5f5476f70"
  },
  "childCall": {
    "id": "d8d84155-3831-43fb-91c9-bb897149a79d",
    "endpoint": {
      "phoneNumber": "41792030000",
      "type": "PHONE"
    },
    "from": "44790123456",
    "to": "44790987654",
    "parentCallId": "3ad8805e-d401-424e-9b03-e02a2016a5e2",
    "machineDetection": {
      "detectionResult": "HUMAN",
      "confidenceRating": {
        "HUMAN": 0.95,
        "MACHINE": 0,
        "MUSIC": 0,
        "RINGING": 0,
        "NOISE": 0.05,
        "SILENCE": 0.01,
        "OTHER": 0.02
      }
    },
    "ringDuration": 3,
    "callsConfigurationId": "dc5942707c704551a00cd2ea",
    "conferenceId": "034e622a-cc7e-456d-8a10-0ba43b11aa5e",
    "customData": {
      "key1": "value1",
      "key2": "value2"
    },
    "dialogId": "5aee53f4-72f8-484b-bfcc-10c5f5476f70"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.