Bitrix API

Config

Table of Contents

Constants

CLOUD_SERVER_VERSION  = 4
DEFAULT_SERVER  = "https://rtc-cloud.bitrix.info"
HOSTNAME_URL  = "/hostname"
IS_REGISTERED_ON_SHARED_SERVER  = 'registered_on_shared_server'
PUB_URL  = "/pub/"
REGISTER_URL  = "/register-client/"
REST_URL  = "/rest/"
RPC_URL  = "/api/"
SERVER_ADDRESS  = 'shared_server_address'
SERVER_LIST_URL  = "/servers"
SHARED_SERVER_KEY  = 'shared_server_key'
SUB_URL  = "/subws/"

Methods

getDefaultCloudServer()  : string
getJsonRpcUrl()  : string
Returns url for Json RPC.
getLongPollingUrl()  : string
Returns url for receiving events with long polling transport.
getPublishUrl()  : string
Returns url for publishing events.
getRegisterUrl()  : mixed
getServerAddress()  : mixed
getServerVersion()  : mixed
getSignatureKey()  : mixed
getWebPublishUrl()  : mixed
getWebSocketUrl()  : string
Returns url for receiving events with websocket transport.
isRegistered()  : mixed
setRegistered()  : mixed
setServerAddress()  : mixed
setSignatureKey()  : mixed

Constants

CLOUD_SERVER_VERSION

public mixed CLOUD_SERVER_VERSION = 4

DEFAULT_SERVER

public mixed DEFAULT_SERVER = "https://rtc-cloud.bitrix.info"

HOSTNAME_URL

public mixed HOSTNAME_URL = "/hostname"

IS_REGISTERED_ON_SHARED_SERVER

public mixed IS_REGISTERED_ON_SHARED_SERVER = 'registered_on_shared_server'

PUB_URL

public mixed PUB_URL = "/pub/"

REGISTER_URL

public mixed REGISTER_URL = "/register-client/"

REST_URL

public mixed REST_URL = "/rest/"

RPC_URL

public mixed RPC_URL = "/api/"

SERVER_ADDRESS

public mixed SERVER_ADDRESS = 'shared_server_address'

SERVER_LIST_URL

public mixed SERVER_LIST_URL = "/servers"

SHARED_SERVER_KEY

public mixed SHARED_SERVER_KEY = 'shared_server_key'

SUB_URL

public mixed SUB_URL = "/subws/"

Methods

getDefaultCloudServer()

public static getDefaultCloudServer() : string
Return values
string

getJsonRpcUrl()

Returns url for Json RPC.

public static getJsonRpcUrl() : string
Return values
string

getLongPollingUrl()

Returns url for receiving events with long polling transport.

public static getLongPollingUrl() : string
Return values
string

getPublishUrl()

Returns url for publishing events.

public static getPublishUrl() : string
Return values
string

getRegisterUrl()

public static getRegisterUrl() : mixed

getServerAddress()

public static getServerAddress() : mixed

getServerVersion()

public static getServerVersion() : mixed

getSignatureKey()

public static getSignatureKey() : mixed

getWebPublishUrl()

public static getWebPublishUrl() : mixed

getWebSocketUrl()

Returns url for receiving events with websocket transport.

public static getWebSocketUrl() : string
Return values
string

isRegistered()

public static isRegistered() : mixed

setRegistered()

public static setRegistered(mixed $isRegistered) : mixed
Parameters
$isRegistered : mixed

setServerAddress()

public static setServerAddress(mixed $serverAddress) : mixed
Parameters
$serverAddress : mixed

setSignatureKey()

public static setSignatureKey(mixed $signatureKey) : mixed
Parameters
$signatureKey : mixed

        
On this page

Search results