channels
voice
calls
call-legs
calls-management

Get call history

Get a single call history. Call history retention period is 5 days.

get/calls/1/calls/{callId}/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

callIdstring required

Call ID.

Response

Success

callIdstring

Unique call ID.

fromstring

Caller ID.

tostring

Callee ID.

direction'INBOUND' | 'OUTBOUND'

Call direction.

state'CALLING' | 'RINGING' | 'PRE_ESTABLISHED' | 'ESTABLISHED' | 'FINISHED' | 'FAILED' | 'CANCELLED' | 'NO_ANSWER' | 'BUSY'

Call state.

startTimestring date-time

Date and time for when the call has been created.

answerTimestring date-time

Date and time for when the call has been answered.

endTimestring date-time

Date and time for when the call has been finished.

parentCallIdstring

Parent call ID.

ringDurationinteger

Ringing duration in seconds.

callsConfigurationIdsstring[]

IDs of the calls configurations used during the call.

conferenceIdsstring[]

IDs of the conferences where the call was a participant.

durationinteger

Call duration in seconds.

hasCameraVideoboolean

Indicates if camera was enabled during the call.

hasScreenshareVideoboolean

Indicates if screen sharing was enabled during the call.

customDataobject

Custom data.

dialogIdstring

Dialog ID.

senderstring

Sender.

hangupSource'ENDPOINT' | 'API' | 'PLATFORM'

Hangup source.

externalIdstring

Client defined call ID.

Example response

{
  "callId": "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,
  "callsConfigurationIds": [
    "a1b06592152e08646b08c057"
  ],
  "conferenceIds": [
    "066675c6-0db6-0db9-b032-031964d09af4"
  ],
  "duration": 5,
  "errorCode": {
    "id": 10000,
    "name": "NORMAL_HANGUP",
    "description": "The call has ended with hangup initiated by caller, callee or API"
  },
  "customData": {
    "key1": "value1",
    "key2": "value2"
  }
}

Changes

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