qi*,ddZddlmZmZmZmZmZddlZddlm Z ddl m Z m Z Gdde Z Gdd e ZGd d e ZGd d e ZGdde ZGdde ZGdde ZGdde ZGdde ZGdde ZGdde ZGdde ZGddZy) z;WhatsApp API. API to communicate with WhatsApp Cloud API. )AnyDictListOptionalUnionN)logger) BaseModelFieldc&eZdZUdZeed<eed<y)WhatsAppSessionzWebRTC session information for WhatsApp calls. Parameters: sdp: Session Description Protocol (SDP) data for WebRTC connection sdp_type: Type of SDP (e.g., "offer", "answer") sdpsdp_typeN__name__ __module__ __qualname____doc__str__annotations__Q/opt/pipecat/venv/lib/python3.12/site-packages/pipecat/transports/whatsapp/api.pyr r s HMrr cDeZdZUdZeed<eed<eed<eeefed<y) WhatsAppErrorzError information from WhatsApp API responses. Parameters: code: Error code number message: Human-readable error message href: URL for more information about the error error_data: Additional error-specific data codemessagehref error_dataN) rrrrintrrrrrrrrr"s& I L IS#XrrcreZdZUdZeed<eddZeed<eed<eed<eed <eeed <e ed <y ) WhatsAppConnectCallawIncoming call connection event data. Represents a user-initiated call that requires handling. This is sent when a WhatsApp user initiates a call to your business number. Parameters: id: Unique call identifier from_: Phone number of the caller (WhatsApp ID format) to: Your business phone number that received the call event: Always "connect" for incoming calls timestamp: ISO 8601 timestamp when the call was initiated direction: Optional call direction ("inbound" for user-initiated calls) session: WebRTC session data containing SDP offer from the caller id.fromaliasfrom_toevent timestamp directionsessionN) rrrrrrr r&rr rrrr!r!2s>  Gs&)E3) G JN} rr!ceZdZUdZeed<eddZeed<eed<eed<eed <eeed <d Z eeed <d Z eeed <d Z eeed<d Z eeed<d Z eeed<y )WhatsAppTerminateCalla;Call termination event data. Represents the end of a call session, whether completed successfully, failed, or was rejected by either party. Parameters: id: Unique call identifier (matches the connect event) from_: Phone number of the caller to: Your business phone number event: Always "terminate" for call end events timestamp: ISO 8601 timestamp when the call ended direction: Optional call direction biz_opaque_callback_data: Optional business-specific callback data status: Call completion status ("FAILED", "COMPLETED", "REJECTED") start_time: ISO 8601 timestamp when call actually started (after acceptance) end_time: ISO 8601 timestamp when call ended duration: Call duration in seconds (only for completed calls) r".r#r$r&r'r(r)r*Nbiz_opaque_callback_datastatus start_timeend_timeduration)rrrrrrr r&rr.r/r0r1r2rrrrr-r-Ks& Gs&)E3) G JN}.2hsm2 FHSM $J $"Hhsm""Hhsm"rr-ceZdZUdZeed<y)WhatsAppProfilez_User profile information. Parameters: name: Display name of the WhatsApp user nameNrrrrr4r4ls Irr4c&eZdZUdZeed<eed<y)WhatsAppContactzContact information for a WhatsApp user. Parameters: profile: User's profile information wa_id: WhatsApp ID (phone number in international format without +) profilewa_idN)rrrrr4rrrrrr7r7vs Jrr7c&eZdZUdZeed<eed<y)WhatsAppMetadatazBusiness phone number metadata. Parameters: display_phone_number: Formatted phone number for display phone_number_id: WhatsApp Business API phone number ID display_phone_numberphone_number_idNrrrrr;r;srr;cFeZdZUdZeed<eed<eeed<ee ed<y)WhatsAppConnectCallValueaWebhook payload for incoming call events. Parameters: messaging_product: Always "whatsapp" metadata: Business phone number information contacts: List of contact information for involved parties calls: List of call connection events messaging_productmetadatacontactscallsN) rrrrrrr;rr7r!rrrr?r?s,?## # $$rr?cPeZdZUdZeed<eed<eeed<dZ e ee ed<y)WhatsAppTerminateCallValueaWebhook payload for call termination events. Parameters: messaging_product: Always "whatsapp" metadata: Business phone number information calls: List of call termination events errors: Optional list of errors that occurred during the call r@rArCNerrors) rrrrrrr;rr-rFrrrrrrErEs5 % &&,0FHT-( )0rrEc0eZdZUdZeeefed<eed<y)WhatsAppChangezWebhook change event wrapper. Parameters: value: The actual event data (connect or terminate) field: Always "calls" for calling webhooks valuefieldN) rrrrrr?rErrrrrrHrHs  )+EE FF JrrHc,eZdZUdZeed<eeed<y) WhatsAppEntryzWebhook entry containing one or more changes. Parameters: id: WhatsApp Business Account ID changes: List of change events in this webhook delivery r"changesN)rrrrrrrrHrrrrLrLs G . !!rrLc,eZdZUdZeed<eeed<y)WhatsAppWebhookRequesta(Complete webhook request from WhatsApp. This is the top-level structure for all webhook deliveries from the WhatsApp Cloud API for calling events. Parameters: object: Always "whatsapp_business_account" entry: List of webhook entries (usually contains one entry) objectentryN)rrrrrrrrLrrrrOrOs K  rrOceZdZdZdZdededejddfdZdefd Z defd Z d ed ed edefdZ d efdZ d efdZ y) WhatsAppApiaWhatsApp Cloud API client for handling calls. This class provides methods to interact with the WhatsApp Cloud API for managing voice calls, including answering, rejecting, and terminating calls. Parameters: BASE_URL: Base URL for WhatsApp Graph API v23.0 phone_number_id: Your WhatsApp Business phone number ID session: aiohttp client session for making HTTP requests whatsapp_url: Complete URL for the calls endpoint whatsapp_token: Bearer token for API authentication z!https://graph.facebook.com/v23.0/whatsapp_tokenr=r+returnNcZ||_||_|j|d|_||_y)aInitialize the WhatsApp API client. Args: whatsapp_token: WhatsApp access token for authentication phone_number_id: Your business phone number ID from WhatsApp Business API session: aiohttp ClientSession for making HTTP requests z/callsN)_phone_number_id_sessionBASE_URL _whatsapp_url_whatsapp_token)selfrTr=r+s r__init__zWhatsAppApi.__init__s3!0 $ .?vF-rc||_y)z4Update the WhatsApp access token for authentication.N)r[)r\rTs rupdate_whatsapp_tokenz!WhatsAppApi.update_whatsapp_tokens -rc||_y)z7Update the WhatsApp phone number ID for authentication.N)rW)r\r=s rupdate_whatsapp_phone_number_idz+WhatsAppApi.update_whatsapp_phone_number_ids /rcall_idactionr r&c \Ktjd|d||jj|jd|j ddd||||ddd  4d {}|j d {cd d d d {S7-77 #1d {7swYy xYww) a7Answer an incoming WhatsApp call. This method handles the call answering process, supporting both "pre_accept" and "accept" actions as required by the WhatsApp calling workflow. Args: call_id: Unique identifier for the call (from connect webhook) action: Action to perform ("pre_accept" or "accept") sdp: Session Description Protocol answer for WebRTC connection from_: Caller's phone number (WhatsApp ID format) Returns: Dict containing the API response with success status and any error details Note: Calls must be pre-accepted before being accepted. The typical flow is: 1. Receive connect webhook 2. Call with action="pre_accept" 3. Call with action="accept" zAnswering call z to WhatsApp, action:Bearer application/json Authorizationz Content-Typewhatsappanswer)r r)r@r'rcrbr+headersjsonNrdebugrXpostrZr[rm)r\rbrcr r&responses ranswer_call_to_whatsappz#WhatsAppApi.answer_call_to_whatsapps*  wi/DVHMN==%%   #*4+?+?*@!A 2 &0 "#&H=  &   ) )!( ) ) )) ) ) ) )sZA!B,#B$B,'B;B<B? B, B B,BB,B)B B)%B,cLKtjd||jj|jd|j dddd|d4d {}|j d {cd d d d {S7-77 #1d {7swYy xYww) alReject an incoming WhatsApp call. This method rejects a call that was received via connect webhook. The caller will receive a rejection notification and a terminate webhook will be sent with status "REJECTED". Args: call_id: Unique identifier for the call (from connect webhook) Returns: Dict containing the API response with success status and any error details Note: This should be called instead of answer_call_to_whatsapp when you want to decline the incoming call. The caller will see the call as rejected. zRejecting call rerfrgrirejectr@rcrbrkNrnr\rbrqs rreject_call_to_whatsappz#WhatsAppApi.reject_call_to_whatsapp"s"  wi01==%%   #*4+?+?*@!A 2 &0"" &  ) )!( ) ) )) ) ) ) )ZAB$B B$B3B 4B7 B$B B$ B B$B!B B!B$cLKtjd||jj|jd|j dddd|d4d {}|j d {cd d d d {S7-77 #1d {7swYy xYww) a}Terminate an active WhatsApp call. This method ends an ongoing call that has been previously accepted. Both parties will be disconnected and a terminate webhook will be sent with status "COMPLETED". Args: call_id: Unique identifier for the active call Returns: Dict containing the API response with success status and any error details Note: This should only be called for calls that have been accepted and are currently active. For incoming calls that haven't been accepted yet, use reject_call_to_whatsapp instead. zTerminating call rerfrgri terminaterurkNrnrvs rterminate_call_to_whatsappz&WhatsAppApi.terminate_call_to_whatsappBs$  ( 23==%%   #*4+?+?*@!A 2 &0%" &  ) )!( ) ) )) ) ) ) )rx)rrrrrYraiohttp ClientSessionr]r_rarrrwr{rrrrSrSs 3H .! .47 .BIBWBW .  ..C.0s0$)S$)#$)C$)X[$)L)S)@))rrS)rtypingrrrrrr|logururpydanticr r r rr!r-r4r7r;r?rErHrLrOrSrrrrs 43% i  I  )2#I#Bi i  y  %y % 1 1 Y  "I " Y L)L)r