Skip to content
Beeper Developer Docs
Download Beeper
API Reference

Bridges

Manage available bridges, connect or reconnect chat accounts

List available bridges
$client->bridges->list(): BridgeListResponse
GET/v1/bridges
Get bridge
$client->bridges->retrieve(string bridgeID): BridgeGetResponse
GET/v1/bridges/{bridgeID}
Get bridge capabilities
$client->bridges->retrieveCapabilities(string bridgeID): ProvisioningCapabilities
GET/v1/bridges/{bridgeID}/capabilities
ModelsExpand Collapse
string id

Bridge ID. Use with bridge endpoints.

list<Account> accounts

Connected accounts for this bridge. Uses the same Account schema as GET /v1/accounts.

int activeAccountCount

Number of active accounts for this network on this device.

string displayName

Human-friendly bridge name shown in Beeper.

Provider provider

Where accounts for this bridge run: on this device or in Beeper Cloud.

Status status

Whether this bridge can currently be used to connect new accounts.

bool supportsMultipleAccounts

Whether this bridge can have multiple active accounts for the same network.

string type

Underlying bridge type, such as matrix, discordgo, slackgo, whatsapp, telegram, or twitter.

?string network

Network grouping used for account counts and limits.

?string statusText

Human-friendly status text matching Beeper account management language.

string bridgeID

Bridge ID.

string loginID

Bridge login ID.

list<RemoveScope> removeScopes
Status status
?list<string> accountIDs

Chat accounts that belong to this bridge login, when known.

?string statusText

Human-friendly bridge login status text.

?User user

User the account belongs to.

list<Type> types
?true omitEmptyTimer
?list<int> timers
bool allowed
?int maxLength
?int minLength
?bool required
?DisappearingTimerCapability settings

Disappearing-message timer capability.

string typeDescription
?GroupFieldCapability avatar

Group creation field capability.

?GroupFieldCapability disappear

Group creation field capability.

?GroupFieldCapability name

Group creation field capability.

?GroupFieldCapability parent

Group creation field capability.

?GroupFieldCapability participants

Group creation field capability.

?GroupFieldCapability topic

Group creation field capability.

?GroupFieldCapability username

Group creation field capability.

string id

Flow ID to pass when creating a bridge login session.

?string description

Short explanation for when to use this flow, when provided.

?string name

Display name for the flow, when provided.

string id

Field ID to send back in the fields object.

?string initialValue

Initial field value, when provided by the network.

?string label

Field label to show to the user.

?bool optional

True if the user can leave this field empty.

?string placeholder

Placeholder text to show when the field is empty.

?string type

Suggested input type, such as text, password, or email.

string bridgeID

Bridge ID.

string loginSessionID

Temporary bridge login session ID.

Status status
?Account account

A chat account added to Beeper.

?string accountID

Chat account ID for reconnect flows, when known.

?CurrentStep currentStep

Step the client should show or complete next. Omitted when the session is complete, cancelled, or failed.

?APIError error
?BridgeLogin login

Signed-in identity for a bridge. One bridge login can contain multiple chat accounts.

?string loginID

Bridge login ID for reconnect flows, when known.

array<string,GroupTypeCapabilities> groupCreation
ResolveIdentifierCapabilities resolveIdentifier

Identifier lookup capabilities for this bridge.

?bool imagePackImport
bool anyPhone
bool contactList
bool createDM
bool lookupEmail
bool lookupPhone
bool lookupUsername

BridgesLogin Flows

Available bridges, bridge logins, login sessions for connect and reconnect flows, and advanced network capabilities.

List login flows
$client->bridges->loginFlows->list(string bridgeID): LoginFlowListResponse
GET/v1/bridges/{bridgeID}/login-flows

BridgesLogins

Available bridges, bridge logins, login sessions for connect and reconnect flows, and advanced network capabilities.

List bridge logins
$client->bridges->logins->list(string bridgeID): LoginListResponse
GET/v1/bridges/{bridgeID}/logins
Get bridge login
$client->bridges->logins->retrieve(string loginID, string bridgeID): BridgeLogin
GET/v1/bridges/{bridgeID}/logins/{loginID}
Remove bridge login
$client->bridges->logins->remove(string loginID, string bridgeID, Scope scope): LoginRemoveResponse
POST/v1/bridges/{bridgeID}/logins/{loginID}/remove

BridgesLogin Sessions

Available bridges, bridge logins, login sessions for connect and reconnect flows, and advanced network capabilities.

Create bridge login session
$client->bridges->loginSessions->create(string bridgeID, ?string accountID, ?string flowID, ?string loginID): LoginSession
POST/v1/bridges/{bridgeID}/login-sessions
Get bridge login session
$client->bridges->loginSessions->retrieve(string loginSessionID, string bridgeID): LoginSession
GET/v1/bridges/{bridgeID}/login-sessions/{loginSessionID}
Cancel bridge login session
$client->bridges->loginSessions->cancel(string loginSessionID, string bridgeID): LoginSessionCancelResponse
DELETE/v1/bridges/{bridgeID}/login-sessions/{loginSessionID}

BridgesLogin SessionsSteps

Available bridges, bridge logins, login sessions for connect and reconnect flows, and advanced network capabilities.

Submit login step
$client->bridges->loginSessions->steps->submit(string stepID, string bridgeID, string loginSessionID, Type type, ?array<string,string> fields, ?string lastURL, ?Source source): LoginSession
POST/v1/bridges/{bridgeID}/login-sessions/{loginSessionID}/steps/{stepID}