> This page is for APIs.

> Fetch clean Markdown by appending `.md` to any page URL under https://signalwire.com/docs or requesting it with the HTTP header `Accept: text/markdown`. The root index at https://signalwire.com/docs/llms.txt lists the available documentation indexes.

# signalwire.ping

GET /

Check the connection with a ping

Reference: https://signalwire.com/docs/apis/relay/server/signalwire/signalwire-ping

## AsyncAPI Specification

```yaml
asyncapi: 2.6.0
info:
  title: signalwire.ping
  version: subpackage_signalwirePing.signalwire.ping
  description: Check the connection with a ping
channels:
  /:
    description: Check the connection with a ping
    publish:
      operationId: subpackage_signalwirePing.signalwire.ping-publish
      summary: signalwire.ping response
      message:
        name: onSignalwirePingResponse
        title: signalwire.ping response
        payload:
          $ref: '#/components/schemas/signalwire.ping_signalwirePingResponse'
    subscribe:
      operationId: subpackage_signalwirePing.signalwire.ping-subscribe
      summary: signalwire.ping
      message:
        name: signalwirePing
        title: signalwire.ping
        payload:
          $ref: '#/components/schemas/signalwire.ping_signalwirePingRequest'
servers:
  production:
    url: wss://relay.signalwire.com/
    protocol: wss
    x-default: true
components:
  schemas:
    ChannelsSignalwirePingMessagesSignalwirePingResponseJsonrpc:
      type: string
      enum:
        - '2.0'
      description: JSON-RPC version. Always `2.0`.
      title: ChannelsSignalwirePingMessagesSignalwirePingResponseJsonrpc
    Signalwire.PingResult:
      type: object
      properties:
        timestamp:
          type: number
          format: double
          description: The `timestamp` from the ping, echoed back unchanged.
        payload:
          type: string
          description: The `payload` from the ping, echoed back unchanged.
      description: >-
        The result of a `signalwire.ping`: the `timestamp` and `payload` from
        the ping, echoed back unchanged.
      title: Signalwire.PingResult
    JsonRpcErrorCode0:
      type: string
      enum:
        - '-32000'
      title: JsonRpcErrorCode0
    JsonRpcErrorCode1:
      type: string
      enum:
        - '-32001'
      title: JsonRpcErrorCode1
    JsonRpcErrorCode2:
      type: string
      enum:
        - '-32002'
      title: JsonRpcErrorCode2
    JsonRpcErrorCode3:
      type: string
      enum:
        - '-32003'
      title: JsonRpcErrorCode3
    JsonRpcErrorCode4:
      type: string
      enum:
        - '-32004'
      title: JsonRpcErrorCode4
    JsonRpcErrorCode5:
      type: string
      enum:
        - '-32005'
      title: JsonRpcErrorCode5
    JsonRpcErrorCode6:
      type: string
      enum:
        - '-32600'
      title: JsonRpcErrorCode6
    JsonRpcErrorCode7:
      type: string
      enum:
        - '-32601'
      title: JsonRpcErrorCode7
    JsonRpcErrorCode8:
      type: string
      enum:
        - '-32602'
      title: JsonRpcErrorCode8
    JsonRpcErrorCode9:
      type: string
      enum:
        - '-32603'
      title: JsonRpcErrorCode9
    JsonRpcErrorCode10:
      type: string
      enum:
        - '-32700'
      title: JsonRpcErrorCode10
    JsonRpcErrorCode:
      oneOf:
        - $ref: '#/components/schemas/JsonRpcErrorCode0'
        - $ref: '#/components/schemas/JsonRpcErrorCode1'
        - $ref: '#/components/schemas/JsonRpcErrorCode2'
        - $ref: '#/components/schemas/JsonRpcErrorCode3'
        - $ref: '#/components/schemas/JsonRpcErrorCode4'
        - $ref: '#/components/schemas/JsonRpcErrorCode5'
        - $ref: '#/components/schemas/JsonRpcErrorCode6'
        - $ref: '#/components/schemas/JsonRpcErrorCode7'
        - $ref: '#/components/schemas/JsonRpcErrorCode8'
        - $ref: '#/components/schemas/JsonRpcErrorCode9'
        - $ref: '#/components/schemas/JsonRpcErrorCode10'
      title: JsonRpcErrorCode
    JsonRpcError:
      type: object
      properties:
        code:
          $ref: '#/components/schemas/JsonRpcErrorCode'
          description: >-
            The error code — a negative integer identifying the failure. See
            `JsonRpcErrorCode` for the full list of values and meanings.
        message:
          type: string
          description: A human-readable description of what went wrong.
        original_request:
          type: object
          additionalProperties:
            description: Any type
          description: >-
            An echo of the request that failed — the full JSON-RPC frame you
            sent

            (`jsonrpc`, `id`, `method`, `params`). Always present.
        requester_nodeid:
          type: string
          description: >-
            The node that sent the failed request. Present only on some routing
            errors.
        requester_identity:
          type: string
          description: >-
            The identity of the requester. Present only on some routing errors;
            same value as `requester_nodeid`.
        responder_nodeid:
          type: string
          description: >-
            The node that was handling the request. Present only on some routing
            errors.
        responder_identity:
          type: string
          description: >-
            The identity of the responder. Present only on some routing errors;
            same value as `responder_nodeid`.
        last_hop_timeout:
          type: boolean
          description: >-
            `true` when the request timed out on its final hop inside
            SignalWire. Present only on some timeout errors.
      required:
        - code
        - message
        - original_request
      description: >-
        A JSON-RPC 2.0 error object, delivered on the `error` field of a
        `JsonRpcResponse` when

        a request fails at the protocol level (bad version, authentication,
        scope, params, or

        your project's connection limit). It replaces `result` — a frame carries
        one or the other, never both.
      title: JsonRpcError
    signalwire.ping_signalwirePingResponse:
      type: object
      properties:
        jsonrpc:
          $ref: >-
            #/components/schemas/ChannelsSignalwirePingMessagesSignalwirePingResponseJsonrpc
          description: JSON-RPC version. Always `2.0`.
        id:
          type: string
          description: The id of the request this responds to.
        result:
          $ref: '#/components/schemas/Signalwire.PingResult'
          description: The method result. Present when the request succeeded.
        error:
          $ref: '#/components/schemas/JsonRpcError'
          description: >-
            Present instead of `result` when the request failed at the protocol
            level.
      required:
        - jsonrpc
        - id
      description: >-
        A JSON-RPC response frame correlated to a request by `id`. On success
        the frame carries

        `result` (the method result). If the request fails at the protocol level
        — an

        incompatible version, failed authentication, insufficient scope, invalid
        params, or your

        project's connection limit — the frame carries `error` instead of
        `result`. Many

        method-level failures (for example most Calling failures) are reported
        the other way: a

        normal `result` whose own `code` is not `"200"`. Each method documents
        which form its

        failures take.


        An `error` returned for `signalwire.connect` is followed by the service
        closing the

        WebSocket; open a new connection to try again. The same happens when

        `signalwire.reauthenticate` sends credentials that are rejected, except
        for a

        Subscriber Access Token. Errors on any other request leave the
        connection open.
      title: signalwire.ping_signalwirePingResponse
    ChannelsSignalwirePingMessagesSignalwirePingRequestJsonrpc:
      type: string
      enum:
        - '2.0'
      description: JSON-RPC version. Always `2.0`.
      title: ChannelsSignalwirePingMessagesSignalwirePingRequestJsonrpc
    ChannelsSignalwirePingMessagesSignalwirePingRequestMethod:
      type: string
      enum:
        - signalwire.ping
      description: The name of the JSON-RPC method being invoked.
      title: ChannelsSignalwirePingMessagesSignalwirePingRequestMethod
    Signalwire.PingParams:
      type: object
      properties:
        timestamp:
          type: number
          format: double
          description: >-
            When the ping was sent, as a Unix timestamp in seconds. Echoed back
            unchanged in the reply.
        payload:
          type: string
          description: >-
            An opaque value echoed back unchanged in the reply. Use it to
            correlate a ping with its response.
      description: >-
        The parameters carried by a `signalwire.ping`, in either direction. Both
        fields

        are optional and are echoed back unchanged in the reply, so you can use
        them to

        measure round-trip latency or correlate a ping with its response.
      title: Signalwire.PingParams
    signalwire.ping_signalwirePingRequest:
      type: object
      properties:
        jsonrpc:
          $ref: >-
            #/components/schemas/ChannelsSignalwirePingMessagesSignalwirePingRequestJsonrpc
          description: JSON-RPC version. Always `2.0`.
        id:
          type: string
          description: Request id, echoed on the correlated response.
        method:
          $ref: >-
            #/components/schemas/ChannelsSignalwirePingMessagesSignalwirePingRequestMethod
          description: The name of the JSON-RPC method being invoked.
        params:
          $ref: '#/components/schemas/Signalwire.PingParams'
          description: The method's input parameters.
      required:
        - jsonrpc
        - id
        - method
        - params
      description: >-
        A JSON-RPC request frame. `Method` is the method name; `Params` is the
        method's input.
      title: signalwire.ping_signalwirePingRequest

```