Add multiple conversation metadata

curl --request POST \
  --url https://api.sandbox.asapp.com/metadata-ingestion/v1/many-convo-metadata \
  --header 'Content-Type: application/json' \
  --header 'asapp-api-id: <api-key>' \
  --header 'asapp-api-secret: <api-key>' \
  --data @- <<EOF
{
  "items": [
    {
      "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"
        }
      ]
    },
    {
      "externlConversationId": "issue1390",
      "eventId": "eventId-1268",
      "lobId": "930",
      "lobName": "retail",
      "groupId": "store-93",
      "groupName": "PlazaA",
      "agentRoutingCode": "route-1983",
      "campaign": "campaign-B",
      "deviceType": "PHONE",
      "platform": "ANDROID",
      "companySegment": [
        "SALES",
        "FINANCE"
      ],
      "companySubdivision": "operating",
      "businessRule": "Apply customer's discount",
      "entryType": "proactive",
      "operatingSystem": "ANDROID",
      "browserType": "Chrome",
      "browserVersion": "103.0.5060.128",
      "attributes": [
        {
          "name": "attr1_name",
          "value": "attr1_value"
        },
        {
          "name": "attr2_name",
          "value": "attr2_value"
        }
      ]
    }
  ]
}
EOF

{
  "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": ""
    }
  ]
}

POST

metadata-ingestion

many-convo-metadata

Add multiple conversation metadata

curl --request POST \
  --url https://api.sandbox.asapp.com/metadata-ingestion/v1/many-convo-metadata \
  --header 'Content-Type: application/json' \
  --header 'asapp-api-id: <api-key>' \
  --header 'asapp-api-secret: <api-key>' \
  --data @- <<EOF
{
  "items": [
    {
      "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"
        }
      ]
    },
    {
      "externlConversationId": "issue1390",
      "eventId": "eventId-1268",
      "lobId": "930",
      "lobName": "retail",
      "groupId": "store-93",
      "groupName": "PlazaA",
      "agentRoutingCode": "route-1983",
      "campaign": "campaign-B",
      "deviceType": "PHONE",
      "platform": "ANDROID",
      "companySegment": [
        "SALES",
        "FINANCE"
      ],
      "companySubdivision": "operating",
      "businessRule": "Apply customer's discount",
      "entryType": "proactive",
      "operatingSystem": "ANDROID",
      "browserType": "Chrome",
      "browserVersion": "103.0.5060.128",
      "attributes": [
        {
          "name": "attr1_name",
          "value": "attr1_value"
        },
        {
          "name": "attr2_name",
          "value": "attr2_value"
        }
      ]
    }
  ]
}
EOF

{
  "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": ""
    }
  ]
}

Authorizations

asapp-api-id

string

header

required

asapp-api-secret

string

header

required

Body

application/json

A request to send more than one conversation metadata attributes; send a list of items

items

object[]

Required array length: 1 - 1000 elements

Show child attributes

items.externalConversationId

string

required

Conversation ID from the external chat / voice system

Maximum string length: 256

Example:

"issue1389"

items.eventId

string | null

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

Maximum string length: 256

Example:

"eventId-1388"

items.lobId

string | null

The line of business id

Maximum string length: 256

Example:

"1038"

items.lobName

string | null

The descriptive name of the line of business

Maximum string length: 256

Example:

"manufacturing"

items.groupId

string | null

The group id of which the agent belong to

Maximum string length: 256

Example:

"group59"

items.groupName

string | null

The descriptive name of the group

Maximum string length: 256

Example:

"groupXYZ"

items.agentRoutingCode

string | null

The agent's routing attribute

Maximum string length: 256

Example:

"route-13988"

items.campaign

string | null

The activities related to the issue

Maximum string length: 256

Example:

"campaign-A"

items.deviceType

enum<string> | null

The client's device type

Available options:

TABLET,

PHONE,

DESKTOP,

WATCH,

OTHER

Example:

"TABLET"

items.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"

items.companySegment

string[] | null

The company's segment of which the issue belongs to

Maximum string length: 64

Example:

["Sales", "Marketing"]

items.companySubdivision

string | null

The company's subdivision of which the issue belongs to

Maximum string length: 256

Example:

"Operating"

items.businessRule

string | null

The business rule to use

Maximum string length: 256

Example:

"Apply customer's discount"

items.entryType

string | null

The way the issue started and created in the system

Maximum string length: 256

Example:

"reactive"

items.operatingSystem

enum<string> | null

The operating system used to enter the issue

Available options:

MAC_OS,

LINUX,

WINDOWS,

ANDROID,

IOS,

OTHER

Example:

"MAC_OS"

items.browserType

string | null

The browser type used

Maximum string length: 64

Example:

"Safari"

items.browserVersion

string | null

The browser version used

Maximum string length: 16

Example:

"14.1.2"

items.attributes

object[] | null

A map of key-value pairs for extra metadata attributes

Maximum array length: 10

Show child attributes

items.attributes.name

string

The name of the attribute

Maximum string length: 256

items.attributes.value

string

The value of the named attribute

Maximum string length: 1024

Example:

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

Response

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".

errorCount

integer

required

Number of message sent with error(s)

results

object[]

required

A list of send result

Show child attributes

results.eventId

string

An UUID identifier string computed for the submitted event message

Example:

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

results.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"

Add a conversation metadata Add a customer metadata

⌘I

ASAPP APIs

Authorizations

Body

Response