An allocation request maps a set of numbers (a-party) to another set of numbers (b-party) using a Variable Virtual Number or a GreenVN. Both parties can optionally have pins (any integer number, preferably limited to 6 digits) associated with the allocation to enable new callers (whose numbers were not passed in the allocation request) to join either party at any time by entering the pin when calling for the first time on the VN since it was allocated. If the ‘usage’ parameter is set to ‘oneway’ in the request, only the a-party may call the b-party. For ‘twoway’ usage, both parties can call each other using the GreenVN.
https://leadassist.exotel.in/v1/tenants/<your_sid>/greenvn
Replace <your_sid> with your tenant ID The following are the POST parameters:
| Parameter Name | Mandatory/Optional | Value / Description |
| connection_id | mandatory | Unique identifier for the specific mapping. This can be any random string. |
| aparty_numbers | mandatory | List of numbers in E164 format for one side of the allocation. In the event that the allocation is oneway, only these numbers will be able to connect to the other party. |
| bparty_numbers | mandatory | List of numbers in E164 format for the other side of the allocation. In the event that the allocation is two-way, these numbers can connect to the a_party using the greenvn. |
| aparty_pins | optional | List of pins to be used for unregistered aparty_caller. This can be any positive integer. We recommend using 4 digit UNIQUE pins |
| bparty_pins | optional |
List of pins to be used for unregistered bparty_caller.This can be any positive integer. We recommend using 4 digit UNIQUE pins |
| usage | mandatory |
“oneway” allocations only permit a-party callers to talk to the b-party. “twoway” allocations permit both sides to call the other. |
| strictness | optional |
If strictness is true, the allocation only performed if all specified conditions are met. This includes the preferred greenvn, region, and number type. If strictness is off, a number is returned which satisfies most maximum possible preferences. The default value is false. |
| preferences | optional |
preferences are a set of preferred options that the returned greenvn should satisfy.
These can be satisfied based on the available greenvn’s in the account |
| deallocation_policy (optional) |
optional |
This parameter is used to schedule an automatic deallocation. If not set, default deallocation period (as in configuration) is used
|
| flow_id |
optional* |
A unique identifier of the call flow, which is required to be associated with the VN, at the time of allocation. *It is required in the allocation request, if there are multiple call flows created at the account level and the expectation is to associate a particular call flow to the allocated VN. |
curl -X POST \
https://leadassist.exotel.in/v1/tenants/<your_sid>/greenvn \
-H 'Authorization: Basic <your Auth string which is Base64 encoded version of “username:Password” string>' \
-H 'Content-Type: application/json' \
-H 'cache-control: no-cache' \
-d '{
"connection_id": "Sample_Connection",
"aparty_numbers": [
"+91917XXX6528"
],
"bparty_numbers": [
"+9181XXXX6620"
],
"aparty_pins": [
1234
],
"bparty_pins": [
2345
],
"strictness": "false",
"preferences": {
"pin_code": "560041"
},
"usage": "twoway",
"flow_id": "44XX8X",
"deallocation_policy": {
"duration": "600s"
}
}'
var request = require("request");
var userName = "XXXXXXXXX";
var password = "YYYYYYYYY";
var accountSID = “ZZZZZZZZZ”;
var encoding = Buffer.from(userName + ':' + password).toString('base64');
var options = { method: 'POST' ,
url: 'https://leadassist.exotel.in/v1/tenants/'+ accountSid + '/greenvn’ ,
headers:
{
Authorization: 'Basic ' + encoding ,
'Content-Type': 'application/json' ,
‘cache-control’: ‘no-cache’
},
body:
{
"connection_id": "Sample_Connection",
"aparty_numbers": [
"+91917XXX6528"
],
"bparty_numbers": [
"+9181XXXX6620"
],
"aparty_pins": [
1234
],
"bparty_pins": [
2345
],
"strictness": "false",
"preferences": {
"pin_code": "560041"
},
"usage": "twoway",
"flow_id": "9867XX",
"deallocation_policy": {
"duration": "600s"
}
},
json: true
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body.error_data);
console.log(body);
});
<?php
$curl = curl_init();
$accountSid = "XXXXXXXXXX";
$userName = "YYYYYYYYYY";
$password = “ZZZZZZZZZZ”;
$encoding = base64_encode($userName.":". $password);
curl_setopt_array($curl, array(
CURLOPT_URL => "https://leadassist.exotel.in/v1/tenants/" . $accountSid . "/greenvn" ,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => '{
"connection_id": "Sample_Connection",
"aparty_numbers": [
"+91917XXX6528"
],
"bparty_numbers": [
"+9181XXXX6620"
],
"aparty_pins": [
1234
],
"bparty_pins": [
2345
],
"strictness": "false",
"preferences": {
"pin_code": "560041"
},
"usage": "twoway",
"flow_id": "989XXX",
"deallocation_policy": {
"duration": "600s"
}
}',
CURLOPT_HTTPHEADER => array(
"Authorization: Basic ".$encoding ,
"Content-Type: application/json"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
import requests, base64, json
accountSid = "XXXXXXXXX"
userName = "YYYYYYYYY"
Password = “ZZZZZZZZZ”
encoding = base64.b64encode(userName + ":" + password)
url = "https://leadassist.exotel.in/v1/tenants/"+accountSid+"/greenvn"
payload = json.dumps({
"connection_id": "Sample_Connection",
"aparty_numbers": [
"+91917XXX6528"
],
"bparty_numbers": [
"+9181XXXX6620"
],
"aparty_pins": [
1234
],
"bparty_pins": [
2345
],
"strictness": "false",
"preferences": {
"pin_code": "560041"
},
"usage": "twoway",
"flow_id": "67676X",
"deallocation_policy": {
"duration": "600s"
}
})
headers = {
'Content-Type': "application/json",
'Authorization': "Basic " + encoding
}
response = requests.request("POST", url, data=payload, headers=headers)
print(response.text)
print(json.dumps(json.loads(response.text), indent = 4, sort_keys = True))
package main
import (
b64 "encoding/base64"
"fmt"
"io/ioutil"
"net/http"
"strings"
)
func main() {
accountSid := "XXXXXXXXX"
userName := "YYYYYYYY"
password := “ZZZZZZZZ”
// Encoding the userName and password to use in Authorization header
encoding := b64.StdEncoding.EncodeToString([]byte(userName + ":" + password))
url := "https://leadassist.exotel.in/v1/tenants/" + accountSid + "/greenvn"
payload := strings.NewReader(`{
"connection_id": "Sample_Connection",
"aparty_numbers": [
"+91917XXX6528"
],
"bparty_numbers": [
"+9181XXXX6620"
],
"aparty_pins": [
1234
],
"bparty_pins": [
2345
],
"strictness": "false",
"preferences": {
"pin_code": "560041"
},
"usage": "twoway",
"flow_id": "65456X",
"deallocation_policy": {
"duration": "600s"
}
}`)
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Authorization", "Basic "+encoding)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
HTTP Response:
{
"success": true,
"status": 200,
"code": null,
"message": null,
"data": {
"bparty_numbers": [
"+9181XXXX6620"
],
"connection_id": "Sample_Connection",
"greenvn": "+914048212136",
"state": "active",
"greenvn_id": "xysysue7-4c2c-b671 d1156d0faf5f",
"aparty_pins": [
1234
],
"usage": "twoway",
"bparty_pins": [
2345
],
"aparty_numbers": [
"+91917XXX6528"
]
}
}
{
"success": false,
"status": 409,
"code": 18,
"message": "Allocation exists for this connection id.",
"data": null
}
Description of parameters mentioned in the above response:
| Parameter Name | Type & Value |
| success | true or false. This shows whether the request succeeded or not. |
| status |
HTTP response code of your request 200: Successfully allocated 400: Bad Request (for example when deallocation request is sent after deallocation has already happened) 402: Unauthorized Request 429: Throttle limit exceeded 499: Response timeout exceeded |
| data |
JSON array representing the response and contains the below parameters
|
| code |
number: This parameter only comes in case of an error where the status returned in non-200. The list of possible error codes are as below:
0: Internal Service Error 9: Unsupported denied |
| state |
This is the current state of the allocation which can have the following values
|
