验证码短信

1、单条短信发送

请求头Content-Type：application/x-www-form-urlencoded
请求方式：POST 返回值：JSON

备注：黑名单等拦截错误实时返回

地址：https://api.3yit.com/api/send-sms-single

参数

结果

2、批量短信发送

请求头Content-Type：application/x-www-form-urlencoded
请求方式：POST   返回值：JSON

备注：黑名单等拦截错误实时返回，一次最多提交一万条

地址：https://api.3yit.com/api/send-sms-batch

参数

结果

3、变量短信发送

请求头Content-Type：application/x-www-form-urlencoded
请求方式：POST 返回值：JSON

备注：黑名单等拦截错误实时返回

地址：https://api.3yit.com/api/send-variable

参数

结果

4、一对一批量发送

请求头Content-Type：application/x-www-form-urlencoded
请求方式：POST 返回值：JSON

备注：黑名单等拦截错误实时返回，一次最多提交一万条

地址：https://api.3yit.com/api/send-biunique

参数

结果

5、获取状态报告

请求头Content-Type：application/x-www-form-urlencoded
请求方式：GET  返回值：JSON

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

地址：https://api.3yit.com/api/report

参数

返回值

6、推送状态报告

每条仅推送一次

注意事项：

推送的是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

7、获取用户上行回复

请求方式：GET 返回值：JSON

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

地址：https://api.3yit.com/api/get-reply

参数

返回值

8、推送用户上行回复

每条上行回复仅推送一次

注意事项：

推送的是utf8原始字节流

推送格式：

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

内容示范：

TD,158114xxxx,048842426601,20220325123304|退订,1891456xxxx,0615,20211115173903

9、获取余额

请求方式：GET 返回值：JSON

https://api.3yit.com/api/balance

参数

返回值

10、模板报备

请求头Content-Type：application/x-www-form-urlencoded
请求方式：POST 返回值：JSON

https://api.3yit.com/api/add-template

参数

返回值

11、获取模板审核状态

请求方式：GET 返回值：JSON

地址：https://api.3yit.com/api/get-template-status

参数

返回值

12、错误码表

发送

短信状态错误码

13、签名生成规则

第一步：准备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、将所有参数（除了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

14、AES加密规则

aes加密发送，需要同时分别加密手机号字段和内容字段

https://api.3yit.com/api/send-sms-single-aes

操作流程

1、发送地址在原来的地址加上-aes，地址：https://api.3yit.com/api/send-sms-single-aes

2、先向客服索要加密key，然后自行生成iv，用AES-128-CBC将手机号或者内容进行加密，并对加密的数据进行base64处理获得字符串s1

3、将生成的iv也进行base64处理生成字符串s2

4、将两个字符串进行json处理生成如下的json字符串s3："{"iv":"s2","value":"s1"}"

5、将上述得到的s3进行base64处理，然后放入相应post数据字段中代替未加密的数据

 $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);

注意事项

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

CMPP提交教程

CMPP（China Mobile Peer to Peer）协议是中国移动为短信服务提供商（SP）与短信中心之间数据交换而精心制定的一套标准协议。通过CMPP协议可以实现短信的批量提交、状态报告接收以及其他高级功能。智慧云信短信平台不仅支持广泛使用的HTTP类型接口，同时也支持更为专业和高效的产品级的CMPP2协议。

一、前期准备工作

在开始使用CMPP协议进行短信服务之前，有几个关键的准备步骤需要完成。

1、首先，您需要在智慧云信短信平台注册一个账号。注册成功后，您还需要提交实名认证资料

2、接下来，在您的账号中，找到对应的产品区域，提交短信签名以及短信模版以供审核。

二、获取并配置连接参数

完成上述准备工作后，下一步是获取并配置CMPP连接参数。

1、请登录到智慧云信短信平台，并导航至【短信验证码】-开发者中心-CMPP2接口参数部分。

2、在这里，您将看到一系列重要的连接参数，包括服务器IP、端口号、长号码、账号（SPID）、接口密码、流速以及最大链接数等。请注意，这些参数都是由系统自动生成的，如链接数、流速等不符合需求，可联系客服修改。

3、获取到这些参数后，您需要将它们配置到您的系统中。请根据您的系统开发文档或技术支持的指导进行配置，以确保一切设置正确无误。

三、查看与测试链接情况

配置完成后，下一步是查看和测试链接情况，以确保您的系统已经成功接入了智慧云信的短信网关。

1、当您完成配置并启动连接后，系统应该会显示链接成功的消息。如果链接成功，这意味着您的系统已经成功与智慧云信的短信网关建立了通信。

2、为了确保一切正常运行，建议您发送几条测试短信，检查是否能够正常接收和发送。如果遇到任何问题，智慧云信的技术支持团队将随时为您提供帮助和解决方案。

通过遵循以上步骤，您应该能够顺利地通过CMPP协议接入智慧云信的短信网关，并享受高效、稳定的短信服务。