get https://examplebaseURL.com/v1/api/apps//tag
Response Format
| Parameter | Type | Description |
|---|---|---|
| code | Number | Refer to Success and Error Code |
| tags | Array | A 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.tagID | String | The ID of the tag from which the information |
| tags.createAt | String | Day and time at which the tag was created |
| tags.basicInfo.tagName | String | The name of the tag |
| tags.basicInfo.tagIcon | String | URL of tags' display icons |
| tags.basicInfo.tagDescription | String | Tags' description |
| tags.functionType | Array of string | A list of the tags' function types Value = CALL (Call), IM (Chat) or CALL (Call) and IM (Chat) |
| tags.tagNameLanguageSetting | Array | It 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.enabled | Boolean | If value=false, the welcome message is disabled. If value=true, the welcome message is enabled. |
| tags.welcomeMessage.messageType | String | If welcomeMessage.enabled:true, the welcome message type which should be one of the following: - general (General Message) - buttons (Button) - quickreply (Quick Reply) |
| tags.welcomeMessage.message.title | String | If welcomeMessage.enabled:true, the welcome message's title |
| tags.welcomeMessage.message.description | String | If tags.welcomeMessage.enabled:true, the welcome message's description |
| tags.welcomeMessage.attachment | String | If tags.welcomeMessage.enabled:true, the welcome message's attachment URL |
| tags.welcomeMessage.buttons | Array | It shows the status of the welcome message button including button name, button type and button URL when tags.welcomeMessage.messageType:buttons or quickreply |
| tags.welcomeMessage.buttons.buttonName | String | When tags.welcomeMessage.messageType:buttons or quickreply, buttonName: (The welcome message's button name) |
| tags.welcomeMessage.buttons.buttonType | String | When tags.welcomeMessage.messageType:buttons or quickreply, buttonType: (The button type which should be openLink) |
| tags.welcomeMessage.buttons.buttonURL | String | When tags.welcomeMessage.messageType:buttons or quickreply, buttonURL: (URL of the button) |
| tags.timeOutRepeatMessage.enabled | Boolean | If value=false, the timeout repeat message is disabled. If value=true, the timeout repeat message is enabled. |
| tags.timeOutRepeatMessage.timeoutDuration | String | If 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.messageType | String | If tags.timeOutRepeatMessage.enabled:true, the timout repeat message type which should be one of the following: - general (General Message) - buttons (Button) - quickreply (Quick Reply) |
| tags.timeOutRepeatMessage.message.title | String | If tags.timeOutRepeatMessage.enabled:true, the timout repeat message's title |
| tags.timeOutRepeatMessage.message.description | String | If tags.timeOutRepeatMessage.enabled:true, the timout repeat message's description |
| tags.timeOutRepeatMessage.attachment | String | If tags.timeOutRepeatMessage.enabled:true, the timout repeat message's attachment URL |
| tags.timeOutRepeatMessage.buttons | Array | It 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 or quickreply |
| tags.timeOutRepeatMessage.buttons.buttonName | String | When tags.timeOutRepeatMessage.messageType:buttons or quickreply, buttonName:(The message's button name) |
| tags.timeOutRepeatMessage.buttons.buttonType | String | When tags.timeOutRepeatMessage.messageType:buttons or quickreply, buttonType:(A list of button type which should be one of the following: - openLink(Open Link) - transferTag (Transfer) - transferStaff(Transfer) - closeInquiry(Close Enquiry)) |
| tags.timeOutRepeatMessage.buttons.buttonURL | String | When tags.timeOutRepeatMessage.messageType:buttons or quickreply, buttonURL:(URL of openLink) |
| tags.timeOutRepeatMessage.buttons.tag | String | When tags.timeOutRepeatMessage.messageType:buttons or quickreply, tag:(Tag ID when the button type is transferTag) |
| tags.timeOutRepeatMessage.buttons.staff | String | When tags.timeOutRepeatMessage.messageType:buttons or quickreply, staff: (Staff ID when the button type is transferStaff) |
| tags.transferFailedMessage.enabled | Boolean | If value=false, the transfer failed message is disabled. If value=true, the transfer failed message is enabled. |
| tags.transferFailedMessage.messageType | String | When tags.transferFailedMessage.enabled:true, the timout repeat message type which should be one of the following: - general (General Message) - buttons (Button) - quickreply (Quick Reply) |
| tags.transferFailedMessage.message.title | String | When tags.transferFailedMessage.enabled:true, the transfer failed message's title |
| tags.transferFailedMessage.message.description | String | When tags.transferFailedMessage.enabled:true, the transfer failed message's description |
| tags.transferFailedMessage.message.attachment | String | When tags.transferFailedMessage.enabled:true, the transfer failed message's attachment URL |
| tags.transferFailedMessage.buttons | Array | It 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 or quickreply |
| tags.transferFailedMessage.buttons.buttonName | String | When tags.transferFailedMessage.messageType:buttons or quickreply, buttonName:(The message's button name) |
| tags.transferFailedMessage.buttons.buttonType | String | When tags.transferFailedMessage.messageType:buttons or quickreply, buttonType:(button type which should be one of the following: - openLink(Open Link) - transferTag (Transfer) - transferStaff(Transfer) - closeInquiry(Close Enquiry)) |
| tags.transferFailedMessage.buttons.buttonURL | String | When tags.transferFailedMessage.messageType:buttons or quickreply, buttonURL:(URL of openLink) |
| tags.transferFailedMessage.buttons.tag | String | When tags.transferFailedMessage.messageType:buttons or quickreply, tag:(Tag ID when the button type is transferTag) |
| tags.transferFailedMessage.buttons.staff | String | When tags.transferFailedMessage.messageType:buttons orquickreply, staff:(Staff ID when the button type is transferStaff) |
| tags.closingMessage.enabled | Boolean | If value=false, the close enquiry message is disabled. If value=true, the close enquiry message is enabled. |
| tags.closingMessage.messageType | String | If tags.closingMessage.enabled:true, the close enquiry message type which should be general (General Message) or buttons (Button). |
| tags.closingMessage.message.title | String | If tags.closingMessage.enabled:true, the close enquiry message's title. |
| tags.closingMessage.message.description | String | If tags.closingMessage.enabled:true, the close enquiry message's description. |
| tags.closingMessage.attachment | String | If tags.closingMessage.enabled:true, the the close enquiry message's attachment URL. |
| tags.closingMessage.buttons | Array | It shows the status of the closing message button including button name, button type and button URL when tags.closingMessage.messageType:buttons. |
| tags.closingMessage.buttons.buttonType | String | When tags.closingMessage.messageType:buttons, tags.closingMessage.buttons.buttonType:openLink (Open Link). |
| tags.closingMessage.buttons.buttonName | String | When tags.closingMessage.messageType:buttons, tags.closingMessage.buttons.buttonName:(The message's button name). |
| tags.closingMessage.buttons.buttonURL | String | When tags.closingMessage.messageType:buttons, closingMessage.buttons.buttonURL:(URL of openLink) |
| tags.routingRule.alternativeRouting.alternativeDestinations | Array | A list of destination ID for the alternative routing |
| tags.routingRule.timeRouting.schedules.days | Array | A list of the scheduled day of the time routing. Value= Monday, Tuesday, Wednesday, Thursday, Friday, Saturday and/or Sunday. |
| tags.routingRule.timeRouting.schedules.from | String | It 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.to | String | It 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.destinations | Array | It is a list of destination ID of the time schedule |
| tags.routingRule.timeRouting.schedules.subPercentageRouting.schedules.percentage | Integer | Return when the percentage layer added. It is the percentage of the distribution of the incoming enquiries. |
| tags.routingRule.timeRouting.schedules.subPercentageRouting.schedules.destinations | Array | Return 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.destinations | Array | Return 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.destinations | Array | Return 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.percentage | Integer | When Percentage routing has been selected. It is the percentage of the distribution of the incoming enquiries. |
| tags.routingRule.percentageRouting.schedules.destinations | Array | It is a list of destination ID of the percentage schedule |
| tags.routingRule.percentageRouting.schedules.subTimeRouting.schedules.days | Array | When 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.from | String | When 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.to | String | When 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.destinations | Array | When 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.destinations | Array | When 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.destinations | Array | When 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.stickyRouting | Boolean | Value = 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.chatURL | String | The chat URL of the tag |
| tags.callURL | String | The call URL of the tag |
| tags.metaData | Array | A list of keywords to be triggered as criteria to show or hide the tag. |
| tags.customChannelInfo.enabled | Boolean | Value = true (enable the custom channel info) Value = false (disable the custom channel info) |
| tags.customChannelInfo.description | String | The 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.
- tags.timeOutRepeatMessage.buttons.staff will only be shown when the user selects the transfer as the button type and the staff name as the destination in the idle message setting.
- tags.timeOutRepeatMessage.buttons.tag will only be shown when the user selects the transfer as the button type and the tag name as the destination in the idle message setting.
- tags.transferFailedMessage.buttons.staff will only be shown when the user selects the transfer as the button type and the staff name as the destination in the transfer failed message setting.
- tags.transferFailedMessage.buttons.tag will only be shown when the user selects the transfer as the button type and the tag name as the destination in the transfer failed message setting.