用户发送消息 - AIRUDDER API

收到用户信息接口，对话使用call_id作为唯一标识，同一个渠道同一个用户同一个时间有且仅有一个活跃的对话

请求参数

Header 参数

X-AIRudder-Sign-Key

string

签名key

必需

示例值:

206c027f3767bab7ccdae625d416f526

X-AIRudder-Sign

string

签名值

必需

Body 参数application/json

channel

enum<string>

会话所属渠道

必需

枚举值:

HuaWei

channel_id

string

渠道id

必需

user

object

用户信息

必需

string

用户唯一标识

必需

name

string

用户名称

可选

messages

array [object {4}]

必需

消息信息，每次只支持1条消息

>= 1 items<= 1 items

type

enum<string>

消息类型

必需

枚举值:

textimagevideoaudiofileinteractive

text

string

文本消息内容

可选

media

object

媒体消息内容

可选

interactive

object

可选

点击interactive消息按钮信息

示例

{
    "channel": "chatbot",
    "channel_id": "sicepat_whatsapp",
    "user": {
        "id": "123",
        "name": "nick"
    },
    "messages": [
        {
            "type": "text",
            "text": "hi"
        },
        {
            "type": "image",
            "media": {
                "origin_url": "https://www.airudder.com/xxx.jpg"
            }
        },
        {
            "type": "video",
            "media": {
                "origin_url": "https://www.airudder.com/xxxx.mp4"
            }
        },
        {
            "type": "audio",
            "media": {
                "origin_url": "https://www.airudder.com/xxx.wav"
            }
        },
        {
            "type": "file",
            "media": {
                "origin_url": "https://www.airudder.com/xxx.pdf",
                "name": "xxx.pdf"
            }
        },
        {
            // 用户点击 interactive list 选项消息示例
            "type": "interactive",
            "interactive": {
                "type": "list_reply",
                "list_reply": {
                    "id": "3eeb467c935f6f2cb45021364ef3c1e8-3-1-list-0-0-",// 用户点击的选项对应的唯一标识
                    "title": "物流查询"// 用户点击的选项对应的文案
                }
            }
        },
        {
            // 用户点击 interactive button 选项消息示例
            "type": "interactive",
            "interactive": {
                "type": "button_reply",
                "button_reply": {
                    "id": "3eeb467c935f6f2cb45021364ef3c1e8-2-1-button-0-",// 用户点击的按钮对应的唯一标识
                    "title": "男"// 用户点击的按钮对应的文案
                }
            }
        }
    ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.airudder.com/api/v1/channel/airudder/message' \
--header 'X-AIRudder-Sign-Key: 206c027f3767bab7ccdae625d416f526' \
--header 'X-AIRudder-Sign;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "channel": "chatbot",
    "channel_id": "sicepat_whatsapp",
    "user": {
        "id": "123",
        "name": "nick"
    },
    "messages": [
        {
            "type": "text",
            "text": "hi"
        },
        {
            "type": "image",
            "media": {
                "origin_url": "https://www.airudder.com/xxx.jpg"
            }
        },
        {
            "type": "video",
            "media": {
                "origin_url": "https://www.airudder.com/xxxx.mp4"
            }
        },
        {
            "type": "audio",
            "media": {
                "origin_url": "https://www.airudder.com/xxx.wav"
            }
        },
        {
            "type": "file",
            "media": {
                "origin_url": "https://www.airudder.com/xxx.pdf",
                "name": "xxx.pdf"
            }
        },
        {
            // 用户点击 interactive list 选项消息示例
            "type": "interactive",
            "interactive": {
                "type": "list_reply",
                "list_reply": {
                    "id": "3eeb467c935f6f2cb45021364ef3c1e8-3-1-list-0-0-",// 用户点击的选项对应的唯一标识
                    "title": "物流查询"// 用户点击的选项对应的文案
                }
            }
        },
        {
            // 用户点击 interactive button 选项消息示例
            "type": "interactive",
            "interactive": {
                "type": "button_reply",
                "button_reply": {
                    "id": "3eeb467c935f6f2cb45021364ef3c1e8-2-1-button-0-",// 用户点击的按钮对应的唯一标识
                    "title": "男"// 用户点击的按钮对应的文案
                }
            }
        }
    ]
}'

返回响应

🟢200成功

application/json

Body

request_id

string

请求唯一标识

必需

code

integer

错误码

必需

message

string

错误说明

必需

data

object

必需

msg_id

string

消息id

必需

call_id

string

会话id

必需

示例

{
  "request_id": "7b50b74e5ec2910fe9b250c9fda7085e",
  "code": 200,
  "message": "success",
  "data": {
    "msg_id": "c98a99f32afab85d709ba23820fccccb",
    "call_id": "6cf8c876eeefdca168ae7a08cb93fe20"
  }
}