发送短信

POST/sms

描述

版本

1.0
签名v2

说明

发送是异步处理，有可能会失败。
单次最大支持100张SIM卡。
每条信息最大支持140个字符。
短信在短信中心的保留时间从24小时到7天不等。
不是所有SIM卡都支持使用本API。详细信息请咨询FAE。

注意
存在以下任意异常，本次发送任务将提交失败，请重新提交发送
- 组织未开通短信发送权限（请与领科FAE、项目等相关支持人员确认）
- 存在归属不是api key对应组织的SIM卡
- 存在数据重复的SIM卡
- 存在不支持该类型短信发送的SIM卡
幂等
- 如果在10s内，在2个请求中发送相同的nonce、相同的sim_ids和相同的sms消息，将被视为同一个请求，并返回相同的job id。实际发送只会发生一次。
当请求超时时，可以使用上述方法检索job id。
- 否则，它将被视为一个新的请求，短信将再次发送。
结果查询
- 若发送短信任务提交成功，data中将返回job_id（发送短信的任务批次号）
- 查询方式
  - 通过API List all SMS by Job ID(MT)进行批量查询
  - 通过API List all SMS by ICCID (MT)进行单张SIM卡查询

SDK API 调用方式

PartnerClient client = new PartnerClient(accessKey,privateKey)
client.v2().sms().sendSms(SendSms.builder(1).iccids("89430101521032290054").messageContent("year of the rabbit").messageType(1).build())

请求参数

sim_ids

array[string]

必需

必填，最多100个iccid

message

object

必需

type

enum<integer>

必需

必填，1-text ；2-binary, 默认值1

枚举值:

默认值:

示例值:

content

string

最大140个字符

必需

{
  "sim_ids": [
    "389852123456789098762",
    "389852123456789098763",
    "389852123456789098764",
    "389852123456789098765"
  ],
  "message": {
    "type": 1,
    "content": "text"
  }
}

示例代码

返回响应

成功(200)

HTTP 状态码: 200

内容格式: JSONapplication/json

data

必需

Any of

object

#/definitions/41430733

string

job_id

string

必需

短信发送回执ID，可进行批量查询

status

#/definitions/41430733

必需

{
  "data": {
    "job_id": "SM20230721008470"
  },
  "status": {
    "code": "CB-00-0000",
    "message": "成功",
    "detail": "https://developer.linksfield.net/doc-1413557?nav=01GBM770ARR76AXBD5856Z6J6P"
  }
}

最后修改时间： 1 年前

发送短信

描述

版本

说明

注意

SDK API 调用方式

请求参数

示例代码

返回响应