Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

SendWhatsAppCallEvent

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 AWS account.

Request Syntax


POST /v1/whatsapp/call/event HTTP/1.1
Content-type: application/json

{
   "callEvent": blob,
   "metaApiVersion": "string",
   "originationPhoneNumberId": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

callEvent

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

Type: Base64-encoded binary data object

Length Constraints: Minimum length of 1. Maximum length of 2048000.

Required: Yes

metaApiVersion

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

Type: String

Required: Yes

originationPhoneNumberId

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 115.

Pattern: .*(^phone-number-id-.*$)|(^arn:.*:phone-number-id/[0-9a-zA-Z]+$).*

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "callId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

callId

The unique identifier that Meta assigns to the call.

Type: String

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedByMetaException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ConflictException

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

HTTP Status Code: 409

DependencyException

Thrown when performing an action because a dependency would be broken.

HTTP Status Code: 502

InternalServiceException

The request processing has failed because of an unknown error, exception, or failure.

HTTP Status Code: 500

InvalidParametersException

One or more parameters provided to the action are not valid.

HTTP Status Code: 400

ResourceNotFoundException

The resource was not found.

HTTP Status Code: 404

ThrottledRequestException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The request contains an invalid parameter value.

HTTP Status Code: 400