Add a conversation metadata

Add metadata attributes of one issue/conversation

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 length: 256

Example:

"issue1389"

eventId

string | null

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

Maximum length: 256

Example:

"eventId-1388"

lobId

string | null

The line of business id

Maximum length: 256

Example:

"1038"

lobName

string | null

The descriptive name of the line of business

Maximum length: 256

Example:

"manufacturing"

groupId

string | null

The group id of which the agent belong to

Maximum length: 256

Example:

"group59"

groupName

string | null

The descriptive name of the group

Maximum length: 256

Example:

"groupXYZ"

agentRoutingCode

string | null

The agent's routing attribute

Maximum length: 256

Example:

"route-13988"

campaign

string | null

The activities related to the issue

Maximum length: 256

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

Example:

["Sales", "Marketing"]

companySubdivision

string | null

The company's subdivision of which the issue belongs to

Maximum length: 256

Example:

"Operating"

businessRule

string | null

The business rule to use

Maximum length: 256

Example:

"Apply customer's discount"

entryType

string | null

The way the issue started and created in the system

Maximum length: 256

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 length: 64

Example:

"Safari"

browserVersion

string | null

The browser version used

Maximum length: 16

Example:

"14.1.2"

attributes

object[] | null

A map of key-value pairs for extra metadata attributes

A key-value pair of additional metadata attributes

Show child attributes

attributes.name

string

The name of the attribute

Maximum length: 256

attributes.value

string

The value of the named attribute

Maximum length: 1024

Example:

[
  {
    "name": "attr1_name",
    "value": "attr1_value"
  },
  {
    "name": "attr2_name",
    "value": "attr2_value"
  }
]

Response

200

application/json

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

Show child attributes

result.eventId

string

An UUID identifier string computed for the submitted event message

Example:

"5484e507-feaf-11ec-bfc1-fda566fa9333"

result.error

string

Status of the failed message if value is not blank; the error is contained in the string

Example:

"FAIL_BAD_PARAMS: ERROR: agent id cannot be blank"

Example:

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