Querying an Existing Message

cURL

curl "https://app.tatango.com/api/v2/lists/ID/messages/MESSAGE_ID" -X GET \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -u [email protected]:my_api_key \
  -H "Host: example.org" \
  -H "Cookie: "

{
  "status": "OK",
  "message": {
    "id": 14523,
    "content": "AMCE Retail: Go to http://bit.ly/acme to see deals on anvils. Reply STOP to end.",
    "sent_at": "2016-09-07T14:10:53-07:00",
    "status": "sent",
    "name": "my message name",
    "is_broadcast": true,
    "recipient_count": 679571,
    "success_count": 675232,
    "bounces_count": 4339,
    "pending_count": 0,
    "clean_count": 2342,
    "unsubscribe_count": 1362,
    "sms_count": 168808,
    "mms_count": 506424,
    "send_cost": 5096.78,
    "attachment": "https://url-to-your-mms-attachment",
    "cancelled_at": null,
    "message_links": [
      {
        "id": 42,
        "link": "http://bit.ly/acme",
        "count": 2356,
        "display_count": 2356
      }
    ],
    "parts": {
      "sum": 679599,
      "minimum": 1,
      "maximum": 2
    }
  }
}

GET

api

lists

{ID}

messages

{MESSAGE_ID}

cURL

curl "https://app.tatango.com/api/v2/lists/ID/messages/MESSAGE_ID" -X GET \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -u [email protected]:my_api_key \
  -H "Host: example.org" \
  -H "Cookie: "

{
  "status": "OK",
  "message": {
    "id": 14523,
    "content": "AMCE Retail: Go to http://bit.ly/acme to see deals on anvils. Reply STOP to end.",
    "sent_at": "2016-09-07T14:10:53-07:00",
    "status": "sent",
    "name": "my message name",
    "is_broadcast": true,
    "recipient_count": 679571,
    "success_count": 675232,
    "bounces_count": 4339,
    "pending_count": 0,
    "clean_count": 2342,
    "unsubscribe_count": 1362,
    "sms_count": 168808,
    "mms_count": 506424,
    "send_cost": 5096.78,
    "attachment": "https://url-to-your-mms-attachment",
    "cancelled_at": null,
    "message_links": [
      {
        "id": 42,
        "link": "http://bit.ly/acme",
        "count": 2356,
        "display_count": 2356
      }
    ],
    "parts": {
      "sum": 679599,
      "minimum": 1,
      "maximum": 2
    }
  }
}

Please note the following:

It takes some time after a message is sent to receive delivery status notifications from the various carriers. We recommend waiting until at least 10 minutes after a message is sent to query for delivery statistics.
The message_links attribute will only be present on messages that have bit.ly links in their content.
The parts attribute will be available 30 minutes after the message was sent.

Request URL

GET https://app.tatango.com/api/v2/lists/{ID}/messages/{MESSAGE_ID}

Authorizations

Authorization

string

header

required

Tatango authenticates API requests by validating an API key passed via HTTP Basic Authentication. Use your login email as the username and your API key as the password.

Path Parameters

integer

required

ID of the list

MESSAGE_ID

integer

required

ID of the message

Response

200 - application/json

Successful response

status

string

required

Response status

Example:

"OK"

message

object

required

Show child attributes

message.content

string

required

The actual content of the message that was sent to subscribers.

Example:

"AMCE Retail: Go to http://bit.ly/acme to see deals on anvils. Reply STOP to end."

message.id

integer

required

A unique ID that identifies this specific message.

Example:

14523

message.name

string

required

An optional name or description for a message.

Example:

"my message name"

message.sent_at

string<date-time>

required

The date/time this message completed it's send.

Example:

"2016-09-07T14:10:53-07:00"

message.status

string

required

The status of the message.

Example:

"sent"

message.is_broadcast

boolean

required

If true, the message was sent to the whole list. If false, was sent only to the phone_number specified.

Example:

true

message.recipient_count

integer

required

The number of recipients the message was sent to.

Example:

679571

message.success_count

integer

required

The number of recipients that succesfully received the message on their mobile phones.

Example:

675232

message.bounces_count

integer

required

The number of recipients that did not receive the message on their mobile phones.

Example:

4339

message.pending_count

integer

required

The number of messages that do not have a delivery status as of the time of the query.

Example:

0

message.clean_count

integer

required

The number of recipients that Tatango automatically unsubscribed from your list due to our

Example:

2342

message.unsubscribe_count

integer

required

The number of recipients that unsubscribed from the list, in response to the message that was sent to them.

Example:

1362

message.phone_number

string

The wireless phone number of the subscriber.

message.sms_count

integer

Number of SMS messages sent

Example:

168808

message.mms_count

integer

Number of MMS messages sent

Example:

506424

message.send_cost

number<float>

Cost of sending the message

Example:

5096.78

message.attachment

string

URL to MMS attachment

Example:

"https://url-to-your-mms-attachment"

message.cancelled_at

string<date-time>

Date/time when message was cancelled

message.message_links

object[]

Links contained in the message (only present on messages that have bit.ly links)

Show child attributes

message.message_links.id

integer

Example:

42

message.message_links.link

string

Example:

"http://bit.ly/acme"

message.message_links.count

integer

Example:

2356

message.message_links.display_count

integer

Example:

2356

message.parts

object

Message parts information (available 30 minutes after message was sent)

Show child attributes

message.parts.sum

integer

Example:

679599

message.parts.minimum

integer

Example:

1

message.parts.maximum

integer

Example:

2

Send Message to Entire List Creating a New MOMT Report

⌘I

v2 API Reference

Accounts

Lists

Subscribers

Custom Fields

Tags

Messaging

Message Log (MOMT) Reports

Shortcodes

Transactional Messages

Webhooks

Querying an Existing Message

Request URL

Authorizations

Path Parameters

Response

v2 API Reference

Accounts

Lists

Subscribers

Custom Fields

Tags

Messaging

Message Log (MOMT) Reports

Shortcodes

Transactional Messages

Webhooks

​Request URL

Authorizations

Path Parameters

Response

Request URL