Agent Metadata
Add multiple agent metadata
ASAPP APIs
- Overview
- Conversations
- Messages
- Generative Agent
- AutoSummary
- AutoTranscribe
- AutoCompose
- Knowledge Base
- Configuration
- File Exporter
- Metadata
- Agent Metadata
- Conversation Metadata
- Customer Metadata
- Health Check
Agent Metadata
Add multiple agent metadata
Add multiple agent metadata items; submit items in a batch in one request
POST
/
metadata-ingestion
/
v1
/
many-agent-metadata
curl --request POST \
--url https://api.sandbox.asapp.com/metadata-ingestion/v1/many-agent-metadata \
--header 'Content-Type: application/json' \
--header 'asapp-api-id: <api-key>' \
--header 'asapp-api-secret: <api-key>' \
--data '{
"items": [
{
"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",
"es-pe"
],
"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"
}
]
},
{
"externalAgentId": "agent392",
"startTs": "2021-09-02T11:15:53.237517000Z",
"lobId": "968",
"lobName": "insurance",
"groupId": "group3",
"groupName": "DFG",
"agentName": "Jonathan Master",
"agentLocation": "Southern-California",
"supervisorId": "1290",
"supervisorName": "John Luna",
"languages": [
"en-us"
],
"concurrency": 3,
"categoryLabel": "Tier-1-Service",
"accountAccessLevel": "High-Profile",
"ranking": 75,
"vendor": "Contracting",
"jobTitle": "Customer-Service",
"jobRole": "Support",
"workShift": "afternoon",
"emailAddress": "jmaster@example.com",
"attributes": [
{
"name": "attr1_name",
"value": "attr1_value"
}
]
},
{
"externalAgentId": "agent6922",
"startTs": null
},
{
"externalAgentId": "agent222"
},
{
"externalAgentId": "agent333",
"emailAddress": "jdoe@example.com"
}
]
}'
{
"errorCount": 1,
"results": [
{
"eventId": "5484e507-feaf-11ec-bfc1-fda566fa9333",
"error": "FAIL_BAD_PARAMS: ERROR: agent id cannot be blank"
},
{
"eventId": "fcf99667-feaf-11ec-a42e-11799134528c",
"error": ""
}
]
}
Body
application/json
A request to send more than one agent metadata; send a list of items
Response
200
application/json
200 - Success | Partial Success
Submit a batch of items to the service to be ingested. Record can be traced back to the submitted record by the eventId.
If any of the records encounter issue during the ingestion, a message sent status will be returned with an error message for each record.
A 200 success is returned as long as there is one item ingested successfully, i.e., "partial success".
The response is of type object
.
Was this page helpful?
curl --request POST \
--url https://api.sandbox.asapp.com/metadata-ingestion/v1/many-agent-metadata \
--header 'Content-Type: application/json' \
--header 'asapp-api-id: <api-key>' \
--header 'asapp-api-secret: <api-key>' \
--data '{
"items": [
{
"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",
"es-pe"
],
"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"
}
]
},
{
"externalAgentId": "agent392",
"startTs": "2021-09-02T11:15:53.237517000Z",
"lobId": "968",
"lobName": "insurance",
"groupId": "group3",
"groupName": "DFG",
"agentName": "Jonathan Master",
"agentLocation": "Southern-California",
"supervisorId": "1290",
"supervisorName": "John Luna",
"languages": [
"en-us"
],
"concurrency": 3,
"categoryLabel": "Tier-1-Service",
"accountAccessLevel": "High-Profile",
"ranking": 75,
"vendor": "Contracting",
"jobTitle": "Customer-Service",
"jobRole": "Support",
"workShift": "afternoon",
"emailAddress": "jmaster@example.com",
"attributes": [
{
"name": "attr1_name",
"value": "attr1_value"
}
]
},
{
"externalAgentId": "agent6922",
"startTs": null
},
{
"externalAgentId": "agent222"
},
{
"externalAgentId": "agent333",
"emailAddress": "jdoe@example.com"
}
]
}'
{
"errorCount": 1,
"results": [
{
"eventId": "5484e507-feaf-11ec-bfc1-fda566fa9333",
"error": "FAIL_BAD_PARAMS: ERROR: agent id cannot be blank"
},
{
"eventId": "fcf99667-feaf-11ec-a42e-11799134528c",
"error": ""
}
]
}