Objects

Action

The Action object contains information about your messages, including organization ID, status, details, messaging statistics, and more

{
  "cid": "12345",
  "account": "Acme Corporation",
  "action": "123",
  "name": "Summer Campaign",
  "status": "live",
  "num": "123",
  "type": "SMS",
  "sent_by": "self",
  "message": "Don't miss our summer sale! Visit our website for discounts.",
  "media": null,
  "campaignId": "No",
  "project": "Summer Campaign",
  "phone": ["11234567890", "10987654321"],
  "areacode": "123",
  "test_phone": "11234567890",
  "group": "1",
  "group_name": "Premium Customers",
  "group_count": 10000,
  "contact_filter": {"op":"all","condition":[{"name":"state","op":"eq","value":"CA"}]},
  "contact_count": 8000,
  "outsource_start_time": "2024-08-20T10:00:00Z",
  "outsource_end_time": "2024-08-20T18:00:00Z",
  "outsource_email": "[email protected]",
  "outsource_notes": "Priority project for VIP clients.",
  "clicks": 1200,
  "shortids": ["abc", "def"],
  "links": ["http://short.url/abc", "http://short.url/def"],
  "redirect": ["http://original.url/1", "http://original.url/2"],
  "live_time": "2024-08-20T09:00:00Z",
  "test_time": "2024-08-19T15:00:00Z",
  "update_time": "2024-08-20T09:30:00Z",
  "sent_time": "2024-08-20T09:05:00Z",
  "reply_time": "2024-08-20T09:15:00Z",
  "estimate_cost": 1500.00,
  "estimate_tax": 120.00,
  "cost": 1450.00,
  "tax": 116.00,
  "target": 10000,
  "sent": 9500,
  "sent_percent": 95.0,
  "segments_sent": 9500,
  "delivered": 9200,
  "delivered_percent": 96.84,
  "received": 800,
  "dnd": 50,
  "bad": 30,
  "spam": 10,
  "landline": 5,
  "err": 15,
  "skipped": 200,
  "replies": 750,
  "responses": 700,
  "autoresponses": 50,
  "received_percent": 8.42,
  "received_target_percent": 7.50,
  "dnd_percent": 0.53,
  "dnd_target_percent": 0.50,
  "bad_percent": 0.32,
  "bad_target_percent": 0.30,
  "spam_percent": 0.11,
  "spam_target_percent": 0.10,
  "landline_percent": 0.05,
  "landline_target_percent": 0.05,
  "err_percent": 0.16,
  "err_target_percent": 0.15,
  "skipped_percent": 2.11,
  "skipped_target_percent": 2.00,
  "replies_percent": 7.89,
  "err_target_percent": 7.50
}

Account

cid - Your account ID
account - Your account name

Project

action - The action id
name - The action name
status - The action status (live, archived)
num - The action number
type - Message type (SMS, MMS)
sent_by - The type of team that sent out the action (self, outsourced, fullservice)
message - The action message
media - The file attachment on the action
campaignId - The Campaign Registry(TCR) Id (No if no ID)
project - The action name
proxy - Phone numbers the action sends from
areacode - Areacode of the phone numbers the action sends from
test_phone - Phone number that test messages are sent to

Contact Group

group - ID of the contact group the action will be sent to
group_name - Name of the contact group the action will be sent to
group_count - Number of contacts of the contact group the action will be sent to
contact_filter - Dynamic filter to filter groups in action before sending
contact_count - Number of contacts the action will be sent to after the filter

Outsource

submit_time - Date and time the action was submitted for outsourcing
outsource_start_time - Start date and time for the action
outsource_end_time - End date and time for the action
outsource_email - Email for action updates to be sent to
outsource_notes - Notes visible in portal for the action.

Short Link

clicks - Total number of link clicks (when RumbleUp link shortener is used)
shortids - A list of existing shortener IDs used in the text
links - A list of links used in the text, it includes all links shortener or not
redirect - A list of shortlink original urls corresponding to the same index in the shortids list above

Timefields

live_time - Date and time the action was made live
test_time - Date and time the action was first tested
update_time - Date the time the action was last updated
sent_time - Date and time of last action message sent
reply_time - Date and time of last reply message received

Billing

estimate_cost - Estimated total cost of the action including tax
estimate_tax - Estimated tax of the action
cost - Total billed cost of the action
tax - Total additional tax charged (when applicable)

Statistics

target - Total number of contacts
sent - Total number of messages sent
sent_percent - Percent of messages sent compared to total
segments_sent - Total number of SMS segments sent
delivered - Total number of messages successfully delivered
delivered_percent - Percent of messages successfully delivered
received - Total number of incoming texts (including opt-outs)
dnd - Number of opt outs received
bad - Number of contacts marked bad on this action
spam - Number of messages flagged as spam
landline - Number of contacts flagged as landline
err - Number of messaged flagged with an error tag (e.g. landline or undeliverable)
skipped - Number of messages where sending was skipped
replies - Total number of replies (without of opt-outs)
responses - Total number of responses sent from texters
autoresponses - Total number of responses sent from auto-responses
received_percent - Percent of messages received out of sent messages
received_target_percent - Percent of messages received out of total contacts
dnd_percent - Percent of opt-outs received out of sent messages
dnd_target_percent - Percent of opt-outs received out of total contacts
bad_percent - Percent of contacts marked bad received out of sent messages
bad_target_percent - Percent of contacts marked bad out of total contacts
spam_percent - Percent of messages undelivered due to spam out of sent messages
spam_target_percent - Percent of messages undelivered due to spam out of total contacts
landline_percent - Percent of contacts marked as landline out of sent messages
landline_target_percent - Percent of contacts marked as landline out of total contacts
err_percent - Percent of messages undelivered due to error out of sent messages
err_target_percent - Percent of messages undelivered due to error out of total contacts
skipped_percent - Percent of messages skipped out of sent messages
skipped_target_percent - Percent of messages skipped out of total contacts
replies_percent - Percent of replies received out of sent messages
err_target_percent - Percent of replies received out of total contacts

Deprecated Fields

tcrcid
live
updated
tested
lastmsg
lastreply
submitted
percent
outsource_start
outsource_end