文档中心
X-Man智能触达接口文档

 

 

一、返回的基础格式:

 

 

1、邮件微信APP推送提交接口

 

请求URL

 

POST /x-man/api/v1/message/imsend

 

请求参数

 

注意:params里面的key是模板里面替换的参数名value是要替换的

 

例如:模板内容是:{keyword1}你好呀,点点一下吗 ?  

 

params的json是 {'keyword1':'客户'}"

 

 

响应参数

 

返回示例:

 

ps:消息异步处理参数校验成功后提交发送返回ok

成功:

 

{

 

 "success": true,

 

 "message": "",

 

 "msgCode": "",

 

 "value": "success"

 

}

 

失败:

 

{

 

 "success": false,

 

 "message": "模板ID[591]不可用",

 

 "msgCode": "4001",

 

 "value": null,

 

 "attributes": null

 

}

 

 

2、短信发送接口

 

请求URL

 

POST /x-man/api/v1/message/smssend

 

请求参数

 

注意:params里面的key是模板里面替换的参数名value是要替换的

 

例如:模板内容是:{keyword1}你好呀,点点一下吗 ?  

 

params的json是 {'keyword1':'客户'}"

 

响应参数

 

 

返回示例

 

ps:短信消息提交失败结果在success和value里面的success 双层判断 外部数数据逻辑 内部是运营商拦截

 

成功:

 

{

 

 "success": true,

 

 "message": "",

 

 "msgCode": "",

 

 "value": {

 

   "msgId": "1186828736268472320",

 

   "message": "发送成功",

 

   "mobile": "17681869126",

 

   "success": true

 

 },

 

 "attributes": null

 

}

 

失败:

 

{

 

 "success": false,

 

 "message": "模板ID[591]不可用",

 

 "msgCode": "4001",

 

 "value": null,

 

 "attributes": null

 

}

 

 

二、X-Man回执接口(主动查询)

 

请求URL

 

/x-man/api/v1/message/smsreceipt

 

 

请求方式

 

 

        POST

 

请求参数

 

 

响应参数

 

 

返回示例:

 

成功:{ "success": true, "message": "", "msgCode": "", "value": { "mobile": "18616760235", "sendStatus": "FAIL", "sendFailReason": "黑名单", "receiptStatus": "FAIL", "receiptResultCode": null,"userReceiveTime":"2019-11-26 03:42:17"}, "attributes": null }

失败:{ "success": false, "message": "明细不存在", "msgCode": null, "value": null, "attributes": null }