发送短信

APIv2

发布时间：2022-05-03 20:49:57

接口描述

您可以通过本接口发送短信。本接口仅支持发送通知类短信及验证码短信。

本接口服务地址：https://api.rivalsa.net/v2/sendsms.php

本接口的 action：sendSMS

输入参数

下表列出的参数需要放在请求体中，除此之外还需要在请求头部中添加公共请求头部。

字段	必选	类型	描述
phoneNumber	是	Array of String	收信人手机号码。采用 E.164 标准，格式为 “+” + “国家或地区代码” + “手机号码”，例如：+8618888888888。单次请求最多支持200个手机号且要求全为境内手机号或全为境外手机号。
templateId	是	String	模板ID，请联系我们申请“模板”。
signName	是	String	短信签名内容，请联系我们申请“短信签名”。
templateParamSet	是	Array of String	短信模板参数，若模板无参数，此字段需传空数组。

输出参数

您调用本接口后，会返回公共响应头部及公共响应体。

本接口为较复杂的多层结构接口，返回成功响应仅代表本层处理成功，并不代表发送短信成功。只有同时满足以下所有条件才表示发送短信成功：

响应体中 code 字段的值为0。
响应体中 response.Response 对象中不存在 Error 字段。
响应体中 response.Response.SendStatusSet[N].Code 字段的值为 Ok。

若出现返回成功响应，但未成功发送短信的情况，请参考以下字段的描述，或者联系我们处理。

response.Response.Error.Code
response.Response.Error.Message
response.Response.SendStatusSet[N].Code
response.Response.SendStatusSet[N].Message

错误码

下表列出的是本接口独有的错误码，除此之外错误码还包括公共错误码。

错误码	描述
100	输入参数 phoneNumber 中存在不符合规则的号码，或者输入参数 phoneNumber 中存在不是 String 类型的值。号码规则：采用 E.164 标准，格式为 “+” + “国家或地区代码” + “手机号码”，例如：+8618888888888。
101	输入参数 templateId 的格式不正确，必须是 6-7 位数字组成的字符串。
102	不支持您使用的请求方式。本接口仅支持 POST 请求。
103	不支持您使用的 Content-Type。Content-Type必须严格为 application/json;charset=UTF-8 一个字符都不能错。
104	输入参数 phoneNumber 类型不正确，必须为 Array 类型。
105	输入参数 templateId 类型不正确，必须为 String 类型。
106	输入参数 signName 类型不正确，如存在 signName 参数则必须为 String 类型。
107	输入参数 templateParamSet 类型不正确，必须为 Array 类型。如果模板没有参数，此值应为空数组。
111	输入参数 templateParamSet 中存在不是 String 类型的字符串。

示例

请求示例

POST https://api.rivalsa.net/v2/sendsms.php

Content-Type:application/json;charset=UTF-8
Host:api.rivalsa.net
<公共响应头部>

{
    "phoneNumber":[
        "+8618888888888",
        "+8617777777777"
    ],
    "templateId":"123456",
    "signName":"RIVALSA",
    "templateParamSet":[
        "1234",
        "5"
    ]
}

成功响应体示例

{
    "code":0,
    "response":{
        Response:{
            "SendStatusSet": [
                {
                    "SerialNo": "xxxx:10xxxxx6691xxxxxxxxxxx49xxxx",
                    "PhoneNumber": "+8618888888888",
                    "Fee": 1,
                    "SessionContext": "",
                    "Code": "Ok",
                    "Message": "send success",
                    "IsoCode": "CN"
                },
                {
                    "SerialNo": "xxxx:10xxxxx6691xxxxxxxxxxx49xxxx",
                    "PhoneNumber": "+8617777777777",
                    "Fee": 1,
                    "SessionContext": "",
                    "Code": "Ok",
                    "Message": "send success",
                    "IsoCode": "CN"
                }
            ],
            "RequestId": "xxxxxxxx-cf91-xxxx-xxxx-xxxxxxxxxx79"
        }
    },
    "requestID":7
}

失败响应体示例

{
    "code":105,
    "msg":"templateId格式不合规",
    "requestID":8
}