Skip to content

短信下行发送

momi00 edited this page Aug 30, 2023 · 51 revisions

简要描述:

  • 下行短信接口

请求方式:

  • URL:http://api2.nxcloud.com/api/sms/mtsend
  • Method:POST
  • Content-Type: application/x-www-form-urlencoded
  • curl 示例 (使用-d参数以后,HTTP 请求会自动加上标头Content-Type : application/x-www-form-urlencoded。并且会自动将请求转为 POST 方法,因此可以省略-X POST。)
curl -d "appkey=1&secretkey=2&phone=123&content=abc" http://api2.nxcloud.com/api/sms/mtsend

参数:

参数名 必选 类型 说明
appkey string 短信应用appkey
secretkey string 短信应用secretkey
phone string 被叫号码(国码+手机号,比如:8615088888888),可以多个并且以","英文逗号隔开。如果是验证码通道的短信应用,不允许一次性提交超过5个号码
content string 短信内容,必须做urlencode(UTF-8),内容最长1000个字符
source_address string sourceaddress (必须为1-20位数字或英文字母)
sys_messageid string 用户自定义messageid,长度为10-50位之间,类型【0-9a-zA-Z-】(如果手机号码多于一个,此字段不生效)
short_link string 短链,数据来自于短链列表;如果此处赋值,短信内容里面必须包含#1#才能起作用,请注意
linkVerbose string 该参数设定的为是否收集用户点击行为,若选择收集用户点击行为,则可在控制台中查看点击了该短链接的号码信息。参数:1:收集;0:不收集。默认为收集
dr_url string dr推送地址(如同时在短信应用上也配置有dr推送地址,优先推送dr给本接口配置的地址) ;(如果手机号码多于一个,此字段不生效,请联系noc,设置到具体的短信应用上)
ext string 透传字段,该字段为自定义信息,在回执中会原样返回,仅支持http请求(如果手机号码多于一个,此字段不生效)
opt_entity_id string 请传印度(91)DLT规则注册后的实体ID(EntityId)
opt_template_id string 请传印度(91)DLT规则注册后的模板ID(TemplateId)
opt_header_id string 请传印度(91)DLT规则注册后的发件人ID(HeaderId)

返回示例

{"result":"请求成功","messageid":"20d6c660bd664c65bef20026564b0b79","code":"0"}

返回参数说明

参数名 类型 说明
result string 请求结果说明
messageid string 系统返回的短信ID
code string 结果编码

备注

-HTTP 错误代码

code 说明
0 请求成功
1 应用不可用或key错误
2 参数错误或为空
3 余额不足
4 内容为空或包含非法关键词
5 内容过长
6 号码有误
8 sourceaddress/sender必须为1-20位数字或英文字母
9 IP非法
27 开启了频率限制,已达到同一个号码在一小时内的允许发送上限 (1小时5条)
28 开启了TPS限流,当前流量已达到配置的TPS流速上限
88 请求失败
99 系统错误
102 当前账户或所属代理商账户已被停用
104 验证码通道的应用不允许一次性提交超过5个号码

-SMPP 提交短信错误代码

code 说明
10 [0x0000000A] sourceaddress (sender) 错误
81 [0x00000051] 号码错误
88 [0x00000058] 频率限制
103 [0x00000067] 余额不足
260 [0x00000104] 内容为空或包含非法关键词
69 提交失败,未知错误(投诉我们,我们查看日志)

简介

短信

语音

云呼叫中心(NXLink)

云呼叫中心(AI自动外呼)

Flash Call

短链

邮件验证码

DID号码

通用

号码检测

WhatsApp

Viber

Zalo ZNS

Super Message API

隐私号(旧)

PNS

坐席(旧版)

AI Agent

Clone this wiki locally