短信接口（http协议）

一、单条短信发送（黑名单等拦截错误实时返回）

地址：http://sms.xunmiaocloud.com:9511/api/send-sms-single

请求头Content-Type：application/x-www-form-urlencoded

请求方式：POST 返回值：JSON

参数

返回值

二、批量短信发送（黑名单等拦截错误实时返回，一次最多提交一万条）

地址：http://sms.xunmiaocloud.com:9511/api/send-sms-batch

请求头Content-Type：application/x-www-form-urlencoded

请求方式：POST 返回值：JSON

参数

返回值

三、变量短信发送（黑名单等拦截错误实时返回，一次最多提交一万条）

地址：http://sms.xunmiaocloud.com:9511/api/send-variable

请求头Content-Type：application/x-www-form-urlencoded

请求方式：POST 返回值：JSON

参数

返回值

四、一对一批量发送（黑名单等拦截错误实时返回，一次最多提交一万条）

地址：http://sms.xunmiaocloud.com:9511/api/send-biunique

请求头Content-Type：application/x-www-form-urlencoded

请求方式：POST 返回值：JSON

参数

返回值

五、获取状态报告(每条短信状态仅可获取一次)

地址：http://sms.xunmiaocloud.com:9511/api/report

请求方式：GET 返回值：JSON

运营商返回某条短信状态后，此接口就能拉取到，之后调用此接口将不会返回此条短信的状态，所以调用者拉到数据后需要根据 手机号+msg_id 将状态存在本地

参数

返回值

六、推送状态报告(每条短信仅推送一次)

注意事项：推送使用的是POST方式，utf8原始字节流

推送格式：扩展号,调用发送接口返回的msg_id,手机号,状态,时间,售价 字段以,分隔 多条记录以|分隔

内容示范：123,2,1762532xxxx,DELIVRD,2021-12-23 01:02:03,0.2|123,2,17862532xxxx,DELIVRD,2021-12-23 01:02:03,0.1

七、获取用户上行回复(比如退订等，每条短信状态仅可获取一次)

地址：http://sms.xunmiaocloud.com:9511/api/get-reply

请求方式：GET 返回值：JSON

手机回复上行后，此接口就能拉取到上行数据，每个上行数据只能拉取到一次，所以调用者拉到上行后，需要将上行的内容存在本地，然后自行根据 msg_id,手机号 等信息匹配具体哪条短信产生的上行回复

参数

返回值

八、推送用户上行回复(每条上行回复仅推送一次)

注意事项：推送的是POST方式，utf8原始字节流

推送格式：urlencode后的内容,手机号,扩展号,时间 字段以,分隔多条记录以|分隔

内容示范：TD,158114xxxx,048842426601,20220325123304|退订,1891456xxxx,0615,20211115173903

九、获取余额

地址：http://sms.xunmiaocloud.com:9511/api/balance

请求方式：GET 返回值：JSON

参数

返回值

十、模板报备

地址：http://sms.xunmiaocloud.com:9511/api/add-template

请求头Content-Type：application/x-www-form-urlencoded

请求方式：POST 返回值：JSON

参数

返回值

十一、获取模板审核状态

地址：http://sms.xunmiaocloud.com:9511/api/get-template-status

请求方式：GET 返回值：JSON

参数

返回值

十二、签名报备

地址：http://sms.xunmiaocloud.com:9511/api/add-sign

请求头Content-Type：application/x-www-form-urlencoded

请求方式：POST 返回值：JSON

参数

返回值

十三、获取签名审核状态

地址：http://sms.xunmiaocloud.com:9511/api/get-sign-status

请求方式：GET 返回值：JSON

参数

返回值

错误码（code）

错误码（data）

签名生成规则

第一步：准备QueryString

1. 将所有参数（除了signature）按照key排序（顺序）
2. 将排序好的参数key和值进行URLEncode，之后再增加三种字符替换：加号（+）替换成 %20、星号（*）替换成 %2A、%7E 替换回波浪号（~）
3. 将格式化后的key和值按照key + "=" + 值进行拼接成字符串QueryString，多个参数间用&连接，例：”a=%E5%93%88%E5%93%88&b=haha”
4. 在上一步得到的QueryString前拼接上请求方式，生成新的QueryString，HTTPMethod + "&" + URLEncode("/") + "&" + QueryString

第二步：准备signature

1. 将上面得到的QueryString进行HmacSHA1算法进行编码，HMAC生成信息摘时需要用您的产品密码作为密钥。
2. 之后将上面加编码后的字符串进行base64编码，得到签名signature

注意：本文档的所有接口都不支持 curl的100 continue协议，如果接口响应过慢就关闭此协议，在Curl中加入curl_setopt($ch, CURLOPT_HTTPHEADER, array("Expect:"))即可

aes加密规则

1. aes加密发送，需要同时分别加密手机号字段和内容字段
2. 发送地址在原来的地址加上-aes，地址：http://sms.xunmiaocloud.com:9511/api/send-sms-single-aes
3. 先向客服索要加密key，然后自行生成iv，用AES-128-CBC将手机号或者内容进行加密，并对加密的数据进行base64处理获得字符串s1
4. 将生成的iv也进行base64处理生成字符串s2
5. 将两个字符串进行json处理生成如下的json字符串s3："{"iv":"s2","value":"s1"}"
6. 将上述得到的s3进行base64处理，然后放入相应post数据字段中代替未加密的数据
7. php代码如下

8.         $cipher = 'AES-128-CBC';
   
           $iv = random_bytes(openssl_cipher_iv_length($cipher));
   
           $value = openssl_encrypt($value, $cipher, $key, 0, $iv);
   
           if ($value === false) {
               throw new RuntimeException('Could not encrypt the data.');
           }
   
           $iv = base64_encode($iv);
   
           $json = json_encode(compact('iv', 'value'), JSON_UNESCAPED_SLASHES);
   
           if (json_last_error() !== JSON_ERROR_NONE) {
               throw new RuntimeException('Could not encrypt the data.');
           }
   
           return base64_encode($json);