Async API PlantaPop! 0.1.0

Operations

Messages

Async API PlantaPop! 0.1.0

Operations

Pub chat/{id}

Parameters
id id
required
string
must match ^[0-9a-fA-F]{24}$

ID of the chat

Accepts the following message:

message

Send messages to a chat

Payload
object
id
string
uuid
chatId
string
uuid
sender
string
email
content
string
timestamp
string
date-time

Additional properties are allowed.

Examples

message
Payload 
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "chatId": "f255124e-3419-4f6e-b7ee-17a6577db94d",
  "sender": "user@example.com",
  "content": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}
This example has been generated automatically.

Sub chat/{id}

Parameters
id id
required
string
must match ^[0-9a-fA-F]{24}$

ID of the chat

Accepts the following message:

message

Receive messages from a chat

Payload
object
id
string
uuid
chatId
string
uuid
sender
string
email
content
string
timestamp
string
date-time

Additional properties are allowed.

Examples

message
Payload 
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "chatId": "f255124e-3419-4f6e-b7ee-17a6577db94d",
  "sender": "user@example.com",
  "content": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}
This example has been generated automatically.

Pub chat/{id}/receipts

Parameters
id id
required
string
must match ^[0-9a-fA-F]{24}$

ID of the chat

Accepts the following message:

receipt

Send read receipts to a chat

Payload
object
messageId
string
uuid
chatId
string
uuid
recipient
string
email
timestamp
string
date-time

Additional properties are allowed.

Examples

receipt
Payload 
{
  "messageId": "8540d774-4863-4d2b-b788-4ecb19412e85",
  "chatId": "f255124e-3419-4f6e-b7ee-17a6577db94d",
  "recipient": "user@example.com",
  "timestamp": "2019-08-24T14:15:22Z"
}
This example has been generated automatically.

Messages

#1 message

Receive messages from a chat

Payload
object
id
string
uuid
chatId
string
uuid
sender
string
email
content
string
timestamp
string
date-time

Additional properties are allowed.

#2 receipt

Send read receipts to a chat

Payload
object
messageId
string
uuid
chatId
string
uuid
recipient
string
email
timestamp
string
date-time

Additional properties are allowed.