MAmatrix

Ask the homeserver to ping the application service to ensure the connection works.

This API asks the homeserver to call the /_matrix/app/v1/ping endpoint on the application service to ensure that the homeserver can communicate with the application service.

This API requires the use of an application service access token (as_token) instead of a typical client's access token. This API cannot be invoked by users who are not identified as application services. Additionally, the appservice ID in the path must be the same as the appservice whose as_token is being used.

post/_matrix/client/v1/appservice/{appserviceId}/ping

Request

Path parameters

appserviceIdstring required

The appservice ID of the appservice to ping. This must be the same as the appservice whose as_token is being used to authenticate the request.

Request body

transaction_idstring

An optional transaction ID that is passed through to the /_matrix/app/v1/ping call.

Example request

{
  "transaction_id": "mautrix-go_1683636478256400935_123"
}

Response

The ping was successful.

duration_msinteger required

The duration in milliseconds that the /_matrix/app/v1/ping request took from the homeserver's point of view.

Changes

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