JSMS iOS SDK API描述
获取短信验证码
+ (void)getVerificationCodeWithPhoneNumber:(NSString * _Nonnull)numberandTemplateID:(NSString * _Nonnull)templateIDcompletionHandler:(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);}}];}
获取语音验证码
1.2.0版本新增—获取语音验证码接口。
+ (void)getVoiceVerificationCodeWithPhoneNumber:(NSString * _Nonnull)numbercompletionHandler:(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);}}];}
获取语音验证码(可设置播报语言)
1.4.0版本新增—获取语音验证码,可设置播报语言类型。
+ (void)getVoiceVerificationCodeWithPhoneNumber:(NSString * _Nonnull)numberlanguageOptions:(JSMSLanguageOptions)optionscompletionHandler:(JSMSCompletionHandler _Nonnull)handler;
接口说明
获取语音验证码接口:创建获取语音验证码的按钮,或者是在自己已有的界面的按钮事件里调用获取语音验证码的方法
参数说明:
- number :手机号码
- options:播报语言。参数无效时,默认中文播报
- handler:请求成功或者失败的回调
调用示例:
//点击获取语音验证码- (IBAction)sendVoiceAuthCode:(id)sender {[JSMSSDK getVoiceVerificationCodeWithPhoneNumber:@"152xxxxxxxx"languageOptions:JSMSLanguage_zh_HanscompletionHandler:^(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)numberverificationCode:(NSString * _Nonnull)vCodecompletionHandler:(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!");}}];
设置请求验证码时间间隔
1.2.0版本新增—设置获取验证码请求时间间隔的接口。
+ (void)setMinimumTimeInterval:(NSTimeInterval)seconds;
接口说明
设置获取验证码请求时间间隔的接口:在设置时间间隔内只能发送一次获取验证码的请求。如果不调用此接口,sdk默认间隔是30s
参数说明:
- seconds:时间间隔
调用示例:
- (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 | 服务端错误 |
