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(<id>) 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) <noreply@anthropic.com>
210 lines
5.7 KiB
Ruby
210 lines
5.7 KiB
Ruby
class Twilio::VoiceController < ApplicationController
|
|
CONFERENCE_EVENT_PATTERNS = {
|
|
/conference-start/i => 'start',
|
|
/participant-join/i => 'join',
|
|
/participant-leave/i => 'leave',
|
|
/conference-end/i => 'end'
|
|
}.freeze
|
|
|
|
before_action :set_inbox!
|
|
|
|
def status
|
|
Voice::StatusUpdateService.new(
|
|
account: current_account,
|
|
call_sid: twilio_call_sid,
|
|
call_status: params[:CallStatus],
|
|
payload: params.to_unsafe_h
|
|
).perform
|
|
|
|
head :no_content
|
|
end
|
|
|
|
def call_twiml
|
|
Rails.logger.info(
|
|
"TWILIO_VOICE_TWIML account=#{current_account.id} call_sid=#{twilio_call_sid} from=#{twilio_from} direction=#{twilio_direction}"
|
|
)
|
|
|
|
call = resolve_call
|
|
render xml: conference_twiml(call)
|
|
end
|
|
|
|
def conference_status
|
|
event = mapped_conference_event
|
|
if event.nil?
|
|
Rails.logger.info(
|
|
"TWILIO_VOICE_CONFERENCE_UNMAPPED_EVENT account=#{current_account.id} event=#{params[:StatusCallbackEvent]} call_sid=#{twilio_call_sid}"
|
|
)
|
|
return head :no_content
|
|
end
|
|
|
|
call = find_call_for_conference!(params[:FriendlyName], twilio_call_sid)
|
|
persist_twilio_conference_sid!(call, params[:ConferenceSid])
|
|
|
|
Voice::Conference::Manager.new(
|
|
call: call,
|
|
event: event,
|
|
participant_label: participant_label
|
|
).process
|
|
|
|
head :no_content
|
|
end
|
|
|
|
def recording_status
|
|
Voice::RecordingStatusService.new(
|
|
account: current_account,
|
|
payload: params.to_unsafe_h
|
|
).perform
|
|
|
|
head :no_content
|
|
end
|
|
|
|
private
|
|
|
|
def twilio_call_sid
|
|
params[:CallSid]
|
|
end
|
|
|
|
def twilio_from
|
|
params[:From].to_s
|
|
end
|
|
|
|
def twilio_to
|
|
params[:To]
|
|
end
|
|
|
|
def twilio_direction
|
|
@twilio_direction ||= (params['Direction'] || params['CallDirection']).to_s
|
|
end
|
|
|
|
def mapped_conference_event
|
|
event = params[:StatusCallbackEvent].to_s
|
|
CONFERENCE_EVENT_PATTERNS.each do |pattern, mapped|
|
|
return mapped if event.match?(pattern)
|
|
end
|
|
nil
|
|
end
|
|
|
|
def agent_leg?(from_number)
|
|
from_number.start_with?('client:')
|
|
end
|
|
|
|
def resolve_call
|
|
return find_call_for_agent if agent_leg?(twilio_from)
|
|
|
|
case twilio_direction
|
|
when 'inbound'
|
|
Voice::InboundCallBuilder.perform!(
|
|
inbox: inbox,
|
|
from_number: twilio_from,
|
|
call_sid: twilio_call_sid
|
|
)
|
|
when 'outbound-api', 'outbound-dial'
|
|
sync_outbound_leg(call_sid: twilio_call_sid, direction: twilio_direction)
|
|
else
|
|
raise ArgumentError, "Unsupported Twilio direction: #{twilio_direction}"
|
|
end
|
|
end
|
|
|
|
def find_call_for_agent
|
|
sid = params[:call_sid].presence
|
|
raise ArgumentError, 'call_sid is required for agent leg' if sid.blank?
|
|
|
|
inbox_calls.find_by!(provider_call_id: sid)
|
|
end
|
|
|
|
def sync_outbound_leg(call_sid:, direction:)
|
|
parent_sid = params['ParentCallSid'].presence
|
|
lookup_sid = direction == 'outbound-dial' ? parent_sid || call_sid : call_sid
|
|
call = inbox_calls.find_by!(provider_call_id: lookup_sid)
|
|
|
|
call.update!(parent_call_sid: parent_sid) if parent_sid.present? && call.parent_call_sid != parent_sid
|
|
call
|
|
end
|
|
|
|
def inbox_calls
|
|
Call.where(inbox_id: inbox.id, provider: :twilio)
|
|
end
|
|
|
|
def conference_twiml(call)
|
|
conference_sid = ensure_conference_sid!(call)
|
|
|
|
Twilio::TwiML::VoiceResponse.new.tap do |response|
|
|
response.dial do |dial|
|
|
dial.conference(
|
|
conference_sid,
|
|
start_conference_on_enter: agent_leg?(twilio_from),
|
|
end_conference_on_exit: false,
|
|
record: 'record-from-start',
|
|
recording_status_callback: recording_status_callback_url,
|
|
recording_status_callback_event: 'completed',
|
|
recording_status_callback_method: 'POST',
|
|
status_callback: conference_status_callback_url,
|
|
status_callback_event: 'start end join leave',
|
|
status_callback_method: 'POST',
|
|
participant_label: participant_label_for(twilio_from)
|
|
)
|
|
end
|
|
end.to_s
|
|
end
|
|
|
|
def ensure_conference_sid!(call)
|
|
return call.conference_sid if call.conference_sid.present?
|
|
|
|
call.update!(conference_sid: call.default_conference_sid)
|
|
call.conference_sid
|
|
end
|
|
|
|
def participant_label_for(from_number)
|
|
return from_number.delete_prefix('client:') if from_number.start_with?('client:')
|
|
|
|
'contact'
|
|
end
|
|
|
|
def conference_status_callback_url
|
|
phone_digits = inbox_channel.phone_number.delete_prefix('+')
|
|
Rails.application.routes.url_helpers.twilio_voice_conference_status_url(phone: phone_digits)
|
|
end
|
|
|
|
def recording_status_callback_url
|
|
phone_digits = inbox_channel.phone_number.delete_prefix('+')
|
|
Rails.application.routes.url_helpers.twilio_voice_recording_status_url(phone: phone_digits)
|
|
end
|
|
|
|
def find_call_for_conference!(friendly_name, call_sid)
|
|
name = friendly_name.to_s
|
|
call = inbox_calls.by_conference_sid(name).first if name.present?
|
|
call || inbox_calls.find_by!(provider_call_id: call_sid)
|
|
end
|
|
|
|
# Twilio's recording webhook only sends its internal ConferenceSid (CF...),
|
|
# not our FriendlyName. Persist Twilio's id the first time we see it on a
|
|
# conference event so the recording lookup can match later.
|
|
def persist_twilio_conference_sid!(call, sid)
|
|
return if sid.blank?
|
|
return if call.twilio_conference_sid == sid
|
|
|
|
call.update!(twilio_conference_sid: sid)
|
|
end
|
|
|
|
def set_inbox!
|
|
digits = params[:phone].to_s.gsub(/\D/, '')
|
|
phone_number = "+#{digits}"
|
|
channel = Channel::TwilioSms.find_by!(phone_number: phone_number)
|
|
raise ActiveRecord::RecordNotFound, "Voice not enabled for #{phone_number}" unless channel.voice_enabled?
|
|
|
|
@inbox = channel.inbox
|
|
end
|
|
|
|
def current_account
|
|
@current_account ||= inbox_account
|
|
end
|
|
|
|
def participant_label
|
|
params[:ParticipantLabel].to_s
|
|
end
|
|
|
|
attr_reader :inbox
|
|
|
|
delegate :account, :channel, to: :inbox, prefix: true
|
|
end
|