# 斜杠指令帮助文档

# 什么是斜杠指令？

斜杠指令允许用户通过在消息编辑器框中输入字符串来调用您的应用。启用斜杠命令后，用户在以下场景可以使用斜杠命令

与应用机器人单聊时
应用机器人在群聊中，在群聊内会展示该机器人的所有指令

# 创建斜杠指令

在开发者后台 (opens new window)-应用能力-更多能力中，找到斜杠指令配置入口，点击开关打开

需确保机器人能力已开启

根据页面提示添加新指令字段

字段	说明	填写要求
指令名称	命令名称通常是描述性的、简单的，这样可以让用户轻松记住	1. 以“/”开头且“/” 不可被删除 2. 25字符以内 3. 不能包含空格 4. 同一应用下指令名称不能重复
指令描述	对您的指令功能的简短描述	25字符以内
使用提示	如果您有任何可用于命令的参数，我们建议在此处给到一些建议	25字符以内
指令类型	用户触发指令的方式	1. 无需输入立即生效 2. 用户输入内容后生效（当前仅支持此类型，需要用户选中指令后，手动发送才算触发指令）
回调地址	当用户调用命令时，我们会将用户输入的内，以json结构`（参考下面回调信息示例）`发送至该 URL	1. 需要为http/https开头 2. 保存时会向该地址发送请求（请求内包含challenge值），若1s内未返回HTTP200和challenge值，则视为请求失败

配置可见性

在单聊中，指令可用性同应用可见性

在群聊中，机器人在群内时，群内所有用户都可以使用指令

# 斜杠指令交互

一个平台建议的斜杠指令流程如下

用户使用斜杠命令，输入内容后发送消息
开放平台向应用发出HTTP请求，请在1s内响应HTTP200
执行其他操作，如：向用户推送消息卡片等（非必须，但建议给到用户一定反馈）

# 回调信息示例

事件json各字段参考文档>>>

{
    "schema": "1.0",
    "header": {
        "event_id": "5e3702a84e847582be8db7fb73283c02",
        "create_time": "1608725989000",
        "token": "rvaYgkND1GOiu5MM0E1rncYC6PLtF7JV",
        "app_id": "bli_9f5343c580712544",
        "tenant_key": "2ca1d211f64f6438"
    },
    "event": {
        "sender": {
            "sender_id": {
                "union_id": "on_8ed6aa67826108097d9ee143816345",
                "user_id": "1122334455",
                "open_id": "ou_84aad35d084aa403a838cf73ee18467"
            },
            "sender_type": "user",
            "tenant_key": "736588c9260f175e~"
        },
        "message": {
            "message_id": "5ce6d572455d361153b7cb51da133945~",
            "root_id": "5ce6d572455d361153b7cb5xxfsd~",
            "parent_id": "5ce6d572455d361153b7cb5xx~",
            "create_time": "1609073151345",
            "chat_id": "5ce6d572455d361153b7xN~",
            "chat_type": "group",
            // 指令id
            "command_id":"5ce6d572455d361153b7cb51da133945",
            // 指令名字
            "command_name":"/reset",
            "platform":"1",
            "message_type": "text",
            "content": "{\"text\":\"@_user_1 hello\"}",
            "mentions": [
                {
                    "key": "@_user_1",
                    "id": {
                        "union_id": "on_8ed6aa67826108097d9ee143816345",
                        "user_id": "1122334455",
                        "open_id": "ou_84aad35d084aa403a838cf73ee18467"
                    },
                    "name": "Tom",
                    "tenant_key": "736588c9260f175e~"
                }
            ]
        }
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

# 给到用户响应

2、3步骤为非必须，可以根据您的实际业务场景判断是否需要执行步骤2/步骤3

确认您收到回调。

这是您必须要做的事情，否则我们将会告知用户本次请求失败

立即做一些有用的事情作为回应。

如：收到请求后立即调用接口向会话中发送消息卡片/回复用户

稍后做一些有用的事情作为回应。

← 自定义机器人指南