Ping client using NID

Your service can ping client using Notification ID as follows:

Use this method to check if a client application is currently capable of receiving notifications. Note that a successful client ping operation does not guarantee that a notification will be delivered to the client application.

URL

/nnapi/1.0/ping/nid/{NID}

NID: Notification ID; must be URL encoded

Note:

This is a cURL command. For more information, see Testing Service using cURL.

Method

GET

Response

200 OK

The client application is able to receive notifications.

204 No content

Consumer is offline when notification request was received, application has been uninstalled or notifications are switched off by the user. In this case consumer is not able to receive this message.

Error cases

404 Bad Request

Read the response body to check the error cause. It can be one of the following:

  • Unknown version. Only version 1.0 is currently supported. Any other version (or no version) returns 400 Bad Request.

  • Target Notification ID not specified. Add correct Notification ID to your request.

401 Unauthorized

  • Authorisation failed. Incorrect service credentials.

  • TCP/TLS connection for the HTTP requests may not be persistent. Make sure that your service uses a persistent TCP/TLS connection for the HTTP requests.

  • Forbidden service. Service access to Nokia Notifications API is forbidden

405 Method Not Allowed

Wrong method used. Only GET method is allowed.

Example

Request GET URL

https://alpha.one.ovi.com/nnapi/1.0/ping/nid/NIDexmaple1

Response DATA

HTTP/1.1 200 OK
Content-Length:2
Content-Type:text/plain;charset=ISO-8859-1
OK

Last updated 9 October 2013

Back to top

Was this page helpful?

Your feedback about this content is important. Let us know what you think.

 

Thank you!

We appreciate your feedback.

×