Online Documentation

Call Provider Is Online Request


The call provider will use the Is Online message to determine if the service provider is online in the dispatch software. When the service provider is online in the dispatch software, the online element in the response will be set to true.

Base URL: https://service.BGsync.com/BGsyncapi/api/request/isOnline 
Method: Http Post
Content-Type: application/json
Parameter Required Default Description
call_provider_BGsync_id Yes   Call Provider sureEcosystem Id
service_provider_BGsync_id Yes   Service Provider sureEcosystem Id
api_key Yes   Call Provider API Key

Sample Request

{
"call_provider_BGsync_id":"1",
"api_key":"ABC1234",
"service_provider_BGsync_id":"1"
}

Sample Response from sureEcosystem

{
"success":true,
"error_message":null,
"call_provider_BGsync_id":"1",
"api_key":"ABC1234",
"service_provider_BGsync_id":"1",
"online":true
}