Contents x
      Set up Response Queue
      • 3 Minutes to read
      • Print
      • Dark
        Light
      Contents

      Set up Response Queue

      • 3 Minutes to read
      • Print
      • Dark
        Light
      Article summary

      Mapp internally configures the Response Queue. Provide your customer success or account manager with the parameters for your queue, and they will map them to the correct attributes.

      Mobile Push for Response Queue is available with api.v2 at least in version 13.

      Tracking Attributes

      Email

      Response Type

      Description

      Specific Tracking Types

      Specific Tracking Attributes

      Bounces

      If this feature is activated, Bounces are added to the response queue and will be retrieved via the API.

      bounce.trackingType

      • bounce.timestamp

      • bounce.trackingType

      • bounce.category

      • bounce.sendoutType

      • bounce.responseText

      • bounce.newCategoryId

      Clicks

      Put the Clicks into the response queue.

      clicker.trackingType

      • clicker.timestamp

      • clicker.trackingType

      • clicker.linkCategoryPK

      • clicker.linkId

      • clicker.url

      • clicker.sendoutType

      Email Openers

      Puts all Opens into the response queue.

      renderer.trackingType

      • renderer.timestamp

      • renderer.trackingType

      Forwarders

      Puts the Forwarders into response queue.

      forwarder.trackingType

      • forwarder.timestamp

      • forwarder.trackingType

      Ignore Bounce Types

      Defines which bounces should be ignored and not put into the response queue.

      This response is to be used in combination with Bounces only.

      n.a.

      n.a.

      Internal Skips

      Puts all Internal Skips into the response queue.

      internalSkip.trackingType

      • internalSkip.timestamp

      • internalSkip.trackingType

      • internalSkip.categoryId

      • internalSkip.category

      Transactional Tracking Data

      Puts the transactional sent events into the response queue.

      sendTransactional.trackingType

      • transactional.timestamp

      • externalTransactionId.externalId

      • sendTransactional.trackingType

      • sendTransactional.timestamp

      Unsubscribes

      Puts the Unsubscribes into the response queue.

      unsubscriber.trackingType

      • unsubscriber.timestamp

      • unsubscriber.trackingType

      Group Message

      Puts Group Message sentToMTA information into the response queue.

      sentToMta.trackingType

      • sentToMta.trackingType

      • sentToMta.timestamp

      Used coupons

      Puts used coupon codes into the response queue.

      usedCoupons.trackingType

      • usedCoupons.couponCodes

      SMS

      Response Type

      Description

      Specific Tracking Types

      Specific Tracking Attributes

      SMS Bounces

      If this feature is activated, SMS Bounces are added to the response queue and will be retrieved via the API.

      bounce.trackingType

      • bounce.timestamp

      • bounce.trackingType

      • bounce.newCategoryId

      • bounce.CategoryId

      • bounce.sendoutType

      • bounce.responseText

      SMS Inbound Messages

      If this feature is activated, incoming SMS messages are added to the Response Queue and can be retrieved via the API. Additional configuration is required if using the alternate email/mobile contact model.

      smsInbound.trackingType

      • smsInbound.message

      • smsInbound.mobileNumber

      • smsInbound.sentDate

      Mobile Push

      Response Type

      Description

      Specific Tracking Types

      Specific Tracking Attributes

      Push Sendout

      Puts all Push Sendouts into the response queue.

      pushSendout.trackingType

      • pushSendout.customerPK

      • pushSendout.userPK

      • pushSendout.messageId

      • pushSendout.sendoutId

      • pushSendout.timestamp

      • pushSendout.sendoutTimestamp (nullable)

      • pushSendout.triggerType (nullable)

      • pushSendout.token

      • pushSendout.subject

      • pushSendout.deviceId (nullable)

      Push Click

      Puts all Push Clicks into the response queue.

      pushClick.trackingType

      • pushClick.customerPK

      • pushClick.userPK

      • pushClick.messageId

      • pushClick.sendoutId

      • pushClick.timestamp

      • pushClick.sendoutTimestamp (nullable)

      • pushClick.buttonId (nullable)

      • pushClick.clickActionType (nullable)

      Push Delivery

      Puts all Push Deliveries into the response queue.

      pushDelivery.trackingType

      • pushDelivery.customerPK

      • pushDelivery.userPK

      • pushDelivery.messageId

      • pushDelivery.sendoutId

      • pushDelivery.timestamp

      • pushDelivery.sendoutTimestamp (nullable)

      • pushDelivery.deviceId (nullable)

      Push Dismiss

      Puts all Push Dismisses into the response queue.

      pushDismiss.trackingType

      • pushDismiss.customerPK

      • pushDismiss.userPK

      • pushDismiss.messageId

      • pushDismiss.sendoutId

      • pushDismiss.timestamp

      • pushDismiss.sendoutTimestamp (nullable)

      Push Error

      Puts all Push Errors into the response queue.

      pushError.trackingType

      • pushError.customerPK

      • pushError.userPK

      • pushError.messageId

      • pushError.sendoutId

      • pushError.timestamp

      • pushError.sendoutTimestamp (nullable)

      • pushError.errorCategory

      • pushError.errorText

      • pushError.deviceId (nullable)

      Engage Attributes

      Engage Attributes

      Category

      Attributes

      Unsupported Response Types

      Custom Attributes

      • user.CustomAttribute

      n.a.

      External transaction information

      • externalTransactionId.externalId

      Unsubscribes in case it is a REST unsubscribe, Forwards

      Group Information

      • group.PK

      • group.Name

      • group.Email

      Unavailable for Push

      Member Attributes

      • user.CampaignAttribute

      n.a.

      Message information

      • message.PK

      • message.Name

      Unsubscribes in case it is a REST unsubscribe.

      Unavailable for Push.

      Standard Attributes

      • user.Email

      • user.FirstName

      • user.PK

      n.a.

      Mobile Message Template

      • mobileMessageTemplate.category

      • mobileMessageTemplate.content

      • mobileMessageTemplate.description

      • mobileMessageTemplate.messageTitle

      This is relevant only for Push Responses.

      Tracking Type Output

      Email

      Response Type

      Specific Tracking Types

      Output

      Details

      Bounces

      bounce.trackingType

      B

      FB

      I

      Bounces
      Feed Back  
      Ignore

      Ignore Bounce Types

      n.a.

      -

      Note: This response is to be used in combination with Bounces only.

      Clicks

      clicker.trackingType

      C

      Forwarders

      forwarder.trackingType

      F

      Internal Skips

      internalSkip.trackingType

      S

      Email Openers

      renderer.trackingType

      R

      Transactional Tracking Data

      sendTransactional.trackingType

      SE

      Available not only for Email, but also for SMS.

      Unsubscribes

      unsubscriber.trackingType

      U

      Used Coupons

      usedCoupons.trackingType

      UC

      SMS

      Response Type

      Specific Tracking Types

      Output

      Details

      SMS Bounces

      bounce.trackingType

      B

      SMS Inbound

      smsInbound.trackingType

      SI

      Transactional Tracking Data

      sendTransactional.trackingType

      SE

      Available not only for Email, but also for SMS.

      Mobile Push

      Response Type

      Specific Tracking Types

      Output

      Push Sendout

      pushSendout.trackingType

      PM

      Push Click

      pushClick.trackingType

      PC

      Push Delivery

      pushDelivery.trackingType

      PS

      Push Dismiss

      pushDismiss.trackingType

      PD

      Push Error

      pushError.trackingType

      PE

      Category Mapping

      For the following tracking types (B, FB, I, S), to see their respective categories, you must configure the below:

      • Responses (bounces/feedback/ignores): bounce.newCategoryId

      • Skips: internalSkip.categoryId

      BOUNCES (B) via Responses

      BOUNCES (B) via Responses

      Tracking Type Value

      ID

      Invalid Address

      B

      0

      Complaint

      B

      -1

      Transient

      B

      1

      Blocked

      B

      2

      Rejected

      B

      3

      Unknown

      B

      4

      Autoresponder

      B

      5

      Temp Communication Failure

      B

      7

      FEEDBACK (FB) via Responses

      FEEDBACK (FB) via Responses

      Tracking Type Value

      ID

      Complaint

      -

      -

      Autoresponder

      -

      -

      IGNORE (I) via Responses

      IGNORE (I) via Responses

      Tracking Type Value

      ID

      NOT_CONFIRMED

      I

      6

      SKIPS (S) from Skipping before Sendout

      SKIPS (S) from Skipping before Sendout

      Tracking Type Value

      ID

      SYS_BOUNCED

      S

      0

      GRP_BOUNCED

      S

      1

      GRP_BLACKLISTED

      S

      3

      SYS_OVER_BOOKED

      S

      4

      USR_OVER_BOOKED

      S

      5

      SEND_FAILED

      S

      6

      PERSONALIZATION_FAILED

      S

      7

      INTERCEPTOR_FAILED

      S

      8

      SYS_BLACKLIST_ROBINSON

      S

      9

      EXTERNAL_ATTRIBUTE_FILTER

      S

      11

      SKIP_RECIPIENT

      S

      12

      CHANNEL_NO_ADDRESS

      S

      14

      CHANNEL_READ_MODE_DENIED

      S

      15

      TEMP_COMMUNICATION_FAILURE

      -

      -

      INVALID_ADDRESS

      -

      -

      INVALID_ALTERNATE_ADDRESS

      S

      18

      INVALID_ENCRYPTED_ADDRESS

      S

      19

      MTA_BLACKLIST_ROBINSON

      S

      20

      Examples

      Example 1

      <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<asyncResults>
<asyncResult>
<queueId>AC108D557716FB4173BB9</queueId>
<output>
<name>leadkey</name>
<value>mapp-3016559930230010128472020-01-17Z</value>
</output>
<output>
<name>mappGroupEmail</name>
<value>example@testdomain.com</value>
</output>
<output>
<name>contactId</name>
<value>30165599302</value>
</output>
<output>
<name>mappGroupid</name>
<value>3000461313</value>
</output>
<output>
<name>linkWebUrl</name>
<value>https://www.google.com?1CP_LK=mapp-3016559930230010128472020-01-17Z</value>
</output>
<output>
<name>communicationId</name>
<value>3001012847</value>
</output>
<output>
<name>responseRecordTypeCode</name>
<value>C</value>
</output>
<output>
<name>clicksLinkId</name>
<value>0</value>
</output>
<output>
<name>email</name>
<value>example1@gmail.com</value>
</output>
<output>
<name>messageName</name>
<value>Copy of Testing SendoutChannel</value>
</output>
<output>
<name>mappGroupName</name>
<value>123 Master Group</value>
</output>
<output>
<name>responseDate</name>
<value>2020-01-17T15:19:36Z</value>
</output>
</asyncResult>

      Example 2

      <asyncResult>
<queueId>AC108D557516FB4173B72</queueId>
<output>
<name>leadkey</name>
<value>mapp-3016559930230010128472020-01-17Z</value>
</output>
<output>
<name>mappGroupEmail</name>
<value>example@testdomain.com</value>
</output>
<output>
<name>contactId</name>
<value>30165599302</value>
</output>
<output>
<name>mappGroupid</name>
<value>3000461313</value>
</output>
<output>
<name>linkWebUrl</name>
<value>https://www.google.com?1CP_LK=mapp-3016559930230010128472020-01-17Z</value>
</output>
<output>
<name>communicationId</name>
<value>3001012847</value>
</output>
<output>
<name>responseRecordTypeCode</name>
<value>C</value>
</output>
<output>
<name>clicksLinkId</name>
<value>0</value>
</output>
<output>
<name>email</name>
<value>example1@gmail.com</value>
</output>
<output>
<name>messageName</name>
<value>Copy of Testing SendoutChannel</value>
</output>
<output>
<name>mappGroupName</name>
<value>India GHH-IND-1 MP 1 Master Group</value>
</output>
<output>
<name>responseDate</name>
<value>2020-01-17T15:19:27Z</value>
</output>
</asyncResult>

      Example 3

      <asyncResult>
<queueId>AC108D557F16FB4173FBC</queueId>
<output>
<name>leadkey</name>
<value>mapp-3016559930230010128472020-01-17Z</value>
</output>
<output>
<name>mappGroupEmail</name>
<value>example@testdomain.com</value>
</output>
<output>
<name>contactId</name>
<value>30165599302</value>
</output>
<output>
<name>mappGroupid</name>
<value>3000461313</value>
</output>
<output>
<name>communicationId</name>
<value>3001012847</value>
</output>
<output>
<name>responseRecordTypeCode</name>
<value>R</value>
</output>
<output>
<name>email</name>
<value>example2@gmail.com</value>
</output>
<output>
<name>messageName</name>
<value>Copy of Testing SendoutChannel</value>
</output>
<output>
<name>mappGroupName</name>
<value>123 Master Group</value>
</output>
<output>
<name>responseDate</name>
<value>2020-01-17T15:18:53Z</value>
</output>
</asyncResult>
</asyncResults>

      Was this article helpful?
      Related articles
      What's Next