List chat messages

GET

messaging

{session}

chats

{conversation}

messages

List chat messages

curl --request GET \
  --url https://api.polymorfa.com/messaging/{session}/chats/{conversation}/messages \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.polymorfa.com/messaging/{session}/chats/{conversation}/messages', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.polymorfa.com/messaging/{session}/chats/{conversation}/messages"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.polymorfa.com/messaging/{session}/chats/{conversation}/messages"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "success": true,
  "data": [
    {
      "id": "739182640518203",
      "whatsapp_ids": {
        "linked_devices": "<string>",
        "official_api": "<string>"
      },
      "conversation": {
        "id": "739182640518203",
        "phoneNumber": "<string>",
        "bsuid": "<string>",
        "username": "<string>",
        "sender": {
          "id": "739182640518203",
          "phoneNumber": "<string>",
          "bsuid": "<string>",
          "username": "<string>"
        }
      },
      "direction": "inbound",
      "fromMe": true,
      "type": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "whatsapp_id": "<string>",
      "pushName": "<string>",
      "text": "<string>",
      "caption": "<string>",
      "mimeType": "<string>",
      "filename": "<string>",
      "ptt": true,
      "latitude": 123,
      "longitude": 123,
      "displayName": "<string>",
      "title": "<string>",
      "reaction": "<string>",
      "reactionTo": "739182640518203",
      "edited": true,
      "unavailable": true,
      "unavailableReason": "<string>",
      "pollOptions": [
        {
          "name": "<string>",
          "hash": "<string>"
        }
      ],
      "media": [
        {
          "id": "<string>",
          "mimeType": "<string>",
          "fileLength": 1,
          "url": "/messaging/media/0e6f1c3a-5a55-4f3c-9d4f-0b1f8f2a9c11"
        }
      ]
    }
  ],
  "hasMore": true,
  "nextCursor": "<string>",
  "previousCursor": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_parameter",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_parameter",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_parameter",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_parameter",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_parameter",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

Authorizations

Authorization

string

header

required

Polymorfa organization key (pmfa_ prefix), project token (pmfa_pt_ prefix) where supported, or short-lived client token (pmfa_ct_ prefix). Organization and project keys may be personal or service-account owned and enforce selected action scopes. Organization keys cover the team and its projects; project tokens stay inside one project. Client tokens stay inside their live project and session and enforce their client rules.

Path Parameters

session

string

required

Identifier of the connected Polymorfa session.

Value constraints

Constraint	Accepted input
String length	At least `1` characters
Number ID.

Minimum string length: 1

conversation

string

required

Public conversation identifier or E.164 phone number. Conversation ID or E.164 phone number.

Query Parameters

limit

integer

default:50

Specifies limit for this query parameter.

Value constraints

Constraint	Accepted input
Numeric value	`1` through `100` (inclusive)
Page size, from 1 through 100.

Required range: 1 <= x <= 100

Example:

50

cursor

string

Specifies cursor for this query parameter.

Value constraints

Constraint	Accepted input
String length	`1` through `1024` characters
Pattern	`^[A-Za-z0-9_-]+$`
Opaque cursor from `nextCursor` or `previousCursor`. Reuse it only with the same path and filters.

Required string length: 1 - 1024

Pattern: ^[A-Za-z0-9_-]+$

order

enum<string>

default:desc

Specifies order for this query parameter.

Allowed values

Value	Meaning
`desc`	Desc.
`asc`	Asc.
`desc` returns newest messages first; `asc` returns oldest first.

Available options:

desc,

asc

since

string<date-time>

Specifies since for this query parameter.

Value constraints

Constraint	Accepted input
Format	`date-time`
Return messages sent at or after this time (ISO 8601).

until

string<date-time>

Specifies until for this query parameter.

Value constraints

Constraint	Accepted input
Format	`date-time`
Return messages sent before this time (ISO 8601).

direction

enum<string>

Specifies direction for this query parameter.

Allowed values

Value	Meaning
`inbound`	Inbound.
`outbound`	Outbound.
`inbound` returns messages from contacts; `outbound` returns messages sent by the Number.

Available options:

inbound,

outbound

types

string

Specifies types for this query parameter.

Value constraints

Constraint	Accepted input
Pattern	`^[a-z][a-z_]{0,31}(?:,[a-z][a-z_]{0,31}){0,15}$`
Comma-separated message types, for example `text,image`. Up to 16 types.

Pattern: ^[a-z][a-z_]{0,31}(?:,[a-z][a-z_]{0,31}){0,15}$

Example:

"text,image"

Response

One page of messages

success

enum<boolean>

required

Whether the request succeeded.

Allowed values

Value	Meaning
`true`	True.

Available options:

true

data

object[]

required

Structured data carried by this object.

Show child attributes

hasMore

boolean

required

True when nextCursor returns more items.

nextCursor

string | null

required

Specifies next cursor for this native list chat messages response.

Accepted alternatives

Alternative	Accepted input
Alternative 1	Type: `string`
Alternative 2	`null`

previousCursor

string | null

required

Cursor for the preceding page of messages. Null when no preceding page exists.

Accepted alternatives

Alternative	Accepted input
Alternative 1	Type: `string`
Alternative 2	`null`

List chat messages

curl --request GET \
  --url https://api.polymorfa.com/messaging/{session}/chats/{conversation}/messages \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.polymorfa.com/messaging/{session}/chats/{conversation}/messages', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.polymorfa.com/messaging/{session}/chats/{conversation}/messages"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.polymorfa.com/messaging/{session}/chats/{conversation}/messages"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "success": true,
  "data": [
    {
      "id": "739182640518203",
      "whatsapp_ids": {
        "linked_devices": "<string>",
        "official_api": "<string>"
      },
      "conversation": {
        "id": "739182640518203",
        "phoneNumber": "<string>",
        "bsuid": "<string>",
        "username": "<string>",
        "sender": {
          "id": "739182640518203",
          "phoneNumber": "<string>",
          "bsuid": "<string>",
          "username": "<string>"
        }
      },
      "direction": "inbound",
      "fromMe": true,
      "type": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "whatsapp_id": "<string>",
      "pushName": "<string>",
      "text": "<string>",
      "caption": "<string>",
      "mimeType": "<string>",
      "filename": "<string>",
      "ptt": true,
      "latitude": 123,
      "longitude": 123,
      "displayName": "<string>",
      "title": "<string>",
      "reaction": "<string>",
      "reactionTo": "739182640518203",
      "edited": true,
      "unavailable": true,
      "unavailableReason": "<string>",
      "pollOptions": [
        {
          "name": "<string>",
          "hash": "<string>"
        }
      ],
      "media": [
        {
          "id": "<string>",
          "mimeType": "<string>",
          "fileLength": 1,
          "url": "/messaging/media/0e6f1c3a-5a55-4f3c-9d4f-0b1f8f2a9c11"
        }
      ]
    }
  ],
  "hasMore": true,
  "nextCursor": "<string>",
  "previousCursor": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_parameter",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_parameter",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_parameter",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_parameter",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_parameter",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

Overview

Messaging API

Platform API

Graph API

Webhook events

List chat messages

Authorizations

Path Parameters

Query Parameters

Response