Route Agent
curl --request POST \
--url https://api.example.com/v1/routing/route-agent \
--header 'Content-Type: application/json' \
--data '
{
"source": "<string>",
"source_id": "<string>",
"reason": "<string>",
"routing_policy": "<string>",
"routable_entities": [
{
"id": "<string>",
"name": "<string>"
}
],
"metadata": {}
}
'import requests
url = "https://api.example.com/v1/routing/route-agent"
payload = {
"source": "<string>",
"source_id": "<string>",
"reason": "<string>",
"routing_policy": "<string>",
"routable_entities": [
{
"id": "<string>",
"name": "<string>"
}
],
"metadata": {}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
source: '<string>',
source_id: '<string>',
reason: '<string>',
routing_policy: '<string>',
routable_entities: [{id: '<string>', name: '<string>'}],
metadata: {}
})
};
fetch('https://api.example.com/v1/routing/route-agent', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/routing/route-agent",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'source' => '<string>',
'source_id' => '<string>',
'reason' => '<string>',
'routing_policy' => '<string>',
'routable_entities' => [
[
'id' => '<string>',
'name' => '<string>'
]
],
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/routing/route-agent"
payload := strings.NewReader("{\n \"source\": \"<string>\",\n \"source_id\": \"<string>\",\n \"reason\": \"<string>\",\n \"routing_policy\": \"<string>\",\n \"routable_entities\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/routing/route-agent")
.header("Content-Type", "application/json")
.body("{\n \"source\": \"<string>\",\n \"source_id\": \"<string>\",\n \"reason\": \"<string>\",\n \"routing_policy\": \"<string>\",\n \"routable_entities\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/routing/route-agent")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"source\": \"<string>\",\n \"source_id\": \"<string>\",\n \"reason\": \"<string>\",\n \"routing_policy\": \"<string>\",\n \"routable_entities\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"routed_agents": [
{
"name": "<string>",
"email": "<string>",
"phone": "<string>"
}
],
"status": "<string>"
}{
"code": 123,
"message": "<string>",
"details": [
{
"@type": "<string>"
}
]
}RoutingService
Route Agent
Route Agent
curl --request POST \
--url https://api.example.com/v1/routing/route-agent \
--header 'Content-Type: application/json' \
--data '
{
"source": "<string>",
"source_id": "<string>",
"reason": "<string>",
"routing_policy": "<string>",
"routable_entities": [
{
"id": "<string>",
"name": "<string>"
}
],
"metadata": {}
}
'import requests
url = "https://api.example.com/v1/routing/route-agent"
payload = {
"source": "<string>",
"source_id": "<string>",
"reason": "<string>",
"routing_policy": "<string>",
"routable_entities": [
{
"id": "<string>",
"name": "<string>"
}
],
"metadata": {}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
source: '<string>',
source_id: '<string>',
reason: '<string>',
routing_policy: '<string>',
routable_entities: [{id: '<string>', name: '<string>'}],
metadata: {}
})
};
fetch('https://api.example.com/v1/routing/route-agent', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/routing/route-agent",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'source' => '<string>',
'source_id' => '<string>',
'reason' => '<string>',
'routing_policy' => '<string>',
'routable_entities' => [
[
'id' => '<string>',
'name' => '<string>'
]
],
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/routing/route-agent"
payload := strings.NewReader("{\n \"source\": \"<string>\",\n \"source_id\": \"<string>\",\n \"reason\": \"<string>\",\n \"routing_policy\": \"<string>\",\n \"routable_entities\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v1/routing/route-agent")
.header("Content-Type", "application/json")
.body("{\n \"source\": \"<string>\",\n \"source_id\": \"<string>\",\n \"reason\": \"<string>\",\n \"routing_policy\": \"<string>\",\n \"routable_entities\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/routing/route-agent")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"source\": \"<string>\",\n \"source_id\": \"<string>\",\n \"reason\": \"<string>\",\n \"routing_policy\": \"<string>\",\n \"routable_entities\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"routed_agents": [
{
"name": "<string>",
"email": "<string>",
"phone": "<string>"
}
],
"status": "<string>"
}{
"code": 123,
"message": "<string>",
"details": [
{
"@type": "<string>"
}
]
}Body
application/json
System or integration that initiated the routing request. E.g: "chat", "inbound_phone", or "email".
Source-system identifier for the entity being routed. Typically the "Dialogue" integer ID.
Human-readable reason or context for routing.
The strategy to do routing with.
A list of all routable entities.
Additional routing context for provider-specific decisions.
Response
OK
The status of the route. Can be useful for communicating queued, etc statuses.
⌘I

