Developer Programs
Vendor Integration Program (VIP)
Direct access to Jack Henry's technical integration resources.
Technical Account Manager (TAM)
Get technical integration help from a single point of contact.
Learn
Shared Responsibility
Learn about shared roles and responsibilities of customers and Jack Henry in open banking.
Developer Use Cases
Find a use case that fits your development needs.
Developer Video Gallery
Watch the latest demos, webinars, and more.
Developer Conference
Connect with industry leaders, gain insights from expert speakers, and explore our latest innovations.
Docs
Admin API
Create solutions for an institution's back office support tools.
Authentication Framework
Map customer identities to your existing system IDs.
Consumer API
Access financial data for user accounts, transactions, and more.
Data Broker
Get deeper access to financial institution data.
Enterprise Event System
Respond to events in real-time using this powerful pub/sub-based solution.
jXchange - REST API
Translate business information between Jack Henry and third-party applications using a REST-based API.
jXchange - SOAP API
Translate business information between Jack Henry and third-party applications using a SOAP-based API.
Operational Data Integration (ODI)
Get customized queries for bulk data needs.
Payments
Embed check deposits, ACH, bill pay, cards, and real-time payments.
Plugin Framework
Embed the best of the fintech world directly into your user's dashboard.
SymXchange
Query Symitar core member accounts, post transactions, run PowerOn scripts, and more.
Xperience
Modern UI that provides consistent visual integration across Jack Henry products.
Important notification about upcoming changes to the DMZ environment. Please read.
More info

Call Log Inquiry

Enterprise SOAP API > API by Reference > Voice Response > Call Log Inquiry

CallLogInq

Call Log Inquiry is a jXchange service designed to allow consumers to obtain the VR call logs.

Message Flow

In jXchange, the Call Log Inquiry service uses a typical exchange of MType messages to allow consumers to obtain the VR call logs.

Primary Request

The consumer forwards the CallLogInqRq_MType message to the service provider. The message contains the following simple elements:

  • ActIntent
  • CallLogId

Primary Response

The service provider returns the CallLogInqRs_MType message to the consumer. The message contains the following simple elements:

  • ActIntent
  • ActIntentKey

Call Log Inquiry Behavior

The Call Log Inquiry service behavior is as follows.

The Call Log Inquiry root request message (CallLogInqRq_MType) requires a valid Call Log Identifier (CallLogId).

The Call Log Inquiry root request message (CallLogInqRq_MType) optionally includes Activity Intention (ActIntent).

The Call Log Inquiry root response (CallLogInqRs_MType) includes Call Log Inquiry Information Record complex (CallLogInqInfoRec_CType), Activity Intention (ActIntent), and Activity Intention Key (ActIntentKey).

The Call Log Inquiry Information Record complex (CallLogInqInfoRec_CType) contains Call Log Information Record (CallLogInfoRec_Ctype), which contains the following elements:

  • Account Identifier (AcctId)
  • Account Type (AcctType)
  • AuthenIdVerifyArray (AuthenIdVerifyArray_AType)
  • Authentication Event Type (AuthenEventType)
  • Call Activity Array (CallActArray_AType)
  • Call Automatic Number Identifier (CallAutoNumId)
  • Call Forward Description (CallFwdDesc)
  • Call Received Time Date (CallRecvTimeDt)
  • Customer Identifier (CustId)
  • Customer Importance Code (CustImporCode)
  • Language Type (LangType)
  • Remark (Rmk)

The Call Activity Array (CallActArray_AType) contains the Call Activity Information Record complex (CallActInfoRec_CType), which contains the following elements:

  • Account Identification (AcctId)
  • Account Type (AcctType)
  • Call Activity Code (CallActCode)
  • Call Activity Description (CallActDesc)
  • Call Activity Remark (CalActRmk)
  • Priority Sequence (PrioritySeq)
  • Transfer Account Identification From (XferAcctIdFrom_CType)
  • Transfer Account Identification To (XferAcctIdTo_CType)

The standard inquiry message tenets are applicable.

Adhere to the tenets for fault reporting.

Adhere to the tenets related to the correlation identifications.

CallLogInqRq_MType

CallLogInqRq_MType is a message MType element.

Contains:

  • Custom_CType
  • MsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

ActIntent
Conveys the consumer intention for a subsequent operation for the data set included in the response. Canonical values are:
  • Dlt
  • ReadOnly
  • Upd

The default value is ReadOnly.

CallLogId
The identifier assigned to a call log entry.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

MsgRqHdr_CType

MsgRqHdr_CType is a complex CType element. This is the default message request header.

Contains:

  • AuthenUsrCred_CType
  • jXchangeHdr_CType
Simple Elements

The following simple elements are contained within this complex.

AuthenProdCred
Authentication of the Consumer Product Credentials in the form of a WS Security element that contains a single SAML V2.0 Assertion.
AuthenUsrCred_CType

AuthenUsrCred_CType is a complex CType element. This element represents authentication of the end-user credentials in the form of a WS Security element that contains a single SAML V2.0 Assertion.

Simple Elements

The following simple elements are contained within this complex.

Security
Defines the wsse:Security SOAP header element per section 4.
jXchangeHdr_CType

jXchangeHdr_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AuditUsrId
The user ID that the consumer would like written in the audit as performing the requested service. It varies, but it could be the same as the user ID. It is not used to authenticate. It is used to audit the Soap Header Fault.
AuditWsId
The workstation ID that the consumer would like written in the audit as performing the requested service for the Soap Header Fault. It varies, but it could be the same as the user ID.
AuthenUsrId
The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.

This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header SrchMsgRqHdr_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.

BusCorrelId
The correlation identification as related to business functions and activities.
ConsumerName
The name of the service consumer (business name) for the Soap Header Fault.
ConsumerProd
The name of the product which is consuming the service (business product name) for the Soap Header Fault.
InstEnv
An identification provided by the consumer that defines the environment in which the institution is operating. Canonical values are:
  • Prod
InstRtId
The identification of the entity of the submitted message. A financial institution entity uses the routing transit or nine-digit number assigned to financial institutions for routing as assigned by the American Bankers Association. Any leading zeros must be provided for a complete routing and transit number. A non-financial institution entity should use a mutually agreed upon identification that must contain at least one non-integer character. The canonical value is JHA.

The element is required in all message requests.

jXLogTrackingId
An identification provided by jXchange to be able to trace the request and response of a message from the third-party gateway, internal gateway, and service provider for the Soap Header Fault.
JxVer
Contains the version jXchange is running for the Soap Header Fault.
ValidConsmName
The consumer name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table. The canonical value is: JHA.
ValidConsmProd
The consumer product name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table.
WorkflowCorrelId
The correlation identification as related to workflow functions and activities.
jXchangeHdr_CType Deprecation Details
AuthenUserId
This element deprecates in three years in accordance with XSD contract tenets. Effective date: 2012–01–01. The new complex element for user authentication credentials was added to the Search Message Request Header, SrchMsgRqHdr_CType, and the Message Request Header, MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.

CallLogInqRs_MType

CallLogInqRs_MType is a message MType element.

Contains:

  • CallLogInqInfoRec_CType
  • Custom_CType
  • MsgRsHdr_CType

Simple Elements

The following simple elements are contained within this message.

ActIntent
Conveys the consumer intention for a subsequent operation for the data set included in the response. Canonical values are:
  • Dlt
  • ReadOnly
  • Upd

The default value is ReadOnly.

ActIntentKey
The service provider key that is delivered to the consumer to be submitted in a subsequent modification operation.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

CallLogInqInfoRec_CType

CallLogInqInfoRec_CType is a complex CType element.

Contains:

  • CallLogInfoRec_CType
  • Custom_CType
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

CallLogInfoRec_CType

CallLogInfoRec_CType is a complex CType element.

Contains:

  • AuthenIdVerifyArray_AType
  • CallActArray_AType
  • Custom_CType
Simple Elements

The following simple elements are contained within this message.

AcctId
The number or character that identifies an account record.
AcctType
The number or character that categorizes the AcctId.
AuthenEventType
The type of authentication that occurred at the call center switch. Canonical values are:
  • BypassAuthen
  • CmpltAuthen
  • NoAuthen
  • PartAuthen
CallAutoNumId
The phone call automatic number identifier referred to the ANI.
CallFwdDesc
A description that identifies the forwarding of a call.
CallRecvTimeDt
The time stamp date a call was received. The time is expressed in ISO 8601 time format and must contain either Zulu time or local time and the UTC offset. Format: [-]CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm] Valid values include:
  • 2001-10-26T21:32:52
  • 2001-10-26T21:32:52+02:00
  • 2001-10-26T19:32:52Z
  • 2001-10-26T19:32:52+00:00
  • 2001-10-26T21:32:52
  • 2001-10-26T21:32:52.12679

Examples of the same moment:

  • 18:30Z
  • 22:30+04
  • 1130-0700
  • 15:00-03:30

See http://books.xmlschemata.org/relaxng/ch19-77049.html or http://en.wikipedia.org/wiki/ISO_8601 for further reference.

CustId
The identifier attached to a customer.
CustImporCode
The customer importance code. Example, VIP.
LangType
The language as defined by ISO 639-2 Language code list, available at http://www.loc.gov/standards/iso639-2/php/code_list.php. Canonical values are:
  • chi
  • eng
  • fre
  • ger
  • ita
  • jpn
  • kor
  • pol
  • por
  • spa
  • swe
  • zho
Rmk
Application or user remarks free-form text.
TaxId
The tax identifier. It includes the MaskVal, Rstr, and SrchType attributes.
AuthenIdVerifyArray_AType

AuthenIdVerifyArray_AType is an array AType element. This is an array of identification verification values.

Contains:

  • AuthenIdVerify_CType
AuthenIdVerify_CType

AuthenIdVerify_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

IdVerifyCode
The identification code that is used to authenticate the customer.
IdVerifyVal
The identification value that is used to authenticate the customer.
IdVerifyDesc
The description of the identification code that is used to authenticate the customer.
IdVerifyAuthenPass
Did the identification used for authentication pass validation? Canonical values are:
true
false
CallActArray_AType

CallActArray_AType is an array AType element. This is an array of call activity.

Contains:

  • CallActInfoRec_CType
CallActInfoRec_CType

CallActInfoRec_CType is a complex CType element.

Contains:

  • Custom_CType
  • XferAcctIdFrom references AcctIdFrom_CType
  • XferAcctIdTo references AcctIdTo_CType
Simple Elements

The following simple elements are contained within this complex.

AcctId
The number or character that identifies an account record.
AcctType
The number or character that categorizes the AcctId.
CallActCode
The code that represents activity that occurred on a call.
CallActDesc
The description of the code that represents activity that occurred on a call.
CallActRmk
Application or user remarks free-form text.
PrioritySeq
The assignment of a priority sequence for an array of items.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

XferAcctIdFrom

AcctIdFrom_CType is a complex CType element. In a transfer from a source account to a destination account, this is the source account.

XferAcctIdFrom references AcctIdFrom_CType.

Simple Elements

The following simple elements are contained within this complex.

FromAcctId
The source account ID.
FromAcctType
The source account type.
XferAcctIdTo

AcctIdTo_CType is a complex CType element. In a transfer from a source account to a destination account, this is the destination account.

XferAcctIdTo references AcctIdTo_CType.

Simple Elements

The following simple elements are contained within this complex.

ToAcctId
The destination account ID.
ToAcctType
The destination account type.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

MsgRsHdr_CType

MsgRsHdr_CType is a complex CType element. This is the default message response header.

Contains:

  • jXchangeHdr_CType
  • MsgRecInfoArray_AType
jXchangeHdr_CType

jXchangeHdr_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AuditUsrId
The user ID that the consumer would like written in the audit as performing the requested service. It varies, but it could be the same as the user ID. It is not used to authenticate. It is used to audit the Soap Header Fault.
AuditWsId
The workstation ID that the consumer would like written in the audit as performing the requested service for the Soap Header Fault. It varies, but it could be the same as the user ID.
AuthenUsrId
The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.

This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header SrchMsgRqHdr_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.

BusCorrelId
The correlation identification as related to business functions and activities.
ConsumerName
The name of the service consumer (business name) for the Soap Header Fault.
ConsumerProd
The name of the product which is consuming the service (business product name) for the Soap Header Fault.
InstEnv
An identification provided by the consumer that defines the environment in which the institution is operating. Canonical values are:
  • Prod
InstRtId
The identification of the entity of the submitted message. A financial institution entity uses the routing transit or nine-digit number assigned to financial institutions for routing as assigned by the American Bankers Association. Any leading zeros must be provided for a complete routing and transit number. A non-financial institution entity should use a mutually agreed upon identification that must contain at least one non-integer character. The canonical value is JHA.

The element is required in all message requests.

jXLogTrackingId
An identification provided by jXchange to be able to trace the request and response of a message from the third-party gateway, internal gateway, and service provider for the Soap Header Fault.
JxVer
Contains the version jXchange is running for the Soap Header Fault.
ValidConsmName
The consumer name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table. The canonical value is: JHA.
ValidConsmProd
The consumer product name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table.
WorkflowCorrelId
The correlation identification as related to workflow functions and activities.
jXchangeHdr_CType Deprecation Details
AuthenUserId
This element deprecates in three years in accordance with XSD contract tenets. Effective date: 2012–01–01. The new complex element for user authentication credentials was added to the Search Message Request Header, SrchMsgRqHdr_CType, and the Message Request Header, MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.
MsgRecInfoArray_AType

MsgRecInfoArray_AType is an array AType element. This is an array of messages that can be returned in a response.

Contains:

  • MsgRec_CType
MsgRec_CType

MsgRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

ErrCat
The Soap Header Fault error category.
ErrCode
The Soap Header Fault error code.
ErrDesc
The Soap Header Fault error description.
ErrElem
The Soap Header Fault when an error or fault occurs. This optional element contains the element which is causing the error condition.
ErrElemVal
The Soap Header Fault when an error or fault occurs. This optional element contains the value of the element which is causing the error condition.
ErrLoc
The Soap Header Fault error location. This is typically the program that generated the error condition.
Have a Question?
Have a how-to question? Seeing a weird error? Get help on StackOverflow.
Register for the Digital Toolkit Meetup where we answer technical Q&A from the audience.
Last updated Mon Jan 24 2022