Client Channel API
The Client Channel API provides you with a standardized method to exchange messages between several types of third-party client channels, for example, Teams, Webex, or Slack, and Digital Messaging Service.
The process of sending and receiving messages as JSON payload requests using the Client Channel API consists of four stages:
- Your client channel sends messages to the integration layer that you configure in premises (back-end), using the communication method that is specific to the type of client channel.
- In your integration layer, transform the received client channel payload into the
format that is required by the Client Channel API. Then, pass the message to the
endpoint for the Digital Messaging Service.
This endpoint is the Digital Messaging Webhook URL that the system specifies in your Digital Messaging Manager and Client Channel API settings, for example: https://incoming.artemis.pega.digital/messages
The Digital Messaging Service then forwards the message to your Pega Platform application.
- Your Pega Platform application returns a response to the Digital Messaging Service which then forwards the response to the endpoint that you specify for your integration layer in your Digital Messaging Manager Client Channel API settings, for example: https://sampleclientchannelwebhook.com. You must configure the webhook URL so that the URL is publicly accessible (off VPN) to enable communication with Digital Messaging Service. If your integration layer is behind a firewall or otherwise limits access to internal-only users and components, you must set up the webhook URL so that the URL is reachable publicly.
- Your integration layer transforms the received Digital Messaging Service payload into the required format by your client channel, and then passes the message to the client channel endpoint.
Supported message types
The system supports the following features during communication from a third-party client channel to Digital Messaging Service:
- Text messages
- Typing indicators
- Attachments
- Postbacks (HTTP POST to the same place)
- End session event (customer ended the conversation)
- Context data
- Text messages
- Typing indicators
- Attachments
- List pickers
- Links or buttons
- Carousels
- End session event (CSR or chatbot ended the conversation)
Previous topic Setting up the IVA for Client Channel API Next topic Client Channel API guidelines