Skip to main content
POST
/
metadata-ingestion
/
v1
/
single-convo-metadata
Add a conversation metadata
curl --request POST \
  --url https://api.sandbox.asapp.com/metadata-ingestion/v1/single-convo-metadata \
  --header 'Content-Type: application/json' \
  --header 'asapp-api-id: <api-key>' \
  --header 'asapp-api-secret: <api-key>' \
  --data @- <<EOF
{
  "externalConversationId": "id-1389",
  "eventId": "eventId-1388",
  "lobId": "1038",
  "lobName": "manufacturing",
  "groupId": "group59",
  "groupName": "groupXYZ",
  "agentRoutingCode": "route-13988",
  "campaign": "campaign-A",
  "deviceType": "TABLET",
  "platform": "IOS",
  "companySegment": [
    "Sales",
    "Marketing"
  ],
  "companySubdivision": "operating",
  "businessRule": "Apply customer's discount",
  "entryType": "reactive",
  "operatingSystem": "MAC_OS",
  "browserType": "Safari",
  "browserVersion": "14.1.2",
  "attributes": [
    {
      "name": "attr1_name",
      "value": "attr1_value"
    },
    {
      "name": "attr2_name",
      "value": "attr2_value"
    }
  ]
}
EOF
{
  "result": {
    "eventId": "5484e507-feaf-11ec-bfc1-fda566fa9333",
    "error": "FAIL_BAD_PARAMS: ERROR: agent id cannot be blank"
  }
}

Authorizations

​
asapp-api-id
string
header
required
​
asapp-api-secret
string
header
required

Body

application/json

A set of conversation metadata attributes

​
externalConversationId
string
required

Conversation ID from the external chat / voice system

Maximum string length: 256
Pattern: [a-zA-Z0-9\-\_]+
Example:

"issue1389"

​
eventId
string | null

An event id used to track the submission; if none is provided, service will generate one

Maximum string length: 256
Pattern: [a-zA-Z0-9\-\_]+
Example:

"eventId-1388"

​
lobId
string | null

The line of business id

Maximum string length: 256
Pattern: [a-zA-Z0-9\-\_]+
Example:

"1038"

​
lobName
string | null

The descriptive name of the line of business

Maximum string length: 256
Example:

"manufacturing"

​
groupId
string | null

The group id of which the agent belong to

Maximum string length: 256
Pattern: [a-zA-Z0-9\-\_]+
Example:

"group59"

​
groupName
string | null

The descriptive name of the group

Maximum string length: 256
Example:

"groupXYZ"

​
agentRoutingCode
string | null

The agent's routing attribute

Maximum string length: 256
Pattern: [a-zA-Z0-9\-\_]+
Example:

"route-13988"

​
campaign
string | null

The activities related to the issue

Maximum string length: 256
Pattern: [a-zA-Z0-9\-\_]+
Example:

"campaign-A"

​
deviceType
enum<string> | null

The client's device type

Available options:
TABLET,
PHONE,
DESKTOP,
WATCH,
OTHER
Example:

"TABLET"

​
platform
enum<string> | null

The client's platform type WAB: WhatsApp Business

Available options:
SMS,
WEB,
IOS,
ANDROID,
APP,
LOCAL,
VOICE,
VOICE_IOS,
VOICE_ANDROID,
VOICE_ECHO,
VOICE_HOMEPOD,
VOICE_GGLHOME,
VOICE_WEB,
APPLEBIZ,
GOOGLEBIZ,
GBM,
WAB
Example:

"IOS"

​
companySegment
string[] | null

The company's segment of which the issue belongs to

Maximum string length: 64
Pattern: [a-zA-Z0-9\-\_]+
Example:
["Sales", "Marketing"]
​
companySubdivision
string | null

The company's subdivision of which the issue belongs to

Maximum string length: 256
Pattern: [a-zA-Z0-9\-\_]+
Example:

"Operating"

​
businessRule
string | null

The business rule to use

Maximum string length: 256
Example:

"Apply customer's discount"

​
entryType
string | null

The way the issue started and created in the system

Maximum string length: 256
Pattern: [a-zA-Z0-9\-\_]+
Example:

"reactive"

​
operatingSystem
enum<string> | null

The operating system used to enter the issue

Available options:
MAC_OS,
LINUX,
WINDOWS,
ANDROID,
IOS,
OTHER
Example:

"MAC_OS"

​
browserType
string | null

The browser type used

Maximum string length: 64
Pattern: [a-zA-Z0-9\-\_]+
Example:

"Safari"

​
browserVersion
string | null

The browser version used

Maximum string length: 16
Pattern: [a-zA-Z0-9\-\_\.]+
Example:

"14.1.2"

​
attributes
object[] | null

A map of key-value pairs for extra metadata attributes

Maximum array length: 10
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.

​
result
object
required

A response with the status of a sent message

Example:
{
  "eventId": "5484e507-feaf-11ec-bfc1-fda566fa9333",
  "error": "FAIL_BAD_PARAMS: ERROR: agent id cannot be blank"
}