Skip to content
Download Beeper

List available bridges

$client->bridges->list(): BridgeListResponse
GET/v1/bridges

List available bridges. A bridge is a chat-network connector that can connect or reconnect chat accounts. Connected accounts use the same Account schema as GET /v1/accounts.

ReturnsExpand Collapse

List available bridges

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

$client = new Client(accessToken: 'My Access Token');

$bridges = $client->bridges->list();

var_dump($bridges);
{
  "items": [
    {
      "id": "id",
      "accounts": [
        {
          "accountID": "accountID",
          "bridge": {
            "id": "id",
            "provider": "cloud",
            "type": "type"
          },
          "status": "connected",
          "user": {
            "id": "id",
            "cannotMessage": true,
            "email": "email",
            "fullName": "fullName",
            "imgURL": "imgURL",
            "isSelf": true,
            "phoneNumber": "phoneNumber",
            "username": "username"
          },
          "capabilities": {
            "allowed_reactions": [
              "string"
            ],
            "archive": true,
            "custom_emoji_reactions": true,
            "delete": -2,
            "delete_chat": true,
            "delete_chat_for_everyone": true,
            "delete_for_me": true,
            "delete_max_age": 0,
            "disappearing_timer": {
              "omit_empty_timer": true,
              "timers": [
                0
              ],
              "types": [
                "after_read"
              ]
            },
            "edit": -2,
            "edit_max_age": 0,
            "edit_max_count": 0,
            "file": {
              "foo": {
                "mime_types": {
                  "foo": -2
                },
                "caption": -2,
                "max_caption_length": 0,
                "max_duration": 0,
                "max_height": 0,
                "max_size": 0,
                "max_width": 0,
                "view_once": true
              }
            },
            "formatting": {
              "foo": -2
            },
            "location_message": -2,
            "mark_as_unread": true,
            "max_text_length": 0,
            "member_actions": {
              "ban": -2,
              "invite": -2,
              "kick": -2,
              "leave": -2,
              "revoke_invite": -2
            },
            "message_request": {
              "accept_with_button": -2,
              "accept_with_message": -2
            },
            "poll": -2,
            "reaction": -2,
            "reaction_count": 0,
            "read_receipts": true,
            "reply": -2,
            "state": {
              "com.beeper.disappearing_timer": {
                "level": -2
              },
              "m.room.avatar": {
                "level": -2
              },
              "m.room.name": {
                "level": -2
              },
              "m.room.topic": {
                "level": -2
              }
            },
            "thread": -2,
            "typing_notifications": true
          },
          "loginID": "loginID",
          "network": "network",
          "statusText": "statusText"
        }
      ],
      "activeAccountCount": 0,
      "displayName": "displayName",
      "provider": "cloud",
      "status": "available",
      "supportsMultipleAccounts": true,
      "type": "type",
      "network": "network",
      "statusText": "statusText"
    }
  ]
}
Returns Examples
{
  "items": [
    {
      "id": "id",
      "accounts": [
        {
          "accountID": "accountID",
          "bridge": {
            "id": "id",
            "provider": "cloud",
            "type": "type"
          },
          "status": "connected",
          "user": {
            "id": "id",
            "cannotMessage": true,
            "email": "email",
            "fullName": "fullName",
            "imgURL": "imgURL",
            "isSelf": true,
            "phoneNumber": "phoneNumber",
            "username": "username"
          },
          "capabilities": {
            "allowed_reactions": [
              "string"
            ],
            "archive": true,
            "custom_emoji_reactions": true,
            "delete": -2,
            "delete_chat": true,
            "delete_chat_for_everyone": true,
            "delete_for_me": true,
            "delete_max_age": 0,
            "disappearing_timer": {
              "omit_empty_timer": true,
              "timers": [
                0
              ],
              "types": [
                "after_read"
              ]
            },
            "edit": -2,
            "edit_max_age": 0,
            "edit_max_count": 0,
            "file": {
              "foo": {
                "mime_types": {
                  "foo": -2
                },
                "caption": -2,
                "max_caption_length": 0,
                "max_duration": 0,
                "max_height": 0,
                "max_size": 0,
                "max_width": 0,
                "view_once": true
              }
            },
            "formatting": {
              "foo": -2
            },
            "location_message": -2,
            "mark_as_unread": true,
            "max_text_length": 0,
            "member_actions": {
              "ban": -2,
              "invite": -2,
              "kick": -2,
              "leave": -2,
              "revoke_invite": -2
            },
            "message_request": {
              "accept_with_button": -2,
              "accept_with_message": -2
            },
            "poll": -2,
            "reaction": -2,
            "reaction_count": 0,
            "read_receipts": true,
            "reply": -2,
            "state": {
              "com.beeper.disappearing_timer": {
                "level": -2
              },
              "m.room.avatar": {
                "level": -2
              },
              "m.room.name": {
                "level": -2
              },
              "m.room.topic": {
                "level": -2
              }
            },
            "thread": -2,
            "typing_notifications": true
          },
          "loginID": "loginID",
          "network": "network",
          "statusText": "statusText"
        }
      ],
      "activeAccountCount": 0,
      "displayName": "displayName",
      "provider": "cloud",
      "status": "available",
      "supportsMultipleAccounts": true,
      "type": "type",
      "network": "network",
      "statusText": "statusText"
    }
  ]
}