認證服務
號碼檢測
短信服務
OCR服務
公共數(shù)據(jù)
1.接口說明(單條短信)
| 名稱 | 說明 |
|---|---|
| 協(xié)議 | HTTPS POST |
| 地址 | https://api.cxlnk.com/api/msgService/sendSms |
| Accept | application/json |
| Content-Type | application/json;charset=utf-8 |
2.請求參數(shù)說明
響應 body 數(shù)據(jù)為 JSON 格式
| 列表 | 內(nèi)容 |
|---|---|
| accessKey | API調(diào)用賬號(必填,String類型,從燦星云平臺獲?。?/td> |
| accessSecret | API調(diào)用密鑰(必填,String類型,從燦星云平臺獲取) |
| signCode | 短信簽名code(必填) |
| templateCode | 短信模版code(必填) |
| mobile | 目標手機號(必填,String類型) |
| params | 參數(shù)(選填,List類型),若有參數(shù)則必填且參數(shù)需與所選模版中參數(shù)名稱以及數(shù)量一致 |
| msgType | 短信類型(必填, Integer類型) 1:驗證碼;2:短信通知;3:會員營銷;4:推廣短信 |
| taskId | 自定義任務 id (非必填) |
3.請求參數(shù)示例
{
"accessKey": "NDYw*******",
"accessSecret": "MDQyOTQ1OTM3*********************",
"signCode": "b1d***",
"templateCode": "65c***",
"mobile": "13800138000",
"params": [
"1234"
],
"msgType": 1,
"taskId": "squis*****dsai"
}
4.響應參數(shù)列表
| 列表 | 內(nèi)容 |
|---|---|
| code | 狀態(tài)碼200則為成功 |
| msg | 狀態(tài)說明 |
| success | 處理是否成功:取值范圍 true,false |
| data | 業(yè)務數(shù)據(jù) 如果失敗則為空 |
| mobile | 手機號碼 |
| msgId | 短信id |
5.響應參數(shù)示例
{
"code": 200,
"msg": "成功",
"success": true,
"data":{
"mobile": "13800138000",
"msgId": "1604770228094443521"
}
}
6.結(jié)果碼說明
| 結(jié)果碼 | 描述 |
|---|---|
| 200 | 成功 |
| 502 | 系統(tǒng)繁忙 |
| 60021 | 余額不足,請充值后重試! |
| 500,501,503 | 系統(tǒng)錯誤 |
| 5001 | 請求參數(shù)校驗異常 |
7.接口說明(多條短信-變量一致)
| 名稱 | 說明 |
|---|---|
| 協(xié)議 | HTTPS POST |
| 地址 | https://api.cxlnk.com/api/msgService/sendSmsBatch |
| Accept | application/json |
| Content-Type | application/json;charset=utf-8 |
8.請求參數(shù)說明
響應 body 數(shù)據(jù)為 JSON 格式
| 列表 | 內(nèi)容 |
|---|---|
| accessKey | API調(diào)用賬號(必填,String類型,從燦星云平臺獲?。?/td> |
| accessSecret | API調(diào)用密鑰(必填,String類型,從燦星云平臺獲?。?/td> |
| signCode | 短信簽名code(必填) |
| templateCode | 短信模版code(必填) |
| mobile | 目標手機號,多個手機號逗號隔開(必填,String類型) |
| params | 參數(shù)(選填,List類型),若有參數(shù)則必填且參數(shù)需與所選模版中參數(shù)名稱以及數(shù)量一致 |
| msgType | 短信類型(必填, Integer類型) 1:驗證碼;2:短信通知;3:會員營銷;4:推廣短信 |
| taskId | 自定義任務 id (非必填) |
9.請求參數(shù)示例
{
"accessKey": "NDYw*******",
"accessSecret": "MDQyOTQ1OTM3*********************",
"signCode": "b1***",
"templateCode": "65c***",
"mobile": "13800138000,13800138001,13800138002",
"params": [
"1234"
],
"msgType": 1,
"taskId": "squis*****dsai"
}
10.響應參數(shù)列表
| 列表 | 內(nèi)容 |
|---|---|
| code | 狀態(tài)碼200則為成功 |
| msg | 狀態(tài)說明 |
| success | 處理是否成功:取值范圍 true,false |
| data | 業(yè)務數(shù)據(jù) 如果失敗則為空 |
| allNum | 手機號碼總數(shù)量 |
| successNum | 成功手機號數(shù)量 |
| failNum | 失敗手機號數(shù)量 |
| list | 集合類型,元素為每條短信發(fā)送結(jié)果,字段具體涵義參考單條短信發(fā)送 |
| code | 狀態(tài)碼200則為成功 |
| msg | 狀態(tài)說明 |
| success | 處理是否成功:取值范圍 true,false |
| data | 業(yè)務數(shù)據(jù) 如果失敗則為空 |
| mobile | 手機號碼 |
| msgId | 短信id |
11.響應參數(shù)示例
{
"code": 200,
"msg": "操作成功",
"success": true,
"data":{
"successNum": 3,
"failNum": 0,
"allNum": 3,
"list": [
{
"code": 200,
"msg": "操作成功",
"success": true,
"data": {
"mobile": "13800138000",
"msgId": "1604771323839586305"
}
},
{
"code": 200,
"msg": "操作成功",
"success": true,
"data": {
"mobile": "13800138001",
"msgId": "1604771324938493953"
}
},
{
"code": 200,
"msg": "操作成功",
"success": true,
"data": {
"mobile": "13800138002",
"msgId": "1604771327220195330"
}
}
]
}
}
12.結(jié)果碼說明
| 結(jié)果碼 | 描述 |
|---|---|
| 200 | 成功 |
| 502 | 系統(tǒng)繁忙 |
| 60021 | 余額不足,請充值后重試! |
| 500,501,503 | 系統(tǒng)錯誤 |
| 5001 | 請求參數(shù)校驗異常 |
13.接口說明(多條短信-變量不一致)
| 名稱 | 說明 |
|---|---|
| 協(xié)議 | HTTPS POST |
| 地址 | https://api.cxlnk.com/api/msgService/sendMsgBatch |
| Accept | application/json |
| Content-Type | application/json;charset=utf-8 |
14.請求參數(shù)說明
響應 body 數(shù)據(jù)為 JSON 格式
| 列表 | 內(nèi)容 |
|---|---|
| accessKey | API調(diào)用賬號(必填,String類型,從燦星云平臺獲?。?/td> |
| accessSecret | API調(diào)用密鑰(必填,String類型,從燦星云平臺獲?。?/td> |
| signCode | 短信簽名code(必填) |
| templateCode | 短信模版code(必填) |
| phoneParam | 目標手機號,模板變量(必填,多個變量以英文逗號分隔) |
| msgType | 短信類型(必填, Integer類型) 1:驗證碼;2:短信通知;3:會員營銷;4:推廣短信 |
| taskId | 自定義任務 id (非必填) |
15.請求參數(shù)示例
{
"accessKey": "NDYw*******",
"accessSecret": "MDQyOTQ1OTM3*********************",
"signCode": "b1***",
"templateCode": "65c***",
"phoneParam": {
"159****0517":"張三,1234",
"181****6194":"李四,5678"
},
"msgType": 2,
"taskId": "squis*****dsai"
}
16.響應參數(shù)列表
| 列表 | 內(nèi)容 |
|---|---|
| code | 狀態(tài)碼200則為成功 |
| msg | 狀態(tài)說明 |
| success | 處理是否成功:取值范圍 true,false |
| data | 業(yè)務數(shù)據(jù)在平臺發(fā)送明細-任務詳情查看 |
17.響應參數(shù)示例
{
"code": 200,
"msg": "操作成功",
"success": true,
"data":null
}
18.結(jié)果碼說明
| 結(jié)果碼 | 描述 |
|---|---|
| 200 | 成功 |
| 502 | 系統(tǒng)繁忙 |
| 60021 | 余額不足,請充值后重試! |
| 500,501,503 | 系統(tǒng)錯誤 |
| 5001 | 請求參數(shù)校驗異常 |