Call Flow
The
call flow is as follows -
1. The SaaS Application (SA) discovers the location of the
Trusted Application API (API)
2. Gets the capabilities. In this case, only messaging
capability is available
3. SA sends a messaging invitation to the API
4. API forwards it to the SFB online recipient - recipient can
be using any client (sip, mobile, web client, etc.)
5. SFB online user sends a plain text message
6. API sends it to the SA
7. SA replies with plain text message
8. API sends it to the SFB online user
9. SFB online user sends a html message
10. API sends it to the SA
11. SA responds with a html message
12. API sends it to the SFB online user
13. SFB online user terminates the conversation
The
way the API informs the SA of any event is via the callback url.
In order for the SA to keep context when starting a new invitation or message,
an operation id can be passed in. This id will be sent back in the callback
event.
The
general principles, capabilities, API style, API concepts are modeled to closely
follow the already released UCWA API. Please see this link for detailed info - UCWA API reference
Being
familiar with the UCWA concepts greatly simplifies understanding the Trusted
Application APIs
The
detailed call flow is shown in the diagram below. Each of the capability
related APIs, related callbacks are modeled on the UCWA capabilities and
callback structure. Please refer to the UCWA API reference to get detailed
description about these
calls.
