This PR introduces basic minimum version of **Instagram Business Login**, making Instagram inbox setup more straightforward by removing the Facebook Page dependency. This update enhances user experience and aligns with Meta’s recommended best practices. Fixes https://linear.app/chatwoot/issue/CW-3728/instagram-login-how-to-implement-the-changes ## Why Introduce Instagram as a Separate Inbox? Currently, our Instagram integration requires linking an Instagram account to a Facebook Page, making setup complex. To simplify this process, Instagram now offers **Instagram Business Login**, which allows users to authenticate directly with their Instagram credentials. The **Instagram API with Instagram Login** enables businesses and creators to send and receive messages without needing a Facebook Page connection. While an Instagram Business or Creator account is still required, this approach provides a more straightforward integration process. | **Existing Approach (Facebook Login for Business)** | **New Approach (Instagram Business Login)** | | --- | --- | | Requires linking Instagram to a Facebook Page | No Facebook Page required | | Users log in via Facebook credentials | Users log in via Instagram credentials | | Configuration is more complex | Simpler setup | Meta recommends using **Instagram Business Login** as the preferred authentication method due to its easier configuration and improved developer experience. --- ## Implementation Plan The core messaging functionality is already in place, but the transition to **Instagram Business Login** requires adjustments. ### Changes & Considerations - **API Adjustments**: The Instagram API uses `graph.instagram`, whereas Koala (our existing library) interacts with `graph.facebook`. We may need to modify API calls accordingly. - **Three Main Modules**: 1. **Instagram Business Login** – Handle authentication flow. 2. **Permissions & Features** – Ensure necessary API scopes are granted. 3. **Webhooks** – Enable real-time message retrieval.  --- ## Instagram Login Flow 1. User clicks **"Create Inbox"** for Instagram. 2. App redirects to the [Instagram Authorization URL](https://developers.facebook.com/docs/instagram-platform/instagram-api-with-instagram-login/business-login#embed-the-business-login-url). 3. After authentication, Instagram returns an authorization code. 5. The app exchanges the code for a **long-lived token** (valid for 60 days). 6. Tokens are refreshed periodically to maintain access. 7. Once completed, the app creates an inbox and redirects to the Chatwoot dashboard. --- ## How to Test the Instagram Inbox 1. Create a new app on [Meta's Developer Portal](https://developers.facebook.com/apps/). 2. Select **Business** as the app type and configure it. 3. Add the Instagram product and connect a business account. 4. Copy Instagram app ID and Instagram app secret 5. Add the Instagram app ID and Instagram app secret to your app config via `{Chatwoot installation url}/super_admin/app_config?config=instagram` 6. Configure Webhooks: - Callback URL: `{your_chatwoot_url}/webhooks/instagram` - Verify Token: `INSTAGRAM_VERIFY_TOKEN` - Subscribe to `messages`, `messaging_seen`, and `message_reactions` events. 7. Set up **Instagram Business Login**: - Redirect URL: `{your_chatwoot_url}/instagram/callback` 8. Test inbox creation via the Chatwoot dashboard. ## Troubleshooting & Common Errors ### Insufficient Developer Role Error - Ensure the Instagram user is added as a developer: - **Meta Dashboard → App Roles → Roles → Add People → Enter Instagram ID** ### API Access Deactivated - Ensure the **Privacy Policy URL** is valid and correctly set. ### Invalid request: Request parameters are invalid: Invalid redirect_uri - Please configure the Frontend URL. The Frontend URL does not match the authorization URL. --- ## To-Do List - [x] Basic integration setup completed. - [x] Enable sending messages via [Messaging API](https://developers.facebook.com/docs/instagram-platform/instagram-api-with-instagram-login/messaging-api). - [x] Implement automatic webhook subscriptions on inbox creation. - [x] Handle **canceled authorization errors**. - [x] Handle all the errors https://developers.facebook.com/docs/instagram-platform/instagram-graph-api/reference/error-codes - [x] Dynamically fetch **account IDs** instead of hardcoding them. - [x] Prevent duplicate Instagram channel creation for the same account. - [x] Use **Global Config** instead of environment variables. - [x] Explore **Human Agent feature** for message handling. - [x] Write and refine **test cases** for all scenarios. - [x] Implement **token refresh mechanism** (tokens expire after 60 days). Fixes https://github.com/chatwoot/chatwoot/issues/10440 --------- Co-authored-by: Sivin Varghese <64252451+iamsivin@users.noreply.github.com> Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com> Co-authored-by: Shivam Mishra <scm.mymail@gmail.com>
123 lines
3.1 KiB
Vue
123 lines
3.1 KiB
Vue
<script setup>
|
|
import { computed } from 'vue';
|
|
import { messageTimestamp } from 'shared/helpers/timeHelper';
|
|
|
|
import MessageStatus from './MessageStatus.vue';
|
|
import Icon from 'next/icon/Icon.vue';
|
|
import { useInbox } from 'dashboard/composables/useInbox';
|
|
import { useMessageContext } from './provider.js';
|
|
|
|
import { MESSAGE_STATUS, MESSAGE_TYPES } from './constants';
|
|
|
|
const {
|
|
isAFacebookInbox,
|
|
isALineChannel,
|
|
isAPIInbox,
|
|
isASmsInbox,
|
|
isATelegramChannel,
|
|
isATwilioChannel,
|
|
isAWebWidgetInbox,
|
|
isAWhatsAppChannel,
|
|
isAnEmailChannel,
|
|
isAInstagramChannel,
|
|
} = useInbox();
|
|
|
|
const { status, isPrivate, createdAt, sourceId, messageType } =
|
|
useMessageContext();
|
|
|
|
const readableTime = computed(() =>
|
|
messageTimestamp(createdAt.value, 'LLL d, h:mm a')
|
|
);
|
|
|
|
const showStatusIndicator = computed(() => {
|
|
if (isPrivate.value) return false;
|
|
if (messageType.value === MESSAGE_TYPES.OUTGOING) return true;
|
|
if (messageType.value === MESSAGE_TYPES.TEMPLATE) return true;
|
|
|
|
return false;
|
|
});
|
|
|
|
const isSent = computed(() => {
|
|
if (!showStatusIndicator.value) return false;
|
|
|
|
// Messages will be marked as sent for the Email channel if they have a source ID.
|
|
if (isAnEmailChannel.value) return !!sourceId.value;
|
|
|
|
if (
|
|
isAWhatsAppChannel.value ||
|
|
isATwilioChannel.value ||
|
|
isAFacebookInbox.value ||
|
|
isASmsInbox.value ||
|
|
isATelegramChannel.value ||
|
|
isAInstagramChannel.value
|
|
) {
|
|
return sourceId.value && status.value === MESSAGE_STATUS.SENT;
|
|
}
|
|
|
|
// All messages will be mark as sent for the Line channel, as there is no source ID.
|
|
if (isALineChannel.value) return true;
|
|
|
|
return false;
|
|
});
|
|
|
|
const isDelivered = computed(() => {
|
|
if (!showStatusIndicator.value) return false;
|
|
|
|
if (
|
|
isAWhatsAppChannel.value ||
|
|
isATwilioChannel.value ||
|
|
isASmsInbox.value ||
|
|
isAFacebookInbox.value
|
|
) {
|
|
return sourceId.value && status.value === MESSAGE_STATUS.DELIVERED;
|
|
}
|
|
// All messages marked as delivered for the web widget inbox and API inbox once they are sent.
|
|
if (isAWebWidgetInbox.value || isAPIInbox.value) {
|
|
return status.value === MESSAGE_STATUS.SENT;
|
|
}
|
|
if (isALineChannel.value) {
|
|
return status.value === MESSAGE_STATUS.DELIVERED;
|
|
}
|
|
|
|
return false;
|
|
});
|
|
|
|
const isRead = computed(() => {
|
|
if (!showStatusIndicator.value) return false;
|
|
|
|
if (
|
|
isAWhatsAppChannel.value ||
|
|
isATwilioChannel.value ||
|
|
isAFacebookInbox.value ||
|
|
isAInstagramChannel.value
|
|
) {
|
|
return sourceId.value && status.value === MESSAGE_STATUS.READ;
|
|
}
|
|
|
|
if (isAWebWidgetInbox.value || isAPIInbox.value) {
|
|
return status.value === MESSAGE_STATUS.READ;
|
|
}
|
|
|
|
return false;
|
|
});
|
|
|
|
const statusToShow = computed(() => {
|
|
if (isRead.value) return MESSAGE_STATUS.READ;
|
|
if (isDelivered.value) return MESSAGE_STATUS.DELIVERED;
|
|
if (isSent.value) return MESSAGE_STATUS.SENT;
|
|
|
|
return MESSAGE_STATUS.PROGRESS;
|
|
});
|
|
</script>
|
|
|
|
<template>
|
|
<div class="text-xs flex items-center gap-1.5">
|
|
<div class="inline">
|
|
<time class="inline">{{ readableTime }}</time>
|
|
</div>
|
|
<Icon v-if="isPrivate" icon="i-lucide-lock-keyhole" class="size-3" />
|
|
<MessageStatus v-if="showStatusIndicator" :status="statusToShow" />
|
|
</div>
|
|
</template>
|
|
`
|