Skip to content

短信下行发送_v2

momi00 edited this page Aug 30, 2023 · 7 revisions

下行短信接口

  • URL:https://api2.nxcloud.com/api/sms/mtsend_v2
  • Method:POST
  • Content-Type:application/json
  • 需要鉴权:

鉴权机制

鉴权规则请参考地址:API接口调用约定


请求参数

header参数:

参数名 类型 必选 示例值 说明
accessKey String fmexxx3ki 用户身份标识
ts String 1655710885431 当前请求的时间戳(单位是毫秒),牛信服务端允许用户端请求最大时间误差为60秒
bizType String 3 业务类型,取固定值“3”
action String mtsend 业务操作,取固定值“mtsend”
sign String 6e95xxx826 API入参参数签名,签名算法

body参数:

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

请求示例

curl --location --request POST 'http://api2.nxcloud.com/api/sms/mtsend_v2' \
--header 'accessKey: asdfsdf' \
--header 'bizType: 3' \
--header 'action: mtsend' \
--header 'ts: 1683277109072' \
--header 'sign: 324324324234324' \
--header 'Content-Type: application/json' \
--data-raw '{
    "appKey": "appKey",
    "phone": "18651883168",
    "content": "content"
}'

响应参数

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

响应示例

成功示例

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

失败示例

{"result":"应用不可用或key错误","code":"1","messageid":""}

响应码说明

code 说明
0 请求成功
1000~10XX 详情参照API鉴权常见错误码
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个号码

简介

短信

语音

云呼叫中心(NXLink)

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

Flash Call

短链

邮件验证码

DID号码

通用

号码检测

WhatsApp

Viber

Zalo ZNS

Super Message API

隐私号(旧)

PNS

坐席(旧版)

AI Agent

Clone this wiki locally