调用方式

开放平台接口调用是指向对话机器人平台服务端地址发送HTTP POST 请求，并按照接口说明在请求中加入相应请求参数，调用后系统会返回处理结果。

请求开放平台接口时，需要使用 HTTPS 协议、JSON 数据格式、UTF-8 编码，POST 请求需要在 HTTP Headers 中设置Content-Type : application/json。

API请求基础结构如下:

https://{Endpoint}/openapi/{version}/{action}

其中：

Endpoint: 服务接入地址为bot.aladdingo.com，如果私有部署则为对应服务器开放的接入地址。

version: 目前接口版本，目前是v1。

action: 要执行的操作，例如message，hello。

详细各个接口的调用结构可以在开放平台提供接口中查看。请求的鉴权是通过 HTTP Request Headers 里面包含的4个Api-Auth-xxx键值对来进行的，鉴权规则可以参考本文档中“开始开发-鉴权认证”部分。

curl命令示例：

curl -X POST https://bot.aladdingo.com/openapi/v1/message \  
-H 'api-auth-key: [鉴权值]' \  
-H 'api-auth-nonce: [鉴权值]' \  
-H 'api-auth-sign: [鉴权值]' \  
-H 'api-auth-timestamp: [鉴权值]' \  
-H 'Content-Type:application/json'  
-d '{ \  
    "sid": "xxx",      
    "user_id": "xxx",      
    "text":"xxx"
}'

注： 4个api-auth-xxx对应[鉴权值]需要替换为真实有效值。

API应答基础结构如下

{
    "code": 0,
    "msg": "",
    "result": {}
}