Party Interaction Management API
REST API
Overview
A User Interaction captures information about past interactions in order to re-use it in future ones. This allows agents to serve users better by knowing the steps they went through. It also allows customers to see better the actions they have performed and how they interacted with us.
Version history
v5.0.0
08-May-2026 docker-compose has been expanded to enable proxy settings by default, simplifying CTK execution in corporate HTTP proxy environments where this previously required in‑house configuration. README files have been updated to document proxy usage. Failed HTML reports can now be opened directly in a browser, and HTML reports now include headers identifying the API and CTK version used, improving certification clarity and traceability.
21-Jan-2026 The CTK and RI have been re-released in a dockerized format, this may require different set up requirements and any automation platforms will need to be updated. Click here for more information.
V4.0 15-May-2026 – CTK updated docker-compose has been expanded to enable proxy settings by default, simplifying CTK execution in corporate HTTP proxy environments. README files have been updated to document proxy configuration.
API No.
TMF683
Stable version
v5.0
This Version
v5.0
Types
RESTful
DOMAIN
Business Partner
IPR MODE
Apache 2.0 unless stated
Release Date
08 May 2026
API assets v5.0
OPEN API SPECIFICATION
Postman collection
API USER GUIDE (RAND)
NewSample implementation code
NewCTK
Conformance Profile (RAND)
Components
ODA Components are the software building blocks of a cloud native digital service provider’s network and IT systems, designed for plug-and-play interoperability in a standardized deployment environment (the ODA Canvas). This is a list of ODA Components that expose this API either as a Mandatory or Optional API.
Mandatory
