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
Name
Description
roomId
stringrequired

List messages in a room, by ID.

mentionedPeople
array

List messages with these people mentioned, by ID. Use me as a shorthand for the current API user.

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.

Response Properties
Name
Description
id
string

The unique identifier for the message.

roomId
string

The room ID of the message.

roomType
enum

The type of room.

direct

1-to-1 room

group

group room

toPersonId
string

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

toPersonEmail
string

The email address of the recipient when sending a private 1-to-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.

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 personId of the message author.

personEmail
string

The email address of the message author.

created
string

The date and time the message was created.

mentionedPeople
array

People IDs for anyone mentioned in the message.

mentionedGroups
array

Group names for the groups mentioned in the message.

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.
403ForbiddenThe request is understood, but it has been refused or access is not allowed.
404Not FoundThe 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.
405Method Not AllowedThe request was made to a resource using an HTTP request method that is not supported.
409ConflictThe 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.
415Unsupported Media TypeThe request was made to a resource without specifying a media type or used a media type that is not supported.
429Too Many RequestsToo 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.
500Internal Server ErrorSomething went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502Bad GatewayThe server received an invalid response from an upstream server while processing the request. Try again later.
503Service UnavailableServer is overloaded with requests. Try again later.
GET
/v1/messages{?,mentionedPeople,before,beforeMessage,max}
Log in to try the API.
Header
Parameters
  • List messages in a room, by ID.
  • List messages with these people mentioned, by ID. Use `me` as a shorthand for the current API user.
  • List messages sent before a date and time.
  • List messages sent before a message, by ID.
  • Limit the maximum number of messages in the response.
Example Response
{
  "items": [
    {
      "id": "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>.",
      "files": [
        "http://www.example.com/images/media.png"
      ],
      "personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
      "personEmail": "matt@example.com",
      "created": "2015-10-18T14:26:16+00:00",
      "mentionedPeople": [
        "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8yNDlmNzRkOS1kYjhhLTQzY2EtODk2Yi04NzllZDI0MGFjNTM",
        "Y2lzY29zcGFyazovL3VzL1BFT1BMRS83YWYyZjcyYy0xZDk1LTQxZjAtYTcxNi00MjlmZmNmYmM0ZDg"
      ],
      "mentionedGroups": [
        "all"
      ]
    }
  ]
}