curl --request GET \
--url https://{organization}.rescueconsole.com/api/communications/messages/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{organization}.rescueconsole.com/api/communications/messages/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/communications/messages/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"id": "<string>",
"recipient_address": "<string>",
"direction": "outbound",
"channel": "email",
"category": "<string>",
"status": "queued",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"tenant_id": "<string>",
"template_id": "<string>",
"person_id": "<string>",
"provider": "<string>",
"provider_message_id": "<string>",
"subject": "<string>",
"related_entity_type": "<string>",
"related_entity_id": "<string>",
"payload_metadata": {
"reason": "<string>",
"suppression_scope": "platform",
"suppression_reason": "<string>",
"failover_attempts": [
{
"tier": 123,
"provider": "<string>",
"success": true,
"error": "<string>",
"provider_message_id": "<string>",
"attempted_at": "2023-11-07T05:31:56Z"
}
],
"cc": [
"<string>"
],
"bcc": [
"<string>"
],
"copies_suppressed": [
"<string>"
],
"thread_id": "<string>",
"error": "<string>"
}
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}Get one sent message
Needs read on Communications.
curl --request GET \
--url https://{organization}.rescueconsole.com/api/communications/messages/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{organization}.rescueconsole.com/api/communications/messages/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/communications/messages/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"id": "<string>",
"recipient_address": "<string>",
"direction": "outbound",
"channel": "email",
"category": "<string>",
"status": "queued",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"tenant_id": "<string>",
"template_id": "<string>",
"person_id": "<string>",
"provider": "<string>",
"provider_message_id": "<string>",
"subject": "<string>",
"related_entity_type": "<string>",
"related_entity_id": "<string>",
"payload_metadata": {
"reason": "<string>",
"suppression_scope": "platform",
"suppression_reason": "<string>",
"failover_attempts": [
{
"tier": 123,
"provider": "<string>",
"success": true,
"error": "<string>",
"provider_message_id": "<string>",
"attempted_at": "2023-11-07T05:31:56Z"
}
],
"cc": [
"<string>"
],
"bcc": [
"<string>"
],
"copies_suppressed": [
"<string>"
],
"thread_id": "<string>",
"error": "<string>"
}
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}Authorizations
An API key from Settings, API keys. It starts with rc_live_.
Path Parameters
The log entry's ID.
Response
The log entry.
Who it was to. For a message sent from a conversation to several people, their addresses separated by commas.
outbound, inbound email The kind of message, as the sender named it. general unless the sender said otherwise; inbox_new and inbox_reply for messages sent from a conversation.
suppressed: stopped before sending. sent: the email service accepted it and no delivery report has come back yet. delivered or bounced: what the delivery report said. failed: the email service did not accept it, or reported that it could not deliver it. received: a message that came in. A status never moves back.
queued, sent, delivered, failed, bounced, received, suppressed Your organization's ID.
The template it was sent from.
The person it was to, when it was sent to a person on file.
The email service that handled it. Null when it never reached one.
The email service's own ID for the message.
The subject as sent. The log keeps the subject, not the body.
The record it was about. email_thread for a message sent from a conversation, with the conversation's ID in related_entity_id.
Detail about what happened. Only the keys that apply are present.
Show child attributes
Show child attributes