The message object

A message from a Podium conversation. Messages include each exchange within a conversation and include
conversations for all channels within Podium (Facebook Messenger, SMS text, GMB, etc).

Deprecations

The contact and sender object fields have been deprecated, they are currently only available in webhook
and will be completely removed at some point in the future.

Attribute	Type	Description
location.uid	string	Podium unique identifier for location.
location.organizationUid	string	Podium unique identifier for organization.
items	array	A list of all items associated with the message uid. This includes text bodies and attachments.
items[].type	string	The type of the message item.
items[].body	string	Body of the message.
items[].uid	string	Podium unique identifier for message item.
items[].createdAt	string	When the message item was created.
items[].attachmentUrl	string	Public URL of the message attachment. NOTE: There is an expiry of 7 days on this URL.
items[].attachmentContentType	string	MIME type of the message attachment.
items[].deliveryStatus	string	Status of the message item.
items[].encryptedAt	string	When the item was encrypted. `null` if the item is not encrypted.
items[].sendBody	string	The send body of the message item that the end consumer sees.
items[].sourceType	string	The source type of the message item.
body	string	Body of the message.
uid	string	Podium unique identifier for message.
contact.name	string	Name of the contact.
contact.uid	string	Podium unique identifier for contact.
contact.externalIdentifier	string	Identifier of the contact that is used external to Podium.
sender.uid	string	Podium unique identifier for user.
conversation.uid	string	Podium unique identifier for conversation.
conversation.channel.type	string	Messenger channel for the conversation. Possible values: ["apple", "car_wars", "email", "facebook", "fallback_email", "google", "google_brand", "iframe", "instagram", "phone", "secure", "sms", "text", "whatsapp"]
conversation.channel.identifier	string	Identifies the Messenger channel. Must be a valid email address or a phone number. Non-US/Canada numbers must include the country code (e.g. +61 for AUS)
conversation.assignedUserUid	string	Podium unique identifier for user.
conversation.startedAt	string	When the conversation was started.
createdAt	string	When the message was created.
contactName	string	Name of the contact.
attachmentUrl	string	URL of message attachment. This field is deprecated, please refer to the attachmentUrl in the items array.
failureReason	string	If the message failed to send, this will be the reason.
senderUid	string	Podium unique identifier for user. If the message was sent from Podium then this will be the Podium user who sent it.

{
  "location": {
    "uid": "00000000-0000-0000-0000-000000000000",
    "organizationUid": "00000000-0000-0000-0000-000000000000"
  },
  "items": [
    {
      "type": "attachment",
      "body": "https://www.podium.com/image.png",
      "uid": "00000000-0000-0000-0000-000000000000",
      "createdAt": "2015-01-23T23:50:07Z",
      "attachmentUrl": "https://www.podium.com/image.png",
      "attachmentContentType": "image/png",
      "deliveryStatus": "sent",
      "encryptedAt": "2015-01-23T23:50:07Z",
      "sendBody": "null",
      "sourceType": "outbound"
    }
  ],
  "body": "Hello there.",
  "uid": "00000000-0000-0000-0000-000000000000",
  "contact": {
    "name": "Joe Orange",
    "uid": "00000000-0000-0000-0000-000000000000",
    "externalIdentifier": "123-abc"
  },
  "sender": {
    "uid": "00000000-0000-0000-0000-000000000000"
  },
  "conversation": {
    "uid": "00000000-0000-0000-0000-000000000000",
    "channel": {
      "type": "email",
      "identifier": "[email protected]"
    },
    "assignedUserUid": "00000000-0000-0000-0000-000000000000",
    "startedAt": "2015-01-23T23:50:07Z"
  },
  "createdAt": "2015-01-23T23:50:07Z",
  "contactName": "Joe Orange",
  "attachmentUrl": "https://www.podium.com/",
  "failureReason": "Attempted to send SMS to a landline.",
  "senderUid": "00000000-0000-0000-0000-000000000000"
}