Support reply button in post message

[fabian4]

No description provided.

[fabian4]

How to fit the struct of reply button data into the post as a kind of sayable ?

const suggestion = [
    {
      reply:{
        displayText:'aaa',
      },
    },
    {
      action:{
        displayText:'Open website or deep link',
        urlAction:{
          openUrl:{
            application:'webview',
            url:'https://xxx.com',
            viewMode:'half',
          },
        },
      },
    },
    {
      action:{
        dialerAction:{
          dialPhoneNumber:{
            phoneNumber:'+8617xxxxxxxxx0',
          },
        },
        displayText:'Call a phone number',
      },
    },
  ]

• support 3 kinds of reply button for now
• each one needs 2 or 3 input params

Should I create another sayable type to fit it or take other actions

@su-chang @huan

[huan]

I think we need a new type of the Sayable: ‘ActionButton’

Could you please to do a research on the standard international RCS protocol, and reference the Action/Reply Button specifications and the data samples to here, so that we can have a better insight on it and design it in the right direction?

Thank you very much!

[fabian4]

There is only 3 kinds of buttons for now.

// reply text
{
  reply:{
    displayText:'aaa',
  },
}

// open link
{
  action:{
    displayText:'Open website or deep link',
    urlAction:{
      openUrl:{
        application:'webview',
        url:'https://xxx.com',
        viewMode:'half',
      },
    },
  },
}

// dial phone
{
  action:{
    dialerAction:{
      dialPhoneNumber:{
        phoneNumber:'+8617xxxxxxxxx0',
      },
    },
    displayText:'Call a phone number',
  },
}

[huan]

Thanks for the data sample.

Could you please also research the standard international RCS protocol and reference the Action/Reply Button specifications links here?

More details will be needed to design our API because we want to make sure it will be generalized and following the international standard protocol specs.

[fabian4]

here is almost all we got after the research

• https://github.com/wechaty/puppet-walnut/blob/main/docs/api-documentation-for-5G-platform.md#23
• https://github.com/wechaty/puppet-walnut/blob/main/docs/5g-message-service-platform-industry-customer-access-interface-specification.pdf

[leochen-g]

目前和 @fabian4 沟通下来，发现suggestion 有共性的地方是三种快捷数据类型都需要 displayText 和postback属性:

1、关于displayText

每张卡片内建议操作和 建议回复按钮总数量不超过4个。位于悬浮菜单的建议操作和建议回复按钮总数量不超过11 个。每个建议操作和每个建议回复的展示文字（DisplayText）最多为25个字符（Byte）。

2、关于postback 暂时觉得应该是回调之类的，具体测试的时候，发现快捷回复返回的数据是把整个reply或者action直接原样返回的。所以对这个postback 还不是很明确具体功能是什么， @IronConrad 康嘉老师有时间可以帮解释一下

关于三种快捷回复类型所必须的参数：

1、纯文字型快捷回复(reply)
必填：displayText

{
    "reply": {
        "displayText": "快捷回复展示文字",
        "postback": {
            "data": "set_by_chatbot_reply_no"
        }
    }
},

2、url链接类型(action)

必填：displayText 、url

其余参数puppet可以使用默认值即可

{
    "action": {
        "urlAction": {
            "openUrl": {
                "url": "https://www.10010.cn",
                "application": "webview",
                "viewMode": "half"
            }
        },
        "displayText": "Open website or deep link",
        "postback": {
            "data": "set_by_chatbot_open_url"
        }
    }
}

3、弹框类型，拨打电话（action）

必填：displayText 、phoneNumber

其余参数puppet可以使用默认值即可

{
    "action": {
        "dialerAction": {
            "dialPhoneNumber": {
                "phoneNumber": "+8617928222350"
            }
        },
        "displayText": "Call a phone number",
        "postback": {
            "data": "set_by_chatbot_open_dialer"
        }
    }
}

根据以上分析，其实可以归为两大类快捷回复，一个reply和一个action，action可以细分两个类型link和dialer.

puppet需要根据建议回复消息的回复类型进行判断，如下图

关于以上提到的分析如果有误的话，欢迎提出，另外也希望我们能够尽快推进快捷回复的落地，因为这个场景实现的功能点是挺吸引开发者的

[leochen-g]

目前能想到可以实现的调用方式如下，在post基础上继续链式构造：

个人初步设想，并不是很完善

this.Post.builder()
          .add(msg.title)
          .add(msg.description)
          .add(FileBox.fromUrl(msg.thumbUrl))
           .reply('快捷一')
           .reply('快捷二')
           .action({type: 'link', text: '快捷三',url:'https://wechaty.js.org/'})
           .action({type: 'dialer', text: '快捷4', contact:'172*******082'})
          .type(0)
          .build()