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>
126 lines
3.5 KiB
Ruby
126 lines
3.5 KiB
Ruby
class Whatsapp::FacebookApiClient
|
|
BASE_URI = 'https://graph.facebook.com'.freeze
|
|
|
|
def initialize(access_token = nil)
|
|
@access_token = access_token
|
|
@api_version = GlobalConfigService.load('WHATSAPP_API_VERSION', 'v22.0')
|
|
end
|
|
|
|
def exchange_code_for_token(code)
|
|
response = HTTParty.get(
|
|
"#{BASE_URI}/#{@api_version}/oauth/access_token",
|
|
query: {
|
|
client_id: GlobalConfigService.load('WHATSAPP_APP_ID', ''),
|
|
client_secret: GlobalConfigService.load('WHATSAPP_APP_SECRET', ''),
|
|
code: code
|
|
}
|
|
)
|
|
|
|
handle_response(response, 'Token exchange failed')
|
|
end
|
|
|
|
def fetch_phone_numbers(waba_id)
|
|
response = HTTParty.get(
|
|
"#{BASE_URI}/#{@api_version}/#{waba_id}/phone_numbers",
|
|
query: { access_token: @access_token }
|
|
)
|
|
|
|
handle_response(response, 'WABA phone numbers fetch failed')
|
|
end
|
|
|
|
def debug_token(input_token)
|
|
response = HTTParty.get(
|
|
"#{BASE_URI}/#{@api_version}/debug_token",
|
|
query: {
|
|
input_token: input_token,
|
|
access_token: build_app_access_token
|
|
}
|
|
)
|
|
|
|
handle_response(response, 'Token validation failed')
|
|
end
|
|
|
|
def register_phone_number(phone_number_id, pin)
|
|
response = HTTParty.post(
|
|
"#{BASE_URI}/#{@api_version}/#{phone_number_id}/register",
|
|
headers: request_headers,
|
|
body: { messaging_product: 'whatsapp', pin: pin.to_s }.to_json
|
|
)
|
|
|
|
handle_response(response, 'Phone registration failed')
|
|
end
|
|
|
|
def phone_number_verified?(phone_number_id)
|
|
response = HTTParty.get(
|
|
"#{BASE_URI}/#{@api_version}/#{phone_number_id}",
|
|
headers: request_headers
|
|
)
|
|
|
|
data = handle_response(response, 'Phone status check failed')
|
|
data['code_verification_status'] == 'VERIFIED'
|
|
end
|
|
|
|
def subscribe_waba_webhook(waba_id, callback_url, verify_token)
|
|
# Step 1: Subscribe app to WABA first (required before override)
|
|
# Meta requires the app to be subscribed before using override_callback_uri
|
|
# See: https://github.com/chatwoot/chatwoot/issues/13097
|
|
subscribe_app_to_waba(waba_id)
|
|
|
|
# Step 2: Override callback URL for this specific WABA
|
|
override_waba_callback(waba_id, callback_url, verify_token)
|
|
end
|
|
|
|
def subscribe_app_to_waba(waba_id)
|
|
response = HTTParty.post(
|
|
"#{BASE_URI}/#{@api_version}/#{waba_id}/subscribed_apps",
|
|
headers: request_headers
|
|
)
|
|
|
|
handle_response(response, 'App subscription to WABA failed')
|
|
end
|
|
|
|
def override_waba_callback(waba_id, callback_url, verify_token)
|
|
response = HTTParty.post(
|
|
"#{BASE_URI}/#{@api_version}/#{waba_id}/subscribed_apps",
|
|
headers: request_headers,
|
|
body: {
|
|
override_callback_uri: callback_url,
|
|
verify_token: verify_token,
|
|
subscribed_fields: %w[messages smb_message_echoes calls]
|
|
}.to_json
|
|
)
|
|
|
|
handle_response(response, 'Webhook callback override failed')
|
|
end
|
|
|
|
def unsubscribe_waba_webhook(waba_id)
|
|
response = HTTParty.delete(
|
|
"#{BASE_URI}/#{@api_version}/#{waba_id}/subscribed_apps",
|
|
headers: request_headers
|
|
)
|
|
|
|
handle_response(response, 'Webhook unsubscription failed')
|
|
end
|
|
|
|
private
|
|
|
|
def request_headers
|
|
{
|
|
'Authorization' => "Bearer #{@access_token}",
|
|
'Content-Type' => 'application/json'
|
|
}
|
|
end
|
|
|
|
def build_app_access_token
|
|
app_id = GlobalConfigService.load('WHATSAPP_APP_ID', '')
|
|
app_secret = GlobalConfigService.load('WHATSAPP_APP_SECRET', '')
|
|
"#{app_id}|#{app_secret}"
|
|
end
|
|
|
|
def handle_response(response, error_message)
|
|
raise "#{error_message}: #{response.body}" unless response.success?
|
|
|
|
response.parsed_response
|
|
end
|
|
end
|