> For the complete documentation index, see [llms.txt](https://uci.sunbird.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://uci.sunbird.org/use/developer/uci-basics/adapters.md).

# Adapters

## 1. Conversation Channel Adapters

Adapters convert information provided by channels (SMS, Whatsapp) for each specific provider to xMessages and vise versa. Adapters are gateway to the external services and resposible to recieving user response and sending response to users. Thus the two major functions of Adapters are

* Convert API/webhook data from channel (and provider) to xMessages
* Convert xMessages back to API/webhook data format for the specific channel(and provider)

A simplified diagram of what adapters do is shown below.

![](https://1242145269-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FnC2042spZ2TIbqdRA37S%2Fuploads%2FkIo3hjgtdIgMj0Zw8Dgo%2Fadapter.jpg?alt=media\&token=6b3368e5-998f-4424-812d-e3aa1109631f)

## 2. How to works

The adapter and the inbound service are linked together as shown in the figure below.

![](https://1242145269-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FnC2042spZ2TIbqdRA37S%2Fuploads%2FYoKc5mydUNHr7eB8ZwYT%2Fadapter-internal.jpg?alt=media\&token=3d8311b7-8416-4d49-8a5e-840efef974e3)

Similarly, the adapter and the outbound service are linked in the following fashion.

![](https://1242145269-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FnC2042spZ2TIbqdRA37S%2Fuploads%2FQWY1sJ0rJ8CuDM3ozg0f%2Foutbound.jpeg?alt=media\&token=198e778e-26e7-4cb0-b5a9-671a576a89ed)

## 3. List of Existing Adapters

* Gupshup-Whatsapp
* Netcore-Whatsapp
* UCI Web Channel
* Firebase Adapter

## 4. How to create an adapter

[Click here](/use/developer/contribution-guide/create-an-adapter.md) to see how to create your own adapter.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://uci.sunbird.org/use/developer/uci-basics/adapters.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.