braango_number is the entity that client entity interacts with in real world. Clients TEXT or CALL this number and are connected to personnel within the sub_dealer associated with that number. Based on binding mode, client can be patched to partner’s server first and then partner can bridge the client to sub_dealer
These set of api under Braangonumbers help setup braango_number and manage it
braango_number can be created for any personnel or all personnel within sub_dealer and group within.
/**
*
*/
package com.braango.virtualdealer.braangonumber;
import java.util.List;
import java.util.Map;
import com.braango.client.ApiCallback;
import com.braango.client.ApiClient;
import com.braango.client.ApiException;
import com.braango.client.braangoapi.BraangonumbersApi;
import com.braango.client.braangoapi.EmailsApi;
import com.braango.client.braangoapi.GroupsApi;
import com.braango.client.braangoapi.WebhooksApi;
import com.braango.client.braangomodel.BraangoNumberCreateInput;
import com.braango.client.braangomodel.BraangoNumberCreateInputBody;
import com.braango.client.braangomodel.BraangoNumberInput;
import com.braango.client.braangomodel.BraangoNumberOutput;
import com.braango.client.braangomodel.BraangoNumberOutputBodyData;
import com.braango.client.braangomodel.EmailOutputBodyData;
import com.braango.client.braangomodel.GroupOutput;
import com.braango.client.braangomodel.GroupOutputBodyData;
import com.braango.client.braangomodel.RequestHeader;
import com.braango.client.braangomodel.EmailInput;
import com.braango.client.braangomodel.EmailInputBody;
import com.braango.client.braangomodel.EmailOutput;
import com.braango.client.braangomodel.WebhookOutput;
import com.braango.client.braangomodel.WebhookOutputBodyData;
/**
* @author braango
*
* Sample code showing how to create
* one braango number for subdealer
* for given group
*
*
*/
public class CreateOneBraangoNumber {
static String basePath = "https://testapi2.braango.com/v2/braango";
/**
* @param args
*/
public static void main(String[] args) {
// TODO Auto-generated method stub
ApiClient braangoApiClient = new ApiClient();
// TEST auth token. Please contact
// sales@braango.com to have one
// created for you
String authToken = "ISNWF0P30WM0CMK";
braangoApiClient.setBasePath(basePath);
// Set the auth_token for api client to
// interact with Braango system
braangoApiClient.setApiKey(authToken);
// Api key is authorization to to access
// resources within braango system
//
// This key is different than auth_token
// that is used to validate the master account
String apiKey = "ISNfTMNOumV3xYNDd2g";
// Create webhookApi api.
BraangonumbersApi braangoNumberApi = new BraangonumbersApi(braangoApiClient);
ApiCallback<BraangoNumberOutput> callBack = new ApiCallback<BraangoNumberOutput>() {
@Override
public void onUploadProgress(long bytesWritten,
long contentLength,
boolean done) {
System.out
.println("Place holder for tracking"
+ " request progress");
}
@Override
public void onSuccess(BraangoNumberOutput result, int statusCode,
Map<String, List<String>> responseHeaders) {
BraangoNumberOutputBodyData braangoNumbers = result.getBody()
.getData();
System.out.println("Braango Numbers : " + braangoNumbers.getBraangoNumberList());
}
@Override
public void onFailure(ApiException e, int statusCode,
Map<String, List<String>> responseHeaders) {
System.out.println("Error is " + statusCode + " "
+ e.getResponseBody());
}
@Override
public void onDownloadProgress(long bytesRead, long contentLength,
boolean done) {
}
};
BraangoNumberCreateInput braangoNumberInput = new BraangoNumberCreateInput();
RequestHeader hdr = new RequestHeader();
hdr.setAccountType("partner");
hdr.setApiKey(apiKey);
hdr.setId("create-braango-number");
braangoNumberInput.setHeader(hdr);
BraangoNumberCreateInputBody body = new BraangoNumberCreateInputBody();
// All all the personnel in represented
// by this group for this sub-dealer
body.setAllPersonnel(true);
body.setFakeBraangoNumber(true);
braangoNumberInput.setBody(body);
try {
String subDealerId = "subdealers1002";
// Group for which the braango number is being created
String group = "DEFAULT";
braangoNumberApi.createBraangoNumberAsync(subDealerId, group, braangoNumberInput, callBack);
} catch (ApiException e1) {
e1.printStackTrace();
}
}
}
/**
*
*/
package com.braango.virtualdealer.braangonumber;
import java.util.List;
import java.util.Map;
import com.braango.client.ApiCallback;
import com.braango.client.ApiClient;
import com.braango.client.ApiException;
import com.braango.client.braangoapi.BraangonumbersApi;
import com.braango.client.braangoapi.EmailsApi;
import com.braango.client.braangoapi.GroupsApi;
import com.braango.client.braangoapi.WebhooksApi;
import com.braango.client.braangomodel.BraangoNumberOutput;
import com.braango.client.braangomodel.BraangoNumberOutputBodyData;
import com.braango.client.braangomodel.EmailOutputBodyData;
import com.braango.client.braangomodel.GroupOutput;
import com.braango.client.braangomodel.GroupOutputBodyData;
import com.braango.client.braangomodel.RequestHeader;
import com.braango.client.braangomodel.EmailInput;
import com.braango.client.braangomodel.EmailInputBody;
import com.braango.client.braangomodel.EmailOutput;
import com.braango.client.braangomodel.WebhookOutput;
import com.braango.client.braangomodel.WebhookOutputBodyData;
/**
* @author braango
*
* Sample code showing how to delete one braango
* number for subDealer
*
*
*
*/
public class DeleteOneBraangoNumber {
static String basePath = "https://testapi2.braango.com/v2/braango";
/**
* @param args
*/
public static void main(String[] args) {
// TODO Auto-generated method stub
ApiClient braangoApiClient = new ApiClient();
// TEST auth token. Please contact
// sales@braango.com to have one
// created for you
String authToken = "ISNWF0P30WM0CMK";
braangoApiClient.setBasePath(basePath);
// Set the auth_token for api client to
// interact with Braango system
braangoApiClient.setApiKey(authToken);
// Api key is authorization to to access
// resources within braango system
//
// This key is different than auth_token
// that is used to validate the master account
String apiKey = "ISNfTMNOumV3xYNDd2g";
// Create webhookApi api.
BraangonumbersApi braangoNumberApi = new BraangonumbersApi(braangoApiClient);
final Boolean typeAdfCrmEmail = false;
ApiCallback<Object> callBack = new ApiCallback<Object>() {
@Override
public void onUploadProgress(long bytesWritten,
long contentLength,
boolean done) {
System.out
.println("Place holder for tracking"
+ " request progress");
}
@Override
public void onSuccess(Object result, int statusCode,
Map<String, List<String>> responseHeaders) {
System.out.println("Braango Numbers status code for delete: " + statusCode);
}
@Override
public void onFailure(ApiException e, int statusCode,
Map<String, List<String>> responseHeaders) {
System.out.println("Error is " + statusCode + " "
+ e.getResponseBody());
}
@Override
public void onDownloadProgress(long bytesRead, long contentLength,
boolean done) {
}
};
try {
String subDealerId = "subdealers1002";
String accountType = "partner";
// UUID returned during creation process or braango number itself
String braangoNumberUUID = "37587f2a-93d5-4f56-b3d0-87ab55fae99d"; //
braangoNumberApi.deleteBraangoNumberAsync(subDealerId, braangoNumberUUID, true, apiKey, accountType, callBack);
} catch (ApiException e1) {
e1.printStackTrace();
}
}
}
/**
*
*/
package com.braango.virtualdealer.braangonumber;
import java.util.List;
import java.util.Map;
import com.braango.client.ApiCallback;
import com.braango.client.ApiClient;
import com.braango.client.ApiException;
import com.braango.client.braangoapi.BraangonumbersApi;
import com.braango.client.braangoapi.EmailsApi;
import com.braango.client.braangoapi.GroupsApi;
import com.braango.client.braangoapi.WebhooksApi;
import com.braango.client.braangomodel.BraangoNumberOutput;
import com.braango.client.braangomodel.BraangoNumberOutputBodyData;
import com.braango.client.braangomodel.EmailOutputBodyData;
import com.braango.client.braangomodel.GroupOutput;
import com.braango.client.braangomodel.GroupOutputBodyData;
import com.braango.client.braangomodel.RequestHeader;
import com.braango.client.braangomodel.EmailInput;
import com.braango.client.braangomodel.EmailInputBody;
import com.braango.client.braangomodel.EmailOutput;
import com.braango.client.braangomodel.WebhookOutput;
import com.braango.client.braangomodel.WebhookOutputBodyData;
/**
* @author braango
*
* Sample code showing how to get all braango numbers
* for sub dealer
*
*
*
*/
public class GetBraangoNumbersAll {
static String basePath = "https://testapi2.braango.com/v2/braango";
/**
* @param args
*/
public static void main(String[] args) {
// TODO Auto-generated method stub
ApiClient braangoApiClient = new ApiClient();
// TEST auth token. Please contact
// sales@braango.com to have one
// created for you
String authToken = "ISNWF0P30WM0CMK";
braangoApiClient.setBasePath(basePath);
// Set the auth_token for api client to
// interact with Braango system
braangoApiClient.setApiKey(authToken);
// Api key is authorization to to access
// resources within braango system
//
// This key is different than auth_token
// that is used to validate the master account
String apiKey = "ISNfTMNOumV3xYNDd2g";
// Create webhookApi api.
BraangonumbersApi braangoNumberApi = new BraangonumbersApi(braangoApiClient);
final Boolean typeAdfCrmEmail = false;
ApiCallback<BraangoNumberOutput> callBack = new ApiCallback<BraangoNumberOutput>() {
@Override
public void onUploadProgress(long bytesWritten,
long contentLength,
boolean done) {
System.out
.println("Place holder for tracking"
+ " request progress");
}
@Override
public void onSuccess(BraangoNumberOutput result, int statusCode,
Map<String, List<String>> responseHeaders) {
BraangoNumberOutputBodyData braangoNumbers = result.getBody()
.getData();
System.out.println("Braango Numbers : " + braangoNumbers.getBraangoNumberList());
}
@Override
public void onFailure(ApiException e, int statusCode,
Map<String, List<String>> responseHeaders) {
System.out.println("Error is " + statusCode + " "
+ e.getResponseBody());
}
@Override
public void onDownloadProgress(long bytesRead, long contentLength,
boolean done) {
}
};
try {
String subDealerId = "subdealers1002";
String salesPersonId = "0550c168-6117-45d5-a95f-e66593e6336b";
String accountType = "partner";
braangoNumberApi.getBraangoNumbersAsync(subDealerId, apiKey, accountType, callBack);
} catch (ApiException e1) {
e1.printStackTrace();
}
}
}
/**
*
*/
package com.braango.virtualdealer.braangonumber;
import java.util.List;
import java.util.Map;
import com.braango.client.ApiCallback;
import com.braango.client.ApiClient;
import com.braango.client.ApiException;
import com.braango.client.braangoapi.BraangonumbersApi;
import com.braango.client.braangoapi.EmailsApi;
import com.braango.client.braangoapi.GroupsApi;
import com.braango.client.braangoapi.WebhooksApi;
import com.braango.client.braangomodel.BraangoNumberOutput;
import com.braango.client.braangomodel.BraangoNumberOutputBodyData;
import com.braango.client.braangomodel.EmailOutputBodyData;
import com.braango.client.braangomodel.GroupOutput;
import com.braango.client.braangomodel.GroupOutputBodyData;
import com.braango.client.braangomodel.RequestHeader;
import com.braango.client.braangomodel.EmailInput;
import com.braango.client.braangomodel.EmailInputBody;
import com.braango.client.braangomodel.EmailOutput;
import com.braango.client.braangomodel.WebhookOutput;
import com.braango.client.braangomodel.WebhookOutputBodyData;
/**
* @author braango
*
* Sample code showing how to get one braango
* number for subDealer
*
*
*
*/
public class GetOneBraangoNumber {
static String basePath = "https://testapi2.braango.com/v2/braango";
/**
* @param args
*/
public static void main(String[] args) {
// TODO Auto-generated method stub
ApiClient braangoApiClient = new ApiClient();
// TEST auth token. Please contact
// sales@braango.com to have one
// created for you
String authToken = "ISNWF0P30WM0CMK";
braangoApiClient.setBasePath(basePath);
// Set the auth_token for api client to
// interact with Braango system
braangoApiClient.setApiKey(authToken);
// Api key is authorization to to access
// resources within braango system
//
// This key is different than auth_token
// that is used to validate the master account
String apiKey = "ISNfTMNOumV3xYNDd2g";
// Create webhookApi api.
BraangonumbersApi braangoNumberApi = new BraangonumbersApi(braangoApiClient);
final Boolean typeAdfCrmEmail = false;
ApiCallback<BraangoNumberOutput> callBack = new ApiCallback<BraangoNumberOutput>() {
@Override
public void onUploadProgress(long bytesWritten,
long contentLength,
boolean done) {
System.out
.println("Place holder for tracking"
+ " request progress");
}
@Override
public void onSuccess(BraangoNumberOutput result, int statusCode,
Map<String, List<String>> responseHeaders) {
BraangoNumberOutputBodyData braangoNumbers = result.getBody()
.getData();
System.out.println("Braango Numbers : " + braangoNumbers.getBraangoNumberList());
}
@Override
public void onFailure(ApiException e, int statusCode,
Map<String, List<String>> responseHeaders) {
System.out.println("Error is " + statusCode + " "
+ e.getResponseBody());
}
@Override
public void onDownloadProgress(long bytesRead, long contentLength,
boolean done) {
}
};
try {
String subDealerId = "subdealers1002";
String accountType = "partner";
// UUID returned during creation process or braango number itself
String braangoNumberUUID = "37587f2a-93d5-4f56-b3d0-87ab55fae99d"; //
braangoNumberApi.getBraangoNumberAsync(subDealerId, braangoNumberUUID, apiKey, accountType, callBack);
} catch (ApiException e1) {
e1.printStackTrace();
}
}
}
<?php
use Braango\braangomodel as model;
use Braango\braangomodel\RequestHeader as rhdr;
require_once(__DIR__ . '/../../vendor/autoload.php');
/**
* @author braango
*
* Sample code showing how to create
* one braango number for subdealer
* for given group
*
*
*/
// TEST auth token. Please contact
// sales@braango.com to have one
// created for you
Braango\Configuration::getDefaultConfiguration()->setApiKey('auth_token', 'ISNWF0P30WM0CMK');
$api_instance = new Braango\braangoapi\BraangonumbersApi();
// string | id of _sub_dealer_
$subdealerid = "subdealers2002";
// string | Group for which the braango number is being created
$group = "DEFAULT";
// Braango\braangomodel\BraangoNumberCreateInput |
$braangoNumberCreateInput = new \Braango\braangomodel\BraangoNumberCreateInput();
/*
* { "api_key": "ISNGvAzwuy4X7vAqrtV", "id": "any value",
* "account_type": "partner" }
*/
$hrd = new rhdr();
// dealer_api_key returned
// when partner_dealer was created
$hrd->setApiKey("ISNMdzuNiKG7jhl9d9v");
// Set the account type to partner for
// virtual dealer and partner hosted
// accounts
$hrd->setAccountType("partner");
// ID that will be reflected back
$hrd->setId(" create-braango-number");
$braangoNumberCreateInput->setHeader($hrd);
$braangoNumberCreateInputBody = new model\BraangoNumberCreateInputBody();
// All all the personnel in represented
// by this group for this sub-dealer
$braangoNumberCreateInputBody->setAllPersonnel(TRUE);
$braangoNumberCreateInputBody->setFakeBraangoNumber(TRUE);
$braangoNumberCreateInput->setBody($braangoNumberCreateInputBody);
try {
$result = $api_instance->createBraangoNumber($subdealerid, $group, $braangoNumberCreateInput);
if($result != null) {
// Extract out response hdr and bdy
$rspHdr = $result->getHeader();
if($requestHdr =! null)
{
$rspId = $rspHdr->getId();
$braangoRequestId = $rspHdr->getIsnRequestId();
print_r("Response ID = " . $rspId . ", API Request Id = " . $braangoRequestId . "\n");
}
$rspBdy = $result->getBody();
if($rspBdy != null) {
$status = $rspBdy->getStatus();
// Typically this value should be always SUCCESS else exception will be thrown
// Sometimes, this can be WARNING to indicate if any resource conflicted or not
// In case of SUCCESS or WARNING, resources are always created (excepting warned sub-resources)
print_r("Status = " . $status . "\n");
$braangoNumberOutputBodyData = $rspBdy->getData();
print "Braango Numbers: ";
print_r($braangoNumberOutputBodyData->getBraangoNumberList());
}
}
} catch (Exception $e) {
echo 'Exception when calling BraangonumbersApi->createBraangoNumber: ', $e->getMessage(), PHP_EOL;
}
?>
<?php
require_once (__DIR__ . '/../../vendor/autoload.php');
/**
*
* @author braango
*
* Sample code showing how to delete one braango
* number for subDealer
*
*
*
*/
// TEST auth token. Please contact
// sales@braango.com to have one
// created for you
Braango\Configuration::getDefaultConfiguration()->setApiKey('auth_token', 'ISNWF0P30WM0CMK');
$api_instance = new Braango\braangoapi\BraangonumbersApi();
// string | id of _sub_dealer_
$subdealerid = "subdealers2002";
// string value
$braangonumberOrUuid = "329525fa-bf26-4117-9547-228e70231ced";
// bool value
$fakeBraangoNumber = true;
// string | API Key to access this dealer's resources.
// Value was returned when create_account api
// was called and dealer was created first time
$apiKey = "ISNMdzuNiKG7jhl9d9v";
// string | Dealer or partner is accessing this API
$accountType = "partner";
try {
$result = $api_instance->deleteBraangoNumber($subdealerid, $braangonumberOrUuid, $fakeBraangoNumber, $apiKey, $accountType);
if ($result != null) {
$status = $rspBdy->getStatus();
// Extract out response hdr and bdy
$rspHdr = $result->getHeader();
if ($requestHdr = ! null) {
$rspId = $rspHdr->getId();
$braangoRequestId = $rspHdr->getIsnRequestId();
print_r("Response ID = " . $rspId . ", API Request Id = " . $braangoRequestId . "\n");
}
$rspBdy = $result->getBody();
if ($rspBdy != null) {
$status = $rspBdy->getStatus();
// Typically this value should be always SUCCESS else exception will be thrown
// Sometimes, this can be WARNING to indicate if any resource conflicted or not
// In case of SUCCESS or WARNING, resources are always created (excepting warned sub-resources)
print_r("Status = " . $status . "\n");
$braangoNumberOutputBodyData = $rspBdy->getData();
print "Braango Numbers: ";
print_r($braangoNumberOutputBodyData->getBraangoNumberList());
}
}
} catch (Exception $e) {
echo 'Exception when calling BraangonumbersApi->deleteBraangoNumber: ', $e->getMessage(), PHP_EOL;
}
?>
<?php
require_once (__DIR__ . '/../../vendor/autoload.php');
/**
*
* @author braango
*
* Sample code showing how to get all braango
* numbers for subDealer
*
*
*
*/
// TEST auth token. Please contact
// sales@braango.com to have one
// created for you
Braango\Configuration::getDefaultConfiguration()->setApiKey('auth_token', 'ISNWF0P30WM0CMK');
$api_instance = new Braango\braangoapi\BraangonumbersApi();
// string | id of _sub_dealer_
$subdealerid = "subdealers2002";
// string | API Key to access this dealer's resources.
// Value was returned when create_account api
// was called and dealer was created first time
$apiKey = "ISNMdzuNiKG7jhl9d9v";
// string | Dealer or partner is accessing this API
$accountType = "partner";
try {
$result = $api_instance->getBraangoNumbers($subdealerid, $apiKey, $accountType);
if ($result != null) {
// Extract out response hdr and bdy
$rspHdr = $result->getHeader();
if ($requestHdr = ! null) {
$rspId = $rspHdr->getId();
$braangoRequestId = $rspHdr->getIsnRequestId();
print_r("Response ID = " . $rspId . ", API Request Id = " . $braangoRequestId . "\n");
}
$rspBdy = $result->getBody();
if ($rspBdy != null) {
$status = $rspBdy->getStatus();
// Typically this value should be always SUCCESS else exception will be thrown
// Sometimes, this can be WARNING to indicate if any resource conflicted or not
// In case of SUCCESS or WARNING, resources are always created (excepting warned sub-resources)
print_r("Status = " . $status . "\n");
$braangoNumberOutputBodyData = $rspBdy->getData();
print "Braango Numbers: ";
print_r($braangoNumberOutputBodyData->getBraangoNumberList());
}
}
} catch (Exception $e) {
echo 'Exception when calling BraangonumbersApi->getBraangoNumbers: ', $e->getMessage(), PHP_EOL;
}
?>
<?php
require_once (__DIR__ . '/../../vendor/autoload.php');
/**
*
* @author braango
*
* Sample code showing how to get one braango number
* for sub dealer
*
*
*
*/
// TEST auth token. Please contact
// sales@braango.com to have one
// created for you
Braango\Configuration::getDefaultConfiguration()->setApiKey('auth_token', 'ISNWF0P30WM0CMK');
$api_instance = new Braango\braangoapi\BraangonumbersApi();
// string | id of _sub_dealer_
$subdealerid = "subdealers2002";
// string |
$braangonumberOrUuid = "329525fa-bf26-4117-9547-228e70231ced";
// string | API Key to access this dealer's resources.
// Value was returned when create_account api
// was called and dealer was created first time
$apiKey = "ISNMdzuNiKG7jhl9d9v";
// string | Dealer or partner is accessing this API
$accountType = "partner";
try {
$result = $api_instance->getBraangoNumber($subdealerid, $braangonumberOrUuid, $apiKey, $accountType);
if ($result != null) {
// Extract out response hdr and bdy
$rspHdr = $result->getHeader();
if ($requestHdr = ! null) {
$rspId = $rspHdr->getId();
$braangoRequestId = $rspHdr->getIsnRequestId();
print_r("Response ID = " . $rspId . ", API Request Id = " . $braangoRequestId . "\n");
}
$rspBdy = $result->getBody();
if ($rspBdy != null) {
$status = $rspBdy->getStatus();
// Typically this value should be always SUCCESS else exception will be thrown
// Sometimes, this can be WARNING to indicate if any resource conflicted or not
// In case of SUCCESS or WARNING, resources are always created (excepting warned sub-resources)
print_r("Status = " . $status . "\n");
$braangoNumberOutputBodyData = $rspBdy->getData();
print "Braango Numbers: ";
print_r($braangoNumberOutputBodyData->getBraangoNumberList());
}
}
} catch (Exception $e) {
echo 'Exception when calling BraangonumbersApi->getBraangoNumber: ', $e->getMessage(), PHP_EOL;
}
?>