Smarthub Api Cn
  1. 短信服务
  • 概述
    • 全局说明
  • SIM卡管理
    • 获取SIM卡详细信息
      GET
    • 批量获取SIM卡详细信息
      GET
    • 获取SIM卡历史变更记录
      GET
    • 获取SIM卡自定义字段
      GET
    • 修改SIM卡自定义字段
      PUT
    • 激活SIM卡
      POST
    • 停用SIM卡
      POST
    • 失效SIM卡
      POST
    • SIM卡订购补充资费方案
      POST
    • 修改SIM卡基础资费方案
      PUT
    • 修改apn状态
      PUT
  • SIM卡批量操作
    • 批量激活SIM卡
      POST
    • 批量停用SIM卡
      POST
    • 批量失效SIM卡
      POST
    • 批量修改SIM卡基础资费方案
      POST
    • 获取批量任务详情
      GET
  • 短信服务
    • 发送下行短信
      POST
    • 查询下行短信发送状态
      GET
    • 上行短信推送
      POST
    • MT短信状态报告推送
      POST
  • 订阅通知
    • 通知用户其SIM卡周期用量已到达设置的告警阈值
      POST
    • 通知用户其SIM卡关联终端IMEI已变更
      POST
    • 通知用户其SIM卡已长时间无网络连接
      POST
    • 通知用户其SIM卡订购的预付资费方案即将到期
      POST
    • 通知用户其SIM卡订购的预付流量使用已到达设置的告警阈值
      POST
    • 通知用户其SIM卡状态已经改变
      POST
    • 通知用户其SIM卡的APN状态已经改变
      POST
  • 共享流量池
    • 获取流量池信息
  • 企业信息
    • 获取企业信息
    • 获取帐户信息
    • 获取资费方案信息
  • Sim卡统计
    • 获取SIM卡统计的国家码的流量和卡数
  • 数据模型
    • Schemas
      • PushSimApnStatusChangeModel
      • MtSmsResult
      • SimChangeLogType
      • BatchJobType
      • BatchJobResponse
      • ApnStatus
      • BatchJobStatus
      • BatchJobTaskStatus
      • Giccid
      • IMEI
      • IMSI
      • MSISDN
      • SimStatus
      • SimStatusParam
      • SimChangeLogStatus
      • MtSmsStatus
      • Signature
      • Response422
      • ServicePackage
      • ServicePackageParam
      • SimCustomField
      • BasePushModel
      • MtStatusPushModel
      • MoPushModel
      • BaseEventModel
      • BaseTriggerDataModel
      • PushCycleUsageTrackingModel
      • PushImeiChangeModel
      • PushNoSessionConnectionModel
      • PushPrepaidServicePackageExpiredModel
      • PushPrepaidServicePackageTrafficTrackingModel
      • PushSimStatusChangeModel
      • SimDetail
      • SimInfoList
      • SimChangeLog
      • BatchJobInfo
  1. 短信服务

发送下行短信

POST
/mt-sms
发送下行短信为异步操作，该接口调用成功表明下行短信已经被平台接收，只有当 status 字段为 DELIVERED
时，才表示下行短信送达终端。
发送下行短信, toGiccid、messageText必填。
短信发送时的编码格式定义:
编码格式描述
0默认编码方案, 取决于运营商的网络配置
1ASCII 表示IA5 (CCITT T.50)/ASCII (ANSI X3.4)
4二进制

消息有效期#

该值定义消息在过期前在 SMSC 中保存的时间长度。消息中心会尝试在此有效期内向移动设备发送消息。如果在此期限结束时消息仍无法传送到设备
(例如，由于设备关机或不在服务区) ，消息将被丢弃。 默认值为 1。
tpvp 参数支持长度为 5 分钟到 63 周之前的有效期，使用由 GSM 03.40 标准定义的 TP-VP 相对格式:
TPVP值有效期可能有效期
0-143(tpvp+1) * 5 分钟5、10、15,…715, 720 （分钟）
144-167(12+(tpvp-143)/2) 小时12:30,13:00,…23:30,24:00 （小时）
168-196(tpvp – 166) 天2, 3, 4, …30 天
197-255(tpvp – 192) 周5, 6, 7, …63 周
返回值 status 定义如下:
状态描述
DELIVERED已送达
PENDING发送中
FAILED发送失败
UNKNOWN未知错误

请求参数

Header 参数

Body 参数application/json

示例
{
    "requestId": "150aa0f9bc6441378938a1e6c6e222f9",
    "toGiccid": "8986011805021000040",
    "messageEncoding": "LITERAL",
    "dataCoding": 0,
    "messageText": "测试短信",
    "pushAck": 0,
    "tpvp": 0
}

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/mt-sms' \
--header 'X-API-Key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "requestId": "150aa0f9bc6441378938a1e6c6e222f9",
    "toGiccid": "8986011805021000040",
    "messageEncoding": "LITERAL",
    "dataCoding": 0,
    "messageText": "测试短信",
    "pushAck": 0,
    "tpvp": 0
}'

返回响应

🟢200成功
application/json
添加发送下行短信任务成功
Body

示例
{
    "smsMsgId": "fa68483a97614af7afe95211941ef1e4",
    "requestId": "150aa0f9bc6441378938a1e6c6e222f9",
    "status": "DELIVERED",
    "toGiccid": "8986011805021000040",
    "dateSent": "2018-10-10T10:32:50+0000",
    "dateReceived": "2018-10-10T10:33:50+0000"
}
修改于 2024-11-06 08:54:50
上一页
获取批量任务详情
下一页
查询下行短信发送状态
Built with