| # TMFC023-PartyInteractionManagement |
|
|
| ```yaml |
| apiVersion: oda.tmforum.org/v1
|
| kind: Component
|
| metadata:
|
| name: components.oda.tmforum.org
|
| spec:
|
| coreFunction:
|
| dependentAPIs:
|
| - id: TMF632
|
| apiType: openapi
|
| apiSDO: tmForum
|
| name: party-management-api
|
| required: false
|
| specification:
|
| - url: https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/OpenApiTable/TMF632_Party/4.0.0/swagger/TMF632_Party_Management_API_v4.0.0_swagger.json
|
| version: v4.0.0
|
| resources:
|
| - individual:
|
| - GET
|
| - GET /id
|
| - organization:
|
| - GET
|
| - GET /id
|
| - id: TMF669
|
| apiType: openapi
|
| apiSDO: tmForum
|
| name: party-role-management-api
|
| required: false
|
| specification:
|
| - url: https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/OpenApiTable/TMF669_Party_Role/4.0.0/swagger/TMF669_Party_Role_Management_API_v4.0.0_swagger.json
|
| version: v4.0.0
|
| resources:
|
| - partyRole:
|
| - GET
|
| - GET /id
|
| - id: TMF662
|
| apiType: openapi
|
| apiSDO: tmForum
|
| name: entity-catalog-management-api
|
| required: false
|
| specification:
|
| - url: https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/OpenApiTable/TMF662_Entity_Catalog/4.0.0/swagger/TMF662_Entity_Catalog_Management_API_v4.0.0_swagger.json
|
| version: v4.0.0
|
| resources:
|
| - entitySpecification:
|
| - GET
|
| - GET /id
|
| - entityCategory:
|
| - GET
|
| - GET /id
|
| - entityCatalog:
|
| - GET
|
| - GET /id
|
| - entityCatalogItem:
|
| - GET
|
| - GET /id
|
| - id: TMF667
|
| apiType: openapi
|
| apiSDO: tmForum
|
| name: document-management-api
|
| required: false
|
| specification:
|
| - url: https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/OpenApiTable/TMF667_Document/4.0.0/swagger/TMF667_Document_Management_API_v4.0.0_swagger.json
|
| version: v4.0.0
|
| resources:
|
| - document:
|
| - GET
|
| - GET /id
|
| - id: TMF681
|
| apiType: openapi
|
| apiSDO: tmForum
|
| name: communication-management-api
|
| required: false
|
| specification:
|
| - url: https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/OpenApiTable/TMF681_Communication/4.0.0/swagger/TMF681_Communication_Management_API_v4.0.0_swagger.json
|
| version: v4.0.0
|
| resources:
|
| - communicationMessage:
|
| - GET
|
| - GET /id
|
| - id: TMF701
|
| apiType: openapi
|
| apiSDO: tmForum
|
| name: process-flow-management-api
|
| required: false
|
| specification:
|
| - url: https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/TMF701_Process_Flow/4.1.0/swagger/TMF701_Process_Flow_Management_API_v4.1.0_beta_swagger.json
|
| version: v4.0.0
|
| resources:
|
| - processFlow:
|
| - POST
|
| - GET
|
| - GET /id
|
| - PATCH
|
| exposedAPIs:
|
| - id: TMF683
|
| apiType: openapi
|
| apiSDO: tmForum
|
| name: party-interaction-management-api
|
| required: true
|
| specification:
|
| - url: https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Historic/TMF683_Party_Interaction/4.0.0/swagger/TMF683-PartyInteraction-4.0.0.swagger.json
|
| version: v4.0.0
|
| - url: https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/OpenApiTable/TMF683_Party_Interaction/4.0.0/swagger/TMF683_Party_Interaction_Management_API_v4.0.0_swagger.json
|
| version: v4.0.0
|
| path: not_defined
|
| developerUI: not_defined
|
| implementation: not_defined
|
| port: 8080
|
| resources:
|
| - partyInteraction:
|
| - GET
|
| - GET /id
|
| - POST
|
| - PATCH
|
| - DELETE
|
| - id: TMF701
|
| apiType: openapi
|
| apiSDO: tmForum
|
| name: process-flow-management-api
|
| required: false
|
| specification:
|
| - url: https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/Beta/TMF701_Process_Flow/4.1.0/swagger/TMF701_Process_Flow_Management_API_v4.1.0_beta_swagger.json
|
| version: v4.0.0
|
| path: not_defined
|
| developerUI: not_defined
|
| implementation: not_defined
|
| port: 8080
|
| resources:
|
| - processFlow:
|
| - POST
|
| - GET
|
| - GET /id
|
| - DELETE
|
| - taskFlow:
|
| - PATCH
|
| - GET
|
| - GET /id
|
| componentMetadata:
|
| id: TMFC023
|
| name: PartyInteractionManagement
|
| version: 1.1.2
|
| description: Party Interaction deals with the initial greeting and welcoming of
|
| a new contact. This will typically be the first component in a customer experience
|
| journey, shared by unassisted (self-service, retail kiosk) or assisted (call
|
| center, retail store) channels. It will identify known Parties or new Parties
|
| and react appropriately to propose available actions. It records all the interactions
|
| for the Parties from all channels.
|
| publicationDate: 2025-10-21
|
| status: specified
|
| functionalBlock: PartyManagement
|
| owners:
|
| - email: Redacted
|
| name: Redacted
|
| url: Redacted
|
| maintainers:
|
| - name: Redacted
|
| email: components@tmforum.org
|
| url: Redacted
|
| eTOMs:
|
| - 1.3.5|Customer_Interaction_Management|v24.0
|
| - 1.3.5.1|Create_Customer_Interaction|v24.0
|
| - 1.3.5.2|Update_Customer_Interaction|v24.0
|
| - 1.3.5.3|Close_Customer_Interaction|v24.0
|
| - 1.3.5.4|Log_Customer_Interaction|v24.0
|
| - 1.3.5.6|Track_and_Manage_Customer_Interaction|v24.0
|
| - 1.3.5.7|Report_Customer_interaction|v24.0
|
| - 1.6.9|Business_Partner_Interaction_Management|v24.0
|
| - 1.6.9.1|Log_Business_Partner_Interaction|v24.0
|
| - 1.6.9.3|Track_and_Manage_Business_Partner_Interaction|v24.0
|
| - 1.6.9.5|Analyze_&_Report_Business_Partner_Interactions|v24.0
|
| functionalFrameworkFunctions:
|
| - 93|Customer_Behavior_Tracking|v24.0
|
| - 163|Contact_Queuing|v24.0
|
| - 165|Customer_Support_Collaboration_Access|v24.0
|
| - 168|Voice_Channel_Contact_Routing|v24.0
|
| - 189|Customer_Interaction_Information_Capturing|v24.0
|
| - 191|Customer_Relationship/Context_Event_Data_Accumulation|v24.0
|
| - 196|Customer_Interaction_Logging|v24.0
|
| - 239|Recommendation_to_Customer_Notification|v24.0
|
| - 1041|Partner_Interaction_Journalizing|v24.0
|
| SIDs:
|
| - Shared_Domain|Communication_Interaction_ABE|v25.0
|
| managementFunction:
|
| exposedAPIs:
|
| - name: metrics
|
| apiType: prometheus
|
| apiSDO: not_defined
|
| specification:
|
| - url: '{{.Release.Name}}-{{.Values.component.name}}-sm'
|
| version: v4.0.0
|
| implementation: '{{.Release.Name}}-{{.Values.component.name}}-sm'
|
| path: /{{.Release.Name}}-{{.Values.component.name}}/metrics
|
| port: 4000
|
| id: exposedAPI_id
|
| version: exposedAPI_version
|
| resources: []
|
| required: false
|
| developerUI: exposedAPI_developerUI
|
| dependentAPIs:
|
| - name: dependentAPI_name
|
| id: dependentAPI_id
|
| version: dependentAPI_version
|
| apiType: dependentAPI_apiType
|
| apiSDO: dependentAPI_apiSDO
|
| specification:
|
| - url: dependentAPI_spec
|
| version: dependentAPI_version
|
| resources: []
|
| required: false
|
| securityFunction:
|
| canvasSystemRole: '{{ .Values.security.controllerRole }}'
|
| secretsManagement:
|
| type: sideCar
|
| sideCar:
|
| port: 8080
|
| podSelector:
|
| namespace: '{{ .Values.secretsManagement.podSelector.namespace }}'
|
| name: '{{ .Values.secretsManagement.podSelector.name }}'
|
| serviceaccount: '{{ .Values.secretsManagement.podSelector.serviceaccount }}'
|
| exposedAPIs:
|
| - id: TMF669
|
| apiType: openapi
|
| apiSDO: not_defined
|
| name: party-role-management-api
|
| required: true
|
| specification:
|
| - url: https://tmf-open-api-table-documents.s3.eu-west-1.amazonaws.com/OpenApiTable/TMF669_Party_Role/4.0.0/swagger/TMF669_Party_Role_Management_API_v4.0.0_swagger.json
|
| version: v4.0.0
|
| path: /{{.Release.Name}}-{{.Values.component.name}}/tmf-api/partyRoleManagement/v4
|
| developerUI: /{{.Release.Name}}-{{.Values.component.name}}/tmf-api/partyRoleManagement/v4/docs
|
| implementation: '{{.Release.Name}}-partyroleapi'
|
| port: 8080
|
| resources: []
|
| dependentAPIs: []
|
| eventNotification:
|
| publishedEvents:
|
| - hub: /{{.Release.Name}}-{{.Values.component.type}}/tmf-api/PartyInteractionManagement/hub
|
| implementation: /{{.Release.Name}}-PartyInteractionManagementEvent
|
| name: PartyInteractionManagement
|
| port: 80
|
| resources:
|
| - partyInteractionCreateEvent
|
| - partyInteractionAttributeValueChangeEvent
|
| - partyInteractionDeleteEvent
|
| - partyInteractionStatusChangeEvent
|
| specification:
|
| - url: https://github.com/tmforum-apis/TMF683_PartyInteraction/blob/master/partyInteractionManagement_TMF_v1.0.0Review2.json
|
| version: null
|
| apiType: openapi
|
| id: TMF683
|
| apiSDO: not_defined
|
| - hub: /{{.Release.Name}}-{{.Values.component.type}}/tmf-api/ProcessFlowManagement/hub
|
| implementation: /{{.Release.Name}}-ProcessFlowManagementEvent
|
| name: ProcessFlowManagement
|
| port: 80
|
| resources:
|
| - processFlowCreateEvent
|
| - processFlowStateChangeEvent
|
| - processFlowStateDeleteEvent
|
| - processFlowStateAttributeValueChangeEvent
|
| - taskFlowCreateEvent
|
| - taskFlowStateChangeEvent
|
| - taskFlowDeleteEvent
|
| - taskFlowAttributeValueChangeEvent
|
| - taskFlowInformationRequiredEvent
|
| specification:
|
| - url: https://github.com/tmforum-apis/TMF701_ProcessFlow/blob/master/TMF701-ProcessFlow-v4.1.0.swagger.json
|
| version: v4.0.0
|
| apiType: openapi
|
| id: TMF701
|
| apiSDO: not_defined
|
| subscribedEvents:
|
| - implementation: /{{.Release.Name}}-PartyManagement
|
| name: PartyManagement
|
| port: 80
|
| resources:
|
| - individualCreateEvent
|
| - individualAttributeValueChangeEvent
|
| - individualStateChangeEvent
|
| - individualDeleteEvent
|
| - organizationCreateEvent
|
| - organizationAttributeValueChangeEvent
|
| - organizationStateChangeEvent
|
| - organizationDeleteEvent
|
| specification:
|
| - url: https://github.com/tmforum-apis/TMF632_PartyManagement/blob/master/TMF632-Party-v4.0.0.swagger.json
|
| version: v4.0.0
|
| apiType: openapi
|
| id: TMF632
|
| callback: /{{.Release.Name}}-{{.Values.component.type}}/tmf-api/PartyManagement/call-back
|
| apiSDO: not_defined
|
| - implementation: /{{.Release.Name}}-PartyRoleManagement
|
| name: PartyRoleManagement
|
| port: 80
|
| resources:
|
| - partyRoleCreateEvent
|
| specification:
|
| - url: https://github.com/tmforum-apis/TMF669_PartyRole/blob/master/TMF669-PartyRole-v4.0.0.swagger.json
|
| version: v4.0.0
|
| apiType: openapi
|
| id: TMF669
|
| callback: /{{.Release.Name}}-{{.Values.component.type}}/tmf-api/PartyRoleManagement/call-back
|
| apiSDO: not_defined
|
| - implementation: /{{.Release.Name}}-DocumentgManagementEvent
|
| name: documentManagement
|
| port: 80
|
| resources:
|
| - documentChangeEvent
|
| - documentSpecificationAttributeValueChangeEvent
|
| specification:
|
| - url: https://github.com/tmforum-apis/TMF667_Document/blob/master/TMF667-Document-v4.0.0.swagger.json
|
| version: v4.0.0
|
| apiType: openapi
|
| id: TMF667
|
| callback: /{{.Release.Name}}-{{.Values.component.type}}/tmf-api/DocumentgManagement/call-back
|
| apiSDO: not_defined
|
| - hub: /{{.Release.Name}}-{{.Values.component.type}}/tmf-api/ProcessFlowManagement/hub
|
| implementation: /{{.Release.Name}}-ProcessFlowManagementEvent
|
| name: ProcessFlowManagement
|
| port: 80
|
| resources:
|
| - processFlowCreateEvent
|
| - processFlowStateChangeEvent
|
| - taskFlowCreateEvent
|
| - taskFlowStateChangeEvent
|
| specification:
|
| - url: https://github.com/tmforum-apis/TMF701_ProcessFlow/blob/master/TMF701-ProcessFlow-v4.1.0.swagger.json
|
| version: v4.0.0
|
| apiType: openapi
|
| id: TMF701
|
| apiSDO: not_defined |
| ``` |
|
|
