silentPushNotificationErrorFeedback

The Publisher can use the silentPushNotificationErrorFeedback API to notify Zendrive backend about any error response while trying to trigger a silent push notification for the user.

The error response contains the following parameters:

  • errorCode

  • reason

  • timestamp

Any errors received in response can help publishers understand why the silent push notification might have resulted in an error. For example:

  • If the error code is 410, then the application might be uninstalled by the user.

  • A timestamp along with error code 410, represented in milliseconds since Epoch at which APNs confirmed the token indicates that the token is no longer valid for the topic.

API Request Authorization: Zendrive will provide an API Key to the publisher which is used in all the IQL API endpoints for authorization.

POST https://iql.zendrive.com/iql/v1/silentpush/error/info

Headers

Name
Type
Description

Authorization*

APIKEY<apikey>

Content_Type*

String

application/json

Request Body

Name
Type
Description

driver_id*

String

The unique identifier of the user.

data.error_code*

Integer

A status code representing the error after a silent push notification fails.

data.reason

String

A description of the error received after an attempt to send a silent push notification fails.

data.timestamp*

Big Integer

This field contains an epoch timestamp, which represents the time the error response was received.

{
    // Response
}

Sample Request Body

{
  "driver_id": "[email protected]",
  "data": {
    "error_code": 410,
    "reason": "The device token is no longer active for the topic.",
    "timestamp": 1654506334000
  }
}

Sample Success Response

{
  "success": "true"
}

Sample Error Response

{
  "success": "false",
  "error": "invalid driver id"
}

Response Fields

Field
Type
Description

success

Boolean

This field represents the overall status of the response. The following are the expected values for this field:

  1. true: This represents the request resulted in a successful response.

  2. false: This represents the request failed due to some invalid field values in the request.

error

String

The description of the error which resulted in a bad request.