Response Format

ParameterTypeDescription
codeNumberRefer to Success and Error Code
tagsArrayA list of tags whose information shown includes:
- tagID
- createAt
- basicInfo (Basic information of the tag)
- functionType
- tagNameLanguageSetting
- welcomeMessage
- timeOutRepeatMessage
- transferFailedMessage
- routingRule (Information of the routing rules which determine how the incoming enquiries are distributed to the specific destinations)
- chatURL
- callURL
- metaData
- customChannelInfo
tags.tagIDStringThe ID of the tag from which the information
tags.createAtStringDay and time at which the tag was created
tags.basicInfo.tagNameStringThe name of the tag
tags.basicInfo.tagIconStringURL of tags' display icons
tags.basicInfo.tagDescriptionStringTags' description
tags.functionTypeArray of stringA list of the tags' function types
Value = CALL (Call) and/or IM (Chat)
tags.tagNameLanguageSettingArrayIt shows a list of the tag's display names and descriptions in different languages.

Format:
"(Language code in ISO 639-1)":{"displayName":"(Tag's display name in the language)", "description":"(Tag's description in the language)"}

Example:
"en":{"displayName":"sales", "description":"sales team"}

(English adopted as the language code is used for the tag's display name which is sales and for its description which is sales team.)
tags.welcomeMessage.enabledBooleanIf value=false, the welcome message is disable.

If value=true, the welcome message is enable.
tags.welcomeMessage.messageTypeStringIf welcomeMessage.enabled:true, the welcome message type which is general (General Message)/buttons (Button)/ quickreply (Quick Reply)
tags.welcomeMessage.message.titleStringIf welcomeMessage.enabled:true, the welcome message's title
tags.welcomeMessage.message.descriptionStringIf tags.welcomeMessage.enabled:true, the welcome message's description
tags.welcomeMessage.attachmentStringIf tags.welcomeMessage.enabled:true, the welcome message's attachment URL
tags.welcomeMessage.buttonsArrayIt shows the status of the welcome message button including button name, button type and button URL when tags.welcomeMessage.messageType:buttons/quickreply
tags.welcomeMessage.buttons.buttonNameStringWhen tags.welcomeMessage.messageType:buttons/quickreply,

buttonName: (The welcome message's button name)
tags.welcomeMessage.buttons.buttonTypeStringWhen tags.welcomeMessage.messageType:buttons/quickreply,

buttonType: (The button type which is openLink)
tags.welcomeMessage.buttons.buttonURLStringWhen tags.welcomeMessage.messageType:buttons/quickreply,

buttonURL: (URL of the button)
tags.timeOutRepeatMessage.enabledBooleanIf value=false, the timeout repeat message is disable.

If value=true, the timeout repeat message is enable.
tags.timeOutRepeatMessage.timeoutDurationStringIf timeOutRepeatMessage.enabled:true, idle time that will trigger the system to send a message to the visitor.

Format:
hh (hours) or mm (minutes).

Example:
10m = 10 minutes
3h = 3 hours
tags.timeOutRepeatMessage.messageTypeStringIf tags.timeOutRepeatMessage.enabled:true, the timout repeat message type which is general (General Message)/buttons (Button)/ quickreply (Quick Reply)
tags.timeOutRepeatMessage.message.titleStringIf tags.timeOutRepeatMessage.enabled:true, the timout repeat message's title
tags.timeOutRepeatMessage.message.descriptionStringIf tags.timeOutRepeatMessage.enabled:true,
the timout repeat message's description
tags.timeOutRepeatMessage.attachmentStringIf tags.timeOutRepeatMessage.enabled:true,
the timout repeat message's attachment URL
tags.timeOutRepeatMessage.buttonsArrayIt shows the status of the timeout repeat message button including button name, button type, button URL, tag and staff link when tags.timeOutRepeatMessage.messageType:buttons/quickreply
tags.timeOutRepeatMessage.buttons.buttonNameStringWhen tags.timeOutRepeatMessage.messageType:buttons/quickreply,

buttonName:(The message's button name)
tags.timeOutRepeatMessage.buttons.buttonTypeStringWhen tags.timeOutRepeatMessage.messageType:buttons/quickreply,

buttonType:(A list of button type which is openLink(Open Link)/transferTag (Transfer)/transferStaff(Transfer)/closeInquiry(Close Enquiry))
tags.timeOutRepeatMessage.buttons.buttonURLStringWhen tags.timeOutRepeatMessage.messageType:buttons/quickreply,

buttonURL:(URL of openLink)
tags.timeOutRepeatMessage.buttons.tagStringWhen tags.timeOutRepeatMessage.messageType:buttons/quickreply,

tag:(Tag ID when the button type is transferTag)
tags.timeOutRepeatMessage.buttons.staffStringWhen tags.timeOutRepeatMessage.messageType:buttons/quickreply,

staff: (Staff ID when the button type is transferStaff)
tags.transferFailedMessage.enabledBooleanIf value=false, the transfer failed message is disable.

If value=true, the transfer failed message is enable.
tags.transferFailedMessage.messageTypeStringWhen tags.transferFailedMessage.enabled:true, the timout repeat message type which is general (General Message)/buttons (Button)/ quickreply (Quick Reply)
tags.transferFailedMessage.message.titleStringWhen tags.transferFailedMessage.enabled:true,

the transfer failed message's title
tags.transferFailedMessage.message.descriptionStringWhen tags.transferFailedMessage.enabled:true,

the transfer failed message's description
tags.transferFailedMessage.message.attachmentStringWhen tags.transferFailedMessage.enabled:true,

the transfer failed message's attachment URL
tags.transferFailedMessage.buttonsArrayIt shows the status of the transfer failed message button including button name, button type, button URL, tag link and staff link when tags.timeFailedMessage.messageType:buttons/quickreply
tags.transferFailedMessage.buttons.buttonNameStringWhen tags.transferFailedMessage.messageType:buttons/quickreply,

buttonName:(The message's button name)
tags.transferFailedMessage.buttons.buttonTypeStringWhen tags.transferFailedMessage.messageType:buttons/quickreply,

buttonType:(button type which is openLink(Open Link)/transferTag (Transfer)/transferStaff(Transfer)/closeInquiry(Close Enquiry))
tags.transferFailedMessage.buttons.buttonURLStringWhen tags.transferFailedMessage.messageType:buttons/quickreply,

buttonURL:(URL of openLink)
tags.transferFailedMessage.buttons.tagStringWhen tags.transferFailedMessage.messageType:buttons/quickreply,

tag:(Tag ID when the button type is transferTag)
tags.transferFailedMessage.buttons.staffStringWhen tags.transferFailedMessage.messageType:buttons/quickreply,

staff:(Staff ID when the button type is transferStaff)
tags.routingRule.alternativeRouting.alternativeDestinationsArrayA list of destination ID for the alternative routing
tags.routingRule.timeRouting.schedules.daysArrayA list of the scheduled day of the time routing.

Value= Monday, Tuesday, Wednesday, Thursday, Friday, Saturday and/or Sunday.
tags.routingRule.timeRouting.schedules.fromStringIt is the starting time of the scheduled day of the time routing.
(This time setting is based on your device time zone and time format: 24-hour notation in the form of HH:MM, based on your device time zone.)
tags.routingRule.timeRouting.schedules.toStringIt is the end time of the scheduled day of the time routing.
(This time setting is based on your device time zone and time format: 24-hour notation in the form of HH:MM, based on your device time zone.)
tags.routingRule.timeRouting.schedules.destinationsArrayIt is a list of destination ID of the time schedule
tags.routingRule.timeRouting.schedules.subPercentageRouting.schedules.percentageIntegerReturn when the percentage layer added.

It is the percentage of the distribution of the incoming enquiries.
tags.routingRule.timeRouting.schedules.subPercentageRouting.schedules.destinationsArrayReturn when the percentage layer added.

It is a list of destination ID of the group of staff dedicated to answering the enquires based on the routing percentage.
tags.routingRule.timeRouting.schedules.subPercentageRouting.otherSchedule.destinationsArrayReturn when the percentage layer added.

It is a list of destination ID of the group of staff dedicated to answering the remaing enquires based on the sub-percentage routing.
tags.routingRule.timeRouting.otherSchedule.destinationsArrayReturn when the time routing has been enaled

It is the list of the destination ID of the group of staff dedicated to answering the remaining enquires distributed based on the time routing rule.
tags.routingRule.percentageRouting.schedules.percentageIntegerWhen Percentage routing has been selected.
It is the percentage of the distribution of the incoming enquiries.
tags.routingRule.percentageRouting.schedules.destinationsArrayIt is a list of destination ID of the percentage schedule
tags.routingRule.percentageRouting.schedules.subTimeRouting.schedules.daysArrayWhen time layer added
It is a list of the scheduled day of the sub-time routing.

Value= Monday, Tuesday, Wednesday, Thursday, Friday, Saturday and/or Sunday.
tags.routingRule.percentageRouting.schedules.subTimeRouting.schedules.fromStringWhen time layer added.
It is the starting time of the scheduled day of the sub-time routing.

(This time setting is based on your device time zone and time format: 24-hour notation in the form of HH:MM, based on your device time zone.)
tags.routingRule.percentageRouting.schedules.subTimeRouting.schedules.toStringWhen time layer added.
It is the end time of the scheduled day of the sub-time routing.

(This time setting is based on your device time zone and time format: 24-hour notation in the form of HH:MM, based on your device time zone.)
tags.routingRule.percentageRouting.schedules.subTimeRouting.schedules.destinationsArrayWhen time layer added.
It is the list of the destination ID of the group of staff dedicated to answering the enquires distributed based on the sub-time routing rule.
tags.routingRule.percentageRouting.schedules.subTimeRouting.otherSchedule.destinationsArrayWhen time layer added.
It is the list of the destination ID of the group of staff dedicated to answering the remaining enquires distributed based on the sub-time routing rule.
tags.routingRule.percentageRouting.otherSchedule.destinationsArrayWhen percentage routing has been selected.
It is the list of the destination ID of the group of staff dedicated to answering the remaining enquires distributed based on the percentage routing rule.
tags.stickyRoutingBooleanValue = true. Bind a visitor to the staff who handled their enquiry using this tag.

Value = false. Do not bind a visitor to the staff who handled their enquiry using this tag.
tags.chatURLStringThe chat URL of the tag
tags.callURLStringThe call URL of the tag
tags.metaDataArrayA list of keywords to be triggered as criteria to show or hide the tag.
tags.customChannelInfo.enabledBooleanValue = true (enable the custom channel info)

Value = false (disable the custom channel info)
tags.customChannelInfo.descriptionStringThe content of the custom channel info.

📘

Notices

  • tags.routingRule.alternativeRouting object will only be shown when the user selected the alternative routing.
  • tags.routingRule.timeRouting object will only be shown when the user selected the time routing.
  • tags.routingRule.timeRouting.schedules.subPercentageRouting object will only be shown when the user adds the percentage layer.
  • tags.routingRule.percentageRouting will only be shown when the user selected the percentage routing.
  • tags.routingrule.percentageRouting.schedules.subTimeRouting object will only be shown when the user adds the time layer.
Language