Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs revamp #819

Merged
merged 17 commits into from
Aug 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 83 additions & 0 deletions docs/contacts/manage-contacts.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
---
title: "Manage Contacts"
description: "Learn how to manage your contacts and enrich them with our +200 million users database"
icon: "user"
---

<img src="/images/contacts.png" style={{ borderRadius: '8px' }} />

## Terminology

<CardGroup cols={2}>
<Card title="What is a contact?" icon="user" color="#f7b245" iconType="solid" href="#what-is-a-contact"></Card>
</CardGroup>

## Create a contact

<CardGroup cols={3}>
<Card title="Using the API" icon="code" color="#f7b245" iconType="solid" href="#1-using-the-api"></Card>
<Card title="Using the widget" icon="code" color="#f7b245" iconType="solid" href="/widget/embed#identifying-chat-users-contacts"></Card>
<Card title="From emails" icon="inbox" color="#f7b245" iconType="solid" href="#3-from-emails"></Card>
<Card title="From phone calls" icon="phone" color="#f7b245" iconType="solid" href="#4-from-phone-calls"></Card>
</CardGroup>

## Advanced Topics

<CardGroup cols={3}>
<Card title="Attach custom data to a contact" icon="code" color="#f7b245" iconType="solid" href="#adding-custom-data-to-a-contact"></Card>
</CardGroup>

----

### What is a contact?

A contact is a user that can interact with the chatbot, phone AI, or email AI. A single contact might have multiple conversations across different channels.

----

### How do I create a contact?

You can create a contact in your organization in two ways:

#### 1. Using the API

We have a simple public API that allows you to manage contacts in your organization. You can use the API to [create a contact](/api-reference/contacts/create).

#### 2. Using the widget

Whenever you embed the copilot widget in your application, you can use the widget options to create a contact. Read more about this option in the [widget documentation](/widget/embed#identifying-chat-users-contacts).

#### 3. From emails

When you send emails using our APIs, OpenCopilot will automatically create a contact for you (if it doesn't exist yet) and assign it to the conversation.

#### 4. From phone calls

When you receive (or initiate) a phone call using our APIs, OpenCopilot will automatically create a contact for you (if it doesn't exist yet) and assign it to the conversation.

----

### Adding custom data to a contact

We support attaching a phone number, email, or name to a contact. However, you can also add any custom data you want to associate with the contact. This data will be returned in the response and can be used for any purpose you want. Just make sure it's a valid JSON string object. The custom data is a simple JSON object. You can add any key-value pairs you want to it, for example:

```jsx
const widgetOptions = {
initialMessage: "Hello! How can I help you?",
token: "your_copilot_token_goes_here",
user: {
name: "your_user_name",
email: "your_user_email",
avatar: "your_user_avatar_url",
phone: "your_user_phone",
customData: {
// any custom data you want to send to the copilot backend
"key1": "value1",
"balance": 100,
"age": 25,
}
},
```
You can use the API or the widget to add custom data to a contact.


Binary file added docs/images/contacts.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/phone-step-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/phone-step-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/phone-step-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
38 changes: 31 additions & 7 deletions docs/inbox/intro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,45 @@
title: "Inbox"
---

<img src="https://framerusercontent.com/images/PGeDCA1zfA8E2ZjDePri8XUyx1I.png" alt="Inbox" />
**(_Everything is in a single place, no matter what channel you are using - email, chat, phone, etc._)**
<img src="https://cloud.opencopilot.so/chat-empty-state.png" alt="Inbox" />
**(_Everything is in a single place, no matter what channel you are usingemail, chat, phone, etc._)**

Inbox is a centralized place to view, manage, and take action on your customer support conversations across all your channels (email, chat, phone, etc.).
The Inbox is a centralized place to view, manage, and take action on your customer support conversations across all your channels (email, chat, phone, etc.).

- You will be able to see all your customer support conversations in one place.
- You can take action on your conversations from the Inbox (reply, change status, add notes, share, etc.).

### Types of Inboxes:
**Types of Inboxes:**

- **Assigned to Me** - Any conversation you have with a customer assigned to you.
- **Assigned to Copilot** - Any conversation that is being handled by the AI.
- **Unassigned** - Any conversation that is not assigned to you or the AI.
- **Everything** - All conversations.

<Warning>
This is a beta feature and might not work as expected. Please reach out to us at [[email protected]](mailto:[email protected]) if you have any questions.
</Warning>
### FAQ

<AccordionGroup>
<Accordion title="I replied to a conversation and now I can no longer see it in the Inbox">
If you replied to a conversation that was assigned to the AI, it will be automatically assigned to you, so you should be able to find it in the Inbox -> Assigned to You section.
</Accordion>

<Accordion title="What happens if I reply to a phone conversation using text?">
If you reply to a phone conversation using text, Open will send this text message to the customer's phone number.
</Accordion>
</AccordionGroup>

## Available APIs

Open provides top-of-the-line APIs for developers to build on top of our platform, including inbox APIs.

<CardGroup cols={2}>
<Card
title="Inbox"
icon="inbox"
href="inbox/intro"
color="#f7b245"
iconType="solid"
>
List and manage support requests and conversations from web, phone, and email channels in a single place.
</Card>
</CardGroup>
Loading
Loading