JSMS iOS SDK API 描述
最近更新：2024-04-17
展开全部
JSMS iOS SDK API 描述
特别提示：极光短信的客户端 SDK 已不再更新维护，请开发者使用 Rest API 完成业务逻辑
获取短信验证码
接口说明
获取短信验证码接口：创建获取短信验证码的按钮，或者是在自己已有的界面的按钮事件里调用获取短信验证码的方法。
+ (void)getVerificationCodeWithPhoneNumber:(NSString * _Nonnull)number
andTemplateID:(NSString * _Nonnull)templateID
completionHandler:(JSMSCompletionHandler _Nonnull)handler;
+ (void)getVerificationCodeWithPhoneNumber:(NSString * _Nonnull)number
andTemplateID:(NSString * _Nonnull)templateID
completionHandler:(JSMSCompletionHandler _Nonnull)handler;
此代码块在浮窗中显示
参数说明
- number :手机号码
- templateID:短信模板 ID
- handler:请求成功或者失败的回调
调用示例
//点击获取短信验证码
- (IBAction)sendSmsAuthCode:(id)sender {
[JSMSSDK getVerificationCodeWithPhoneNumber:@"152xxxxxxxx" andTemplateID:@"1" completionHandler:^(id resultObject, NSError *error) {
if (!error) {
NSLog(@"Get verification code success!");
}else{
NSLog(@"Get verification code failure!");
NSLog(@"%@",error);
}
}];
}
//点击获取短信验证码
- (IBAction)sendSmsAuthCode:(id)sender {
[JSMSSDK getVerificationCodeWithPhoneNumber:@"152xxxxxxxx" andTemplateID:@"1" completionHandler:^(id resultObject, NSError *error) {
if (!error) {
NSLog(@"Get verification code success!");
}else{
NSLog(@"Get verification code failure!");
NSLog(@"%@",error);
}
}];
}
此代码块在浮窗中显示
获取语音验证码
接口说明
获取语音验证码接口：创建获取语音验证码的按钮，或者是在自己已有的界面的按钮事件里调用获取语音验证码的方法。
1.2.0版本新增--获取语音验证码接口。
+ (void)getVoiceVerificationCodeWithPhoneNumber:(NSString * _Nonnull)number
completionHandler:(JSMSCompletionHandler _Nonnull)handler;
+ (void)getVoiceVerificationCodeWithPhoneNumber:(NSString * _Nonnull)number
completionHandler:(JSMSCompletionHandler _Nonnull)handler;
此代码块在浮窗中显示
参数说明
- number :手机号码
- handler:请求成功或者失败的回调
调用示例
//点击获取语音验证码
- (IBAction)sendVoiceAuthCode:(id)sender {
[JSMSSDK getVoiceVerificationCodeWithPhoneNumber:@"152xxxxxxxx" completionHandler:^(id resultObject, NSError *error) {
if (!error) {
NSLog(@"Get voice verification code success!");
}else{
NSLog(@"Get voice verification code failure!");
NSLog(@"%@",error);
}
}];
}
//点击获取语音验证码
- (IBAction)sendVoiceAuthCode:(id)sender {
[JSMSSDK getVoiceVerificationCodeWithPhoneNumber:@"152xxxxxxxx" completionHandler:^(id resultObject, NSError *error) {
if (!error) {
NSLog(@"Get voice verification code success!");
}else{
NSLog(@"Get voice verification code failure!");
NSLog(@"%@",error);
}
}];
}
此代码块在浮窗中显示
获取语音验证码（可设置播报语言）
接口说明
获取语音验证码接口：创建获取语音验证码的按钮，或者是在自己已有的界面的按钮事件里调用获取语音验证码的方法。
1.4.0版本新增--获取语音验证码，可设置播报语言类型。
+ (void)getVoiceVerificationCodeWithPhoneNumber:(NSString * _Nonnull)number
languageOptions:(JSMSLanguageOptions)options
completionHandler:(JSMSCompletionHandler _Nonnull)handler;
+ (void)getVoiceVerificationCodeWithPhoneNumber:(NSString * _Nonnull)number
languageOptions:(JSMSLanguageOptions)options
completionHandler:(JSMSCompletionHandler _Nonnull)handler;
此代码块在浮窗中显示
参数说明
- number :手机号码
- options:播报语言。参数无效时，默认中文播报
- handler:请求成功或者失败的回调
调用示例
//点击获取语音验证码
- (IBAction)sendVoiceAuthCode:(id)sender {
[JSMSSDK getVoiceVerificationCodeWithPhoneNumber:@"152xxxxxxxx"
languageOptions:JSMSLanguage_zh_Hans
completionHandler:^(id resultObject, NSError *error) {
if (!error) {
NSLog(@"Get voice verification code success!");
}else{
NSLog(@"Get voice verification code failure!");
NSLog(@"%@",error);
}
}];
}
//点击获取语音验证码
- (IBAction)sendVoiceAuthCode:(id)sender {
[JSMSSDK getVoiceVerificationCodeWithPhoneNumber:@"152xxxxxxxx"
languageOptions:JSMSLanguage_zh_Hans
completionHandler:^(id resultObject, NSError *error) {
if (!error) {
NSLog(@"Get voice verification code success!");
}else{
NSLog(@"Get voice verification code failure!");
NSLog(@"%@",error);
}
}];
}
此代码块在浮窗中显示
验证验证码
接口说明
验证验证码：创建提交验证码的按钮，或者是在自己已有的界面的按钮事件里调用提交验证码的方法。
+ (void)commitWithPhoneNumber:(NSString * _Nonnull)number
verificationCode:(NSString * _Nonnull)vCode
completionHandler:(JSMSCompletionHandler _Nonnull)handler;
+ (void)commitWithPhoneNumber:(NSString * _Nonnull)number
verificationCode:(NSString * _Nonnull)vCode
completionHandler:(JSMSCompletionHandler _Nonnull)handler;
此代码块在浮窗中显示
参数说明
- number:手机号码
- vCode:短信验证码
- handler:请求成功或者失败的回调
调用示例
//验证验证码
[JSMSSDK commitWithPhoneNumber:@"152xxxxxxxx" verificationCode:@"123456" completionHandler:^(id resultObject, NSError *error) {
if (!error) {
NSLog(@"Commit verification vode success!");
}else{
NSLog(@"%@",error);
NSLog(@"Commit verification code failure!");
}
}];
//验证验证码
[JSMSSDK commitWithPhoneNumber:@"152xxxxxxxx" verificationCode:@"123456" completionHandler:^(id resultObject, NSError *error) {
if (!error) {
NSLog(@"Commit verification vode success!");
}else{
NSLog(@"%@",error);
NSLog(@"Commit verification code failure!");
}
}];
此代码块在浮窗中显示
设置请求验证码时间间隔
接口说明
设置获取验证码请求时间间隔的接口：在设置时间间隔内只能发送一次获取验证码的请求。如果不调用此接口，sdk 默认间隔是 30s。
1.2.0版本新增--设置获取验证码请求时间间隔的接口。
+ (void)setMinimumTimeInterval:(NSTimeInterval)seconds;
+ (void)setMinimumTimeInterval:(NSTimeInterval)seconds;
此代码块在浮窗中显示
参数说明
- seconds:时间间隔
调用示例
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
[JSMSSDK setMinimumTimeInterval:60];
return YES;
}
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
[JSMSSDK setMinimumTimeInterval:60];
return YES;
}
此代码块在浮窗中显示
错误码描述
错误码 |
错误码描述 |
备注 |
|---|---|---|
| 2993 | uuid 错误，验证码验证失败 | |
| 2994 | 参数错误 | |
| 2996 | 两次请求在最小时间间隔内 | |
| 2997 | 号码改变，请首先获取验证码 | |
| 2998 | 网络错误 | |
| 2999 | 其他错误 | |
| 3001 | 请求超时 | |
| 4204 | 无效的手机号码 | |
| 4001 | body 为空 | |
| 4002 | 无效的 appkey | |
| 4003 | 无效的来源 | |
| 4004 | body 解密失败 | |
| 4005 | aes key 解密失败 | |
| 4006 | 时间戳转化失败 | |
| 4007 | body 格式不正确 | |
| 4008 | 无效时间戳 | |
| 4009 | 没有短信验证权限 | |
| 4011 | 发送超频 | 同一手机号每天获取验证码无限制，通知类相同内容 10 分钟 3 条，不同内容无限制，营销类 10 分钟 3 条。 |
| 4012 | api 不存在 | |
| 4013 | 模板不存在 | |
| 4014 | extra 为空 | |
| 4015 | 验证码不正确 | |
| 4016 | 没有余额 | |
| 4017 | 验证码超时 | |
| 4018 | 验证码已经验证过 | |
| 5000 | 服务端错误 |
文档内容是否对您有帮助？
