Call operations

Generate a shareable WhatsApp call link#

POST /api/v1/channels/{channel_id}/calls/link

Token scope: manage. Paid access and a ready, customer-owned session are required. Supply an Idempotency-Key. Returns an operation ID; inspect /api/v1/operations/{id}. A completed result is recorded; an unconfirmed result is uncertain and never automatically retried.

Upstream permissions and engine support apply. Unsupported operations may return 501; WhatsApp can refuse actions even when a session is connected.

typeRequired

string

Allowed: ["audio","video"]. Maximum 4096 characters. See JSON schema for all validation constraints.

startTimeRequired

integer

See JSON schema for all validation constraints.

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "audio",
        "video"
      ],
      "maxLength": 4096
    },
    "startTime": {
      "type": "integer",
      "minimum": 1,
      "maximum": 8640000000000000
    }
  },
  "required": [
    "type",
    "startTime"
  ],
  "additionalProperties": false
}

Reject a ringing incoming call#

POST /api/v1/channels/{channel_id}/calls/{callId}/reject

Token scope: manage. Paid access and a ready, customer-owned session are required. Supply an Idempotency-Key. Returns an operation ID; inspect /api/v1/operations/{id}. A completed result is recorded; an unconfirmed result is uncertain and never automatically retried.

Upstream permissions and engine support apply. Unsupported operations may return 501; WhatsApp can refuse actions even when a session is connected.

{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "required": []
}