org.glamey.scaffold.component.sms.huanxin

类 HuanXinRestAPI

java.lang.Object

org.glamey.scaffold.component.sms.huanxin.HuanXinRestAPI

public final class HuanXinRestAPI
extends Object

环信restAPI

作者:

by zhouyang.zhou

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	HuanXinRestAPI.Builder 参数设置,初始化配置

字段概要

字段

限定符和类型	字段和说明
static String	APPLICATION_JSON
private String	baseUrl
private String	clientId
private String	clientSecret
static String	CONTENT_TYPE
private static okhttp3.OkHttpClient	HTTP_CLIENT
private static org.glamey.scaffold.json.JsonMapper	JSON_MAPPER
private static org.slf4j.Logger	LOGGER
private static okhttp3.MediaType	MEDIA_TYPE_JSON

构造器概要

构造器

限定符	构造器和说明
private	HuanXinRestAPI(HuanXinRestAPI.Builder builder)

方法概要

限定符和类型	方法和说明
Map<String,Object>	accountInfo(String accountId) 获取账户信息
private okhttp3.Headers	buildTokenHeader()
Map<String,Object>	createAccount(String accountId, String password, String nickName) 创建账户
private Map<String,Object>	doRequest(okhttp3.Request request, String message) 数据请求及其处理
private okhttp3.Response	httpExecute(okhttp3.Request request)
Map<String,Object>	token() 获取token 接口限流说明: 同一个IP每秒最多可调用30次, 超过的部分会返回429或503错误, 所以在调用程序中, 如果碰到了这样的错误, 需要稍微暂停一下并且重试。
Map<String,Object>	updateNickName(String accountId, String nickName) 修改用户昵称

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

LOGGER

private static final org.slf4j.Logger LOGGER

CONTENT_TYPE

public static final String CONTENT_TYPE

另请参阅:

常量字段值

APPLICATION_JSON

public static final String APPLICATION_JSON

另请参阅:

常量字段值

baseUrl

private String baseUrl

clientId

private String clientId

clientSecret

private String clientSecret

HTTP_CLIENT

private static final okhttp3.OkHttpClient HTTP_CLIENT

JSON_MAPPER

private static final org.glamey.scaffold.json.JsonMapper JSON_MAPPER

MEDIA_TYPE_JSON

private static final okhttp3.MediaType MEDIA_TYPE_JSON

构造器详细资料

HuanXinRestAPI

private HuanXinRestAPI(HuanXinRestAPI.Builder builder)

方法详细资料

token

public final Map<String,Object> token()
                               throws IOException

获取token 接口限流说明: 同一个IP每秒最多可调用30次, 超过的部分会返回429或503错误, 所以在调用程序中, 如果碰到了这样的错误, 需要稍微暂停一下并且重试。如果该限流控制不满足需求，请联系商务经理开放更高的权限。

返回:

响应值

抛出:

IOException - exception

accountInfo

public final Map<String,Object> accountInfo(String accountId)
                                     throws IOException

获取账户信息

参数:

accountId - accountId

返回:

the response result

抛出:

IOException - IOException

createAccount

public final Map<String,Object> createAccount(String accountId,
                                              String password,
                                              String nickName)
                                       throws IOException

创建账户

参数:

accountId - accountId

password - password

nickName - nickName

返回:

the response result

抛出:

IOException - IOException

updateNickName

public final Map<String,Object> updateNickName(String accountId,
                                               String nickName)
                                        throws IOException

修改用户昵称

参数:

accountId - accountId

nickName - nickName

返回:

the response result

抛出:

IOException - IOException

doRequest

private Map<String,Object> doRequest(okhttp3.Request request,
                                     String message)
                              throws IOException

数据请求及其处理

参数:

request - request

message - message

返回:

the response result

抛出:

IOException - IOException

httpExecute

private okhttp3.Response httpExecute(okhttp3.Request request)
                              throws IOException

参数:

request - request

返回:

response

抛出:

IOException - IOException

buildTokenHeader

private okhttp3.Headers buildTokenHeader()
                                  throws IOException

返回:

http headers

抛出:

IOException - IOException