国际短信集成

注：（营销和验证码业务需商务开通不同账户）

1.营销短信群发

接口名称：send

说明：提交短信接口，支持单个号码或多个号码发送

请求方式：POST，一次最多提交3w个号码。

请求URLhttps://sms.pgyer.com/sms/send

请求参数说明：

POST请求示例：

（发送内容“hello world” ）

响应参数说明：

注：提交发送成功后，系统会给每个提交成功的号码对应生成一个平台uuid，后续客户可以根据这个uuid来查询该号码的发送结果

响应示例：

2.营销短信状态查询

接口名称：getReport

说明：查询指定uuid集合的发送结果

请求方式：GET

请求URL https://sms.pgyer.com/sms/getReport?uuids={ uuids }

请求参数说明：

请求示例：

响应参数说明：

响应示例：

3.余额查询

接口名称：getBalance

说明：用于获取账户余额接口

请求方式：GET

请求URLhttps://sms.pgyer.com/sms/getBalance

请求示例：

响应参数说明：

响应示例：

4.平台主动推送状态报告

说明：当用户在平台管理页面，配置了http推送地址后，平台会将http-api接入的短信，状态报告主动推送给用户配置地址

请求方式：POST

请求URL：用户配置的http推送地址

推送示例：

Request URL:用户配置的http推送地址

Request Method: POST

Request Headers: Content-Type: application/json;charset=UTF-8

Request Body:

推送参数说明：

响应示例：

Http响应200成功即可，平台不做响应内容校验

5.验证码短信发送

接口名称：sendVerify

说明：提交短信接口，只支持单个号码

请求方式：POST，一次最多提交1个号码。

请求URLhttps://sms.pgyer.com/sms/sendVerify

请求参数说明：

POST请求示例：

（发送内容 “hello world” ）

响应参数说明：

注：提交发送成功后，系统会给每个提交成功的号码对应生成一个平台uuid，后续客户可以根据这个uuid来查询该号码的发送结果。

响应示例：

6.验证码短信状态查询

接口名称：getVerifyStatus

说明：查询指定验证码的发送结果

请求方式：GET

请求URL https://sms.pgyer.com/sms/ getVerifyStatus?uuid={ uuid }

请求参数说明：

请求示例：

响应参数说明：

响应示例：

sign说明：

状态码：

---

知识共享，实时协作，高效办公云平台

举报