List WhatsApp messages

GET /whatsapp/messages

List WhatsApp messages

cURL

curl --request GET \
  --url https://api.pineyard.ai/whatsapp/messages \
  --header 'Authorization: Bearer <token>'

200

{
  "messages": [
    {
      "id": "<string>",
      "direction": "OUTBOUND",
      "toPhone": "<string>",
      "type": "TEXT",
      "body": "<string>",
      "status": "QUEUED",
      "providerMsgId": "<string>",
      "mediaItemId": "<string>",
      "collectionId": "<string>",
      "callId": "<string>",
      "campaignId": "<string>",
      "error": "<string>",
      "createdAt": "<string>",
      "sentAt": "<string>",
      "deliveredAt": "<string>",
      "readAt": "<string>",
      "templateId": "<string>",
      "providerErrorReason": "<string>",
      "failureReason": "<string>",
      "templateValues": {
        "headerValues": [
          "<string>"
        ],
        "bodyValues": [
          "<string>"
        ],
        "name": "<string>",
        "templatePurpose": "<string>",
        "fileName": "<string>"
      },
      "conversationId": "<string>",
      "contactId": "<string>",
      "campaignContactId": "<string>",
      "hasMedia": true,
      "mediaMimeType": "<string>",
      "mediaFileName": "<string>"
    }
  ]
}

Required scope: whatsapp.view

Authorizations

Authorization · string · header · required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Response

200

application/json

OK

messages · object[] · required

Show child attributes