channels
voice
calls
dialog-calls
dialog-management

Get dialog history

Get a single dialog history. Dialog history retention period is 5 days.

get/calls/1/dialogs/{dialogId}/history

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

dialogIdstring

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.

parentCallIdstring

Unique parent call ID.

childCallIdstring

Unique child call ID.

durationinteger

Dialog duration in seconds.

hangupSource'API' | 'PARENT_ENDPOINT' | 'CHILD_ENDPOINT' | 'PLATFORM'

Example response

{
  "dialogId": "034e622a-cc7e-456d-8a10-0ba43b11aa5e",
  "callsConfigurationId": "dc5942707c704551a00cd2ea",
  "parentCallId": "d8d84155-3831-43fb-91c9-10b5a8d628a0",
  "childCallId": "ae024ad1-52e7-45d5-a5d2-cd7c809e03f8",
  "duration": 5,
  "recording": {
    "composedFiles": [
      {
        "id": "65f0b3d7c8b6a00001a2b3c4",
        "name": "example-audio.wav",
        "fileFormat": "WAV",
        "size": 292190,
        "duration": 3
      }
    ],
    "callRecordings": [
      {
        "callId": "d8d84155-3831-43fb-91c9-10b5a8d628a0",
        "endpoint": {
          "phoneNumber": "41792030000",
          "type": "PHONE"
        },
        "files": [
          {
            "id": "65f0b3d7c8b6a00001a2b3c4",
            "name": "example-audio.wav",
            "fileFormat": "WAV",
            "size": 292190,
            "duration": 3
          }
        ]
      }
    ]
  },
  "errorCode": {
    "id": 10000,
    "name": "NORMAL_HANGUP",
    "description": "The call has ended with hangup initiated by caller, callee or API"
  }
}

Changes

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