POST
/
metadata-ingestion
/
v1
/
single-convo-metadata

Authorizations

asapp-api-id
string
headerrequired
asapp-api-secret
string
headerrequired

Body

application/json

A set of conversation metadata attributes

externalConversationId
string
required

Conversation ID from the external chat / voice system

Maximum length: 256
eventId
string | null

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

Maximum length: 256
lobId
string | null

The line of business id

Maximum length: 256
lobName
string | null

The descriptive name of the line of business

Maximum length: 256
groupId
string | null

The group id of which the agent belong to

Maximum length: 256
groupName
string | null

The descriptive name of the group

Maximum length: 256
agentRoutingCode
string | null

The agent's routing attribute

Maximum length: 256
campaign
string | null

The activities related to the issue

Maximum length: 256
deviceType
enum<string> | null

The client's device type

Available options:
TABLET,
PHONE,
DESKTOP,
WATCH,
OTHER
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
companySegment
string[] | null

The company's segment of which the issue belongs to

companySubdivision
string | null

The company's subdivision of which the issue belongs to

Maximum length: 256
businessRule
string | null

The business rule to use

Maximum length: 256
entryType
string | null

The way the issue started and created in the system

Maximum length: 256
operatingSystem
enum<string> | null

The operating system used to enter the issue

Available options:
MAC_OS,
LINUX,
WINDOWS,
ANDROID,
IOS,
OTHER
browserType
string | null

The browser type used

Maximum length: 64
browserVersion
string | null

The browser version used

Maximum length: 16
attributes
object[] | null

A map of key-value pairs for extra metadata attributes

Response

200 - application/json
result
object
required

A response with the status of a sent message

Was this page helpful?

Add multiple agent metadataAdd multiple conversation metadata