Whatsapp Signup

List Whatsapp signup sessions

Changed on

List finished WhatsApp Embedded Signup sessions, with status SUCCESS or FAILURE, newest first. Use the errors of a failed session to see why provisioning stopped.

get/whatsapp/signup

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/whatsapp/signup
  • Auth: HTTP bearer

Query parameters

numberinteger

The page number to load

sizeinteger

The size of the page

Consolidated page parameter (deepObject style). Originally: page[number], page[size]

filter[waba_id]string

Filter by Meta WABA ID

filter[customer_id]string

Filter by the tech provider customer reference

filter[created_at][gte]string date-time

Return sessions created at or after this time (RFC 3339)

filter[created_at][lte]string date-time

Return sessions created at or before this time (RFC 3339)

Response

Successful response with a list of WhatsApp signup sessions

Example response

{
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

Changes