NicoChatNicoChatDocumentaçãoBuscar na documentação…
Entrar

Actions - Formatos

A propriedade actions da resposta do servidor é opcional.

2026-08-12

Ação adicionar tag

Use esta resposta para adicionar uma tag a um inscrito. Uma tag com o mesmo nome precisa existir no seu canal:

texto
{
  "version": "v1",
  "content": {
    "messages": [
      {
        "type": "text",
        "text": "simple text with button",
        "buttons": [
          {
            "type": "url",
            "caption": "External link",
            "url": "https://NicoChat.com.au"
          }
        ]
      }
    ],
    "actions": [
      {
        "action": "add_tag",
        "tag_name": "your tag",
      }
    ],
    "quick_replies": []
  }
}

O nome da tag enviado no parâmetro tag_name deve corresponder a uma das tags existentes no canal do NicoChat

Ação remover tag

Use esta resposta para remover uma tag de um inscrito. Uma tag com o mesmo nome precisa existir no seu canal:

texto
{
  "version": "v1",
  "content": {
    "messages": [
      {
        "type": "text",
        "text": "simple text with button",
        "buttons": [
          {
            "type": "url",
            "caption": "External link",
            "url": "https://NicoChat.com.au"
          }
        ]
      }
    ],
    "actions": [
      {
        "action": "remove_tag",
        "tag_name": "your tag",
      }
    ],
    "quick_replies": []
  }
}

Ação definir o valor do campo do inscrito

Use esta resposta para definir o valor do campo do inscrito. Um campo personalizado com o mesmo nome precisa existir no seu canal

texto
{
  "version": "v1",
  "content": {
    "messages": [
      {
        "type": "text",
        "text": "simple text with button",
        "buttons": [
          {
            "type": "url",
            "caption": "External link",
            "url": "https://NicoChat.com.au"
          }
        ]
      }
    ],
    "actions": [
      {
        "action": "set_field_value",
        "field_name": "your field name",
        "value": "some value"
      }
    ],
    "quick_replies": []
  }
}

O nome do campo enviado em field_name deve corresponder ao nome de um dos campos personalizados existentes no canal do NicoChat. Você precisa controlar o tipo de dado registrado nos campos personalizados: o tipo do dado deve corresponder ao tipo do campo personalizado.

Use os seguintes formatos de valor:

  • Para o tipo de campo Number, o valor deve ser numérico, como 2 ou 3.14, sem aspas duplas;
  • Para o tipo de campo Text, o valor deve ser enviado como texto: "some text";
  • Para o tipo de campo Date, o valor deve ser enviado como texto com a data no formato YYYY-MM-DD, ou seja, "2018-03-25";
  • Para o tipo de campo Date Time, o valor deve ser enviado como texto com a data no formato ISO8601 UTC, ou seja, "2018-03-25T13:25:00.000Z"

Ação limpar o valor do campo do inscrito

Use esta resposta para limpar (apagar) o valor do campo do inscrito. Um campo personalizado com o mesmo nome precisa existir no seu canal

texto
{
  "version": "v1",
  "content": {
    "messages": [
      {
        "type": "text",
        "text": "simple text with button",
        "buttons": [
          {
            "type": "url",
            "caption": "External link",
            "url": "https://NicoChat.com.au"
          }
        ]
      }
    ],
    "actions": [
      {
        "action": "unset_field_value",
        "field_name": "your field name"
      }
    ],
    "quick_replies": []
  }
}