Messages - List Messages | Webex for Developers

List Messages

Lists all messages in a room. Each message will include content attachments if present.

The list sorts the messages in descending order by creation date.

Long result sets will be split into pages.

GET/v1/messages

Query Parameters

roomId

stringrequired

List messages in a room, by ID.

parentId

string

List messages with a parent, by ID.

mentionedPeople

array

List messages with these people mentioned, by ID. Use me as a shorthand for the current API user. Only me or the person ID of the current user may be specified. Bots must include this parameter to list messages in group rooms (spaces).

before

string

List messages sent before a date and time.

beforeMessage

string

List messages sent before a message, by ID.

max

number

Limit the maximum number of messages in the response. Cannot exceed 100 if used with mentionedPeople.

Default: 50

Response Properties

items

array[List Message]

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

string

1:1 room

group

string

group room

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 clients.

files

array[string]

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[string]

People IDs for anyone mentioned in the message.

mentionedGroups

array[string]

Group names for the groups mentioned in the message.

attachments

array[Attachment]

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.

type

string

Must be AdaptiveCard.

version

string

Adaptive Card schema version.

body

array[object]

The card's elements.

type

string

Possible values: TextBlock

text

string

Possible values: Adaptive Cards

size

string

Possible values: large

actions

array[object]

The card's actions.

type

string

Possible values: Action.OpenUrl

url

string

Possible values: http://adaptivecards.io

title

string

Possible values: Learn More

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.

isVoiceClip

boolean

true if the audio file is a voice clip recorded by the client; false if the audio file is a standard audio file not posted using the voice clip feature.

Response Codes

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

Code	Status	Description
200	OK	Successful request with body content.
201	Created	The request has succeeded and has led to the creation of a resource.
202	Accepted	The request has been accepted for processing.
204	No Content	Successful request without body content.
400	Bad Request	The request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401	Unauthorized	Authentication credentials were missing or incorrect.
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{?roomId,parentId,mentionedPeople,before,beforeMessage,max}

Header

Authorization
Use personal access token
Bearer
This limited-duration personal access token is hidden for your security.

Query Parameters

roomId
stringRequired
List messages in a room, by ID.
parentId
string
List messages with a parent, by ID.
mentionedPeople
array
List messages with these people mentioned, by ID. Use `me` as a shorthand for the current API user. Only `me` or the person ID of the current user may be specified. Bots must include this parameter to list messages in group rooms (spaces).
before
string
List messages sent before a date and time.
beforeMessage
string
List messages sent before a message, by ID.
max
number
Limit the maximum number of messages in the response. Cannot exceed 100 if used with `mentionedPeople`.

https://webexapis.com/v1/messages?roomId=Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0&parentId=Y2lzY29zcGFyazovL3VzL01FU1NBR0UvZWM1ZTIzZjAtN2RhMS0xMWU5LTg2NTgtZTkzYzNiODZjZmFm&mentionedPeople=Y2lzY29zcGFyazovL3VzL1BFT1BMRS8yNDlmNzRkOS1kYjhhLTQzY2EtODk2Yi04NzllZDI0MGFjNTM&before=2016-04-21T19:01:55.966Z&beforeMessage=Y2lzY29zcGFyazovL3VzL01FU1NBR0UvOTJkYjNiZTAtNDNiZC0xMWU2LThhZTktZGQ1YjNkZmM1NjVk&max=100

200 / OK

{
  "items": [
    {
      "id": "Y2lzY29zcGFyazovL3VzL01FU1NBR0UvOTJkYjNiZTAtNDNiZC0xMWU2LThhZTktZGQ1YjNkZmM1NjVk",
      "parentId": "Y2lzY29zcGFyazovL3VzL01FU1NBR0UvOTJkYjNiZTAtNDNiZC0xMWU2LThhZTktZGQ1YjNkZmM1NjVk",
      "roomId": "Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0",
      "roomType": "group",
      "text": "PROJECT UPDATE - A new project plan has been published on http://example.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 <http://example.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://example.com/s/lf5vj\\\" rel=\\\"nofollow\\\">here</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",
      "isVoiceClip": false
    }
  ]
}