Add an agent metadata
curl --request POST \
--url https://api.sandbox.asapp.com/metadata-ingestion/v1/single-agent-metadata \
--header 'Content-Type: application/json' \
--header 'asapp-api-id: <api-key>' \
--header 'asapp-api-secret: <api-key>' \
--data '
{
"externalAgentId": "agent158",
"startTs": "2022-07-08T11:15:53.237517000Z",
"lobId": "1038",
"lobName": "manufacturing",
"groupId": "group5",
"groupName": "XYZ",
"agentName": "Jane Doe",
"agentLocation": "Northern-California",
"supervisorId": "3080",
"supervisorName": "Linda Lemon",
"languages": [
"en-us",
"zh-hans-hk"
],
"concurrency": 3,
"categoryLabel": "Tier-2-Escalation",
"accountAccessLevel": "High-Profile",
"ranking": 78,
"vendor": "Contracting",
"jobTitle": "Booking-Manager",
"jobRole": "booking",
"workShift": "afternoon",
"emailAddress": "jdoe@example.com",
"attributes": [
{
"name": "attr1_name",
"value": "attr1_value"
},
{
"name": "attr2_name",
"value": "attr2_value"
}
]
}
'import requests
url = "https://api.sandbox.asapp.com/metadata-ingestion/v1/single-agent-metadata"
payload = {
"externalAgentId": "agent158",
"startTs": "2022-07-08T11:15:53.237517000Z",
"lobId": "1038",
"lobName": "manufacturing",
"groupId": "group5",
"groupName": "XYZ",
"agentName": "Jane Doe",
"agentLocation": "Northern-California",
"supervisorId": "3080",
"supervisorName": "Linda Lemon",
"languages": ["en-us", "zh-hans-hk"],
"concurrency": 3,
"categoryLabel": "Tier-2-Escalation",
"accountAccessLevel": "High-Profile",
"ranking": 78,
"vendor": "Contracting",
"jobTitle": "Booking-Manager",
"jobRole": "booking",
"workShift": "afternoon",
"emailAddress": "jdoe@example.com",
"attributes": [
{
"name": "attr1_name",
"value": "attr1_value"
},
{
"name": "attr2_name",
"value": "attr2_value"
}
]
}
headers = {
"asapp-api-id": "<api-key>",
"asapp-api-secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'asapp-api-id': '<api-key>',
'asapp-api-secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
externalAgentId: 'agent158',
startTs: '2022-07-08T11:15:53.237517000Z',
lobId: '1038',
lobName: 'manufacturing',
groupId: 'group5',
groupName: 'XYZ',
agentName: 'Jane Doe',
agentLocation: 'Northern-California',
supervisorId: '3080',
supervisorName: 'Linda Lemon',
languages: ['en-us', 'zh-hans-hk'],
concurrency: 3,
categoryLabel: 'Tier-2-Escalation',
accountAccessLevel: 'High-Profile',
ranking: 78,
vendor: 'Contracting',
jobTitle: 'Booking-Manager',
jobRole: 'booking',
workShift: 'afternoon',
emailAddress: 'jdoe@example.com',
attributes: [
{name: 'attr1_name', value: 'attr1_value'},
{name: 'attr2_name', value: 'attr2_value'}
]
})
};
fetch('https://api.sandbox.asapp.com/metadata-ingestion/v1/single-agent-metadata', 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.sandbox.asapp.com/metadata-ingestion/v1/single-agent-metadata",
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([
'externalAgentId' => 'agent158',
'startTs' => '2022-07-08T11:15:53.237517000Z',
'lobId' => '1038',
'lobName' => 'manufacturing',
'groupId' => 'group5',
'groupName' => 'XYZ',
'agentName' => 'Jane Doe',
'agentLocation' => 'Northern-California',
'supervisorId' => '3080',
'supervisorName' => 'Linda Lemon',
'languages' => [
'en-us',
'zh-hans-hk'
],
'concurrency' => 3,
'categoryLabel' => 'Tier-2-Escalation',
'accountAccessLevel' => 'High-Profile',
'ranking' => 78,
'vendor' => 'Contracting',
'jobTitle' => 'Booking-Manager',
'jobRole' => 'booking',
'workShift' => 'afternoon',
'emailAddress' => 'jdoe@example.com',
'attributes' => [
[
'name' => 'attr1_name',
'value' => 'attr1_value'
],
[
'name' => 'attr2_name',
'value' => 'attr2_value'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"asapp-api-id: <api-key>",
"asapp-api-secret: <api-key>"
],
]);
$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.sandbox.asapp.com/metadata-ingestion/v1/single-agent-metadata"
payload := strings.NewReader("{\n \"externalAgentId\": \"agent158\",\n \"startTs\": \"2022-07-08T11:15:53.237517000Z\",\n \"lobId\": \"1038\",\n \"lobName\": \"manufacturing\",\n \"groupId\": \"group5\",\n \"groupName\": \"XYZ\",\n \"agentName\": \"Jane Doe\",\n \"agentLocation\": \"Northern-California\",\n \"supervisorId\": \"3080\",\n \"supervisorName\": \"Linda Lemon\",\n \"languages\": [\n \"en-us\",\n \"zh-hans-hk\"\n ],\n \"concurrency\": 3,\n \"categoryLabel\": \"Tier-2-Escalation\",\n \"accountAccessLevel\": \"High-Profile\",\n \"ranking\": 78,\n \"vendor\": \"Contracting\",\n \"jobTitle\": \"Booking-Manager\",\n \"jobRole\": \"booking\",\n \"workShift\": \"afternoon\",\n \"emailAddress\": \"jdoe@example.com\",\n \"attributes\": [\n {\n \"name\": \"attr1_name\",\n \"value\": \"attr1_value\"\n },\n {\n \"name\": \"attr2_name\",\n \"value\": \"attr2_value\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("asapp-api-id", "<api-key>")
req.Header.Add("asapp-api-secret", "<api-key>")
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.sandbox.asapp.com/metadata-ingestion/v1/single-agent-metadata")
.header("asapp-api-id", "<api-key>")
.header("asapp-api-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"externalAgentId\": \"agent158\",\n \"startTs\": \"2022-07-08T11:15:53.237517000Z\",\n \"lobId\": \"1038\",\n \"lobName\": \"manufacturing\",\n \"groupId\": \"group5\",\n \"groupName\": \"XYZ\",\n \"agentName\": \"Jane Doe\",\n \"agentLocation\": \"Northern-California\",\n \"supervisorId\": \"3080\",\n \"supervisorName\": \"Linda Lemon\",\n \"languages\": [\n \"en-us\",\n \"zh-hans-hk\"\n ],\n \"concurrency\": 3,\n \"categoryLabel\": \"Tier-2-Escalation\",\n \"accountAccessLevel\": \"High-Profile\",\n \"ranking\": 78,\n \"vendor\": \"Contracting\",\n \"jobTitle\": \"Booking-Manager\",\n \"jobRole\": \"booking\",\n \"workShift\": \"afternoon\",\n \"emailAddress\": \"jdoe@example.com\",\n \"attributes\": [\n {\n \"name\": \"attr1_name\",\n \"value\": \"attr1_value\"\n },\n {\n \"name\": \"attr2_name\",\n \"value\": \"attr2_value\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.asapp.com/metadata-ingestion/v1/single-agent-metadata")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["asapp-api-id"] = '<api-key>'
request["asapp-api-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"externalAgentId\": \"agent158\",\n \"startTs\": \"2022-07-08T11:15:53.237517000Z\",\n \"lobId\": \"1038\",\n \"lobName\": \"manufacturing\",\n \"groupId\": \"group5\",\n \"groupName\": \"XYZ\",\n \"agentName\": \"Jane Doe\",\n \"agentLocation\": \"Northern-California\",\n \"supervisorId\": \"3080\",\n \"supervisorName\": \"Linda Lemon\",\n \"languages\": [\n \"en-us\",\n \"zh-hans-hk\"\n ],\n \"concurrency\": 3,\n \"categoryLabel\": \"Tier-2-Escalation\",\n \"accountAccessLevel\": \"High-Profile\",\n \"ranking\": 78,\n \"vendor\": \"Contracting\",\n \"jobTitle\": \"Booking-Manager\",\n \"jobRole\": \"booking\",\n \"workShift\": \"afternoon\",\n \"emailAddress\": \"jdoe@example.com\",\n \"attributes\": [\n {\n \"name\": \"attr1_name\",\n \"value\": \"attr1_value\"\n },\n {\n \"name\": \"attr2_name\",\n \"value\": \"attr2_value\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"result": {
"eventId": "5484e507-feaf-11ec-bfc1-fda566fa9333",
"error": "FAIL_BAD_PARAMS: ERROR: agent id cannot be blank"
}
}{
"result": {
"eventId": "5484e507-feaf-11ec-bfc1-fda566fa9333",
"error": "FAIL_BAD_PARAMS: ERROR: agent id cannot be blank"
}
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "401-01",
"message": "Unauthorized"
}
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "403-01",
"message": "Forbidden Response"
}
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "404-01",
"message": "Not Found"
}
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "409-01",
"message": "Conflict"
}
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "413-01",
"message": "Request Entity Too Large"
}
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "422-01",
"message": "Unprocessable Entity"
}
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "429-01",
"message": "Too Many Requests"
}
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "503-01",
"message": "Service Unavailable"
}
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "500-01",
"message": "Internal server error"
}
}Agent Metadata
Add an agent metadata
Add metadata attributes of one agent
POST
/
metadata-ingestion
/
v1
/
single-agent-metadata
Add an agent metadata
curl --request POST \
--url https://api.sandbox.asapp.com/metadata-ingestion/v1/single-agent-metadata \
--header 'Content-Type: application/json' \
--header 'asapp-api-id: <api-key>' \
--header 'asapp-api-secret: <api-key>' \
--data '
{
"externalAgentId": "agent158",
"startTs": "2022-07-08T11:15:53.237517000Z",
"lobId": "1038",
"lobName": "manufacturing",
"groupId": "group5",
"groupName": "XYZ",
"agentName": "Jane Doe",
"agentLocation": "Northern-California",
"supervisorId": "3080",
"supervisorName": "Linda Lemon",
"languages": [
"en-us",
"zh-hans-hk"
],
"concurrency": 3,
"categoryLabel": "Tier-2-Escalation",
"accountAccessLevel": "High-Profile",
"ranking": 78,
"vendor": "Contracting",
"jobTitle": "Booking-Manager",
"jobRole": "booking",
"workShift": "afternoon",
"emailAddress": "jdoe@example.com",
"attributes": [
{
"name": "attr1_name",
"value": "attr1_value"
},
{
"name": "attr2_name",
"value": "attr2_value"
}
]
}
'import requests
url = "https://api.sandbox.asapp.com/metadata-ingestion/v1/single-agent-metadata"
payload = {
"externalAgentId": "agent158",
"startTs": "2022-07-08T11:15:53.237517000Z",
"lobId": "1038",
"lobName": "manufacturing",
"groupId": "group5",
"groupName": "XYZ",
"agentName": "Jane Doe",
"agentLocation": "Northern-California",
"supervisorId": "3080",
"supervisorName": "Linda Lemon",
"languages": ["en-us", "zh-hans-hk"],
"concurrency": 3,
"categoryLabel": "Tier-2-Escalation",
"accountAccessLevel": "High-Profile",
"ranking": 78,
"vendor": "Contracting",
"jobTitle": "Booking-Manager",
"jobRole": "booking",
"workShift": "afternoon",
"emailAddress": "jdoe@example.com",
"attributes": [
{
"name": "attr1_name",
"value": "attr1_value"
},
{
"name": "attr2_name",
"value": "attr2_value"
}
]
}
headers = {
"asapp-api-id": "<api-key>",
"asapp-api-secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'asapp-api-id': '<api-key>',
'asapp-api-secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
externalAgentId: 'agent158',
startTs: '2022-07-08T11:15:53.237517000Z',
lobId: '1038',
lobName: 'manufacturing',
groupId: 'group5',
groupName: 'XYZ',
agentName: 'Jane Doe',
agentLocation: 'Northern-California',
supervisorId: '3080',
supervisorName: 'Linda Lemon',
languages: ['en-us', 'zh-hans-hk'],
concurrency: 3,
categoryLabel: 'Tier-2-Escalation',
accountAccessLevel: 'High-Profile',
ranking: 78,
vendor: 'Contracting',
jobTitle: 'Booking-Manager',
jobRole: 'booking',
workShift: 'afternoon',
emailAddress: 'jdoe@example.com',
attributes: [
{name: 'attr1_name', value: 'attr1_value'},
{name: 'attr2_name', value: 'attr2_value'}
]
})
};
fetch('https://api.sandbox.asapp.com/metadata-ingestion/v1/single-agent-metadata', 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.sandbox.asapp.com/metadata-ingestion/v1/single-agent-metadata",
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([
'externalAgentId' => 'agent158',
'startTs' => '2022-07-08T11:15:53.237517000Z',
'lobId' => '1038',
'lobName' => 'manufacturing',
'groupId' => 'group5',
'groupName' => 'XYZ',
'agentName' => 'Jane Doe',
'agentLocation' => 'Northern-California',
'supervisorId' => '3080',
'supervisorName' => 'Linda Lemon',
'languages' => [
'en-us',
'zh-hans-hk'
],
'concurrency' => 3,
'categoryLabel' => 'Tier-2-Escalation',
'accountAccessLevel' => 'High-Profile',
'ranking' => 78,
'vendor' => 'Contracting',
'jobTitle' => 'Booking-Manager',
'jobRole' => 'booking',
'workShift' => 'afternoon',
'emailAddress' => 'jdoe@example.com',
'attributes' => [
[
'name' => 'attr1_name',
'value' => 'attr1_value'
],
[
'name' => 'attr2_name',
'value' => 'attr2_value'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"asapp-api-id: <api-key>",
"asapp-api-secret: <api-key>"
],
]);
$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.sandbox.asapp.com/metadata-ingestion/v1/single-agent-metadata"
payload := strings.NewReader("{\n \"externalAgentId\": \"agent158\",\n \"startTs\": \"2022-07-08T11:15:53.237517000Z\",\n \"lobId\": \"1038\",\n \"lobName\": \"manufacturing\",\n \"groupId\": \"group5\",\n \"groupName\": \"XYZ\",\n \"agentName\": \"Jane Doe\",\n \"agentLocation\": \"Northern-California\",\n \"supervisorId\": \"3080\",\n \"supervisorName\": \"Linda Lemon\",\n \"languages\": [\n \"en-us\",\n \"zh-hans-hk\"\n ],\n \"concurrency\": 3,\n \"categoryLabel\": \"Tier-2-Escalation\",\n \"accountAccessLevel\": \"High-Profile\",\n \"ranking\": 78,\n \"vendor\": \"Contracting\",\n \"jobTitle\": \"Booking-Manager\",\n \"jobRole\": \"booking\",\n \"workShift\": \"afternoon\",\n \"emailAddress\": \"jdoe@example.com\",\n \"attributes\": [\n {\n \"name\": \"attr1_name\",\n \"value\": \"attr1_value\"\n },\n {\n \"name\": \"attr2_name\",\n \"value\": \"attr2_value\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("asapp-api-id", "<api-key>")
req.Header.Add("asapp-api-secret", "<api-key>")
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.sandbox.asapp.com/metadata-ingestion/v1/single-agent-metadata")
.header("asapp-api-id", "<api-key>")
.header("asapp-api-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"externalAgentId\": \"agent158\",\n \"startTs\": \"2022-07-08T11:15:53.237517000Z\",\n \"lobId\": \"1038\",\n \"lobName\": \"manufacturing\",\n \"groupId\": \"group5\",\n \"groupName\": \"XYZ\",\n \"agentName\": \"Jane Doe\",\n \"agentLocation\": \"Northern-California\",\n \"supervisorId\": \"3080\",\n \"supervisorName\": \"Linda Lemon\",\n \"languages\": [\n \"en-us\",\n \"zh-hans-hk\"\n ],\n \"concurrency\": 3,\n \"categoryLabel\": \"Tier-2-Escalation\",\n \"accountAccessLevel\": \"High-Profile\",\n \"ranking\": 78,\n \"vendor\": \"Contracting\",\n \"jobTitle\": \"Booking-Manager\",\n \"jobRole\": \"booking\",\n \"workShift\": \"afternoon\",\n \"emailAddress\": \"jdoe@example.com\",\n \"attributes\": [\n {\n \"name\": \"attr1_name\",\n \"value\": \"attr1_value\"\n },\n {\n \"name\": \"attr2_name\",\n \"value\": \"attr2_value\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.asapp.com/metadata-ingestion/v1/single-agent-metadata")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["asapp-api-id"] = '<api-key>'
request["asapp-api-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"externalAgentId\": \"agent158\",\n \"startTs\": \"2022-07-08T11:15:53.237517000Z\",\n \"lobId\": \"1038\",\n \"lobName\": \"manufacturing\",\n \"groupId\": \"group5\",\n \"groupName\": \"XYZ\",\n \"agentName\": \"Jane Doe\",\n \"agentLocation\": \"Northern-California\",\n \"supervisorId\": \"3080\",\n \"supervisorName\": \"Linda Lemon\",\n \"languages\": [\n \"en-us\",\n \"zh-hans-hk\"\n ],\n \"concurrency\": 3,\n \"categoryLabel\": \"Tier-2-Escalation\",\n \"accountAccessLevel\": \"High-Profile\",\n \"ranking\": 78,\n \"vendor\": \"Contracting\",\n \"jobTitle\": \"Booking-Manager\",\n \"jobRole\": \"booking\",\n \"workShift\": \"afternoon\",\n \"emailAddress\": \"jdoe@example.com\",\n \"attributes\": [\n {\n \"name\": \"attr1_name\",\n \"value\": \"attr1_value\"\n },\n {\n \"name\": \"attr2_name\",\n \"value\": \"attr2_value\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"result": {
"eventId": "5484e507-feaf-11ec-bfc1-fda566fa9333",
"error": "FAIL_BAD_PARAMS: ERROR: agent id cannot be blank"
}
}{
"result": {
"eventId": "5484e507-feaf-11ec-bfc1-fda566fa9333",
"error": "FAIL_BAD_PARAMS: ERROR: agent id cannot be blank"
}
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "401-01",
"message": "Unauthorized"
}
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "403-01",
"message": "Forbidden Response"
}
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "404-01",
"message": "Not Found"
}
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "409-01",
"message": "Conflict"
}
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "413-01",
"message": "Request Entity Too Large"
}
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "422-01",
"message": "Unprocessable Entity"
}
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "429-01",
"message": "Too Many Requests"
}
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "503-01",
"message": "Service Unavailable"
}
}{
"error": {
"requestId": "8e033668-9f1a-11ec-b909-0242ac120002",
"code": "500-01",
"message": "Internal server error"
}
}Body
application/json
A set of agent metadata attributes
The agent id in question
Maximum string length:
256Pattern:
[a-zA-Z0-9\-\_]+Example:
"agent158"
An event id used to track the submission; if none is provided, service will generate one
Maximum string length:
256Pattern:
[a-zA-Z0-9\-\_]+Example:
"eventId-158"
The date and time when the agent is hired in ISO-8601
Example:
"2022-07-08T11:15:53.237517000Z"
The line of business id
Maximum string length:
256Pattern:
[a-zA-Z0-9\-\_]+Example:
"1038"
The descriptive name of the line of business
Maximum string length:
256Example:
"manufacturing"
The group id of which the agent belong to
Maximum string length:
256Pattern:
[a-zA-Z0-9\-\_]+Example:
"group5"
The descriptive name of the group
Maximum string length:
256Example:
"XYZ"
The name of the agent
Maximum string length:
256Example:
"Jane Doe"
The location (or address) of where the agent worked
Maximum string length:
256Example:
"Northern-California"
The supervisor id of who the agent report to
Maximum string length:
256Pattern:
[a-zA-Z0-9\-\_]+Example:
"3080"
The name of the agent's supervisor
Maximum string length:
256Example:
"Linda Lemon"
A list of agent's known language codes in ISO 639 e.g., English (United States) code = en-US
Maximum string length:
16Pattern:
[a-zA-Z0-9\-]+Example:
["en-us", "zh-hans-hk"]
The number of issues that an agent can take at a time
Example:
3
The category label that indicates the types of workflows an agent have access to or problems they solved
Maximum string length:
256Pattern:
[a-zA-Z0-9\-\_]+Example:
"Tier-2-Escalation"
The levels of mapping that an agent have access to make changes to customer accounts
Maximum string length:
256Pattern:
[a-zA-Z0-9\-\_]+Example:
"High-Profile"
Some numerical value indicating relative or absolute performance on a single scale
Example:
78
Vendor or BPO (Business Process Outsourcing) that the agent is part of
Maximum string length:
256Example:
"Contracting"
The agent's job title
Maximum string length:
256Pattern:
[a-zA-Z0-9\-\_]+Example:
"Booking-Manager"
The agent's role
Maximum string length:
256Pattern:
[a-zA-Z0-9\-\_]+Example:
"booking"
The hours or shift name they work
Maximum string length:
256Pattern:
[a-zA-Z0-9\-\_]+Example:
"afternoon"
The agent's email address
Example:
"jdoe@example.com"
A map of key-value pairs for extra metadata attributes
Maximum array length:
10Show child attributes
Show child attributes
Example:
[
{
"name": "attr1_name",
"value": "attr1_value"
},
{
"name": "attr2_name",
"value": "attr2_value"
}
]
Response
200 - Success Submit a single item to the service to be ingested. Record can be traced back to the submitted record by the eventId. A message sent status will be returned with no error message for successful input checks.
A response with the status of a sent message
Show child attributes
Show child attributes
Example:
{
"eventId": "5484e507-feaf-11ec-bfc1-fda566fa9333",
"error": "FAIL_BAD_PARAMS: ERROR: agent id cannot be blank"
}
Was this page helpful?