短信对接文档

最后更新于:2021-07-16 10:12:46

一、生成请求头参数

Authorization Basic bWF0ZTptYXRlX3NlY3JldA==

Basic后的值为使用Base64加密 key:secret 生成,后面所有请求如果缺失头部参数信息,调用失败。

注意:Basic后面包含空格,示例格式如下。

Accept: application/json, text/plain, */*
Accept-Encoding: gzip, deflate, br
Accept-Language: zh-CN,zh;q=0.9
Authorization: Basic bWF0ZT*******lY3JldA==
Connection: keep-alive

二、生成token

请求地址 https://sms.afrilink.tech/api/mate-uaa/oauth/token

请求方式 POST

参数类型
grant_typeStringpassword 固定不变
passwordStringMD5(用户密码)
scopeStringall 固定不变
usernameString提供的用户名

响应结果如下所示:

{
    "code": 200,
    "msg": "处理成功",
    "time": 1622207604005,
    "data": {
        "roleId": "1",
        "deptId": 1,
        "tenantId": "100000",
        "avatar": "https://ss0.bdstatic.com/70cFvHSh_Q111034&fm=26&gp=0.jpg",
        "userName": "admin",
        "type": 1,
        "userId": "2",
        "jti": "2d491ed3-67b0-4b1e-bc19-160938efe903",
        "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ***************buPatL8",
        "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1***************rewrOewr3"
    }
}
如何使用token?

将上述接口中获取到的accessToken的值放入request header中,格式如下:

Mate-Auth: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c*******************************5v2LYE

后续调用接口都会使用到上述授权信息 AuthorizationMate-Auth, 如果调用时使用错误的参数,接口将不可被调用,如token过期,重新调用接口获取即可。

三、短信单条发送接口

请求地址 https://sms.afrilink.tech/api/mate-smsplatform/mate-sms/send/single

请求方式 POST

请求参数如下:

参数类型
senderString发送方.eg:Kashmullah
receiverString接收方.eg:254XXXXXXXXX
textString发送内容。160字符按一条计算,超出额外计费。

响应结果:

此处发送为异步发送,回调结果通过注册的url回调地址接收,地址需要外网可连通。

四、短信群发接口

①先新增号码组

请求接口 https://sms.afrilink.tech/api/mate-smsplatform/customer-group/import

请求方式 POST

请求参数

参数类型
groupNameString群组名称,不能重复
filefile导入的号码组(Excel后缀为xls)
remarkString备注

响应结果

{"code":200,"msg":"操作成功","time":1622208666212,"data":"SUCCESS"}
注意:导入的文件后缀为xls。导入模板示例如下
mobile
254XXXXXXXXX
254XXXXXXXXX
254XXXXXXXXX
254XXXXXXXXX

② 开始群发

请求接口 https://sms.afrilink.tech/api/mate-smsplatform/mate-sms/send/group

请求方式 POST

请求参数

参数类型
groupString上文新增号码组groupName字段的值
deptIdString上文请求token接口中返回结果的deptId
sendPrefixString发送前缀。eg:Kashmullah
textString群发内容

响应结果:

此处发送为异步发送,回调结果通过注册的url回调地址接收,地址需要外网可连通。