Comms API ReferencePush Notifications

Fetch a Push Notification Operation

This operation fetches a single Push Notification Operation using its ID.

Authentication

AuthorizationBasic

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

OR
AuthorizationBasic

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

Path parameters

operationIdstringRequired

Response

OK
idstringformat: "^comms_operation_[0-7][a-hjkmnpqrstv-z0-9]{25,34}"
The Operation ID is an identifier that can be used to correlate all of the resources created in a request. Issue a GET request to the resource list location, using the Operation ID as a query parameter to retrieve the resources that correlate with the Operation.
statusenum
The status of an Operation.
Allowed values:
statsobject
Represents the stats of a sending operation of one or many `Push Notifications`. - `total` is the total number of `Push Notifications` in the `Operation`. * To get the status for each `Push Notification`, fetch the resource with: `GET /PushNotifications/{pushNotificationId}`. - `recipients` is the total number of recipients targeted in an Operation. - `unaddressable` is the number of recipients to which no sending attempts were made because a valid token could not be found in the recipient's `Device Registration` set for the `Credentials` or `App` provided. - `scheduled` is the number of `Push Notifications` that are scheduled to be sent by Twilio in the future. - `queued` is the number of `Push Notifications` that are queued in Twilio for sending. - `sent` is the number of `Push Notifications` that have been sent by Twilio. - `failed` is the number of `Push Notifications` that failed during processing by Twilio. Get `Errors` with `GET /PushNotifications/Operations/{operationId}/Errors` fore more detail. - `canceled` is the number of `Push Notifications` that were canceled via API request.
createdAtstringformat: "date-time"
updatedAtstringformat: "date-time"

Errors