From de696a55cbbc0af3ad55e2cffe856ac883d139b6 Mon Sep 17 00:00:00 2001 From: Tanmay Deep Sharma <32020192+tds-1@users.noreply.github.com> Date: Tue, 12 May 2026 11:23:57 +0530 Subject: [PATCH] feat(voice): add WhatsApp inbound call webhook pipeline [3] (#14315) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Adds the server-side flow that turns Meta WhatsApp Cloud Calling webhooks into Chatwoot Calls, conversations, voice_call message bubbles, and ActionCable broadcasts. Stacked on top of #14312 (PR-2 — provider methods); intentionally does not include the HTTP controller, routes, or frontend (those land in PR-4 and PR-9). ## Closes - Part of the WhatsApp Cloud Calling rollout. Linear: TBD ## What changed **Webhook routing** - `app/jobs/webhooks/whatsapp_events_job.rb` — append `prepend_mod_with('Webhooks::WhatsappEventsJob')` so EE can extend it without forking. - `enterprise/app/jobs/enterprise/webhooks/whatsapp_events_job.rb` (new) — overlay that prepends `handle_message_events` to intercept `field: 'calls'` payloads (route to `Whatsapp::IncomingCallService`) and `interactive.call_permission_reply` messages (route to `Whatsapp::CallPermissionReplyService`); falls through with `super` for regular messages. **Services** - `enterprise/app/services/whatsapp/incoming_call_service.rb` (new) — gated on `provider_config['calling_enabled']`; processes `connect` (creates inbound call via `Voice::InboundCallBuilder` or transitions an existing outbound call to `in_progress`) and `terminate` events; updates conversation `additional_attributes` and broadcasts `voice_call.incoming`/`voice_call.outbound_connected`/`voice_call.ended`. - `enterprise/app/services/whatsapp/call_permission_reply_service.rb` (new) — handles WhatsApp interactive `call_permission_reply` replies; clears the conversation's `call_permission_requested_at` flag and broadcasts `voice_call.permission_granted` so the agent UI can re-enable the call button. **Builder/model adjustments** - `enterprise/app/services/voice/inbound_call_builder.rb` — provider-agnostic; accepts `provider:` and `extra_meta:` kwargs, drops `account:` (now derived from `inbox.account` to keep the param count under rubocop's ceiling without disabling cops), uses digits-only `source_id` for WhatsApp ContactInbox (validation requires `^\d{1,15}\z`), skips Twilio-only `conference_sid` for non-Twilio providers. - `enterprise/app/services/voice/call_message_builder.rb` — adds `create!`/`update_status!` API and `CALL_TO_VOICE_STATUS` map; uses direct `Message.create!` (bypasses `Messages::MessageBuilder`'s incoming-on-non-Api-inbox guard, which would otherwise reject the system bubble); content is `'WhatsApp Call'` for WhatsApp and `'Voice Call'` for Twilio. Backwards-compatible `perform!` retained for the existing Twilio call sites. - `enterprise/app/models/call.rb` — adds `default_ice_servers` (driven by `VOICE_CALL_STUN_URLS` env), `direction_label` alias for the `inbound`/`outbound` strings the FE expects, and `ringing?`/`in_progress?`/`terminal?` predicates used throughout the pipeline. **Outgoing-channel guard** - `app/services/base/send_on_channel_service.rb` — extends `invalid_message?` to skip messages with `content_type == 'voice_call'`. Without this, agent-initiated outbound calls (PR-4) would deliver \"WhatsApp Call\" as a text message to the contact every time. **Twilio call-site update** - `enterprise/app/controllers/twilio/voice_controller.rb` — drops the now-redundant `account: current_account` kwarg from the `Voice::InboundCallBuilder.perform!` call. **Tests** - New: `spec/enterprise/services/whatsapp/incoming_call_service_spec.rb` (5 examples — calling-disabled, inbound connect, outbound connect, terminate completed, terminate no-answer, unknown event). - New: `spec/enterprise/services/whatsapp/call_permission_reply_service_spec.rb` (3 examples — accept, reject, calling-disabled). - Updated: `spec/enterprise/services/voice/inbound_call_builder_spec.rb` and `spec/enterprise/controllers/twilio/voice_controller_spec.rb` to drop the `account:` kwarg from call expectations. ## How to test In `rails console` against an account with a WhatsApp inbox where `provider_config['calling_enabled']` is true: ```ruby inbox = Inbox.find() params = { calls: [{ id: 'wacid_test', from: '15550001111', event: 'connect', session: { sdp: 'v=0...', sdp_type: 'offer' } }] } Whatsapp::IncomingCallService.new(inbox: inbox, params: params).perform # => Conversation + Call (status: 'ringing', provider: 'whatsapp') + voice_call message bubble # => ActionCable broadcasts `voice_call.incoming` to the assignee or account-wide # Then terminate it: Whatsapp::IncomingCallService.new(inbox: inbox, params: { calls: [{ id: 'wacid_test', event: 'terminate', duration: 0, terminate_reason: 'no_answer' }] } ).perform # => Call status flips to 'no_answer', message bubble updates, `voice_call.ended` broadcast fires ``` End-to-end browser flow (Meta → cable → UI) requires the controller from PR-4 and the frontend from PR-9. --------- Co-authored-by: Claude Opus 4.7 (1M context) --- .../messages/messenger/message_builder.rb | 4 + app/jobs/webhooks/whatsapp_events_job.rb | 2 + app/models/attachment.rb | 12 + app/models/channel/whatsapp.rb | 10 + app/services/base/send_on_channel_service.rb | 3 +- app/services/whatsapp/facebook_api_client.rb | 2 +- app/views/api/v1/models/_inbox.json.jbuilder | 3 + config/initializers/active_storage.rb | 13 + config/locales/en.yml | 13 + config/routes.rb | 15 ++ .../enterprise/messages/message_builder.rb | 7 +- .../v1/accounts/contacts/calls_controller.rb | 19 +- .../v1/accounts/whatsapp_calls_controller.rb | 187 ++++++++++++++ .../controllers/twilio/voice_controller.rb | 1 - .../webhooks/whatsapp_events_job.rb | 59 +++++ enterprise/app/models/call.rb | 29 ++- .../models/enterprise/concerns/attachment.rb | 19 ++ .../app/models/enterprise/conversation.rb | 15 ++ .../providers/whatsapp_cloud_service.rb | 19 +- .../services/voice/call_message_builder.rb | 30 ++- .../services/voice/inbound_call_builder.rb | 61 +++-- .../services/voice/outbound_call_builder.rb | 9 +- .../whatsapp/call_permission_reply_service.rb | 73 ++++++ .../app/services/whatsapp/call_service.rb | 110 ++++++++ .../whatsapp/incoming_call_service.rb | 186 ++++++++++++++ .../whatsapp_calls/accept.json.jbuilder | 1 + .../whatsapp_calls/initiate.json.jbuilder | 5 + .../whatsapp_calls/reject.json.jbuilder | 2 + .../whatsapp_calls/show.json.jbuilder | 1 + .../whatsapp_calls/terminate.json.jbuilder | 2 + .../upload_recording.json.jbuilder | 2 + .../v1/models/_whatsapp_call.json.jbuilder | 24 ++ .../twilio/voice_controller_spec.rb | 1 - .../providers/whatsapp_cloud_service_spec.rb | 8 +- .../voice/inbound_call_builder_spec.rb | 40 ++- .../call_permission_reply_service_spec.rb | 98 +++++++ .../whatsapp/incoming_call_service_spec.rb | 242 ++++++++++++++++++ .../telegram/send_attachments_service_spec.rb | 4 +- .../whatsapp/facebook_api_client_spec.rb | 4 +- 39 files changed, 1288 insertions(+), 47 deletions(-) create mode 100644 config/initializers/active_storage.rb create mode 100644 enterprise/app/controllers/api/v1/accounts/whatsapp_calls_controller.rb create mode 100644 enterprise/app/jobs/enterprise/webhooks/whatsapp_events_job.rb create mode 100644 enterprise/app/services/whatsapp/call_permission_reply_service.rb create mode 100644 enterprise/app/services/whatsapp/call_service.rb create mode 100644 enterprise/app/services/whatsapp/incoming_call_service.rb create mode 100644 enterprise/app/views/api/v1/accounts/whatsapp_calls/accept.json.jbuilder create mode 100644 enterprise/app/views/api/v1/accounts/whatsapp_calls/initiate.json.jbuilder create mode 100644 enterprise/app/views/api/v1/accounts/whatsapp_calls/reject.json.jbuilder create mode 100644 enterprise/app/views/api/v1/accounts/whatsapp_calls/show.json.jbuilder create mode 100644 enterprise/app/views/api/v1/accounts/whatsapp_calls/terminate.json.jbuilder create mode 100644 enterprise/app/views/api/v1/accounts/whatsapp_calls/upload_recording.json.jbuilder create mode 100644 enterprise/app/views/api/v1/models/_whatsapp_call.json.jbuilder create mode 100644 spec/enterprise/services/whatsapp/call_permission_reply_service_spec.rb create mode 100644 spec/enterprise/services/whatsapp/incoming_call_service_spec.rb diff --git a/app/builders/messages/messenger/message_builder.rb b/app/builders/messages/messenger/message_builder.rb index be1f98b43..ecd6f06ea 100644 --- a/app/builders/messages/messenger/message_builder.rb +++ b/app/builders/messages/messenger/message_builder.rb @@ -28,6 +28,10 @@ class Messages::Messenger::MessageBuilder filename: attachment_file.original_filename, content_type: attachment_file.content_type ) + # The Attachment row is saved before the blob is attached, so the + # after_create_commit broadcast bails on `file.attached?`. Re-fire here + # for audio so the bubble updates without waiting on transcription. + attachment.message&.reload&.send_update_event if attachment.file_type.to_sym == :audio end def attachment_params(attachment) diff --git a/app/jobs/webhooks/whatsapp_events_job.rb b/app/jobs/webhooks/whatsapp_events_job.rb index b0bede8b0..49b7265b8 100644 --- a/app/jobs/webhooks/whatsapp_events_job.rb +++ b/app/jobs/webhooks/whatsapp_events_job.rb @@ -128,3 +128,5 @@ class Webhooks::WhatsappEventsJob < MutexApplicationJob return channel if channel && channel.provider_config['phone_number_id'] == phone_number_id end end + +Webhooks::WhatsappEventsJob.prepend_mod_with('Webhooks::WhatsappEventsJob') diff --git a/app/models/attachment.rb b/app/models/attachment.rb index 769e134be..8c87ff433 100644 --- a/app/models/attachment.rb +++ b/app/models/attachment.rb @@ -104,11 +104,23 @@ class Attachment < ApplicationRecord audio_file_data = base_data.merge(file_metadata) audio_file_data.merge( { + # ActiveStorage's redirect endpoint defaults to Content-Disposition: attachment, + # which makes