发送短信

通过 GSM/3G/4G 中继给外部号码发送短信。

应用场景： 拨打人工服务的时候，人工可按某个键直接把要查询的具体内容发到你手机上。

注：
  • 信息内容字符限制为最多1000个汉字，即2000个字符，不能包含表情。
  • 确保 PBX 系统能够正常收发短信。

Endpoint

POST /api/v1.1.0/sms/send?token={token}

请求参数

名称 是否必需 类型 描述
phonenumber 是 String 手机号码。
message 是 String 信息内容(需经过 URL 编码)。
trunk 是 String 使用的 GSM/3G/4G 中继名。

响应参数

名称 类型 描述
action Object 表明该条响应是短信发送的结果。
status String 请求状态：
  • Success：短信发送成功。
  • Failed：短信发送失败。
smsid String 每条短信的唯一标识。

实际示例

请求示例
注： 短信内容必须经过 URL 编码。URL编码工具
POST /api/v1.1.0/sms/send?token=1e3b3ebb6a974cb42ed31de5413df52d HTTP/1.1
Content-Type:application/json; charset=utf-8
Host: 192.168.5.150
{
    "trunk": "GSM",
    "phonenumber": "18396210850",
    "message": "%E4%BD%A0%E5%A5%BD"
}
响应示例
HTTP/1.1 200 OK
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE
{
    "status": "Success",
    "smsid": "18396210850-1502874159"
}
请求成功后会有产生两条响应，一条表明发送的请求是否正确，一条则表明短信是否发送成功。

  • 短信发送成功：

    HTTP/1.1 200 OK
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE
{
    "action": "sms-send",
    "status": "Succeed",
    "smsid": "18396210850-1502874445"
}

  • 短信发送失败：

    HTTP/1.1 200 OK
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE
{
    "action": "sms-send",
    "status": "Failed",
    "smsid": "18396210850-1502874159"
}
请求失败：
HTTP/1.1 200 OK
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE
{
    "status": "Failed",
    "errno": "20004"
}