Teaser API

Get List Teaser Management

GET [server] /dolphin/apiv1/graph/teaser

This API is used to retrieve the list of all available teasers.

Headers

Name

Value

Content-Type

application/json

Authorization

Bearer <token>

Response

{
  "status": "success",
  "data": [
    {
      "id": "[teaser_id]",
      "spell": [
        "[title]",
        "Saat ini terjadi kendala pembelian atau pendaftaran voucher internet. Kendala ini sedang dalam penanganan. Mohon ditunggu ya."
      ],
      "owner": "[system_id]",
      "createdDate": 1757412141056,
      "createdBy": "[user/system_id]",
      "modifiedDate": 1757412141056,
      "modifiedBy": "[user/system_id]",
      "partial": null,
      "category": "Alert",
      "title": "[title]",
      "description": "Saat ini terjadi kendala pembelian atau pendaftaran voucher internet. Kendala ini sedang dalam penanganan. Mohon ditunggu ya.",
      "channels": [
        "9f4b9d9764adc4541978abdca27fb38d"
      ],
      "status": "active",
      "pictureLink": "null",
      "picturePublicLink": null,
      "iconLink": null,
      "iconPublicLink": null,
      "publishedDateInfo": 1757412141056,
      "publishedDate": null,
      "publishedEndDate": null,
      "color": "#FDB934",
      "showDialog": false,
      "dialogMessage": null,
      "dialogTimeout": 0,
      "dialogTheme": null,
      "deleted": null,
      "name": "1",
      "popupBannerTimeout": 5
    }
  ]
}

{
  "status": 401, 
  "title": "Invalid token", 
  "message": "Last unit does not have enough valid bits", 
  "path": "/dolphin/apiv1/graph/teaser" 
}

This is explanation about component body response field:

Name

Description

status

Indicates the result of the request contained in the request body.

data

Indicates the array list of teaser data.

Indicates the unique identifier for each teaser.

spell

Teaser title and body.

owner

ID of the owner who created the teaser.

createdDat e

Creation timestamp in millisecond.

createdBy

User ID of the creator.

modifiedDa te

Last modified timestamp in milliseconds.

modifiedBy

User ID of the last person who modified the template.

partial

If set to true, it means that only specific fields are being updated, not the entire data.

hash

A unique value that serves as an identifier to ensure that the data remains unchanged.

category

Teaser category.

title

Represents the teaser header that will be displayed.

description

Description of teaser. Note: Max. 350 character

channels

List of channel IDs the teaser attached.

status

Status of the teaser.

pictureLink

Internal link to picture asset.

Note: The image ratio for the pop-up banner is 5:2

picturePubli cLink

Public URL to the picture.

iconLink

Internal link to icon asset.

iconPublicLi nk

Public url to the icon.

publishDate Info

Indicates date when the teaser published.

publishedD ate

Indicates the start date when teaser will be activated.

publishedE ndDate

Indicates the start date when teaser will be deactivated.

color

Theme color used for teaser display.

showDialog

To show a pop up notification upon the consumer closing the teaser.

dialogMess age

Message to show in the dialog (if enabled).

dialogTime out

Timeout duration for dialog.

dialogThem e

Theme color used for dialog teaser display.

deleted

Indicates this teaser already deleted or not (soft delete from UI).

name

It represents the teaser name that serves as a unique name or identifier for the teaser within the system.

popupBann erTimeout

Indicates the duration (in seconds) that determines how long a popup banner will be displayed on the screen before the user clicks the ‘Lanjut Chat’ or ‘End Chat’ button.

Get Teaser Active

GET [server] /dolphin/apiv1/graph/teaser/active

This API is used to retrieve a list of active teasers based on category and channel ID.

Headers

Name

Value

Content-Type

application/json

Authorization

Bearer <token>

Query Parameter

Name

Type

Description

category

string

This field to filter active teaser based on their categories.

channelId

string ID

This field filters active teasers according to the specified channel.

Response

{
  "status": "success",
  "data": [
    {
      "id": "[teaser_id]",
      "spell": null,
      "owner": "[system_id]",
      "createdDate": 1694412868982,
      "createdBy": "[user/system_id]",
      "modifiedDate": null,
      "modifiedBy": "[user/system_id]",
      "partial": null,
      "category": "Alert",
      "title": "Gangguan Layanan Voice",
      "description": "<p>Saat ini sedang terjadi kendala pada layanan telepon. Mohon kesabarannya selama kendala ini dalam penanganan ya.</p>",
      "channels": null,
      "status": null,
      "pictureLink": null,
      "picturePublicLink": null,
      "iconLink": null,
      "iconPublicLink": null,
      "publishedDateInfo": null,
      "publishedDate": null,
      "publishedEndDate": null,
      "color": "#FF0000",
      "showDialog": false,
      "dialogMessage": null,
      "dialogTimeout": 0,
      "dialogTheme": null,
      "deleted": null,
      "name": "Teaser Alert 2",
      "popupBannerTimeout": 1
    }
  ]
}

{
  "status": 401, 
  "title": "Invalid token", 
  "message": "Last unit does not have enough valid bits", 
  "path": "/dolphin/apiv1/graph/teaser" 
}

This is explanation about component body response field:

Name

Description

status

Indicates the result of the request contained in the request body.

data

Indicates the array list of teaser data.

Indicates the unique identifier for each teaser.

spell

Teaser title and body.

owner

ID of the owner who created the teaser.

createdDat e

Creation timestamp in millisecond.

createdBy

User ID of the creator.

modifiedDa te

Last modified timestamp in milliseconds.

modifiedBy

User ID of the last person who modified the template.

partial

If set to true, it means that only specific fields are being updated, not the entire data.

hash

A unique value that serves as an identifier to ensure that the data remains unchanged.

category

Teaser category.

title

Represents the teaser header that will be displayed.

description

Description of teaser. Note: Max. 350 character

channels

List of channel IDs the teaser attached.

status

Status of the teaser.

pictureLink

Internal link to picture asset.

Note: The image ratio for the pop-up banner is 5:2

picturePubli cLink

Public URL to the picture.

iconLink

Internal link to icon asset.

iconPublicLi nk

Public url to the icon.

publishDate Info

Indicates date when the teaser published.

publishedD ate

Indicates the start date when teaser will be activated.

publishedE ndDate

Indicates the start date when teaser will be deactivated.

color

Theme color used for teaser display.

showDialog

To show a pop up notification upon the consumer closing the teaser.

dialogMess age

Message to show in the dialog (if enabled).

dialogTime out

Timeout duration for dialog.

dialogThem e

Theme color used for dialog teaser display.

deleted

Indicates this teaser already deleted or not (soft delete from UI).

name

It represents the teaser name that serves as a unique name or identifier for the teaser within the system.

popupBann erTimeout

Indicates the duration (in seconds) that determines how long a popup banner will be displayed on the screen before the user clicks the ‘Lanjut Chat’ or ‘End Chat’ button.

Get Teaser By ID

GET [server]/ dolphin/apiv1/graph/teaser/[teaser_id]

This API is used to retrieve a teaser based on its teaser ID.

Headers

Name

Value

Content-Type

application/json

Authorization

Bearer <token>

Query Parameter

Name

Type

Description

teaserId

string ID

A unique identifier used to represent a specific teaser.

Response

{
  "status": "success",
  "data": {
    "id": "[teaser_id]",
    "spell": null,
    "owner": "[system_id]",
    "createdDate": 1757412141056,
    "createdBy": "[user/system_id]",
    "modifiedDate": 1757412141056,
    "modifiedBy": "[user/system_id]",
    "partial": null,
    "category": "Alert",
    "title": "[title]",
    "description": "Saat ini terjadi kendala pembelian atau pendaftaran voucher internet. Kendala ini sedang dalam penanganan. Mohon ditunggu ya.",
    "channels": [
      "9f4b9d9764adc4541978abdca27fb38d"
    ],
    "status": "active",
    "pictureLink": "null",
    "picturePublicLink": null,
    "iconLink": null,
    "iconPublicLink": null,
    "publishedDateInfo": 1757412141056,
    "publishedDate": null,
    "publishedEndDate": null,
    "color": "#FDB934",
    "showDialog": false,
    "dialogMessage": null,
    "dialogTimeout": 0,
    "dialogTheme": null,
    "deleted": null,
    "name": "1",
    "popupBannerTimeout": 5
    }
  }
}

{ 
  "status": 401, 
  "title": "Invalid token", 
  "message": "Last unit does not have enough valid bits", 
  "path": "/dolphin/apiv1/graph/teaser/9617f02fcac3060d3be3ee79b4157827" 
}

{ 
  "status": "error", 
  "data": null, 
  "message": "Teaser not found" 
}

This is explanation about component body response field:

Name

Description

status

Indicates the result of the request contained in the request body.

data

Indicates the array list of teaser data.

Indicates the unique identifier for each teaser.

spell

Teaser title and body.

owner

ID of the owner who created the teaser.

createdDat e

Creation timestamp in millisecond.

createdBy

User ID of the creator.

modifiedDa te

Last modified timestamp in milliseconds.

modifiedBy

User ID of the last person who modified the template.

partial

If set to true, it means that only specific fields are being updated, not the entire data.

hash

A unique value that serves as an identifier to ensure that the data remains unchanged.

category

Teaser category.

title

Represents the teaser header that will be displayed.

description

Description of teaser. Note: Max. 350 character

channels

List of channel IDs the teaser attached.

status

Status of the teaser.

pictureLink

Internal link to picture asset.

Note: The image ratio for the pop-up banner is 5:2

picturePubli cLink

Public URL to the picture.

iconLink

Internal link to icon asset.

iconPublicLi nk

Public url to the icon.

publishDate Info

Indicates date when the teaser published.

publishedD ate

Indicates the start date when teaser will be activated.

publishedE ndDate

Indicates the start date when teaser will be deactivated.

color

Theme color used for teaser display.

showDialog

To show a pop up notification upon the consumer closing the teaser.

dialogMess age

Message to show in the dialog (if enabled).

dialogTime out

Timeout duration for dialog.

dialogThem e

Theme color used for dialog teaser display.

deleted

Indicates this teaser already deleted or not (soft delete from UI).

name

It represents the teaser name that serves as a unique name or identifier for the teaser within the system.

popupBann erTimeout

Indicates the duration (in seconds) that determines how long a popup banner will be displayed on the screen before the user clicks the ‘Lanjut Chat’ or ‘End Chat’ button.

Add Teaser Management

POST [server]/ dolphin/apiv1/graph/teaser/add

This API is used to add or create a new teaser.

Headers

Name

Value

Content-Type

application/json

Authorization

Bearer <token>

Body Request

{
  "category": "string",
  "channels": "string",
  "color": "string",
  "deleted": true,
  "description": "string",
  "dialogMessage": "string",
  "dialogTheme": "string",
  "dialogTimeout": 0,
  "iconLink": "string",
  "name": "string",
  "pictureLink": "string",
  "popupBannerTimeout": 0,
  "publishedDate": "string",
  "publishedDateInfo": "string",
  "publishedEndDate": "string",
  "showDialog": true,
  "status": "string",
  "title": "string"
}

This is explanation about component body request field:

Name

Type

Description

category

string

Insert the teaser category

channels

array of string

Add channel IDs the teaser will attached.

color

string

Theme color used for teaser display.

description

string

Description of teaser.

Note: Max. 350 characters.

dialogMessag e

string

Message to show in the dialog (if field showDialog is true).

dialogTheme

string

Theme color used for message dialog display (if field showDialog is true).

dialogTimeou t

integer

Timeout duration for message dialog.

name

string

It represents the teaser name that serves as a unique name or identifier for the teaser within the system.

pictureLink

string/ null

Internal link to picture asset.

Note: The image ratio for the pop-up banner is 5:2

popupBanner Timeout

integer

Indicates the duration (in seconds) that determines how long a popup banner will be displayed on the screen before the user clicks the ‘Lanjut Chat’ or ‘End Chat’ button.

publishedDat e

integer

Indicates the start date when teaser will be activated.

publishDateIn fo

integer

Indicates date when the teaser published.

publishedEnd Date

integer

Indicates the start date when teaser will be deactivated.

showDialog

boolea n

To show a pop -up notification upon the consumer closing the teaser.

status

string

Status of the teaser.

title

string

Represents the teaser header that will be displayed.

Response

{
  "status": "success",
  "data": {
    "id": "[teaser_id]",
    "spell": null,
    "owner": "[system_id]",
    "createdDate": 1757412141056,
    "createdBy": "[user/system_id]",
    "modifiedDate": 1757412141056,
    "modifiedBy": "[user/system_id]",
    "partial": null,
    "category": "Alert",
    "title": "info gangguan terkini",
    "description": "Maaf sedang terjadi gangguan",
    "channels": [
      "9f4b9d9764adc4541978abdca27fb38d"
    ],
    "status": "active",
    "pictureLink": "null",
    "picturePublicLink": null,
    "iconLink": null,
    "iconPublicLink": null,
    "publishedDateInfo": 1757412141056,
    "publishedDate": null,
    "publishedEndDate": null,
    "color": "#FFFF00",
    "showDialog": true,
    "dialogMessage": "Terima kasih sudah menghubungi kami",
    "dialogTimeout": 3,
    "dialogTheme": "#00DAA5",
    "deleted": null,
    "name": "gangguan 24 jam",
    "popupBannerTimeout": 0
  }
}

{ 
  "status": 401, 
  "title" : "invalid token",
  "message" : "Expected a ',' or '}' at 27 [character 28 line 1]",
  "path": "/dolphin/apiv1/graph/teaser/add"
}

{ 
  "status": "error", 
  "data": null, 
  "message": "Only one field attachment can be filled at a time." 
}

This is explanation about component body response field:

Name

Description

status

Indicates the result of the request contained in the request body.

data

Indicates the array list of teaser data.

Indicates the unique identifier for each teaser.

spell

Teaser title and body.

owner

ID of the owner who created the teaser.

createdDat e

Creation timestamp in millisecond.

createdBy

User ID of the creator.

modifiedDa te

Last modified timestamp in milliseconds.

modifiedBy

User ID of the last person who modified the template.

partial

If set to true, it means that only specific fields are being updated, not the entire data.

hash

A unique value that serves as an identifier to ensure that the data remains unchanged.

category

Teaser category.

title

Represents the teaser header that will be displayed.

description

Description of teaser. Note: Max. 350 character

channels

List of channel IDs the teaser attached.

status

Status of the teaser.

pictureLink

Internal link to picture asset.

Note: The image ratio for the pop-up banner is 5:2

picturePubli cLink

Public URL to the picture.

iconLink

Internal link to icon asset.

iconPublicLi nk

Public url to the icon.

publishDate Info

Indicates date when the teaser published.

publishedD ate

Indicates the start date when teaser will be activated.

publishedE ndDate

Indicates the start date when teaser will be deactivated.

color

Theme color used for teaser display.

showDialog

To show a pop up notification upon the consumer closing the teaser.

dialogMess age

Message to show in the dialog (if enabled).

dialogTime out

Timeout duration for dialog.

dialogThem e

Theme color used for dialog teaser display.

deleted

Indicates this teaser already deleted or not (soft delete from UI).

name

It represents the teaser name that serves as a unique name or identifier for the teaser within the system.

popupBann erTimeout

Indicates the duration (in seconds) that determines how long a popup banner will be displayed on the screen before the user clicks the ‘Lanjut Chat’ or ‘End Chat’ button.

Edit Teaser Management

PUT [server]/ dolphin/apiv1/graph/teaser/edit/[teaser_id]

This API used to edit teaser management that already exists. This API also supports activating and deactivating existing teasers. In the request body, you can edit specific fields as needed.

Headers

Name

Value

Content-Type

application/json

Authorization

Bearer <token>

Body

{
  "category": "string",
  "channels": "string",
  "color": "string",
  "deleted": true,
  "description": "string",
  "dialogMessage": "string",
  "dialogTheme": "string",
  "dialogTimeout": 0,
  "iconLink": "string",
  "name": "string",
  "pictureLink": "string",
  "popupBannerTimeout": 0,
  "publishedDate": "string",
  "publishedDateInfo": "string",
  "publishedEndDate": "string",
  "showDialog": true,
  "status": "string",
  "title": "string"
}

This is explanation about component body request field:

Name

Type

Description

category

string

Request to update the teaser category based on teaserId.

channel

array of string

Request to update the teaser channels based on teaserId.

color

string

Request to update the main color of the teaser based on teaserId.

deleted

Boolean /null

Indicates this teaser already deleted or not.

description

string

Request to update the teaser description based on teaserId. Note: Max. 350 characters.

dialogMessage

string

Request to update the dialog message displayed in the teaser based on teaserId.

dialogTheme

String

Request to update the dialog theme of the teaser

dialogTimeout

integers

Request to update the dialog duration (in seconds) based on teaserId.

iconLink

String/n ull

Request to update the teaser icon (URL) based on teaserId.

name

string

Request to update the name of the teaser based on teaserId that serves as a unique name or identifier for the teaser within the system.

pictureLink

String/n ull

Request to update the teaser image (URL) based on teaserId.

Note: The image ratio for the pop-up banner is 5:2

popupBannerTimeout

integer

Request to update the popup banner duration (in seconds) based on teaserId.

publishedDate

integer

Request to update the start date of teaser publication based on teaserId.

publishedDateInfo

integer

Indicates date when the teaser published.

publishedEndDate

Integer

Request to update the end date of teaser publication based on teaserId.

showDialog

Boolean

Request to update whether the teaser is displayed as a dialog pop-up based on teaserId.

status

string

Request to update the teaser status based on teaserId.

title

string

Request to update the teaser header based on teaserId that will be displayed.

Response

{
  "status": "success",
  "data": {
      "id": "[teaser_id]",
      "spell": [
        "Pemberitahuan Gangguan Jaringan",
        "<p>Gangguan jaringan sementara di wilayah Anda. Tim kami sedang bekerja memperbaiki.</p>"
      ],
      "owner": "[system_id]",
      "createdDate": 1755599593771,
      "createdBy": "[user/system_id]",
      "modifiedDate": 1755668189488,
      "modifiedBy": "[user/system_id]",
      "partial": null,
      "category": "Alert",
      "title": "Pemberitahuan Gangguan Jaringan",
      "description": "<p>Gangguan jaringan sementara di wilayah Anda. Tim kami sedang bekerja memperbaiki.</p>",
      "channels": [
        "f592b319b4b8dd2aa221cfba3c8f84c2"
      ],
      "status": "active",
      "pictureLink": "{\"fileName\":\"teaser_1755599545667_Alert.png\",\"fileSize\":\"1005Kb\",\"fileType\":\"image/png\",\"fileLink\":\"https://minioxldev.3dolphins.ai:9000/teaser/teaser_1755599545667_Alert.png?X-Amz-Algorithm\\u003dAWS4-HMAC-SHA256\\u0026X-Amz-Credential\\u003dFAKCZ3B3ZP1WJ4G0I6BP%2F20250819%2Fus-east-1%2Fs3%2Faws4_request\\u0026X-Amz-Date\\u003d20250819T103225Z\\u0026X-Amz-Expires\\u003d604800\\u0026X-Amz-SignedHeaders\\u003dhost\\u0026X-Amz-Signature\\u003d7f815035f278e62ab8bb8ae4ba358f98cf0d60fae62d1ce717bc2834726e4224\",\"bucketName\":\"teaser\"}",
      "picturePublicLink": null,
      "iconLink": null,
      "iconPublicLink": null,
      "publishedDateInfo": 1755599593771,
      "publishedDate": null,
      "publishedEndDate": null,
      "color": "#03A6FF",
      "showDialog": false,
      "dialogMessage": "",
      "dialogTimeout": 0,
      "dialogTheme": "",
      "deleted": null,
      "name": "Teaser Alert 1",
      "popupBannerTimeout": 3
    }
}

{
  "status": 401, 
  "title": "Invalid token", 
  "message": "Expected a ':' after a key at 14 [character 15 line 1]", 
  "path": "/dolphin/apiv1/graph/teaser/edit/9617f02fcac3060d3be3ee79b4157827" 
}

{
  "status": 401, 
  "title": "Invalid token", 
  "message": "Expected a ':' after a key at 14 [character 15 line 1]", 
  "path": "/dolphin/apiv1/graph/teaser/edit/9617f02fcac3060d3be3ee79b4157827" 
}

This is explanation about component body response field:

Name

Description

status

Indicates the result of the request contained in the request body.

data

Indicates the array list of teaser data.

Indicates the unique identifier for each teaser.

spell

Teaser title and body.

owner

ID of the owner who created the teaser.

createdDat e

Creation timestamp in millisecond.

createdBy

User ID of the creator.

modifiedDa te

Last modified timestamp in milliseconds.

modifiedBy

User ID of the last person who modified the template.

partial

If set to true, it means that only specific fields are being updated, not the entire data.

hash

A unique value that serves as an identifier to ensure that the data remains unchanged.

category

Teaser category.

title

Represents the teaser header that will be displayed.

description

Description of teaser. Note: Max. 350 character

channels

List of channel IDs the teaser attached.

status

Status of the teaser.

pictureLink

Internal link to picture asset.

Note: The image ratio for the pop-up banner is 5:2

picturePubli cLink

Public URL to the picture.

iconLink

Internal link to icon asset.

iconPublicLi nk

Public url to the icon.

publishDate Info

Indicates date when the teaser published.

publishedD ate

Indicates the start date when teaser will be activated.

publishedE ndDate

Indicates the start date when teaser will be deactivated.

color

Theme color used for teaser display.

showDialog

To show a pop up notification upon the consumer closing the teaser.

dialogMess age

Message to show in the dialog (if enabled).

dialogTime out

Timeout duration for dialog.

dialogThem e

Theme color used for dialog teaser display.

deleted

Indicates this teaser already deleted or not (soft delete from UI).

name

It represents the teaser name that serves as a unique name or identifier for the teaser within the system.

popupBann erTimeout

Indicates the duration (in seconds) that determines how long a popup banner will be displayed on the screen before the user clicks the ‘Lanjut Chat’ or ‘End Chat’ button.

Delete Teaser

DELETE [server]/ dolphin/apiv1/graph/teaser/delete/[teaser_id]

This API is used to delete a previously created teaser.

Headers

Name

Value

Content-Type

application/json

Authorization

Bearer <token>

Query Parameter

Name

Type

Description

teaserId

string

A unique identifier used to represent a specific teaser.

Response

 {
  "status": "success",
  "data": "Delete Success"
}

{ 
  "status": 401, 
  "title": "Invalid token", 
  "message": "Illegal escape. at 17 [character 18 line 1]", 
  "path": "/dolphin/apiv1/graph/teaser/delete/e848dd78319f2542751d6316552b532a" 
}

{ 
  "status": "error", 
  "data": null, 
  "message": "not found" 
}

This is explanation about component body response field:

Name

Description

status

Indicates the result of the request.

data

Indicates that the delete status was successful.

PreviousTask API NextBot API

Last updated 47 minutes ago

Was this helpful?