CallRequestPayload

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/whatsapp/json-schema/whatsapp-call-request-payload-schema.json",
  "title": "CallRequestPayload",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/whatsapp-business-messaging-api-openapi.yml#/components/schemas/CallRequestPayload",
  "type": "object",
  "properties": {
    "messaging_product": {
      "type": "string",
      "description": "Messaging product"
    },
    "to": {
      "type": "string",
      "description": "The number being called (callee)"
    },
    "action": {
      "type": "string",
      "enum": [
        "connect",
        "pre_accept",
        "accept",
        "reject",
        "terminate"
      ],
      "description": "The action being taken on the given call ID"
    },
    "session": {
      "type": "object",
      "properties": {
        "sdp_type": {
          "type": "string",
          "enum": [
            "offer",
            "answer"
          ],
          "description": "SDP type - \"offer\" for connect action, \"answer\" for accept action"
        },
        "sdp": {
          "type": "string",
          "description": "The SDP info of the device on the other end of the call. The SDP must be compliant with RFC 8866"
        }
      },
      "required": [
        "sdp_type",
        "sdp"
      ],
      "description": "Contains the session description protocol (SDP) type and description language"
    },
    "biz_opaque_callback_data": {
      "type": "string",
      "maxLength": 512,
      "description": "An arbitrary string you can pass in that is useful for tracking and logging purposes. Any app subscribed to the \"calls\" webhook field on your WhatsApp Business Account can receive this string, as it is included in the calls object within the subsequent Call Terminate Webhook payload. Cloud API does not process this field. Maximum 512 characters\n"
    }
  },
  "required": [
    "messaging_product",
    "to",
    "action"
  ]
}