MAmatrix
Third-party Lookup

Retrieve Matrix-side portals rooms leading to a third-party location.

Requesting this endpoint with a valid protocol name results in a list of successful mapping results in a JSON array. Each result contains objects to represent the Matrix room or rooms that represent a portal to this third-party network. Each has the Matrix room alias string, an identifier for the particular third-party network protocol, and an object containing the network-specific fields that comprise this identifier. It should attempt to canonicalise the identifier as much as reasonably possible given the network type.

get/_matrix/client/v3/thirdparty/location/{protocol}

Request

Path parameters

protocolstring required

The protocol used to communicate to the third-party network.

Query parameters

fieldsobject

One or more custom fields to help identify the third-party location.

Response

At least one portal room was found.

aliasstring required

An alias for a matrix room.

fieldsobject required

Information used to identify this third-party location.

protocolstring required

The protocol ID that the third-party location is a part of.

Example response

[
  {
    "alias": "#freenode_#matrix:matrix.org",
    "fields": {
      "channel": "#matrix",
      "network": "freenode"
    },
    "protocol": "irc"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.