Skip to content
Kalipto Devs Platform — API Docs

List Messages

GET
/platform/v1/messages
 
curl --request GET \
  --url https://example.com/platform/v1/messages

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
channel_id
Any of:
integer
conversation_id
Any of:
integer
direction
Any of:
string
/^(inbound|outbound)$/
source
Any of:
string
/^(contact|api|app_echo)$/
status
Any of:
string
type
Any of:
string
has_media
Any of:
boolean
since
Any of:
string format: date-time
until
Any of:
string format: date-time
after
Any of:
string
before
Any of:
string
limit
Any of:
integer

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
PlatformMessagePage
object
data
required
Data
Array<object>
PlatformMessageResponse
object
created_at
required
Created At
string format: date-time
direction
required
Direction
string
has_media
required
Has Media
boolean
id
required
Id
integer
media_id
Any of:
string
message_type
Any of:
string
meta_error
Any of:
Meta Error
meta_message_id
Any of:
string
peer_id
required
Peer Id
string
platform_channel_id
required
Platform Channel Id
integer
platform_conversation_id
Any of:
integer
pricing
Any of:
Pricing
referral
Any of:
Referral
sent_at
Any of:
string format: date-time
source
Any of:
string
status
Any of:
string
status_history
Status History
Array
default:
text_body
Any of:
string
next_cursor
Any of:
string
prev_cursor
Any of:
string
Example 
{
  "data": [
    {
      "status_history": []
    }
  ]
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Example generated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}