mirror of
https://github.com/lingble/chatwoot.git
synced 2025-11-01 19:48:08 +00:00
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>
82 lines
2.6 KiB
Ruby
82 lines
2.6 KiB
Ruby
class Messages::Messenger::MessageBuilder
|
|
include ::FileTypeHelper
|
|
|
|
def process_attachment(attachment)
|
|
# This check handles very rare case if there are multiple files to attach with only one usupported file
|
|
return if unsupported_file_type?(attachment['type'])
|
|
|
|
attachment_obj = @message.attachments.new(attachment_params(attachment).except(:remote_file_url))
|
|
attachment_obj.save!
|
|
attach_file(attachment_obj, attachment_params(attachment)[:remote_file_url]) if attachment_params(attachment)[:remote_file_url]
|
|
fetch_story_link(attachment_obj) if attachment_obj.file_type == 'story_mention'
|
|
update_attachment_file_type(attachment_obj)
|
|
end
|
|
|
|
def attach_file(attachment, file_url)
|
|
attachment_file = Down.download(
|
|
file_url
|
|
)
|
|
attachment.file.attach(
|
|
io: attachment_file,
|
|
filename: attachment_file.original_filename,
|
|
content_type: attachment_file.content_type
|
|
)
|
|
end
|
|
|
|
def attachment_params(attachment)
|
|
file_type = attachment['type'].to_sym
|
|
params = { file_type: file_type, account_id: @message.account_id }
|
|
|
|
if [:image, :file, :audio, :video, :share, :story_mention, :ig_reel].include? file_type
|
|
params.merge!(file_type_params(attachment))
|
|
elsif file_type == :location
|
|
params.merge!(location_params(attachment))
|
|
elsif file_type == :fallback
|
|
params.merge!(fallback_params(attachment))
|
|
end
|
|
|
|
params
|
|
end
|
|
|
|
def file_type_params(attachment)
|
|
{
|
|
external_url: attachment['payload']['url'],
|
|
remote_file_url: attachment['payload']['url']
|
|
}
|
|
end
|
|
|
|
def update_attachment_file_type(attachment)
|
|
return if @message.reload.attachments.blank?
|
|
return unless attachment.file_type == 'share' || attachment.file_type == 'story_mention'
|
|
|
|
attachment.file_type = file_type(attachment.file&.content_type)
|
|
attachment.save!
|
|
end
|
|
|
|
def fetch_story_link(attachment)
|
|
message = attachment.message
|
|
result = get_story_object_from_source_id(message.source_id)
|
|
|
|
return if result.blank?
|
|
|
|
story_id = result['story']['mention']['id']
|
|
story_sender = result['from']['username']
|
|
message.content_attributes[:story_sender] = story_sender
|
|
message.content_attributes[:story_id] = story_id
|
|
message.content_attributes[:image_type] = 'story_mention'
|
|
message.content = I18n.t('conversations.messages.instagram_story_content', story_sender: story_sender)
|
|
message.save!
|
|
end
|
|
|
|
# This is a placeholder method to be overridden by child classes
|
|
def get_story_object_from_source_id(_source_id)
|
|
{}
|
|
end
|
|
|
|
private
|
|
|
|
def unsupported_file_type?(attachment_type)
|
|
[:template, :unsupported_type].include? attachment_type.to_sym
|
|
end
|
|
end
|