WhatsApp.Response (WhatsApp SDK v0.1.0)

Copy Markdown View Source

HTTP response metadata from a WhatsApp Cloud API call.

Extracts named fields from the response headers defined in the OpenAPI spec (v23.0). Raw headers are also preserved for any additional values.

Named Header Fields

Response HeaderStruct FieldDescription (from OpenAPI spec)
x-fb-trace-idtrace_idFacebook trace identifier for request tracking
x-fb-request-idrequest_idUnique identifier for the request for debugging purposes
X-FB-DebugdebugFacebook debug information for troubleshooting
facebook-api-versionapi_versionFacebook Graph API version used for the request
x-business-use-case-usagebusiness_use_case_usageBusiness use case usage metrics and rate limiting information (parsed JSON)
x-app-usageapp_usageApplication usage metrics (parsed JSON)
x-fb-rlafrrate_limit_statusFacebook rate limiting and feature restriction status
X-FB-Connection-Qualityconnection_qualityFacebook connection quality metrics
x-fb-revrevFacebook internal revision number

Summary

Functions

Build a Response from HTTP status and headers.

Types

t()

@type t() :: %WhatsApp.Response{
  api_version: String.t() | nil,
  app_usage: map() | nil,
  business_use_case_usage: map() | nil,
  connection_quality: String.t() | nil,
  debug: String.t() | nil,
  headers: [{String.t(), String.t()}],
  rate_limit_status: String.t() | nil,
  request_id: String.t() | nil,
  rev: String.t() | nil,
  status: non_neg_integer(),
  trace_id: String.t() | nil
}

Functions

from_fields(status, headers)

@spec from_fields(non_neg_integer(), [{String.t(), String.t()}]) :: t()

Build a Response from HTTP status and headers.

Extracts named header fields and parses JSON-encoded headers (x-business-use-case-usage, x-app-usage) into maps.