{
  "results": [
    {
      "messageId": "1215f543ab19-345f-adbd-12ad31451ed25f35",
      "from": "353861234569",
      "to": "353861234581",
      "sentAt": "2018-12-12T11:21:57.793+0000",
      "seenAt": "2018-12-12T11:21:58.251+0000",
      "applicationId": "example-application-id",
      "entityId": "example-entity-id",
      "contact": {
        "name": "name",
        "phoneNumber": "353861234581",
        "userId": "US.1349120865530274191",
        "parentUserId": "US.ENT.118157495734",
        "username": "username"
      }
    }
  ]
}

channels

Receive seen reports

For each message that you send out, we can send you a seen report. For this to work you need to have an endpoint to forward the reports to. Please provide the endpoint’s URL to Customer Support and they will set it up for you. Once the setup is complete, we will be able to deliver the reports to you in real time. Alternatively you can specify the endpoint per each message via the notifyURL parameter. Contact support@phonovation.com if you require help. Use one URL for all report types.

WEBHOOK

receive-whatsapp-seen-reports

{
  "results": [
    {
      "messageId": "1215f543ab19-345f-adbd-12ad31451ed25f35",
      "from": "353861234569",
      "to": "353861234581",
      "sentAt": "2018-12-12T11:21:57.793+0000",
      "seenAt": "2018-12-12T11:21:58.251+0000",
      "applicationId": "example-application-id",
      "entityId": "example-entity-id",
      "contact": {
        "name": "name",
        "phoneNumber": "353861234581",
        "userId": "US.1349120865530274191",
        "parentUserId": "US.ENT.118157495734",
        "username": "username"
      }
    }
  ]
}

Authorizations

Authorization

string

header

default:App

required

This is the most secure authorization type and the one with the most flexibility.

API keys can be generated by calling the dedicated API method. Furthermore, API keys can have a limited scope and cover only some API methods. Lastly, they can be revoked at any time. This range of possibilities makes API keys well suited for separating the API access rights across multiple applications or use cases. Finally, the loss of an API key is easily manageable.

You can manage your API keys from GUI, or programmatically with dedicated API.

API key Authorization header example:

Authorization: App 003026bbc133714df1834b8638bb496e-8f4b3d9a-e931-478d-a994-28a725159ab9

Body

application/json

results

SeenReport · object[]

write-only

Collection of reports, one per every message.

Show child attributes

Response

200

Your server returns this code if it accepts the callback