Call Log Search
CallLogSrch
Call Log Search is a jXchange service designed to allow consumers to obtain the VR call logs.
Message Flow
In jXchange, the Call Log Search service uses a typical exchange of MType messages to allow consumers
to obtain the VR call logs.
Primary Request
The consumer forwards the CallLogSrchRq_MType message to the
service provider. The message contains the following simple elements:
- CallAutoNumId
- CallRecvEndTimeDt
- CallRecvStartTimeDt
Primary Response
The service provider returns the CallLogSrchRs_MType message to the
consumer. The message contains the following simple elements:
- CallAutoNumId
- CallRecvEndTimeDt
- CallRecvStartTimeDt
Call Log Search Behavior
The Call Log Search service behavior is as follows.
The Call Log Search root request message (CallLogSrchRq_MType) includes the
Call Auto Number Identifier (ANI) (CallAutoNumId), Call Received Start
Time Date (CallRecvStartTimeDt), and Call Received End Time Date
(CallRecvEndTimeDt).
The root request elements represent a documented choice statement whereas all of the elements are optional in the request but at least one element is required.
A consumer request with a Call Received Start time and date (CallRecvStartTimeDt) but without a Call Received End time and date (CallRecvEndTimeDt) returns all of the qualified call records with a time/date equal to or greater than the Call Received Time Date (CallRecvTimeDt).
A consumer request with a Call Received End time and date (CallRecvEndTimeDt) but without a Call Received Start time and date (CallRecvStartTimeDt) returns all of the qualified call records with a time/date equal to or less than the Call Received Time Date (CallRecvTimeDt).
A consumer request with a Call Received Start time and date (CallRecvStartTimeDt) and a Call Received End time and date (CallRecvEndTimeDt) returns all of the qualified call records with a time/date equal to or greater than the Call Received Time Date (CallRecvTimeDt) and a date equal to or less than the Call Received Time Date (CallRecvTimeDt).
The Call Log Search root response message (CallLogSrchRs_MType) includes an
echo back of the Call Auto Number Identifier (ANI) (CallAutoNumId),
Call Received Start Time Date (CallRecvStartTimeDt), and Call Received
End Time Date (CallRecvEndTimeDt).
Call Log Search root response message (CallLogSrchRs_MType) includes the
Call Log Search Array (CallLogSrchArray_AType) which contains the Call Log
Search Record (CallLogSrchRec_CType). The Call Log Search Record contains the
following elements:
- Account Identifier (
AccountId_CType) - Call Auto Number Identifier (ANI) (CallAutoNumId)
- Call Log Identifier (CallLogId)
- Call Received Time Date (CallRecvTimeDt)
- Customer Identifier (CustId)
- Tax Identifier (TaxId)
The customer can cache the Call Log Identifier (CallLogId) to use in a subsequent call logging service.
The standard Search message header tenets are not applicable at this time. The service does not handle paging at this time. The consumer must build in the paging functionality.
The standard Search message tenets are applicable.
Adhere to the tenets for fault reporting.
Adhere to the tenets related to the correlation identifications.
CallLogSrchRq_MType
CallLogSrchRq_MType is a message MType element.
Contains:
Custom_CTypeSrchMsgRqHdr_CType
Simple Elements
The following simple elements are contained within this message.
- CallAutoNumId
- The phone call automatic number identifier referred to the ANI.
- CallRecvEndTimeDt
- 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.
- CallRecvStartTimeDt
- 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.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
SrchMsgRqHdr_CType
SrchMsgRqHdr_CType is a complex
CType element. This is a
standard request message header.
Contains:
AuthenUsrCred_CTypejXchangeHdr_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.
- Cursor
- The state information that allows the next call to understand where it left off when returning multiple records and allowing a subsequent call to retrieve more records.
- MaxRec
- The maximum number of records when multiple records are returned.
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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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.AuthenUsrIdis ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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 byWS-Security.
CallLogSrchRs_MType
CallLogSrchRs_MType is a message MType element.
Contains:
CallLogSrchArray_ATypeCustom_CTypeSrchMsgRsHdr_CType
Simple Elements
The following simple elements are contained within this message.
- CallAutoNumId
- The phone call automatic number identifier referred to the ANI.
- CallRecvEndTimeDt
- 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.
- CallRecvStartTimeDt
- 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.
CallLogSrchArray_AType
CallLogSrchArray_AType is an array AType element. This is an array of
responses for Call Log Search.
Contains:
CallLogSrchRec_CType
CallLogSrchRec_CType
CallLogSrchRec_CType is a complex CType element.
Contains:
AccountId_CTypeCustom_CType
Simple Elements
The following simple elements are contained within this complex.
- CallAutoNumId
- The phone call automatic number identifier referred to the ANI.
- CallLogId
- The identifier assigned to a call log entry.
- 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.
- TaxId
- The tax identifier. It includes the
MaskVal,Rstr, andSrchTypeattributes.
AccountId_CType
AccountId_CType is a complex
CType element. This element contains the incoming account
identification information and any restrictions.
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.
- Rstr
- The level of restrictions that can exist at a parent and/or child node. Canonical
values are:
- Hid
- NoAccess
- NoAccessPart
- ReadOnly
- ReadOnlyPart
- ReadWrite
- ReadWritePart
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
SrchMsgRsHdr_CType
SrchMsgRsHdr_CType is a complex
CType element. It searches specific message response
headers.
Contains:
jXchangeHdr_CTypeMsgRecInfoArray_AType
Simple Elements
The following simple elements are contained within this complex.
- Cursor
- The state information that allows the next call to understand where it left off when returning multiple records and allowing a subsequent call to retrieve more records.
- MoreRec
- Indicates if there are more records that could be returned. Canonical values are:
- false
- true
- SentRec
- The number of records sent in the response.
- TotRec
- Indicates the total records the request selected, which could be larger than
MaxRec.
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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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.AuthenUsrIdis ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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 byWS-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.