List Push Notification Operations

import { TwilioClient } from "twilio-comms";
async function main() {
    const client = new TwilioClient({
        accountId: "YOUR_ACCOUNTID_HERE",
        authToken: "YOUR_AUTHTOKEN_HERE",
    });
    await client.pushNotifications.listOperations({});
}
main();

{
  "operations": [
    {
      "id": "comms_operation_01h9krwprkeee8fzqspvwy6nq8",
      "status": "SCHEDULED",
      "stats": {
        "total": 150,
        "recipients": 145,
        "unaddressable": 3,
        "scheduled": 20,
        "queued": 50,
        "sent": 70,
        "failed": 5,
        "canceled": 2
      },
      "createdAt": "2024-04-20T14:22:00Z",
      "updatedAt": "2024-04-20T15:45:00Z"
    },
    {
      "id": "comms_operation_01h9ksxq9v7b2m4r5t6y7z8a9",
      "status": "COMPLETED",
      "stats": {
        "total": 300,
        "recipients": 300,
        "unaddressable": 0,
        "scheduled": 0,
        "queued": 0,
        "sent": 295,
        "failed": 5,
        "canceled": 0
      },
      "createdAt": "2024-04-18T10:00:00Z",
      "updatedAt": "2024-04-18T12:30:00Z"
    }
  ],
  "pagination": {
    "next": "eyJwYWdlVG9rZW4iOiAiY29tbXNfb3BlcmF0aW9uXzAxaG9qbnZ3b3J4b3B5b3V6bG1uIn0",
    "self": "eyJwYWdlVG9rZW4iOiAiY29tbXNfb3BlcmF0aW9uXzAxaDkrcnducGtrZWVlOGZ6cXNwdnd5Nm5xOCJ9"
  }
}

This operation fetches a paginated list of Push Notification Operations.

Data retention: Records are available for 7 days after creation. Requests for data older than 7 days may return incomplete results.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <account_id:auth_token>.

AuthorizationBasic

Basic authentication of the form Basic <api_key:api_key_secret>.

Query parameters

pageTokenstringOptional

The token to retrieve the next page of results.

pageSizeintegerOptional1-1000Defaults to 50

The number of resources to return in a page.

startDatestringOptionalformat: "date-time"

Filter to Operations created after the specified date and time.

endDatestringOptionalformat: "date-time"

Filter to Operations created before the specified date and time.

statusenumOptional

Filter to Operations with the specified status.

Allowed values:

Response

operationslist of objects

A list of Push Notification Operations.

paginationobject

Metadata for paginated results. This object contains two tokens to navigate through paginated results.

Use next to retrieve the ‘next’ page in the result list.
Use self to retrieve the same page of the result list again.
Supply the token in the pageToken query param.

Errors

400

Bad Request Error

429

Too Many Requests Error

500

Internal Server Error

503

Service Unavailable Error