一次性密码短信API

确保您的软件

介绍

与365美高美游戏大厅官网的OTP API365美高美游戏大厅官网很容易. 当您使用365美高美游戏大厅官网的休息 API将短信功能365美高美游戏大厅官网到您的应用程序中, 与从头开始构建OTP功能相比,您将节省数百个小时.

+, 您将与短信的全球领导者合作,您的应用程序的所有短信需求由一个提供专家支持的提供商覆盖.


概述的功能 滚动到最热门的▲


如何开始 滚动到最热门的▲

下面的示例演示如何启动验证过程,向最终用户发送验证码.

发送OTP 滚动到最热门的▲

这可以用于发送OTP.


var 有效载荷 = {
  起源: “从”,
  消息: '{*代码*}是您的365美高美游戏大厅官网验证码.',
  目的地: “目的地”
};
// {*代码*}占位符是强制性的,将被自动生成的数字代码替换.
smsglobal.otp.发送(有效载荷, 函数(错误, 响应) {
  if (响应) {
    控制台.日志(响应);
  }
  if (错误) {
    控制台.日志(错误);
  }
});
成功响应对象
{
  状态Code: 200,
  状态: 'OK',
  data: {
    requestId: '404372541683676561917558',
    目的地: '61400000000',
    validUnitlTimestamp: '2020-11-18 17:08:14',
    createdTimestamp: '2020-11-18 16:58:14',
    lastEventTimestamp: '2020-11-18 16:58:14',
    状态: “发送”
  }
}
验证错误时的错误响应对象
{
  状态Code: 400,
  状态: “糟糕的请求”,
  data: {
    错误: {
     消息: {
      错误: [
       '消息模板应该包含代码i的占位符.e. {*代码*}.'
      ]
     }
    }
  }
}

 require_once __DIR__ . ' /供应商/自动装载.php的;
 //从MXT http://mxt获取您的休息 API密钥.trumpfortlauderdale.com/integrations
 \365美高美游戏大厅官网\凭证::(“YOUR_API_KEY”, “YOUR_SECRET_KEY”);
 $otp =  \365美高美游戏大厅官网\资源\Otp();
 试一试 {
    $响应 = $otp->发送(“DESTINATION_NUMBER”, '{*代码*}是您的365美高美游戏大厅官网验证码.');
    print_r($响应);
 }  (\异常 $e) {
    回声 $e->getMessage();
 }
以下json响应将由服务器返回:
{
    "requestId": "404372541683674336263499",
    "validUnitlTimestamp": "2020-11-18 16:24:51",
    "createdTimestamp": "2020-11-18 16:22:51",
    "lastEventTimestamp": "2020-11-18 16:22:51",
    "目的地": "61400000000",
    "状态": "发送"
}
 
var 客户端 =  客户端( 凭证("短信GLOBAL-API-KEY", "短信GLOBAL-SECRET-KEY"));
var 响应 = 等待 客户端.OTP.OTPSend(
 {
    消息 = "{*代码*}是您的365美高美游戏大厅官网验证码.",
    目的地 = "目标设备号码",
});

响应对象将包含OTP细节,如请求id,目标编号,如:


{
 "requestId":"409261431691990777288109",
 "目的地":"61450000000",
 "validUnitlTimestamp":"2021-02-18 11:39:07",
 "createdTimestamp":"2021-02-18 11:29:07",
 "lastEventTimestamp":"2021-02-18 11:29:08",
 "状态":"发送",
 "状态code":200,
 "状态消息":"OK"
}

取消OTP请求 滚动到最热门的▲

如果OTP请求没有过期和验证,则可以取消该请求. 它可以通过使用 requestId or 目的地数量. 以下是每种方法的例子:


var id = “otp-request-id”; //在发送OTP时收到requesttid
 var 承诺 = smsglobal.otp.cancelByRequestId(id)
 承诺.然后((响应) => {
  控制台.日志(响应)
 }).((犯错) => {
  控制台.日志(错误)
 });
var 目的地 = “目标设备号码”;
var 承诺 = smsglobal.otp.cancelByDestination(id)
承诺.然后((响应) => {
  控制台.日志(响应)
}).((犯错) => {
  控制台.日志(错误)
});
成功响应对象
{
  状态Code: 200,
  状态: 'OK',
  data: {
    requestId: '404372541683676561917558',
    目的地: '61400000000',
    validUnitlTimestamp: '2020-11-18 17:08:14',
    createdTimestamp: '2020-11-18 16:58:14',
    lastEventTimestamp: '2020-11-18 16:58:14',
    状态: “取消”
  }
}
require_once __DIR__ . ' /供应商/自动装载.php的;
 //从MXT http://mxt获取您的休息 API密钥.trumpfortlauderdale.com/integrations
 \365美高美游戏大厅官网\凭证::(“YOUR_API_KEY”, “YOUR_SECRET_KEY”);
 $otp =  \365美高美游戏大厅官网\资源\Otp();
 试一试 {
    $响应 = $otp->cancelByRequestId(“请求Id”);
    print_r($响应);
 }  (\异常 $e) {
    回声 $e->getMessage();
 }
require_once __DIR__ . ' /供应商/自动装载.php的;
//从MXT http://mxt获取您的休息 API密钥.trumpfortlauderdale.com/integrations
\365美高美游戏大厅官网\凭证::(“YOUR_API_KEY”, “YOUR_SECRET_KEY”);
$otp =  \365美高美游戏大厅官网\资源\Otp();
试一试 {
    $响应 = $otp->cancelByDestination(“目的地号码”);
    print_r($响应);
}  (\异常 $e) {
    回声 $e->getMessage();
}

如果取消成功,服务器将返回以下json响应:


{
    "requestId": "404372541683674336263499",
    "validUnitlTimestamp": "2020-11-18 16:24:51",
    "createdTimestamp": "2020-11-18 16:22:51",
    "lastEventTimestamp": "2020-11-18 16:22:51",
    "目的地": "61400000000",
    "状态": "取消了"
}
 
var 客户端 =  客户端( 凭证("短信GLOBAL-API-KEY", "短信GLOBAL-SECRET-KEY"));
 字符串 requestid = "请求id";
 var 响应 = 等待 客户端.OTP.OTPCancelRequest(requestid);
var 客户端 =  客户端( 凭证("短信GLOBAL-API-KEY", "短信GLOBAL-SECRET-KEY"));
字符串 目的地 = "目标设备号码";
var 响应 = 等待 客户端.OTP.OTPCancelDestination(目的地);

响应对象将包含OTP细节,如请求id,目标编号,如:


{
 "requestId":"409261431691990777288109",
 "目的地":"61450000000",
 "validUnitlTimestamp":"2021-02-18 11:39:07",
 "createdTimestamp":"2021-02-18 11:29:07",
 "lastEventTimestamp":"2021-02-18 11:29:08",
 "状态":"取消了 ",
 "状态code":200,
 "状态消息":"OK"
 }

验证用户输入的OTP代码 滚动到最热门的▲

用户输入的OTP代码可以通过以下两种方式进行验证 requestId or 目的地数量. 以下是每种方法的例子:


var id = “otp-request-id”; //在发送OTP时收到requesttid
var code = “otp-code”; //用户输入的代码
smsglobal.otp.verifyByRequestId(id, code, 函数(错误, 响应) {
  if (响应) {
    控制台.日志(响应);
  }
  if (错误) {
    控制台.日志(错误);
  }
});
var 目的地 = “目标设备号码”;
var code = “otp-code”; //用户输入的代码
smsglobal.otp.verifyByDestination(id, code, 函数(错误, 响应) {
  if (响应) {
    控制台.日志(响应);
  }
  if (错误) {
    控制台.日志(错误);
  }
});
成功响应对象
{
  状态Code: 200,
  状态: 'OK',
  data: {
    requestId: '404372541683676561917558',
    目的地: '61400000000',
    validUnitlTimestamp: '2020-11-18 17:08:14',
    createdTimestamp: '2020-11-18 16:58:14',
    lastEventTimestamp: '2020-11-18 16:58:14',
    状态: “验证”
  }
}

 require_once __DIR__ . ' /供应商/自动装载.php的;
 //从MXT http://mxt获取您的休息 API密钥.trumpfortlauderdale.com/integrations
 \365美高美游戏大厅官网\凭证::(“YOUR_API_KEY”, “YOUR_SECRET_KEY”);
 $otp =  \365美高美游戏大厅官网\资源\Otp();
 试一试 {
    $响应 = $otp->verifyByRequestId(“请求Id”, '您的用户输入的OTP代码.');
    print_r($响应);
 }  (\异常 $e) {
    回声 $e->getMessage();
 }

require_once __DIR__ . ' /供应商/自动装载.php的;
//从MXT http://mxt获取您的休息 API密钥.trumpfortlauderdale.com/integrations
\365美高美游戏大厅官网\凭证::(“YOUR_API_KEY”, “YOUR_SECRET_KEY”);
$otp =  \365美高美游戏大厅官网\资源\Otp();
试一试 {
    $响应 = $otp->verifyByDestination(“目的地号码”, '您的用户输入的OTP代码.');
    print_r($响应);
}  (\异常 $e) {
    回声 $e->getMessage();
}

如果验证成功,服务器将返回以下json响应:


{
    "requestId": "404372541683674336263499",
    "validUnitlTimestamp": "2020-11-18 16:24:51",
    "createdTimestamp": "2020-11-18 16:22:51",
    "lastEventTimestamp": "2020-11-18 16:22:51",
    "目的地": "61400000000",
    "状态": "验证"
}
 
var 客户端 =  客户端( 凭证("短信GLOBAL-API-KEY", "短信GLOBAL-SECRET-KEY"));
字符串 requestid = "请求id";
字符串 code = "OTP-CODE";
var 响应 = 等待 客户端.OTP.OTPValidateRequest(requestid, 
{
    code = code,
});
var 客户端 =  客户端( 凭证("短信GLOBAL-API-KEY", "短信GLOBAL-SECRET-KEY"));
字符串 目的地id = "目标设备号码";
字符串 code = "OTP-CODE";
var 响应 = 等待 客户端.OTP.OTPValidateDestination(目的地id, 
{
    code = code,
});

响应对象将包含OTP细节,如请求id,目标编号,如:


{
 "requestId":"409261431691990777288109",
 "目的地":"61450000000",
 "validUnitlTimestamp":"2021-02-18 11:39:07",
 "createdTimestamp":"2021-02-18 11:29:07",
 "lastEventTimestamp":"2021-02-18 11:29:08",
 "状态":"验证",
 "状态code":200,
 "状态消息":"OK"
}

休息 API端点 滚动到最热门的▲

身份验证

休息 API使用基于的身份验证方案 此OAuth 2规范 . 所有对资源的请求(不包括 模式 页)必须附有一个正确的 授权 标题按此规范. 头部看起来像这样:

 授权:MAC id="您的API密钥", ts="1325376000", 现时标志= "随机字符串", mac = " base64-encoded-hash " 


  • OTP
    / v2 / otp
    • 帖子 / v2 / otp β 自从v2

      文档

      发送一个OTP消息到指定的目的地号码

      参数

      参数类型要求?格式描述
      消息字符串真正的请求标识符
      长度整数码的长度在4-10位之间. 默认值是6.
      codeExpiry整数No. OtpApi过期后的秒数. 应该是60秒或更长时间. 默认为10分钟
      起源字符串短信从何而来. 3-11 characters A-Za-z0-9 if alphanumeric; 3日- 15日的数字 if numeric
      目的地字符串真正的目标手机号码. 3日- 15日的数字
      消息ExpiryDateTimedatetimeyyyy-MM-dd HH: mm: ss消息中的UTC日期时间将过期.

      返回

      参数类型版本描述
      requestId字符串>=v2消息模板. E.g. {*代码*}是您的安全代码. 消息只有在包含代码占位符i时才有效.e. {*代码*}.
      目的地字符串>=v2目标手机号码. 4-15数字
      validUnitlTimestampDateTime>=v2返回关联用户的帐户时区的validUnitlTimestamp
      createdTimestampDateTime>=v2返回关联用户帐户时区中的createdTimestmap
      lastEventTimestampDateTime>=v2返回关联用户的帐户时区中的lastEventTimestamp
      状态字符串>=v2返回人类可读状态

      状态码

      状态码描述
      200
      • 成功时返回
      400
      • 输入验证失败时返回
      402
      • 当帐户用完时返回
      403
      • 当用户未被授权时返回
      405
      • 方法不允许
    / v2 / otp / requestid / {id} /取消
    • 帖子 / v2 / otp / requestid / {id} /取消 β 自从v2

      文档

      取消一个由请求id标识的OTP请求.

      需求

      的名字要求类型描述
      id字符串请求Id

      返回

      参数类型版本描述
      requestId字符串>=v2请求标识符
      目的地字符串>=v2目标手机号码. 4-15数字
      validUnitlTimestampDateTime>=v2返回关联用户的帐户时区的validUnitlTimestamp
      createdTimestampDateTime>=v2返回关联用户帐户时区中的createdTimestmap
      lastEventTimestampDateTime>=v2返回关联用户的帐户时区中的lastEventTimestamp
      状态字符串>=v2返回人类可读状态

      状态码

      状态码描述
      200
      • 成功时返回
      403
      • 当用户未被授权时返回
      404
      • 当OTP未找到时返回
      405
      • 方法不允许
    / v2 / otp / requestid / {id} /验证
    • 帖子 / v2 / otp / requestid / {id} /验证 β 自从v2

      文档

      针对由请求id标识的OTP请求验证一个OTP代码.

      需求

      的名字要求类型描述
      id字符串请求Id

      参数

      参数类型要求?格式描述
      code字符串真正的用户输入的OtpApi验证码.

      返回

      参数类型版本描述
      requestId字符串>=v2请求标识符
      目的地字符串>=v2目标手机号码. 4-15数字
      validUnitlTimestampDateTime>=v2返回关联用户的帐户时区的validUnitlTimestamp
      createdTimestampDateTime>=v2返回关联用户帐户时区中的createdTimestmap
      lastEventTimestampDateTime>=v2返回关联用户的帐户时区中的lastEventTimestamp
      状态字符串>=v2返回人类可读状态

      状态码

      状态码描述
      200
      • 成功时返回
      400
      • 输入验证失败时返回
      403
      • 当用户未被授权时返回
      404
      • 当OTP未找到时返回
      405
      • 方法不允许
    / v2 / otp / {msisdn} /取消
    • 帖子 / v2 / otp / {msisdn} /取消 β 自从v2

      文档

      取消由目的号码标识的OTP请求.

      需求

      的名字要求类型描述
      msisdn字符串目的地数量

      返回

      参数类型版本描述
      requestId字符串>=v2请求标识符
      目的地字符串>=v2目标手机号码. 4-15数字
      validUnitlTimestampDateTime>=v2返回关联用户的帐户时区的validUnitlTimestamp
      createdTimestampDateTime>=v2返回关联用户帐户时区中的createdTimestmap
      lastEventTimestampDateTime>=v2返回关联用户的帐户时区中的lastEventTimestamp
      状态字符串>=v2返回人类可读状态

      状态码

      状态码描述
      200
      • 成功时返回
      403
      • 当用户未被授权时返回
      404
      • 当OTP未找到时返回
      405
      • 方法不允许
    / v2 / otp / {msisdn} /验证
    • 帖子 / v2 / otp / {msisdn} /验证 β 自从v2

      文档

      根据目标编号识别的OTP请求验证OTP代码.

      需求

      的名字要求类型描述
      msisdn字符串目的地数量

      参数

      参数类型要求?格式描述
      code字符串真正的用户输入的OtpApi验证码.

      返回

      参数类型版本描述
      requestId字符串>=v2请求标识符
      目的地字符串>=v2目标手机号码. 4-15数字
      validUnitlTimestampDateTime>=v2返回关联用户的帐户时区的validUnitlTimestamp
      createdTimestampDateTime>=v2返回关联用户帐户时区中的createdTimestmap
      lastEventTimestampDateTime>=v2返回关联用户的帐户时区中的lastEventTimestamp
      状态字符串>=v2返回人类可读状态

      状态码

      状态码描述
      200
      • 成功时返回
      400
      • 输入验证失败时返回
      403
      • 当用户未被授权时返回
      404
      • 当OTP未找到时返回
      405
      • 方法不允许
加载形式
友情链接: 1 2 3 4 5