EndUserMessagingSocial / Client / send_whatsapp_call_event

send_whatsapp_call_event

EndUserMessagingSocial.Client.send_whatsapp_call_event(**kwargs)

Sends a WhatsApp calling event, such as connecting or terminating a call, for a business phone number. This operation passes the event through to Meta. To use this operation, the origination phone number must belong to a WhatsApp Business Account that is linked to your Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

response = client.send_whatsapp_call_event(
    originationPhoneNumberId='string',
    metaApiVersion='string',
    callEvent=b'bytes'
)
Parameters:

  • originationPhoneNumberId (string) –

    [REQUIRED]

    The unique identifier of the origination phone number for the call. The phone number identifiers are formatted as phone-number-id-01234567890123456789012345678901. Use GetLinkedWhatsAppBusinessAccount to find a phone number’s ID.

  • metaApiVersion (string) –

    [REQUIRED]

    The version of the Meta Graph API to use for the request.

  • callEvent (bytes) –

    [REQUIRED]

    The call event payload to send, as a JSON blob in the format defined by the Meta calling API.

Return type:

dict

Returns:

Response Syntax

{
    'callId': 'string'
}

Response Structure

  • (dict) –

    • callId (string) –

      The unique identifier that Meta assigns to the call.

Exceptions

  • EndUserMessagingSocial.Client.exceptions.ValidationException

  • EndUserMessagingSocial.Client.exceptions.ConflictException

  • EndUserMessagingSocial.Client.exceptions.AccessDeniedException

  • EndUserMessagingSocial.Client.exceptions.InvalidParametersException

  • EndUserMessagingSocial.Client.exceptions.ResourceNotFoundException

  • EndUserMessagingSocial.Client.exceptions.AccessDeniedByMetaException

  • EndUserMessagingSocial.Client.exceptions.ThrottledRequestException

  • EndUserMessagingSocial.Client.exceptions.InternalServiceException

  • EndUserMessagingSocial.Client.exceptions.DependencyException