国际短信集成

注:(营销和验证码业务需商务开通不同账户)

1.营销短信群发

接口名称:send

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

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

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

请求参数说明:

参数说明是否必填类型
numbers短信接收号码,多个号码之间以英文逗号分隔(最多1000个)String
content发送内容,长度不能超过1000字符String
mcc国家码(中国:86,美国:1)String
withAreaCode号码是否已携带区号(0否,1是)String

POST请求示例:

(发送内容“hello world” )

响应参数说明:

参数说明类型
status状态码,0成功,其他失败参见状态码说明String
msg失败原因说明String
totalNum提交成功的号码个数int
succArray提交成功的json集合JSONArray
uuid提交号码对应平台uuidString
number提交号码String

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

响应示例:

2.营销短信状态查询

接口名称:getReport

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

请求方式:GET

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

请求参数说明:

参数说明是否必填类型
uuids接口响应返回的平台id,多个用英文逗号分隔,单次查询最大50个uuidString

请求示例:

响应参数说明:

参数说明类型
status状态码,0成功,其他失败参见状态码说明String
msg说明String
array找到发送结果的json集合JSONArray
uuid提交号码对应平台msgIdString
number提交号码String
receiveTime发送时间,ISO8601标准时间格式(2021-02-12T09:30:03+08:00)String
status发送状态:2发送成功,1:发送中,-1:发送失败String

响应示例:

3.余额查询

接口名称:getBalance

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

请求方式:GET

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

请求示例:

响应参数说明:

参数说明类型
status状态码,0成功,其他失败参见状态码说明String
msg说明String
data实际账户的余额String

响应示例:

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

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

请求方式:POST

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

推送示例:

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

Request Method: POST

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

Request Body:

推送参数说明:

参数说明类型
uuid提交号码对应平台uuidLong
number提交号码String
status发送状态说明:2发送成功,1:发送中,-1:发送失败Int
sendTime发送时间Long

响应示例:

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

5.验证码短信发送

接口名称:sendVerify

说明:提交短信接口,只支持单个号码

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

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

请求参数说明:

参数说明是否必填类型
numbers短信接收号码,多个号码之间以英文逗号分隔(最多1000个)String
content发送内容,长度不能超过1000字符String
mcc国家码(中国:86,美国:1)String
withAreaCode号码是否已携带区号(0否,1是)String

POST请求示例:

(发送内容 “hello world” )

响应参数说明:

参数说明类型
status状态码,0成功,其他失败参见状态码说明String
msg失败原因说明String
uuid提交号码对应平台uuidString
number提交号码String

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

响应示例:

6.验证码短信状态查询

接口名称:getVerifyStatus

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

请求方式:GET

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

请求参数说明:

参数说明是否必填类型
uuid接口响应返回的平台idString

请求示例:

响应参数说明:

参数 说明 类型
status状态码,0成功,其他失败参见状态码说明String
msg说明String
uuid提交号码对应平台msgIdString
number提交号码String
receiveTime发送时间,ISO8601标准时间格式(2021-02-12T09:30:03+08:00)String
status发送状态:2发送成功,1:发送中,-1:发送失败String

响应示例:

sign说明:

sign签名验证MD5(api_key+apiSecret+timestamp)秘钥apisecret由供应商提供
由应用key+秘钥+时间戳(秒)经过md5加密后的32位16进制小写字符串(拼接过程不包括+)

状态码:

状态码说明
0成功 
-1认证失败
-2参数异常
-3号码为空
-4号码个数过多
-30号码格式有误
-5内容为空
-6内容过长
-7内容含有敏感字符
-8余额不足,不能满足此次发送
-9uuids为空
-10uuids 超出最大个数上限
-20认证完成后,请联系商务经理为您开启对应国家通道
-98ip白名单限制
-99接口异常