Jump to

• Request
• Response

Fetch details of Call Summary

get

/api/1.0/callActionTransactional/callSummary

This endpoint is used to fetch details of Call Summary.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• limit: integer
  Limit is maximum number of records to be fetched.
• mode: boolean
  Mode is total results count to be fetched.
• offset: integer
  Offset is starting number of records to be fetched.

Header Parameters

• appId(required): string
  The application ID of host service.
• branchCode(required): string
  The branch code of requesting branch.
• contentType: string
  The content type of request or response body.
• entityId(required): string
  The entity ID of host service.
• userId(required): string
  The user ID of requesting user.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Successful performs the operation

Body ()

Root Schema : CallSummaryCollection

Type: object

For fetching the list of Call Summaries associated with a UserId.

Show Source

• aiFlag: boolean
  AI flag value
• callSummaryDtoList: array callSummaryDtoList
• paging: object PagingDto

{
    "description":"For fetching the list of Call Summaries associated with a UserId.",
    "type":"object",
    "properties":{
        "callSummaryDtoList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CallSummaryDTO"
            }
        },
        "aiFlag":{
            "description":"AI flag value",
            "type":"boolean"
        },
        "paging":{
            "description":"Paging",
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : callSummaryDtoList

Type: array

Show Source

• Array of: object CallSummaryDTO
  CallSummaryDTO model

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/CallSummaryDTO"
    }
}

Nested Schema : PagingDto

Type: object

Show Source

• totalResults: integer

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer"
        }
    }
}

Nested Schema : CallSummaryDTO

Type: object

CallSummaryDTO model

Show Source

• accountId: string
  Account Id
• acctNbr: string
  Account Number
• action: string
  Action
• actionId: string
  Action Id
• callDttm: string
  Call Date and Time
• result: string
  Result
• taskId: string
  Task Id
• taskName: string
  Task Name
• taskStatus: string
  Task Status
• userAssigned: string
  User assigned

{
    "description":"CallSummaryDTO model",
    "type":"object",
    "properties":{
        "taskName":{
            "description":"Task Name ",
            "type":"string"
        },
        "taskStatus":{
            "description":"Task Status",
            "type":"string"
        },
        "acctNbr":{
            "description":"Account Number",
            "type":"string"
        },
        "action":{
            "description":"Action ",
            "type":"string"
        },
        "actionId":{
            "description":"Action Id",
            "type":"string"
        },
        "taskId":{
            "description":"Task Id",
            "type":"string"
        },
        "result":{
            "description":"Result",
            "type":"string"
        },
        "userAssigned":{
            "description":"User assigned ",
            "type":"string"
        },
        "accountId":{
            "description":"Account Id",
            "type":"string"
        },
        "callDttm":{
            "description":"Call Date and Time",
            "type":"string"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error

Back to Top