Get Message Details

Shows details for a message, by message ID.

Specify the message ID in the messageId parameter in the URI.

GET/v1/messages/{messageId}
URI Parameters
messageId
stringrequired

The unique identifier for the message.

Response Properties
id
string

The unique identifier for the message.

parentId
string

The unique identifier for the parent message.

roomId
string

The room ID of the message.

roomType
enum

The type of room.

direct

1:1 room

group

group room

toPersonId
string

The person ID of the recipient when sending a private 1:1 message.

toPersonEmail
string

The email address of the recipient when sending a private 1:1 message.

text
string

The message, in plain text. If markdown is specified this parameter may be optionally used to provide alternate text for UI clients that do not support rich text.

markdown
string

The message, in Markdown format.

html
string

The text content of the message, in HTML format. This read-only property is used by the Webex Teams clients.

files
array

Public URLs for files attached to the message. For the supported media types and the behavior of file uploads, see Message Attachments.

personId
string

The person ID of the message author.

personEmail
string

The email address of the message author.

mentionedPeople
array

People IDs for anyone mentioned in the message.

mentionedGroups
array

Group names for the groups mentioned in the message.

attachments
array

Message content attachments attached to the message. See the Cards Guide for more information.

contentType
string

The content type of the attachment.

content
Adaptive Card

Adaptive Card content.

created
string

The date and time the message was created.

updated
string

The date and time that the message was last edited by the author. This field is only present when the message contents have changed.

Response Codes

The list below describes the common success and error responses you should expect from the API.

CodeStatusDescription
200OKSuccessful request with body content.
204No ContentSuccessful request without body content.
400Bad RequestThe request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401UnauthorizedAuthentication credentials were missing or incorrect.
  1. | 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. | | 404 | Not Found | The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method. | | 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. | | 409 | Conflict | The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once. | | 410 | Gone | The requested resource is no longer available. | | 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. | | 423 | Locked | The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again. | | 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded.
    | 429 | Too Many Requests | Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made. | | 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. | | 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. | | 503 | Service Unavailable | Server is overloaded with requests. Try again later. | | 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
GET
/v1/messages/
Log in to try the API.
Header
https://webexapis.com/v1/messages/Y2lzY29zcGFyazovL3VzL01FU1NBR0UvOTJkYjNiZTAtNDNiZC0xMWU2LThhZTktZGQ1YjNkZmM1NjVk
200 / OK
{
  "id": "Y2lzY29zcGFyazovL3VzL01FU1NBR0UvOTJkYjNiZTAtNDNiZC0xMWU2LThhZTktZGQ1YjNkZmM1NjVk",
  "parentId": "Y2lzY29zcGFyazovL3VzL01FU1NBR0UvOTJkYjNiZTAtNDNiZC0xMWU2LThhZTktZGQ1YjNkZmM1NjVk",
  "roomId": "Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0",
  "roomType": "group",
  "toPersonId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mMDZkNzFhNS0wODMzLTRmYTUtYTcyYS1jYzg5YjI1ZWVlMmX",
  "toPersonEmail": "julie@example.com",
  "text": "PROJECT UPDATE - A new project plan has been published on Box: http://box.com/s/lf5vj. The PM for this project is Mike C. and the Engineering Manager is Jane W.",
  "markdown": "**PROJECT UPDATE** A new project plan has been published [on Box](http://box.com/s/lf5vj). The PM for this project is <@personEmail:mike@example.com> and the Engineering Manager is <@personEmail:jane@example.com>.",
  "html": "<p><strong>PROJECT UPDATE</strong> A new project plan has been published <a href=\\\"http://box.com/s/lf5vj\\\" rel=\\\"nofollow\\\">on Box</a>. The PM for this project is mike@example.com and the Engineering Manager is jane@example.com.</p>",
  "files": [
    "http://www.example.com/images/media.png"
  ],
  "personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
  "personEmail": "matt@example.com",
  "mentionedPeople": [
    "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8yNDlmNzRkOS1kYjhhLTQzY2EtODk2Yi04NzllZDI0MGFjNTM",
    "Y2lzY29zcGFyazovL3VzL1BFT1BMRS83YWYyZjcyYy0xZDk1LTQxZjAtYTcxNi00MjlmZmNmYmM0ZDg"
  ],
  "mentionedGroups": [
    "all"
  ],
  "attachments": [
    {
      "contentType": "application/vnd.microsoft.card.adaptive",
      "content": {
        "type": "AdaptiveCard",
        "version": "1.0",
        "body": [
          {
            "type": "TextBlock",
            "text": "Adaptive Cards",
            "size": "large"
          }
        ],
        "actions": [
          {
            "type": "Action.OpenUrl",
            "url": "http://adaptivecards.io",
            "title": "Learn More"
          }
        ]
      }
    }
  ],
  "created": "2015-10-18T14:26:16+00:00",
  "updated": "2015-10-18T14:27:16+00:00"
}