- 产品与解决方案
- 行业解决方案
- 服务
- 支持
- 合作伙伴
- 新华三人才研学中心
- 关于我们
26-SMS命令
本章节下载： 26-SMS命令 (210.23 KB)
目 录
app-id命令用来配置第三方短信平台的标识。
undo app-id命令用来恢复缺省情况。
【命令】
app-id app-id
undo app-id
【缺省情况】
未配置第三方短信平台的标识。
【视图】
短信网关视图
【缺省用户角色】
network-admin
context-admin
【参数】
app-id：第三方短信平台的标识，为1～31个字符的字符串，区分大小写。
【使用指导】
此标识会被封装在HTTP请求报文首部字段，发送至第三方短信平台，用于验证短信网关的身份，以及匹配对应的解密密钥并授权其相应的服务。
此标识由第三方短信平台提供。
【举例】
# 在短信网关gw1下配置第三方短信平台的标识为abc。
<Sysname> system-view
[Sysname] sms-gateway gw1
[Sysname-sms-gateway-gw1] app-id abc
【相关命令】
· secret-key
display sms-gateway命令用来显示短信网关的信息。
【命令】
display sms-gateway [ brief | name gateway-name ]
【视图】
任意视图
【缺省用户角色】
network-admin
network-operator
context-admin
context-operator
【参数】
brief：显示所有短信网关的简要信息。
name gateway-name：显示指定短信网关的详细信息。gateway-name表示短信网关名称，为1～31个字符的字符串，只能包含字母、数字、下划线，不区分大小写。如果不指定本参数，则显示所有短信网关的信息。
【使用指导】
若不指定任何参数，则表示显示所有短信网关的详细信息。
配置的用于加密短信数据的密钥，将以密文形式显示。
【举例】
# 显示所有短信网关的详细信息。
<Sysname> display sms-gateway
Total Number of SMS gateways： 5
SMS gateway name: gw1
SMS platform: emay
App ID: abc
Secret key: $c$3$zvzJI1AMQ4OVHCkSnXXoAOUyd2STdtIFtQDlJETCg=
VPN instance： vpn1
SMS gateway name: gw2
SMS platform: emay
App ID: 123
Secret key: $c$3$AS4tqlnOVODYEQ5IMHJNyNTTAyBPotXgw==
VPN instance： vpn1
SMS gateway name: gw3
SMS platform: tplink
App ID: 123
Secret key: $c$3$AS4tqlnOVODYEQ5IMHJNyNTTAyBPotXgw==
VPN instance： vpn1
URL: https://example.com/EmPlat/rest/message/sendVpnCode
SMS gateway name: gw4
SMS platform: pingan
VPN instance： vpn1
URL: http://wehub-sf.fat.qa.pab.com.cn/api/brcp_mpp.brcp-mpp-mms.sendOneRealTimeMsg
Consumer ID: 3031
Provider ID: 679900
ChannelCode: 104936
Access token: 25F2B4DCC07F43768CF3D948791E461F
Message type: NYH_ZH220119018
SMS gateway name: gw5
SMS platform: smp
Server host: smp.test.com
Server key: $c$3$zvzJI1AMQ4OVHCkSnXXoAOUyd2STdtIFtQDlJETCg=
VPN instance： vpn1
表1-1 display sms-gateway命令显示信息描述表
|
字段 |
描述 |
|
Total Number of SMS gateways |
短信网关的总数量 |
|
SMS gateway name |
短信网关的名称 |
|
SMS platform |
短信网关发送短信的平台，取值包括： · emay：亿美软通 · pingan：平安银行 · smp：SMP · tplink：TP-LINK |
|
App ID |
第三方短信平台的标识 |
|
Secret key |
加密短信数据的密钥（密文形式） |
|
VPN instance |
短信网关关联的VPN实例 |
|
URL |
TP-LINK短信平台的URL地址 |
|
Consumer ID |
平安银行短信平台的消费者编号 |
|
Provider ID |
平安银行短信平台的生产者编号 |
|
ChannelCode |
平安银行短信平台的渠道号 |
|
Access token |
平安银行短信平台的认证Token |
|
Message type |
平安银行短信平台的事件代码 |
|
Server host |
SMP安全管理平台的主机名 |
|
Server key |
SMP安全管理平台的密钥 |
# 显示所有短信网关的简要信息。
<Sysname> display sms-gateway brief
SMS gateway name SMS platform VPN instance
gw1 emay vpn1
gw2 emay vpn1
gw3 tplink vpn1
gw4 pingan vpn1
gw5 smp vpn1
表1-2 display sms-gateway brief命令显示信息描述表
|
字段 |
描述 |
|
SMS gateway name |
短信网关的名称 |
|
SMS platform |
短信网关发送短信的平台 短信网关发送短信的平台，取值包括： · emay：亿美软通 · pingan：平安银行 · smp：SMP · tplink：TP-LINK |
|
VPN instance |
短信网关关联的VPN实例，未配置时显示为“-” |
secret-key命令用来配置用于加密短信数据的密钥。
undo secret-key命令用来恢复缺省情况。
【命令】
secret-key { cipher | simple } string
undo secret-key
【缺省情况】
未配置用于加密短信数据的密钥。
【视图】
短信网关视图
【缺省用户角色】
network-admin
context-admin
【参数】
cipher：表示以密文方式设置密钥。
simple：表示以明文方式设置密钥，该密钥将以密文形式存储。
string：密钥字符串，区分大小写。明文密钥为1～63个字符的字符串；密文密钥为1～117个字符的字符串。
【使用指导】
仅当短信平台的类型为亿美软通、TP-LINK或SMP时，需要配置本命令。
本命令配置的密钥与app-id命令配置的第三方短信平台的标识一一对应。
当短信平台的类型为亿美软通（通过sms-platform emay命令配置）时，业务模块会将短信数据发送至短信网关，短信网关将短信数据解析并转换为第三方短信平台所能识别的数据，并使用密钥及算法对相应的数据进行加密，加密的数据通过短信网关发送至第三方短信平台。第三方短信平台接收加密的数据，通过查找HTTP请求报文首部字段内的标识（app-id值），匹配对应的密钥对数据进行解密。解密之后得到短信数据明文，最后由短信平台将短信发送至用户手机。
当短信平台的类型为TP-LINK（通过sms-platform tplink命令配置）时，业务模块会将短信数据发送至短信网关，短信网关将短信数据解析并转换为第三方短信平台所能识别的数据。短信网关将密钥、短信平台的标识、短信数据以及其他的参数一起封装在HTTPS请求报文中，发送至第三方短信平台。第三方短信平台收到HTTPS请求报文后，根据报文中的标识和密钥验证短信网关的身份，验证通过后由短信平台将短信发送至用户手机。
当短信平台的类型为SMP（通过sms-platform smp命令配置）时，需要通过本命令配置用户名和密码，格式为用户名:密码。
此密钥由第三方短信平台提供。
【举例】
# 在短信网关gw1下配置用于加密短信数据的明文密钥为TESTplat&！。
<Sysname> system-view
[Sysname] sms-gateway gw1
[Sysname-sms-gateway-gw1] secret-key simple TESTplat&！
【相关命令】
· app-id
sms-gateway命令用来创建短信网关，并进入短信网关视图。如果指定的短信网关已经存在，则直接进入短信网关视图。
undo sms-gateway命令用来删除指定的短信网关。
【命令】
sms-gateway gateway-name
undo sms-gateway gateway-name
【缺省情况】
不存在短信网关。
【视图】
系统视图
【缺省用户角色】
network-admin
context-admin
【参数】
gateway-name：短信网关名称，为1～31个字符的字符串，只能包含字母、数字、下划线，不区分大小写。
【使用指导】
设备通过短信网关实现短信发送功能。业务模块将短信数据发送至短信网关，短信网关根据配置策略将短信数据转换为第三方短信平台所能识别的数据，然后通过HTTP协议将数据发送给第三方短信平台，最后由第三方短信平台将短信发送至用户手机。
短信网关视图用来配置实现发送短信功能的相关参数，包括发送短信的方式、登录第三方短信平台的标识、用于加密短信数据的密钥等。
一个短信网关可以被多个有发送短信需求的业务模块引用。
【举例】
# 创建短信网关gw1，并进入短信网关视图。
<Sysname> system-view
[Sysname] sms-gateway gw1
[Sysname-sms-gateway-gw1]
【相关命令】
· display sms-gateway
sms-platform命令用来配置短信网关发送短信的平台。
undo sms-platform命令用来恢复缺省情况。
【命令】
sms-platform { emay | pingan sms-platform-url consumerid providerid channelcode accesstoken messagetype | smp server-host | tplink sms-platform-url }
undo sms-platform
【缺省情况】
未配置短信网关发送短信的平台。
【视图】
短信网关视图
【缺省用户角色】
network-admin
context-admin
【参数】
emay：表示第三方亿美软通短信平台。
pingan sms-platform-url：表示指定第三方短信平台为平安银行，sms-platform-url是平安银行短信平台的URL地址，为1～255个字符的字符串，不区分大小写。
consumerid：消费者编号，为1～10个字符的字符串，仅支持数字，在短信网关向平安银行短信平台发送请求报文时，将其填入HTTP报文头部的x-g-consumerid字段。
providerid：生产者编号，为1～10个字符的字符串，仅支持数字，在短信网关向平安银行短信平台发送请求报文时，将其填入HTTP报文头部的x-g-providerid字段。
channelcode：短信网关向平安银行短信平台发送请求报文时使用的渠道号，为1～10个字符的字符串，仅支持数字。
accesstoken：短信网关向平安银行短信平台发送请求报文时使用的认证Token，为1～63个字符的字符串，以明文方式设置，区分大小写。
messagetype：短信网关向平安银行短信平台发送请求报文时使用的事件代码，为1～63个字符的字符串，区分大小写。
smp server-host：表示指定短信平台为SMP安全管理平台，server-host是SMP短信平台的主机名，为1～127个字符的字符串，只能包含字母、数字、下划线、“:”“-”和“.”，不区分大小写。
tplink sms-platform-url：表示指定第三方短信平台为TP-LINK，sms-platform-url是TP-LINK短信平台的URL地址，为1～255个字符的字符串，不区分大小写。
【使用指导】
当短信平台的类型为亿美软通或TP-LINK时，本命令所配置的第三方短信平台还需要配合第三方短信平台的标识（通过app-id命令）和密钥（通过secret-key命令）才能使用。
当短信平台的类型为SMP时，本命令所配置的第三方短信平台还需要配置用户名和密钥（通过secret-key命令）才能使用。
当配置的URL中包括域名时，设备需要配置域名解析功能，以便将域名转化成对应的IP地址。有关域名解析的详细介绍，请参见“三层技术-IP业务”中的“域名解析”。
【举例】
# 在短信网关gw1下配置短信网关发送短信的平台为亿美软通短信平台。
<Sysname> system-view
[Sysname] sms-gateway gw1
[Sysname-sms-gateway-gw1] sms-platform emay
# 在短信网关gw2下配置短信网关发送短信的平台为TP-LINK短信平台，URL地址为https://example.com/EmPlat/rest/message/sendVpnCode。
<Sysname> system-view
[Sysname] sms-gateway gw2
[Sysname-sms-gateway-gw2] sms-platform tplink https://example.com/EmPlat/rest/message/sendVpnCode
# 在短信网关gw3下配置短信网关发送短信的平台为平安银行短信平台，URL地址为http://example.com.cn:8888/api/brcp_mpp.brcp-mpp-mms.sendOneRealTimeMsg，消费者编号为3031，生产者编号为679900，渠道号为104936，密钥为25F2B4DCC07F43768CF3D948791E461F，事件代码为NYH_ZH220119018。
<Sysname> system-view
[Sysname] sms-gateway gw3
[Sysname-sms-gateway-gw3] sms-platform pingan http://example.com.cn:8888/api/brcp_mpp.brcp-mpp-mms.sendOneRealTimeMsg 3031 679900 104936 25F2B4DCC07F43768CF3D948791E461F NYH_ZH220119018
# 在短信网关gw3下配置短信网关发送短信的平台为SMP短信平台，主机名为smp.test.com。
<Sysname> system-view
[Sysname] sms-gateway gw3
[Sysname-sms-gateway-gw3] sms-platform smp smp.test.com
【相关命令】
· app-id
· secret-key
sms-send test-mobile命令用来配置向测试手机号码发送短信。
【命令】
sms-send test-mobile number
【视图】
短信网关视图
【缺省用户角色】
network-admin
context-admin
【参数】
number：接收测试短信的手机号码，为1～31个字符的字符串，仅支持数字。
【使用指导】
通过向测试手机号码发送测试短信，判断配置的短信网关是否可以正常工作。如果在手机上接收到内容为“XXX（app-id）验证通过！”的测试短信，则认为此短信网关可以正常工作。
【举例】
# 在短信网关gw1下配置测试手机号码为111111。
<Sysname> system-view
[Sysname] sms-gateway gw1
[Sysname-sms-gateway-gw1] sms-send test-mobile 111111
【相关命令】
· app-id
· secret-key
· sms-platform
vpn-instance命令用来配置短信网关关联的VPN实例。
undo vpn-instance命令用来恢复缺省情况。
【命令】
vpn-instance vpn-instance-name
undo vpn-instance
【缺省情况】
短信网关属于公网。
【视图】
短信网关视图
【缺省用户角色】
network-admin
context-admin
【参数】
vpn-instance-name：短信网关关联的MPLS L3VPN的VPN实例名称，为1～31个字符的字符串，区分大小写。
【使用指导】
执行本命令后，短信网关包含的资源将属于关联的VPN实例。
每个短信网关只能关联一个VPN实例。
【举例】
# 配置短信网关gw1关联VPN实例vpn1。
<Sysname> system-view
[Sysname] sms-gateway gw1
[Sysname-sms-gateway-gw1] vpn-instance vpn1
不同款型规格的资料略有差异, 详细信息请向具体销售和400咨询。H3C保留在没有任何通知或提示的情况下对资料内容进行修改的权利!
支持
售前咨询
售后咨询
人工在线咨询
