-
Notifications
You must be signed in to change notification settings - Fork 6
短信下行发送_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接口调用约定
| 参数名 | 类型 | 必选 | 示例值 | 说明 |
|---|---|---|---|---|
| accessKey | String | 是 | fmexxx3ki | 用户身份标识 |
| ts | String | 是 | 1655710885431 | 当前请求的时间戳(单位是毫秒),牛信服务端允许用户端请求最大时间误差为60秒 |
| bizType | String | 是 | 3 | 业务类型,取固定值“3” |
| action | String | 是 | mtsend | 业务操作,取固定值“mtsend” |
| sign | String | 是 | 6e95xxx826 | API入参参数签名,签名算法 |
| 参数名 | 类型 | 必选 | 说明 |
|---|---|---|---|
| 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个号码 |
简介
短信
语音
- 上传语音录音文件
- 上传语音录音文件_v1
- 已上传录音文件查询
- 发送语音群呼
- 发送语音通知
- 发送语音验证码
- 语音验证码回填上报
- 语音回执回调
- 语音记录查询
- 上传语音录音文件-旧版本已废弃
- 发送语音群呼‐旧版已废弃
- 发送语音通知‐旧版已废弃
- 发送语音验证码‐旧版已废弃
- 语音回执回调‐旧版已废弃
云呼叫中心(NXLink)
- Web SDK
- Iframe集成
- 手动拨号通话记录查询
- 通过orderId查询
- 手动拨号记录回调
- 坐席信息查询
- 坐席状态查询
- 坐席状态信息查询
- 坐席组查询
- 坐席可用主叫查询
- 坐席组成员查询
- 坐席组更新成员
- 坐席效率统计
- 创建AICC外呼任务
- Webhook-手动外呼
云呼叫中心(AI自动外呼)
- Callbot API概述
- Callbot API鉴权
- Callbot 接口探活
- 创建自动拨号任务
- 批量添加拨打名单
- 创建自动拨号任务并添加拨打名单
- 任务控制(启动/暂停)
- 更新任务
- 获取通话列表
- 获取任务列表
- 获取拨打订单列表
- 停止订单拨打
- 查询订单维度拨打详情
- 通话维度回调
- 订单维度拨打回调
- 任务状态回调
- 批次-导出最新批次数据
- 批次-导入最新批次数据
Flash Call
短链
邮件验证码
DID号码
- DID号码进行短信下行V2
- DID短信结果回调(加签)
- DID短信结果回调(无加签)
- DID号码短信记录查询(新接口,未启用)
- DID号码通话记录查询
- DID呼出并转接到Amazon坐席
- DID呼出前与Connect号码绑定
通用
号码检测
- 发送消息
- 发送otp消息
- webhook
- 标记入站消息已读
- 上传媒体文件
- 获取媒体文件
- 删除媒体文件
- 查询号码信息
- 查询消息模板
- 创建消息模板
- 异步创建消息模板
- 编辑消息模板
- 删除消息模板
- 上传模板示例文件
- 嵌入式页面登录
- 创建客户应用
- 客户应用的号码列表
- 获取验证码
- 核验验证码
- flows-创建流
- flows-更新流
- flows-根据流ID查询流信息
- flows-根据whatsapp号码查询流列表
- flows-根据流ID查询流预览地址
- flows-查询流JSON
- flows-发布流
- flows-删除流草稿
- flows-废弃已发布的流
- flows-更新流JSON
- flows-上传业务公钥
- ads-根据公共主页ID查询绑定的数据集列表
- ads-根据数据集ID上报CAPI广告数据
- 封锁用户
- 业务主页
- 查询消息记录
- 查询calling配置
- 查询calling通话记录
- 禁用calling配置
- 启用calling配置
Viber
Zalo ZNS
Super Message API
隐私号(旧)
PNS
坐席(旧版)
- NXphone PC 使用说明
- NXphone Android 使用说明
- NXphone Android SDK 接入文档
- 呼叫挂断原因解释
- 话单CDR查询接口
- 话单CDR回调接口说明(V1.0)
- 坐席API调用接口说明(V1.0)
- 根据orderid查询话单CDR接口
- 坐席系统sip链接调用方式(推荐)
- 号码脱敏处理
- 修改话机密码接口
- 查询审批单
- 查询话机
- WebRTC SDK使用说明
AI Agent