List sent messages
curl --request GET \
--url https://{organization}.rescueconsole.com/api/communications/messages \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{organization}.rescueconsole.com/api/communications/messages', 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"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"results": [
{
"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>"
}
}
],
"limit": 123,
"offset": 123,
"has_more": true
}{
"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)"
}Message log
List sent messages
The messages your organization has sent or tried to send, newest first, including those stopped before sending. A message sent from a conversation is here too; its body is in the conversation. Needs read on Communications.
GET
/
api
/
communications
/
messages
List sent messages
curl --request GET \
--url https://{organization}.rescueconsole.com/api/communications/messages \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{organization}.rescueconsole.com/api/communications/messages', 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"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"results": [
{
"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>"
}
}
],
"limit": 123,
"offset": 123,
"has_more": true
}{
"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_.
Query Parameters
Available options:
outbound, inbound Available options:
queued, sent, delivered, failed, bounced, received, suppressed One category, exactly as it was sent.
Messages to one person on file.
How many to return. 25 unless you say, 100 at most.
Required range:
1 <= x <= 100How many to skip, for the next page.
Required range:
x >= 0