API渠道接入

接入小多机器人API，第三方需要按步骤获取基本信息：

1. 注册账号
2. 登录系统，添加API渠道 （登录系统-->设置-->渠道设置-->创建API渠道）
3. 获取创建的渠道信息。企业ID、渠道ID、APPSecret

开始接入

接口列表　　

1、创建api对话
2、api渠道发送消息
3、第三方消息回调
4、获取未读消息
5、用户会话状态获取
6、消息推送

服务地址: https://cvd.xiaoduoai.com

创建api对话

/v1/api/open_api_dialog

请求方式：

post body (utf8 json)

请求参数：

{
     "unit_id":1001,
     "channel_id": 1001,
     "ts": 1529800000,
     "state":"",
     "sign":"",
     "customer":{
          "id":"unique_id",             
          "name":"",        
          "sex":1,    
          "age":25,  
          "phone" :"",
          "faceurl":"",                
          "third_params":
          {
             "key1":"val1",
             "key2":"val2",
             ......
          }
      }
}

sign生成：

1）将unit_id、channel_id、ts、state、customer.id 5个参数进行字典序排序 
2）将三个参数字符串以&拼接成一个字符串
3）将第2步得到的字符串拼接上APPSecret得到的字符串进行MD5签名，得到一个16进制大写表示的字符串。

请求参数举例：

注册账号，获取到企业ID：5，渠道ID：157，APPSecret:"98f756ac5f938904fed5b6543f1af9b6"

参与签名的字段值如下：
unit_id=5 channel_id=157 ts=1529800000 state="test" customer.id="12345"

sign计算过程：
1）将参与签名的参数进行字典序排序,以&拼接得到"channel_id=157&customer.id=12345&state=test&ts=15298000000&unit_id=5"
2）再拼接APPSecret得到"channel_id=157&customer.id=12345&state=test&ts=15298000000&unit_id=598f756ac5f938904fed5b6543f1af9b6RRONkNKn"
3) 再计算MD5,upper(hex(MD5("channel_id=157&customer.id=12345&state=test&ts=15298000000&unit_id=598f756ac5f938904fed5b6543f1af9b6RRONkNKn")))
4）得到sign="FF9BEB2B5BB29062651B22DF1579D65D"

返回值json：

{
     "error_code":0,
     "info":"",
}

返回值说明：

api渠道发送消息

/v1/api/send_api_msg

请求方式：

post body (utf8 json)

请求参数：

{
     "unit_id":1001,
     "channel_id": 1001,
     "ts": 1529800000,
     "state":"",
     "sign":"",
     "customer_id":"",
     "msgs":[
         {
             "type":"TIMTextElem", // 文本
             "content":{
                 "Text":"hello!"
             },
             "random":1529874653389
         },
         {
             "type":"TIMImageElem", // 图片
             "content":{
                 "ImageInfoArray":[ // 使用数组的原因是很多其实一个图片包含大图、中图、小图。如果只有一副，填一个即可
                     {
                         "Size":1024,
                         "Width":50,
                         "Hight":60,
                         "URL":""
                     }
                 ]
             },
             "random":1529874653301000
         }

     ]
}

返回值json：

{
     "error_code":0,
     "info":"",
}

返回值说明：

第三方消息回调

对调地址为：晓得后台渠道管理页面配置的地址

请求方式：

post body (utf8 json)

请求参数：

{
     "op":1,
     "ts": 1529800000,
     "state":"",
     "sign":"",
     "customer_id":"",
     "msg": {
             "type":"TIMTextElem", // 文本
             "content":{
                 "Text":"hello!"
             },
             "random":1529874653389001
     }
}

返回值json：

{
     "error_code":0,
     "info":"",
}

返回值说明：

获取未读消息

/v1/api/get_unread_msgs

请求方式：

post body (utf8 json)

请求参数：

{
     "unit_id":1001,
     "channel_id": 1001,
     "ts": 1529800000,
     "sign":"",
     "customer_id":"tid"
}

返回值json：

{
     "error_code":0,
     "info":"",
     "unread_num": 3,
     "new_msgs":[
         {
             "type":"TIMTextElem", // 文本
             "content":{
                 "Text":"hello!"
             },
             "random":1529874653389
         },
         {
             "type":"TIMImageElem", // 图片
             "content":{
                 "ImageInfoArray":[ // 使用数组的原因是很多其实一个图片包含大图、中图、小图。如果只有一副，填一个即可
                     {
                         "Size":1024,
                         "Width":50,
                         "Hight":60,
                         "URL":""
                     }
                 ]
             },
             "random":1529874653301000
         }

     ]

}

返回值说明：

用户会话状态获取

/v1/api/get_dialog_status

请求方式：

post body (utf8 json)

请求参数：

{
     "unit_id":1001,
     "ts": 1529800000,
     "sign":"",
     "customer_id":"tid"
}

返回值json：

{
     "error_code":0,
     "info":"",
     "is_Open": false,
     "customer_id": "cid123",
     "channel_id": 1,
     "unread_num": 3,
     "new_msgs":[
         {
             "type":"TIMTextElem", // 文本
             "content":{
                 "Text":"hello!"
             },
             "random":1529874653389
         },
         {
             "type":"TIMImageElem", // 图片
             "content":{
                 "ImageInfoArray":[ // 使用数组的原因是很多其实一个图片包含大图、中图、小图。如果只有一副，填一个即可
                     {
                         "Size":1024,
                         "Width":50,
                         "Hight":60,
                         "URL":""
                     }
                 ]
             },
             "random":1529874653301000
         }

     ]

}

返回值说明：

消息推送

对调地址为：第三方企业提供消息接收地址

鉴权方式：

需要鉴权的接口统一使用http header Authorization 判断，  
该字段签名格式为 timestamp.nonce.sign 由点号分隔，分为三部分，  
timestamp为当前unix时间戳,如1557894000，
nonce为随机串，长度为8位(英文字母数字)，
sign生成规则是 lowercase(md5(timestamp.secret.nonce.secrect)) ,其中secret为晓多提供。  

请求方式：

header : Authorization 1557894000.adjfiosd.8fde18088d7e8d8ecb9cdc4d92543739
post body (utf8 json)

请求参数：

{
     "customer_id": "cid123",
     "channel_id": 1,
     "msg_text":"[图片]",
     "raw_msg":[
        {
             "type":"TIMTextElem", // 文本
             "content":{
                 "Text":"hello!"
             },
        }
     ]
}

返回值json：

{
     "error_code":0,
     "info":"",
}

返回值说明：

错误码：