Messages

Search and list messages.

Parameters

Parameters can be added to filter the query. 

key	A message key.
channel	A string search in the channel name.
since	Returns messages created after the given timestamp (number of milliseconds since January 1, 1970, midnight UTC/GMT.)
before	Returns messages created before the given timestamp (number of milliseconds since January 1, 1970, midnight UTC/GMT.)
gatewayIn	A string search in the gateway in name.
gatewayOut	A string search in the gateway out name.
maxInSize	The maximum size of the incoming message (in bytes).
minInSize	The minimum size of the incoming message (in bytes).
errorDescription	A string search within the error description.
errorDescriptionRegex	A regex search within the error description.
userComment	A string search within the user comment.
ref	A string search within the message reference
status	The status of the message. The accepted values are IN_PROGRESS, PAUSED, IN_DELIVERY, SUCCESS, ERROR, ERROR_CLOSED.
type	The type of ticket. The accepted values are REGULAR and TEST.
start	An integer to set the first result. By default, the value is at 0. The API returns 25 results per query. To get the 25 following ones, it should be 25,   then 50, then 75, ...
childOf	UUID of the child message
parentOf	UUID of the parent message

Examples

• Get regular messages that ended up in success in JSON format in environment 12345

  https://www.babelway.net/SelfService3/rest/v2/hub-12345/messages.json?status=DONE&type=REGULAR

  [
      {
          "hub": 12345,
          "key": "8e106505-cca5-4b34-9137-7ce507a82b05",
          "status": "SUCCESS",
          "testStatus": null,
          "channel": {
              "id": 2977021,
              "name": "test solcae",
              "type": "Channel",
              "subType": "CHANNEL"
          },
          "gatewayIn": {
              "id": 6066579,
              "name": "HTTP/HTTPS SERVER IN (Username: babelway)",
              "type": "Gateway",
              "subType": "GATEWAY_IN_HTTP_IN"
          },
          "gatewayOut": {
              "id": 6066580,
              "name": "NULL OUT-17",
              "type": "Gateway",
              "subType": "GATEWAY_OUT_NULL_OUT"
          },
          "messageIn": {
              "step": "messageReception"
          },
          "messageOut": {
              "step": "messageReception"
          },
          "reference": "attachment",
          "keepUntilMoment": 1780664751583,
          "errorDescription": null,
          "receiveMoment": 1777986351557,
          "slaMoment": 1777986351573,
          "endMoment": 1777986351583,
          "gatewayInMessageStatus": "Received from CN=My user with IP 99.209.179.94 on https://dev.babelway.net/ws/ws-twa/gateways/6066579 (52.29.107.61)",
          "gatewayOutMessageStatus": null,
          "gatewayInMessageKey": null,
          "gatewayOutMessageKey": null,
          "test": "false",
          "testCase": null,
          "userComment": null,
          "steps": [
              "messageReception"
          ],
          "additionalFiles": [
              "contextIn",
              "contextOut"
          ]
      },
      [more messages...]
  ]