MAmatrix
Third-party Lookup

Retrieve metadata about a specific protocol that the homeserver supports.

Fetches the metadata from the homeserver about a particular third-party protocol.

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

Request

Path parameters

protocolstring required

The name of the protocol.

Response

The protocol was found and metadata returned.

field_typesobject required

The type definitions for the fields defined in user_fields and location_fields. Each entry in those arrays MUST have an entry here. The string key for this object is the field name itself.

May be an empty object if no fields are defined.

iconstring required

A content URI representing an icon for the third-party protocol.

location_fieldsstring[] required

Fields which may be used to identify a third-party location. These should be ordered to suggest the way that entities may be grouped, where higher groupings are ordered first. For example, the name of a network should be searched before the name of a channel.

user_fieldsstring[] required

Fields which may be used to identify a third-party user. These should be ordered to suggest the way that entities may be grouped, where higher groupings are ordered first. For example, the name of a network should be searched before the nickname of a user.

Example response

{
  "field_types": {
    "channel": {
      "placeholder": "#foobar",
      "regexp": "#[^\\s]+"
    },
    "network": {
      "placeholder": "irc.example.org",
      "regexp": "([a-z0-9]+\\.)*[a-z0-9]+"
    },
    "nickname": {
      "placeholder": "username",
      "regexp": "[^\\s#]+"
    }
  },
  "icon": "mxc://example.org/aBcDeFgH",
  "location_fields": [
    "network",
    "channel"
  ],
  "user_fields": [
    "network",
    "nickname"
  ],
  "instances": [
    {
      "desc": "Freenode",
      "fields": {
        "network": "freenode"
      },
      "icon": "mxc://example.org/JkLmNoPq",
      "network_id": "freenode",
      "instance_id": "irc-freenode"
    }
  ]
}

Changes

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