Skip to content
Messaging/
/
Retrieve messages

Interex Messaging API (1.0.1)

Download OpenAPI description
api.json
api.yaml
Languages
Servers
Mock server
https://developer.interex.io/_mock/spec/design/messaging/api/

Messages

Operations

Retrieve messages

Request

Query
lastIdinteger(int64)required

The id of the last message previously fetched

countinteger(int32)required

The number of messages to retrieve. (default is 10)

messageTypestring

The message type to filter on

schemaVersionstring

The schema version to filter on

channelstring

The channel for the messages.

entitystringrequired

The sender/recipient to filter on. Depends on the sent flag.

sentbooleanrequired

Display sent messages

fromTimestampstring(date-time)required

The earliest timestampe to filter on

toTimestampstring(date-time)required

The latest timestamp to filter on

Headers
x-correlation-idstring
curl -i -X GET \
  'https://developer.interex.io/_mock/spec/design/messaging/api/v1/messages?lastId=0&count=0&messageType=string&schemaVersion=string&channel=string&entity=string&sent=true&fromTimestamp=2019-08-24T14%3A15%3A22Z&toTimestamp=2019-08-24T14%3A15%3A22Z' \
  -H 'x-correlation-id: string'

Responses

The request has succeeded.

Headers
x-correlation-idstringrequired
Bodyapplication/jsonArray [
idinteger(int32)required

The id assigned by the messaging service.

frominteger(int32)required

The sender of the message.

tointeger(int32)required

Who the message is to be delivered to.

timestampstring(date-time)required

The UTC timestamp of when the message was received.

messageTypestringrequired

The message type contained in the payload.

schemaVersionstringrequired

The schema version of the message type.

payloadstringbase64required

The base64 encoded message payload.

]
Response
application/json
[
  {
    "id": 0,
    "from": 0,
    "to": 0,
    "timestamp": "2019-08-24T14:15:22Z",
    "messageType": "string",
    "schemaVersion": "string",
    "payload": "string"
  }
]

Send Message

Request

Headers
x-correlation-idstring
Bodyapplication/jsonrequired
recipientinteger(int32)required

The intended recipient for the message

messageTypestringrequired

The message type contained in the payload.

schemaVersionstringrequired

The schema version of the message type.

payloadstringbase64required

The base64 encoded message payload.

curl -i -X POST \
  https://developer.interex.io/_mock/spec/design/messaging/api/v1/messages \
  -H 'Content-Type: application/json' \
  -H 'x-correlation-id: string' \
  -d '{
    "recipient": 0,
    "messageType": "string",
    "schemaVersion": "string",
    "payload": "string"
  }'

Responses

The request has succeeded and a new resource has been created as a result.

Headers
x-correlation-idstringrequired
Bodyapplication/json
idinteger(int32)required

The id assigned by the messaging service.

frominteger(int32)required

The sender of the message.

tointeger(int32)required

Who the message is to be delivered to.

timestampstring(date-time)required

The UTC timestamp of when the message was received.

messageTypestringrequired

The message type contained in the payload.

schemaVersionstringrequired

The schema version of the message type.

payloadstringbase64required

The base64 encoded message payload.

Response
application/json
{
  "id": 0,
  "from": 0,
  "to": 0,
  "timestamp": "2019-08-24T14:15:22Z",
  "messageType": "string",
  "schemaVersion": "string",
  "payload": "string"
}
Copyright © iov42 Limited.