聊天应用程序接口文档
概述
聊天应用程序接口便于检索聊天机器人,并使用户能够通过发布信息与之互动。
基本 URL
https://app.openspokenai.com/api
认证
客户端必须使用基本授权标头对每次请求进行验证:
授权:基本 {authString}
其中 {authString} 是格式为 username:password 的 base64 编码字符串。
使用示例
curl -X GET "https://app.openspokenai.com/api/chat" -H "Authorization:Basic {authString}"
终点
GET /chat
读取可进行互动的活动聊天列表。
查询参数:
组(可选):按指定组过滤聊天。
成功回复:
{
"消息":"成功"、
"数据":[
{
"名称":"字符串"、
"chat_code":"string"(字符串)、
"description"(描述):"字符串"、
"组":"字符串"
}
]
}
未找到内容:
{
"消息":"错误"、
"数据":{
"消息":"未找到指定群组的聊天机器人"。
}
}
发送 /chat
向特定聊天发送信息并接收回复。
页眉:
Content-Type: 应用程序/json
授权:基本 {authString}
所需有效载荷:
prompt:(字符串)聊天回复的输入文本。
request_id:(字符串)用于跟踪请求的唯一 ID。
webhook_url(可选):(URL)通过 webhook 发送响应的端点。
成功回复:
{
"消息":"成功"、
"数据":{
"request_id":"string"(字符串)、
"信息":"字符串"
}
}
错误回复:
学分不足:
{
"消息":"错误"、
"数据":{
"信息":"您生成单词的点数已用完。请充值后再试一次"。
}
}
未找到聊天机器人:
{
"消息":"错误"、
"数据":{
"消息":"未找到聊天机器人"。
}
}
Webhook 失败:
{
"消息":"错误"、
"数据":{
"消息":"向网络钩子发送响应失败"。
}
}