Properties
| NAME | TYPE | DESCRIPTION |
total | integer | Total number of messages documents that matched your query. |
messages | array | List of messages. Can be one of: |
Example
JSON
{
"total": 5,
"messages": [
{
"$id": "5e5ea5c16897e",
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"providerType": "email",
"topics": [
"5e5ea5c16897e"
],
"users": [
"5e5ea5c16897e"
],
"targets": [
"5e5ea5c16897e"
],
"scheduledAt": "2020-10-15T06:38:00.000+00:00",
"deliveredAt": "2020-10-15T06:38:00.000+00:00",
"deliveryErrors": [
"Failed to send message to target 5e5ea5c16897e: Credentials not valid."
],
"deliveredTotal": 1,
"data": {
"subject": "Welcome to Appwrite",
"content": "Hi there, welcome to Appwrite family."
},
"status": "Message status can be one of the following: draft, processing, scheduled, sent, or failed."
}
]
}
JSON
{
"total": 5,
"messages": [
{
"_id": "5e5ea5c16897e",
"_createdAt": "2020-10-15T06:38:00.000+00:00",
"_updatedAt": "2020-10-15T06:38:00.000+00:00",
"providerType": "email",
"topics": [
"5e5ea5c16897e"
],
"users": [
"5e5ea5c16897e"
],
"targets": [
"5e5ea5c16897e"
],
"scheduledAt": "2020-10-15T06:38:00.000+00:00",
"deliveredAt": "2020-10-15T06:38:00.000+00:00",
"deliveryErrors": [
"Failed to send message to target 5e5ea5c16897e: Credentials not valid."
],
"deliveredTotal": 1,
"data": {
"subject": "Welcome to Appwrite",
"content": "Hi there, welcome to Appwrite family."
},
"status": "Message status can be one of the following: draft, processing, scheduled, sent, or failed."
}
]
}