栏目

系统知识

System Knowledge

当前位置:首页 > 系统知识

云极新系统国际短信API接入文档

2023-03-24

1. 接口描述

为用户提供简单、迅速、低成本的国际短信发送能力。只需接入国际短信网关就能给世界上任何手机发送信息,真正做到一点接入全球覆盖。

2. 使用场景

在业务系统中,调用指定接口实现国际短信的发送。

3. 接口说明

  • 3.1. 发送国际短信
  • 实现国际短信的发送。
    • 3.1.1. 接口协议
    • HTTP POST
    • 3.1.2. 接口方法
    • https://api.juncyun.com/api/msgService/internationalMsg/sendInternationalSms
    • 3.1.3. 报头定义
    • 编码 列表 内容 备注
      1 Accept application/json
      2 Content-Type application/json;charset=utf-8
    • 3.1.4. 请求参数
      • 3.1.4.1. 请求参数列表
      • 编码 列表 内容 备注
        1 accessKey API调用账号(必填)
        2 accessSecret API调用密钥(必填)
        3 msgType 短信类型(必填):1-验证码,2-短信通知,3-会员营销
        4 templateCode 短信模版code(选填,模版code与内容二选一)
        5 phone 目标手机号(必填)
        6 params 参数(选填,map类型),若有参数则必填且参数需与所选模版中参数名称以及数量一致
        7 msgContent 短信内容(选填,模版code与内容二选一)
      • 3.1.4.2. 请求参数示例
        • {
        • "accessKey": "NDYw*******",
        • "accessSecret": "MDQyOTQ1OTM3*********************",
        • "msgType":1,
        • "templateCode":"62pu****",
        • "phone":"9113735886671",
        • "params": [
        • {
        • "code":"1234"
        • }
        • ]
        • }
    • 3.1.5. 响应参数
      • 3.1.5.1. 响应参数列表
      • 编码 列表 内容 备注
        1 code 状态码200则为成功
        2 msg 状态说明
        3 success 处理是否成功:取值范围 true,false
        4 data 业务数据 如果失败则为空
        5 taskId 本次任务id
        6 allNum 手机号码总数量
      • 3.1.5.2. 响应参数示例
        • {
        • "code": 200,
        • "msg": "成功",
        • "success": true,
        • "data": {
        • "taskId":"1545114656135451",
        • "allNum":1
        • }
        • }
国际短信API接入