发送短信

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

注：
  • 确保 PBX 能够正常收发短信。
  • 信息内容限制为最多 666 个汉字，即 2000 个字符。

请求 URL

POST {base_url}/{api_path}/sms/create?access_token={access_token}

请求参数

表 1.
参数 必填 类型 说明
message 是 String 短信内容（需经过 URL 编码）。
number 是 String 手机号码。
trunk_name 是 String 用于发送短信的 GSM/3G/4G 中继的名称。

响应参数

表 2.
参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。

示例

请求示例
POST /openapi/v1.0/sms/create?access_token=ojPrvnfzPdwc8OCcRmhG16gEHuZcwFco HTTP/1.1
Host: 192.168.5.150:8088
Content-Type: application/json
{
    "number":"15880123456",
    "trunk_name":"UMTS2-7",
    "message":"Hello%20Yeastar"
}
响应示例
HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS"
}