Calls

Join a call room

Upgrade to a WebSocket as either Contact in a live Call. This socket is signaling only: every frame is JSON text and media never passes through it. Each participant sends join when the socket opens, and again after any reconnect; the callee answers a ringing Call by sending join. Relay answers every join with iceServers, the STUN and TURN servers for the RTCPeerConnection, then roomState. Each participant then sends an offer publishing a WebRTC track named audio, and later one adding a track named video the first time its camera turns on; Relay returns answer. After applying that answer, send connected only when the RTCPeerConnection connectionState is connected. Once both participants have published and reported connected, Relay pulls every track each participant has published into the other Cloudflare SFU Session, one at a time, and sends that participant an offer naming the track; answer it with answer to complete renegotiation. A participant whose PeerConnection is dead sends offer with restart: true from a new PeerConnection: Relay moves it onto a new SFU Session, the Call stays in progress, and both directions are pulled again after it sends connected. The room is scoped to the Call and accepts only its authenticated user or agent Contact.

GET

calls

{callId}

room

Join a call room

curl --request GET \
  --url https://api.relayapp.im/v1/calls/{callId}/room \
  --header 'Authorization: Bearer <token>' \
  --header 'Upgrade: <upgrade>'

{
  "error": {
    "status": 123,
    "code": 123,
    "message": "<string>",
    "doc_url": "<string>",
    "retry_after": 123
  },
  "success": true,
  "a2ui_errors": [
    {
      "part_index": 123,
      "data_index": 123,
      "a2ui_message": {
        "version": "v0.9.1",
        "error": {
          "code": "VALIDATION_FAILED",
          "surfaceId": "<string>",
          "path": "<string>",
          "message": "<string>"
        }
      }
    }
  ],
  "trace_id": "<string>"
}

{
  "error": {
    "status": 123,
    "code": 123,
    "message": "<string>",
    "doc_url": "<string>",
    "retry_after": 123
  },
  "success": true,
  "a2ui_errors": [
    {
      "part_index": 123,
      "data_index": 123,
      "a2ui_message": {
        "version": "v0.9.1",
        "error": {
          "code": "VALIDATION_FAILED",
          "surfaceId": "<string>",
          "path": "<string>",
          "message": "<string>"
        }
      }
    }
  ],
  "trace_id": "<string>"
}

{
  "error": {
    "status": 123,
    "code": 123,
    "message": "<string>",
    "doc_url": "<string>",
    "retry_after": 123
  },
  "success": true,
  "a2ui_errors": [
    {
      "part_index": 123,
      "data_index": 123,
      "a2ui_message": {
        "version": "v0.9.1",
        "error": {
          "code": "VALIDATION_FAILED",
          "surfaceId": "<string>",
          "path": "<string>",
          "message": "<string>"
        }
      }
    }
  ],
  "trace_id": "<string>"
}

{
  "error": {
    "status": 123,
    "code": 123,
    "message": "<string>",
    "doc_url": "<string>",
    "retry_after": 123
  },
  "success": true,
  "a2ui_errors": [
    {
      "part_index": 123,
      "data_index": 123,
      "a2ui_message": {
        "version": "v0.9.1",
        "error": {
          "code": "VALIDATION_FAILED",
          "surfaceId": "<string>",
          "path": "<string>",
          "message": "<string>"
        }
      }
    }
  ],
  "trace_id": "<string>"
}

{
  "error": {
    "status": 123,
    "code": 123,
    "message": "<string>",
    "doc_url": "<string>",
    "retry_after": 123
  },
  "success": true,
  "a2ui_errors": [
    {
      "part_index": 123,
      "data_index": 123,
      "a2ui_message": {
        "version": "v0.9.1",
        "error": {
          "code": "VALIDATION_FAILED",
          "surfaceId": "<string>",
          "path": "<string>",
          "message": "<string>"
        }
      }
    }
  ],
  "trace_id": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer token authentication. Include your API token in the Authorization header.

Format: Authorization: Bearer <your-token>

Headers

Upgrade

string

required

Allowed value: "websocket"

Path Parameters

callId

string<uuid>

required

Response

WebSocket upgrade accepted. See x-relay-call-room-frames for frame schemas.

Join a call room

curl --request GET \
  --url https://api.relayapp.im/v1/calls/{callId}/room \
  --header 'Authorization: Bearer <token>' \
  --header 'Upgrade: <upgrade>'

{
  "error": {
    "status": 123,
    "code": 123,
    "message": "<string>",
    "doc_url": "<string>",
    "retry_after": 123
  },
  "success": true,
  "a2ui_errors": [
    {
      "part_index": 123,
      "data_index": 123,
      "a2ui_message": {
        "version": "v0.9.1",
        "error": {
          "code": "VALIDATION_FAILED",
          "surfaceId": "<string>",
          "path": "<string>",
          "message": "<string>"
        }
      }
    }
  ],
  "trace_id": "<string>"
}

{
  "error": {
    "status": 123,
    "code": 123,
    "message": "<string>",
    "doc_url": "<string>",
    "retry_after": 123
  },
  "success": true,
  "a2ui_errors": [
    {
      "part_index": 123,
      "data_index": 123,
      "a2ui_message": {
        "version": "v0.9.1",
        "error": {
          "code": "VALIDATION_FAILED",
          "surfaceId": "<string>",
          "path": "<string>",
          "message": "<string>"
        }
      }
    }
  ],
  "trace_id": "<string>"
}

{
  "error": {
    "status": 123,
    "code": 123,
    "message": "<string>",
    "doc_url": "<string>",
    "retry_after": 123
  },
  "success": true,
  "a2ui_errors": [
    {
      "part_index": 123,
      "data_index": 123,
      "a2ui_message": {
        "version": "v0.9.1",
        "error": {
          "code": "VALIDATION_FAILED",
          "surfaceId": "<string>",
          "path": "<string>",
          "message": "<string>"
        }
      }
    }
  ],
  "trace_id": "<string>"
}

{
  "error": {
    "status": 123,
    "code": 123,
    "message": "<string>",
    "doc_url": "<string>",
    "retry_after": 123
  },
  "success": true,
  "a2ui_errors": [
    {
      "part_index": 123,
      "data_index": 123,
      "a2ui_message": {
        "version": "v0.9.1",
        "error": {
          "code": "VALIDATION_FAILED",
          "surfaceId": "<string>",
          "path": "<string>",
          "message": "<string>"
        }
      }
    }
  ],
  "trace_id": "<string>"
}

{
  "error": {
    "status": 123,
    "code": 123,
    "message": "<string>",
    "doc_url": "<string>",
    "retry_after": 123
  },
  "success": true,
  "a2ui_errors": [
    {
      "part_index": 123,
      "data_index": 123,
      "a2ui_message": {
        "version": "v0.9.1",
        "error": {
          "code": "VALIDATION_FAILED",
          "surfaceId": "<string>",
          "path": "<string>",
          "message": "<string>"
        }
      }
    }
  ],
  "trace_id": "<string>"
}

Overview

Chats

Messages

Attachments

Contacts

Webhooks

WebSocket

Agents

Calls

Payments

Tasks

Communities

Join a call room

Authorizations

Headers

Path Parameters

Response