文档首页 > > API参考> API> 短信操作> 发送短信验证码或短信通知

发送短信验证码或短信通知

分享
更新时间: 2019/09/12 GMT+08:00

功能介绍

说明:

短信操作类接口已于2018.05.14停止维护,当前接口仅提供给存量用户使用,如果您需使用短信发送功能,请移步至“云通信-消息&短信”,感谢您的支持。

  • 接口名称

    SmsPublish

  • 功能描述

    将短信发送给指定的手机号码。

URI

  • URI格式

    POST /v2/{project_id}/notifications/sms

  • 参数说明

    名称

    是否必选

    参数类型

    说明

    project_id

    String

    项目ID

    获取项目ID请参考获取项目ID

请求消息

  • 参数说明

    名称

    是否必选

    参数类型

    说明

    endpoint

    String

    手机号码。

    终端节点必须是一个电话号码,国际号码必须以“+[国家码]”开头,国内号码可以省略“+”或“+[国家码]”。

    message

    String

    短信消息内容。

    长度不超过490个字符。如果传递sign_id参数,则message中不需要携带签名,系统会自动拼接签名信息于message头部。如果传递message_include_sign _flag参数,则message的签名信息由用户拼接。将签名放置于“【】”括号中,并添加到内容头部。例如:“【XX商城】您的验证码为123456,请尽快完成验证。”

    sign_id

    当message_include_sign_flag参数不传递时,此参数必选

    String

    签名ID

    短信签名ID在创建短信签名时由系统自动生成,是短信签名的唯一标识。请在SMN控制台左侧导航栏单击“短信”,在页面的短信签名列表中获取签名ID,参考查询短信签名

    message_include_sign_flag

    当sign_id参数不传递时,此参数必选。

    String

    参数为"true" 或 "false",不传参数则默认为"false"。

    如果您需要在message中自行拼接签名信息,请将此参数设置为"true"。

    extend_code

    String

    扩展字段,短信状态通知时,会返回该字段内容。其长度小于等于32个字节。

    extend_src_id

    String

    短信发送号码的扩展号码。

    8位以内的数字。该字段仅限可自定义扩展号码的签名使用。

  • 请求样例
    请求样例1
    POST https://{SMN_Endpoint}/v2/{project_id}/notifications/sms
    { 
       "endpoint": "+86159****1990", 
       "message": "Sms message test",
       "sign_id":"94d3b63a5dfb475994d3ac34664e2346",
       "extend_code":"extend code test"
    }

    请求样例2

    POST https://{SMN_Endpoint}/v2/{project_id}/notifications/sms
    {
        "endpoint": "+86159****1990",
        "message": "【XX商城】sms message test.", 
        "message_include_sign_flag": "true"
    }

响应消息

  • 要素说明

    名称

    参数类型

    说明

    request_id

    String

    请求的唯一标识ID

    message_id

    String

    唯一的消息ID

  • 响应样例
    { 
       "message_id": "bf94b63a5dfb475994d3ac34664e24f2", 
       "request_id": "9974c07f6d554a6d827956acbeb4be5f" 
    }

返回值

请参考返回值

错误码

请参考错误码说明

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区