List chats

GET

messaging

{session}

chats

List chats

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

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

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

package main

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

func main() {

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

	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": [
    {
      "conversation": {
        "id": "739182640518203",
        "phoneNumber": "<string>",
        "bsuid": "<string>",
        "username": "<string>"
      },
      "kind": "direct",
      "lastActivityAt": "2023-11-07T05:31:56Z",
      "lastMessage": {
        "id": "739182640518203",
        "whatsapp_ids": {
          "linked_devices": "<string>",
          "official_api": "<string>"
        },
        "direction": "inbound",
        "type": "<string>",
        "timestamp": "2023-11-07T05:31:56Z",
        "whatsapp_id": "<string>"
      }
    }
  ],
  "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

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_-]+$

kind

enum<string>

Kind discriminator for this object.

Allowed values

Value	Meaning
`direct`	Direct.
`group`	Group.
`channel`	Channel.
`broadcast`	Broadcast.
Return only conversations of this kind.

Available options:

direct,

group,

channel,

broadcast

activeSince

string<date-time>

Specifies active since for this query parameter.

Value constraints

Constraint	Accepted input
Format	`date-time`
Return conversations with activity at or after this time (ISO 8601).

activeBefore

string<date-time>

Specifies active before for this query parameter.

Value constraints

Constraint	Accepted input
Format	`date-time`
Return conversations whose latest activity is before this time (ISO 8601).

Response

One page of conversations

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 chats response.

Accepted alternatives

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

previousCursor

string | null

required

Always null for conversations. Use nextCursor to continue listing.

Accepted alternatives

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

List chats

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

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

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

package main

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

func main() {

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

	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": [
    {
      "conversation": {
        "id": "739182640518203",
        "phoneNumber": "<string>",
        "bsuid": "<string>",
        "username": "<string>"
      },
      "kind": "direct",
      "lastActivityAt": "2023-11-07T05:31:56Z",
      "lastMessage": {
        "id": "739182640518203",
        "whatsapp_ids": {
          "linked_devices": "<string>",
          "official_api": "<string>"
        },
        "direction": "inbound",
        "type": "<string>",
        "timestamp": "2023-11-07T05:31:56Z",
        "whatsapp_id": "<string>"
      }
    }
  ],
  "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

Authorizations

Path Parameters

Query Parameters

Response