question
stringlengths 1
57
| tag
stringclasses 18
values | response
stringlengths 112
68.3k
| content
stringlengths 238
68.5k
| __index_level_0__
int64 0
12k
|
|---|---|---|---|---|
BMXRosterServiceListener | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXRosterServiceListener
# BMXRosterServiceListener
最近更新时间: 2022-07-22 22:50:10
class im.floo.floolib.BMXRosterServiceListener
好友变化监听者
Index
字段
* swigCMemOwn
方法
* getCPtr
* finalize
* delete
* swigDirectorDisconnect
* swigReleaseOwnership
* swigTakeOwnership
* onFriendAdded
* onFriendRemoved
* onApplied
* onApplicationAccepted
* onApplicationDeclined
* onBlockListAdded
* onBlockListRemoved
* onRosterInfoUpdate
* onRosterListUpdate
* registerRosterService
字段
swigCMemOwn
* protected transient boolean swigCMemOwn
*
方法
getCPtr
* protected static long getCPtr(BMXRosterServiceListener obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
swigDirectorDisconnect
* protected void swigDirectorDisconnect();
* Returns void
swigReleaseOwnership
* public void swigReleaseOwnership();
* Returns void
swigTakeOwnership
* public void swigTakeOwnership();
* Returns void
onFriendAdded
* public void onFriendAdded(long sponsorId, long recipientId);
* 添加好友
Parameters
* sponsorId: long
操作的发起者
* recipientId: long
操作的接受者
Returns void
onFriendRemoved
* public void onFriendRemoved(long sponsorId, long recipientId);
* 删除好友
Parameters
* sponsorId: long
操作的发起者
* recipientId: long
操作的接受者
Returns void
onApplied
* public void onApplied(long sponsorId, long recipientId, String message);
* 收到加好友申请
Parameters
* sponsorId: long
操作的发起者
* recipientId: long
操作的接受者
* message: String
好友申请消息
Returns void
onApplicationAccepted
* public void onApplicationAccepted(long sponsorId, long recipientId);
* 加好友申请被通过了
Parameters
* sponsorId: long
操作的发起者
* recipientId: long
操作的接受者
Returns void
onApplicationDeclined
* public void onApplicationDeclined(long sponsorId, long recipientId, String reason);
* 加好友申请被拒绝了
Parameters
* sponsorId: long
操作的发起者
* recipientId: long
操作的接受者
* reason: String
申请拒绝原因
Returns void
onBlockListAdded
* public void onBlockListAdded(long sponsorId, long recipientId);
* 添加黑名单
Parameters
* sponsorId: long
操作的发起者
* recipientId: long
操作的接受者
Returns void
onBlockListRemoved
* public void onBlockListRemoved(long sponsorId, long recipientId);
* 删除黑名单
Parameters
* sponsorId: long
操作的发起者
* recipientId: long
操作的接受者
Returns void
onRosterInfoUpdate
* public void onRosterInfoUpdate(BMXRosterItem item);
* 用户信息更新
Parameters
* item: [BMXRosterItem](https://developer.qiniu.com/IM/api/8274/bmxrosteritem)
更新的好友信息
Returns void
onRosterListUpdate
* public void onRosterListUpdate();
* 客户端从服务器拉取到新联系人时触发，用于用户联系人列表更新，从SDK调用本地获取联系人即可取得全部成员信息
Returns void
registerRosterService
* public void registerRosterService(BMXRosterService service);
* Returns void
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXRosterServiceListener
# BMXRosterServiceListener
最近更新时间: 2022-07-22 22:50:10
class im.floo.floolib.BMXRosterServiceListener
好友变化监听者
Index
字段
* swigCMemOwn
方法
* getCPtr
* finalize
* delete
* swigDirectorDisconnect
* swigReleaseOwnership
* swigTakeOwnership
* onFriendAdded
* onFriendRemoved
* onApplied
* onApplicationAccepted
* onApplicationDeclined
* onBlockListAdded
* onBlockListRemoved
* onRosterInfoUpdate
* onRosterListUpdate
* registerRosterService
字段
swigCMemOwn
* protected transient boolean swigCMemOwn
*
方法
getCPtr
* protected static long getCPtr(BMXRosterServiceListener obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
swigDirectorDisconnect
* protected void swigDirectorDisconnect();
* Returns void
swigReleaseOwnership
* public void swigReleaseOwnership();
* Returns void
swigTakeOwnership
* public void swigTakeOwnership();
* Returns void
onFriendAdded
* public void onFriendAdded(long sponsorId, long recipientId);
* 添加好友
Parameters
* sponsorId: long
操作的发起者
* recipientId: long
操作的接受者
Returns void
onFriendRemoved
* public void onFriendRemoved(long sponsorId, long recipientId);
* 删除好友
Parameters
* sponsorId: long
操作的发起者
* recipientId: long
操作的接受者
Returns void
onApplied
* public void onApplied(long sponsorId, long recipientId, String message);
* 收到加好友申请
Parameters
* sponsorId: long
操作的发起者
* recipientId: long
操作的接受者
* message: String
好友申请消息
Returns void
onApplicationAccepted
* public void onApplicationAccepted(long sponsorId, long recipientId);
* 加好友申请被通过了
Parameters
* sponsorId: long
操作的发起者
* recipientId: long
操作的接受者
Returns void
onApplicationDeclined
* public void onApplicationDeclined(long sponsorId, long recipientId, String reason);
* 加好友申请被拒绝了
Parameters
* sponsorId: long
操作的发起者
* recipientId: long
操作的接受者
* reason: String
申请拒绝原因
Returns void
onBlockListAdded
* public void onBlockListAdded(long sponsorId, long recipientId);
* 添加黑名单
Parameters
* sponsorId: long
操作的发起者
* recipientId: long
操作的接受者
Returns void
onBlockListRemoved
* public void onBlockListRemoved(long sponsorId, long recipientId);
* 删除黑名单
Parameters
* sponsorId: long
操作的发起者
* recipientId: long
操作的接受者
Returns void
onRosterInfoUpdate
* public void onRosterInfoUpdate(BMXRosterItem item);
* 用户信息更新
Parameters
* item: [BMXRosterItem](https://developer.qiniu.com/IM/api/8274/bmxrosteritem)
更新的好友信息
Returns void
onRosterListUpdate
* public void onRosterListUpdate();
* 客户端从服务器拉取到新联系人时触发，用于用户联系人列表更新，从SDK调用本地获取联系人即可取得全部成员信息
Returns void
registerRosterService
* public void registerRosterService(BMXRosterService service);
* Returns void
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,890 |
BMXSDKConfig | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXSDKConfig
# BMXSDKConfig
最近更新时间: 2022-07-22 22:35:52
class im.floo.floolib.BMXSDKConfig
SDK设置管理
Index
方法
* getCPtr
* finalize
* delete
* getDataDir
* getCacheDir
* getClientType
* getVsn
* getSDKVersion
* getPushCertName
* setPushCertName
* getUserAgent
* carryUsernameInMessage
* setCarryUsernameInMessage
* enableDeliveryAck
* setEnableDeliveryAck
* getLogLevel
* setLogLevel
* getConsoleOutput
* setConsoleOutput
* setHostConfig
* getHostConfig
* getLoadAllServerConversations
* setLoadAllServerConversations
* setLoadAllServerConversations
* getDeviceUuid
* setDeviceUuid
* getDBCryptoKey
* setDBCryptoKey
* getVerifyCertificate
* setVerifyCertificate
* setVerifyCertificate
* getEnableDNS
* setEnableDNS
* setEnableDNS
* getUserDNSAddress
* setUserDNSAddress
* getAppID
* setAppID
* getAppSecret
* setAppSecret
* getPushProviderType
* setPushProviderType
* getPushEnvironmentType
* setEnvironmentType
* getDebugLogReceiverId
* setDebugLogReceiverId
方法
getCPtr
* protected static long getCPtr(BMXSDKConfig obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
getDataDir
* public String getDataDir();
* Returns String
getCacheDir
* public String getCacheDir();
* Returns String
getClientType
* public BMXClientType getClientType();
* Returns [BMXClientType](https://developer.qiniu.com/IM/api/8198/bmxclienttype)
getVsn
* public String getVsn();
* Returns String
getSDKVersion
* public String getSDKVersion();
* Returns String
getPushCertName
* public String getPushCertName();
* Returns String
setPushCertName
* public void setPushCertName(String arg0);
* Returns void
getUserAgent
* public String getUserAgent();
* Returns String
carryUsernameInMessage
* public boolean carryUsernameInMessage();
* Returns boolean
setCarryUsernameInMessage
* public void setCarryUsernameInMessage(boolean arg0);
* Returns void
enableDeliveryAck
* public boolean enableDeliveryAck();
* Returns boolean
setEnableDeliveryAck
* public void setEnableDeliveryAck(boolean arg0);
* Returns void
getLogLevel
* public BMXLogLevel getLogLevel();
* Returns [BMXLogLevel](https://developer.qiniu.com/IM/api/8238/bmxloglevel)
setLogLevel
* public void setLogLevel(BMXLogLevel arg0);
* Returns void
getConsoleOutput
* public boolean getConsoleOutput();
* Returns boolean
setConsoleOutput
* public void setConsoleOutput(boolean arg0);
* Returns void
setHostConfig
* public void setHostConfig(BMXSDKConfig.HostConfig config);
* Returns void
getHostConfig
* public BMXSDKConfig.HostConfig getHostConfig();
* Returns HostConfig
getLoadAllServerConversations
* public boolean getLoadAllServerConversations();
* Returns boolean
setLoadAllServerConversations
* public void setLoadAllServerConversations(boolean enable);
* Returns void
setLoadAllServerConversations
* public void setLoadAllServerConversations();
* Returns void
getDeviceUuid
* public String getDeviceUuid();
* Returns String
setDeviceUuid
* public void setDeviceUuid(String uuid);
* Returns void
getDBCryptoKey
* public String getDBCryptoKey();
* Returns String
setDBCryptoKey
* public void setDBCryptoKey(String cryptoKey);
* Returns void
getVerifyCertificate
* public boolean getVerifyCertificate();
* Returns boolean
setVerifyCertificate
* public void setVerifyCertificate(boolean verify);
* Returns void
setVerifyCertificate
* public void setVerifyCertificate();
* Returns void
getEnableDNS
* public boolean getEnableDNS();
* Returns boolean
setEnableDNS
* public void setEnableDNS(boolean enable);
* Returns void
setEnableDNS
* public void setEnableDNS();
* Returns void
getUserDNSAddress
* public String getUserDNSAddress();
* Returns String
setUserDNSAddress
* public void setUserDNSAddress(String dns);
* Returns void
getAppID
* public String getAppID();
* Returns String
setAppID
* public void setAppID(String appID);
* Returns void
getAppSecret
* public String getAppSecret();
* Returns String
setAppSecret
* public void setAppSecret(String appSecret);
* Returns void
getPushProviderType
* public BMXPushProviderType getPushProviderType();
* Returns [BMXPushProviderType](https://developer.qiniu.com/IM/api/8254/bmxpushprovidertype)
setPushProviderType
* public void setPushProviderType(BMXPushProviderType type);
* Returns void
getPushEnvironmentType
* public BMXPushEnvironmentType getPushEnvironmentType();
* Returns [BMXPushEnvironmentType](https://developer.qiniu.com/IM/api/8252/bmxpushenvironmenttype)
setEnvironmentType
* public void setEnvironmentType(BMXPushEnvironmentType type);
* Returns void
getDebugLogReceiverId
* public long getDebugLogReceiverId();
* Returns long
setDebugLogReceiverId
* public void setDebugLogReceiverId(long uid);
* Returns void
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXSDKConfig
# BMXSDKConfig
最近更新时间: 2022-07-22 22:35:52
class im.floo.floolib.BMXSDKConfig
SDK设置管理
Index
方法
* getCPtr
* finalize
* delete
* getDataDir
* getCacheDir
* getClientType
* getVsn
* getSDKVersion
* getPushCertName
* setPushCertName
* getUserAgent
* carryUsernameInMessage
* setCarryUsernameInMessage
* enableDeliveryAck
* setEnableDeliveryAck
* getLogLevel
* setLogLevel
* getConsoleOutput
* setConsoleOutput
* setHostConfig
* getHostConfig
* getLoadAllServerConversations
* setLoadAllServerConversations
* setLoadAllServerConversations
* getDeviceUuid
* setDeviceUuid
* getDBCryptoKey
* setDBCryptoKey
* getVerifyCertificate
* setVerifyCertificate
* setVerifyCertificate
* getEnableDNS
* setEnableDNS
* setEnableDNS
* getUserDNSAddress
* setUserDNSAddress
* getAppID
* setAppID
* getAppSecret
* setAppSecret
* getPushProviderType
* setPushProviderType
* getPushEnvironmentType
* setEnvironmentType
* getDebugLogReceiverId
* setDebugLogReceiverId
方法
getCPtr
* protected static long getCPtr(BMXSDKConfig obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
getDataDir
* public String getDataDir();
* Returns String
getCacheDir
* public String getCacheDir();
* Returns String
getClientType
* public BMXClientType getClientType();
* Returns [BMXClientType](https://developer.qiniu.com/IM/api/8198/bmxclienttype)
getVsn
* public String getVsn();
* Returns String
getSDKVersion
* public String getSDKVersion();
* Returns String
getPushCertName
* public String getPushCertName();
* Returns String
setPushCertName
* public void setPushCertName(String arg0);
* Returns void
getUserAgent
* public String getUserAgent();
* Returns String
carryUsernameInMessage
* public boolean carryUsernameInMessage();
* Returns boolean
setCarryUsernameInMessage
* public void setCarryUsernameInMessage(boolean arg0);
* Returns void
enableDeliveryAck
* public boolean enableDeliveryAck();
* Returns boolean
setEnableDeliveryAck
* public void setEnableDeliveryAck(boolean arg0);
* Returns void
getLogLevel
* public BMXLogLevel getLogLevel();
* Returns [BMXLogLevel](https://developer.qiniu.com/IM/api/8238/bmxloglevel)
setLogLevel
* public void setLogLevel(BMXLogLevel arg0);
* Returns void
getConsoleOutput
* public boolean getConsoleOutput();
* Returns boolean
setConsoleOutput
* public void setConsoleOutput(boolean arg0);
* Returns void
setHostConfig
* public void setHostConfig(BMXSDKConfig.HostConfig config);
* Returns void
getHostConfig
* public BMXSDKConfig.HostConfig getHostConfig();
* Returns HostConfig
getLoadAllServerConversations
* public boolean getLoadAllServerConversations();
* Returns boolean
setLoadAllServerConversations
* public void setLoadAllServerConversations(boolean enable);
* Returns void
setLoadAllServerConversations
* public void setLoadAllServerConversations();
* Returns void
getDeviceUuid
* public String getDeviceUuid();
* Returns String
setDeviceUuid
* public void setDeviceUuid(String uuid);
* Returns void
getDBCryptoKey
* public String getDBCryptoKey();
* Returns String
setDBCryptoKey
* public void setDBCryptoKey(String cryptoKey);
* Returns void
getVerifyCertificate
* public boolean getVerifyCertificate();
* Returns boolean
setVerifyCertificate
* public void setVerifyCertificate(boolean verify);
* Returns void
setVerifyCertificate
* public void setVerifyCertificate();
* Returns void
getEnableDNS
* public boolean getEnableDNS();
* Returns boolean
setEnableDNS
* public void setEnableDNS(boolean enable);
* Returns void
setEnableDNS
* public void setEnableDNS();
* Returns void
getUserDNSAddress
* public String getUserDNSAddress();
* Returns String
setUserDNSAddress
* public void setUserDNSAddress(String dns);
* Returns void
getAppID
* public String getAppID();
* Returns String
setAppID
* public void setAppID(String appID);
* Returns void
getAppSecret
* public String getAppSecret();
* Returns String
setAppSecret
* public void setAppSecret(String appSecret);
* Returns void
getPushProviderType
* public BMXPushProviderType getPushProviderType();
* Returns [BMXPushProviderType](https://developer.qiniu.com/IM/api/8254/bmxpushprovidertype)
setPushProviderType
* public void setPushProviderType(BMXPushProviderType type);
* Returns void
getPushEnvironmentType
* public BMXPushEnvironmentType getPushEnvironmentType();
* Returns [BMXPushEnvironmentType](https://developer.qiniu.com/IM/api/8252/bmxpushenvironmenttype)
setEnvironmentType
* public void setEnvironmentType(BMXPushEnvironmentType type);
* Returns void
getDebugLogReceiverId
* public long getDebugLogReceiverId();
* Returns long
setDebugLogReceiverId
* public void setDebugLogReceiverId(long uid);
* Returns void
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,894 |
BMXSDKConfig.HostConfig | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXSDKConfig](https://developer.qiniu.com/IM/api/8284/bmxsdkconfig) >
BMXSDKConfig.HostConfig
# BMXSDKConfig.HostConfig
最近更新时间: 2022-07-22 22:40:08
class im.floo.floolib.BMXSDKConfig.HostConfig
Index
字段
* swigCMemOwn
方法
* getCPtr
* finalize
* delete
* setImHost
* getImHost
* setImPort
* getImPort
* setRestHost
* getRestHost
字段
swigCMemOwn
* protected transient boolean swigCMemOwn
*
方法
getCPtr
* protected static long getCPtr(HostConfig obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
setImHost
* public void setImHost(String value);
* Returns void
getImHost
* public String getImHost();
* Returns String
setImPort
* public void setImPort(int value);
* Returns void
getImPort
* public int getImPort();
* Returns int
setRestHost
* public void setRestHost(String value);
* Returns void
getRestHost
* public String getRestHost();
* Returns String
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXSDKConfig](https://developer.qiniu.com/IM/api/8284/bmxsdkconfig) >
BMXSDKConfig.HostConfig
# BMXSDKConfig.HostConfig
最近更新时间: 2022-07-22 22:40:08
class im.floo.floolib.BMXSDKConfig.HostConfig
Index
字段
* swigCMemOwn
方法
* getCPtr
* finalize
* delete
* setImHost
* getImHost
* setImPort
* getImPort
* setRestHost
* getRestHost
字段
swigCMemOwn
* protected transient boolean swigCMemOwn
*
方法
getCPtr
* protected static long getCPtr(HostConfig obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
setImHost
* public void setImHost(String value);
* Returns void
getImHost
* public String getImHost();
* Returns String
setImPort
* public void setImPort(int value);
* Returns void
getImPort
* public int getImPort();
* Returns int
setRestHost
* public void setRestHost(String value);
* Returns void
getRestHost
* public String getRestHost();
* Returns String
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,903 |
BMXSignInStatus | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXSignInStatus
# BMXSignInStatus
最近更新时间: 2021-07-19 19:21:51
## 枚举 BMXSignInStatus
* java.lang.Object
* * java.lang.Enum
* * im.floo.floolib.BMXSignInStatus
* 所有已实现的接口:
java.io.Serializable, java.lang.Comparable
* * *
public enum BMXSignInStatus
extends java.lang.Enum<BMXSignInStatus>
登录状态
* * ### 枚举常量概要
枚举常量 枚举常量和说明
---
`SignIn`
`SignOut`
* ### 方法概要
所有方法 静态方法 实例方法 具体方法 限定符和类型 | 方法和说明
---|---
`static BMXSignInStatus` | `swigToEnum(int swigValue)`
`int` | `swigValue()`
`static BMXSignInStatus` | `valueOf(java.lang.String name)` 返回带有指定名称的该类型的枚举常量。
`static BMXSignInStatus[]` | `values()` 按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。
* ### 从类继承的方法 java.lang.Enum
`clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name,
ordinal, toString, valueOf`
* ### 从类继承的方法 java.lang.Object
`getClass, notify, notifyAll, wait, wait, wait`
* * ### 枚举常量详细资料
* #### SignOut
public static final BMXSignInStatus SignOut
* #### SignIn
public static final BMXSignInStatus SignIn
* ### 方法详细资料
* #### values
public static BMXSignInStatus[] values()
按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。该方法可用于迭代 常量, 如下所示:
for (BMXSignInStatus c : BMXSignInStatus.values())
System.out.println(c);
返回:
按照声明该枚举类型的常量的顺序返回的包含这些常量的数组
* #### valueOf
public static BMXSignInStatus valueOf(java.lang.String name)
返回带有指定名称的该类型的枚举常量。 字符串必须与用于声明该类型的枚举常量的 标识符 _完全_ 匹配。(不允许有多余 的空格字符。)
参数:
`name` \- 要返回的枚举常量的名称。
返回:
返回带有指定名称的枚举常量
抛出:
`java.lang.IllegalArgumentException` \- 如果该枚举类型没有带有指定名称的常量
`java.lang.NullPointerException` \- 如果参数为空值
* #### swigValue
public final int swigValue()
* #### swigToEnum
public static BMXSignInStatus swigToEnum(int swigValue)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXSignInStatus
# BMXSignInStatus
最近更新时间: 2021-07-19 19:21:51
## 枚举 BMXSignInStatus
* java.lang.Object
* * java.lang.Enum
* * im.floo.floolib.BMXSignInStatus
* 所有已实现的接口:
java.io.Serializable, java.lang.Comparable
* * *
public enum BMXSignInStatus
extends java.lang.Enum<BMXSignInStatus>
登录状态
* * ### 枚举常量概要
枚举常量 枚举常量和说明
---
`SignIn`
`SignOut`
* ### 方法概要
所有方法 静态方法 实例方法 具体方法 限定符和类型 | 方法和说明
---|---
`static BMXSignInStatus` | `swigToEnum(int swigValue)`
`int` | `swigValue()`
`static BMXSignInStatus` | `valueOf(java.lang.String name)` 返回带有指定名称的该类型的枚举常量。
`static BMXSignInStatus[]` | `values()` 按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。
* ### 从类继承的方法 java.lang.Enum
`clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name,
ordinal, toString, valueOf`
* ### 从类继承的方法 java.lang.Object
`getClass, notify, notifyAll, wait, wait, wait`
* * ### 枚举常量详细资料
* #### SignOut
public static final BMXSignInStatus SignOut
* #### SignIn
public static final BMXSignInStatus SignIn
* ### 方法详细资料
* #### values
public static BMXSignInStatus[] values()
按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。该方法可用于迭代 常量, 如下所示:
for (BMXSignInStatus c : BMXSignInStatus.values())
System.out.println(c);
返回:
按照声明该枚举类型的常量的顺序返回的包含这些常量的数组
* #### valueOf
public static BMXSignInStatus valueOf(java.lang.String name)
返回带有指定名称的该类型的枚举常量。 字符串必须与用于声明该类型的枚举常量的 标识符 _完全_ 匹配。(不允许有多余 的空格字符。)
参数:
`name` \- 要返回的枚举常量的名称。
返回:
返回带有指定名称的枚举常量
抛出:
`java.lang.IllegalArgumentException` \- 如果该枚举类型没有带有指定名称的常量
`java.lang.NullPointerException` \- 如果参数为空值
* #### swigValue
public final int swigValue()
* #### swigToEnum
public static BMXSignInStatus swigToEnum(int swigValue)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,905 |
BMXUserManager | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXUserManager
# BMXUserManager
最近更新时间: 2022-07-22 22:42:26
class im.floo.floolib.BMXUserManager
用户管理器
Index
方法
* signUpNewUser
* signInByName
* signInById
* autoSignInByName
* autoSignInById
* signOut
* signOut
* connectStatus
* signInStatus
* bindDevice
* getDeviceList
* deleteDevice
* getProfile
* setNickname
* uploadAvatar
* downloadAvatar
* setPublicInfo
* setPrivateInfo
* setAddFriendAuthMode
* setAuthQuestion
* setEnablePush
* setEnablePushDetaile
* setPushNickname
* setPushAlias
* setNotificationSound
* setNotificationVibrate
* setAutoDownloadAttachment
* setAutoAcceptGroupInvite
* addUserListener
* removeUserListener
* changeAppId
方法
signUpNewUser
* public void signUpNewUser(final String username, final String password, final BMXDataCallBack<BMXUserProfile> callBack);
* 注册
Parameters
* password: String
密码
* username: String
用户名
* callBack: <any>
BMXUserProfile
Returns void
signInByName
* public void signInByName(final String name, final String password, final BMXCallBack callBack);
* 用户名登陆
Parameters
* name: String
* password: String
* callBack: BMXCallBack
BMXErrorCode
Returns void
signInById
* public void signInById(final long id, final String password, final BMXCallBack callBack);
* id 登陆
Parameters
* id: long
* password: String
* callBack: BMXCallBack
BMXErrorCode
Returns void
autoSignInByName
* public void autoSignInByName(final String name, final String password, final BMXCallBack callBack);
* 自动登陆 根据用户名
Parameters
* name: String
* password: String
* callBack: BMXCallBack
BMXErrorCode
Returns void
autoSignInById
* public void autoSignInById(final long uid, final String password, final BMXCallBack callBack);
* 自动登陆 根据id
Parameters
* uid: long
* password: String
* callBack: BMXCallBack
BMXErrorCode
Returns void
signOut
* public void signOut(final BMXCallBack callBack);
* 退出登录
Parameters
* callBack: BMXCallBack
BMXErrorCode
Returns void
signOut
* public void signOut(final long userId, final BMXCallBack callBack);
* 退出登录
Parameters
* callBack: long
BMXErrorCode
Returns void
connectStatus
* public BMXConnectStatus connectStatus();
* 获取当前和服务器的连接状态
Returns
[BMXConnectStatus](https://developer.qiniu.com/IM/api/8202/bmxconnectstatus)
signInStatus
* public BMXSignInStatus signInStatus();
* 获取当前的登录状态
Returns
[BMXSignInStatus](https://developer.qiniu.com/IM/api/8286/bmxsigninstatus)
bindDevice
* public void bindDevice(final String token, final BMXCallBack callBack);
* 绑定设备推送token
Parameters
* token: String
device token
* callBack: BMXCallBack
BMXErrorCode
Returns void
getDeviceList
* public void getDeviceList(final BMXDataCallBack<BMXDeviceList> callBack);
* 获取登录的设备列表
Parameters
* callBack: <any>
BMXErrorCode 登录的设备列表
Returns void
deleteDevice
* public void deleteDevice(final int device_sn, final BMXCallBack callBack);
* 删除设备
Parameters
* callBack: int
BMXErrorCode
Returns void
getProfile
* public void getProfile(final boolean forceRefresh, final BMXDataCallBack<BMXUserProfile> callBack);
* 获取用户详情
Parameters
* forceRefresh: boolean
强制从服务器拉取最新结果
* callBack: <any>
BMXErrorCode,用户详情
Returns void
setNickname
* public void setNickname(final String nickname, final BMXCallBack callBack);
* 设置昵称
Parameters
* nickname: String
昵称
* callBack: BMXCallBack
BMXErrorCode
Returns void
uploadAvatar
* public void uploadAvatar(final String avatarPath, final FileProgressListener listener, final BMXCallBack callBack);
* 上传头像
Parameters
* avatarPath: String
头像本地文件路径
* listener: FileProgressListener
上传进度监听器
* callBack: BMXCallBack
BMXErrorCode
Returns void
downloadAvatar
* public void downloadAvatar(final BMXUserProfile profile, final FileProgressListener listener, final BMXCallBack callBack);
* 下载头像
Parameters
* profile: [BMXUserProfile](https://developer.qiniu.com/IM/api/8304/bmxuserprofile)
用户详情
* listener: FileProgressListener
下载进度监听器
* callBack: BMXCallBack
BMXErrorCode
Returns void
setPublicInfo
* public void setPublicInfo(final String publicInfo, final BMXCallBack callBack);
* 设置公开扩展信息
Parameters
* publicInfo: String
用户公开信息
* callBack: BMXCallBack
BMXErrorCode
Returns void
setPrivateInfo
* public void setPrivateInfo(final String privateInfo, final BMXCallBack callBack);
* 设置私有扩展信息
Parameters
* privateInfo: String
用户私有信息（只对自己可见）
* callBack: BMXCallBack
BMXErrorCode
Returns void
setAddFriendAuthMode
* public void setAddFriendAuthMode(final BMXUserProfile.AddFriendAuthMode mode, final BMXCallBack callBack);
* 设置加好友验证方式
Parameters
* mode: AddFriendAuthMode
添加好友时的验证方式
* callBack: BMXCallBack
BMXErrorCode
Returns void
setAuthQuestion
* public void setAuthQuestion(final BMXUserProfile.AuthQuestion authQuestion, final BMXCallBack callBack);
* 设置加好友验证问题
Parameters
* authQuestion: AuthQuestion
验证问题
* callBack: BMXCallBack
BMXErrorCode
Returns void
setEnablePush
* public void setEnablePush(final boolean enable, final BMXCallBack callBack);
* 设置是否允许推送
Parameters
* enable: boolean
是否允许推送，true推送，false不推送
* callBack: BMXCallBack
BMXErrorCode
Returns void
setEnablePushDetaile
* public void setEnablePushDetaile(final boolean enable, final BMXCallBack callBack);
* 设置是否推送详情
Parameters
* enable: boolean
是否推送详情，true推送，false不推送
* callBack: BMXCallBack
BMXErrorCode
Returns void
setPushNickname
* public void setPushNickname(final String nickname, final BMXCallBack callBack);
* 设置推送昵称
Parameters
* nickname: String
推送昵称
* callBack: BMXCallBack
BMXErrorCode
Returns void
setPushAlias
* public void setPushAlias(final String alias, final String bmxPushToken, final BMXCallBack callBack);
* 设置推送别名
Parameters
* alias: String
别名
* bmxPushToken: String
推送token
* callBack: BMXCallBack
BMXErrorCode
Returns void
setNotificationSound
* public void setNotificationSound(final boolean enable, final BMXCallBack callBack);
* 设置收到新消息是否声音提醒
Parameters
* enable: boolean
收到新消息是否声音提醒，true提醒，false不提醒
* callBack: BMXCallBack
BMXErrorCode
Returns void
setNotificationVibrate
* public void setNotificationVibrate(final boolean enable, final BMXCallBack callBack);
* 设置收到新消息是否震动
Parameters
* enable: boolean
收到新消息是否震动，true震动，false不震动
* callBack: BMXCallBack
BMXErrorCode
Returns void
setAutoDownloadAttachment
* public void setAutoDownloadAttachment(final boolean enable, final BMXCallBack callBack);
* 设置是否自动缩略图和语音附件
Parameters
* enable: boolean
是否自动缩略图和语音附件，true自动下载，false不会自动下载
* callBack: BMXCallBack
BMXErrorCode
Returns void
setAutoAcceptGroupInvite
* public void setAutoAcceptGroupInvite(final boolean enable, final BMXCallBack callBack);
* 设置是否自动同意入群邀请
Parameters
* enable: boolean
是否自动同意入群邀请，true同意，false不同意
* callBack: BMXCallBack
BMXErrorCode
Returns void
addUserListener
* public void addUserListener(BMXUserServiceListener listener);
* 添加用户状态监听者
Parameters
* listener: [BMXUserServiceListener](https://developer.qiniu.com/IM/api/8293/bmxuserservicelistener)
用户状态监听者
Returns void
removeUserListener
* public void removeUserListener(BMXUserServiceListener listener);
* 移除用户状态监听者
Parameters
* listener: [BMXUserServiceListener](https://developer.qiniu.com/IM/api/8293/bmxuserservicelistener)
用户状态监听者
Returns void
changeAppId
* public void changeAppId(final String appId, final BMXCallBack callBack);
* 切换appId
Parameters
* appId: String
appId
Returns void
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXUserManager
# BMXUserManager
最近更新时间: 2022-07-22 22:42:26
class im.floo.floolib.BMXUserManager
用户管理器
Index
方法
* signUpNewUser
* signInByName
* signInById
* autoSignInByName
* autoSignInById
* signOut
* signOut
* connectStatus
* signInStatus
* bindDevice
* getDeviceList
* deleteDevice
* getProfile
* setNickname
* uploadAvatar
* downloadAvatar
* setPublicInfo
* setPrivateInfo
* setAddFriendAuthMode
* setAuthQuestion
* setEnablePush
* setEnablePushDetaile
* setPushNickname
* setPushAlias
* setNotificationSound
* setNotificationVibrate
* setAutoDownloadAttachment
* setAutoAcceptGroupInvite
* addUserListener
* removeUserListener
* changeAppId
方法
signUpNewUser
* public void signUpNewUser(final String username, final String password, final BMXDataCallBack<BMXUserProfile> callBack);
* 注册
Parameters
* password: String
密码
* username: String
用户名
* callBack: <any>
BMXUserProfile
Returns void
signInByName
* public void signInByName(final String name, final String password, final BMXCallBack callBack);
* 用户名登陆
Parameters
* name: String
* password: String
* callBack: BMXCallBack
BMXErrorCode
Returns void
signInById
* public void signInById(final long id, final String password, final BMXCallBack callBack);
* id 登陆
Parameters
* id: long
* password: String
* callBack: BMXCallBack
BMXErrorCode
Returns void
autoSignInByName
* public void autoSignInByName(final String name, final String password, final BMXCallBack callBack);
* 自动登陆 根据用户名
Parameters
* name: String
* password: String
* callBack: BMXCallBack
BMXErrorCode
Returns void
autoSignInById
* public void autoSignInById(final long uid, final String password, final BMXCallBack callBack);
* 自动登陆 根据id
Parameters
* uid: long
* password: String
* callBack: BMXCallBack
BMXErrorCode
Returns void
signOut
* public void signOut(final BMXCallBack callBack);
* 退出登录
Parameters
* callBack: BMXCallBack
BMXErrorCode
Returns void
signOut
* public void signOut(final long userId, final BMXCallBack callBack);
* 退出登录
Parameters
* callBack: long
BMXErrorCode
Returns void
connectStatus
* public BMXConnectStatus connectStatus();
* 获取当前和服务器的连接状态
Returns
[BMXConnectStatus](https://developer.qiniu.com/IM/api/8202/bmxconnectstatus)
signInStatus
* public BMXSignInStatus signInStatus();
* 获取当前的登录状态
Returns
[BMXSignInStatus](https://developer.qiniu.com/IM/api/8286/bmxsigninstatus)
bindDevice
* public void bindDevice(final String token, final BMXCallBack callBack);
* 绑定设备推送token
Parameters
* token: String
device token
* callBack: BMXCallBack
BMXErrorCode
Returns void
getDeviceList
* public void getDeviceList(final BMXDataCallBack<BMXDeviceList> callBack);
* 获取登录的设备列表
Parameters
* callBack: <any>
BMXErrorCode 登录的设备列表
Returns void
deleteDevice
* public void deleteDevice(final int device_sn, final BMXCallBack callBack);
* 删除设备
Parameters
* callBack: int
BMXErrorCode
Returns void
getProfile
* public void getProfile(final boolean forceRefresh, final BMXDataCallBack<BMXUserProfile> callBack);
* 获取用户详情
Parameters
* forceRefresh: boolean
强制从服务器拉取最新结果
* callBack: <any>
BMXErrorCode,用户详情
Returns void
setNickname
* public void setNickname(final String nickname, final BMXCallBack callBack);
* 设置昵称
Parameters
* nickname: String
昵称
* callBack: BMXCallBack
BMXErrorCode
Returns void
uploadAvatar
* public void uploadAvatar(final String avatarPath, final FileProgressListener listener, final BMXCallBack callBack);
* 上传头像
Parameters
* avatarPath: String
头像本地文件路径
* listener: FileProgressListener
上传进度监听器
* callBack: BMXCallBack
BMXErrorCode
Returns void
downloadAvatar
* public void downloadAvatar(final BMXUserProfile profile, final FileProgressListener listener, final BMXCallBack callBack);
* 下载头像
Parameters
* profile: [BMXUserProfile](https://developer.qiniu.com/IM/api/8304/bmxuserprofile)
用户详情
* listener: FileProgressListener
下载进度监听器
* callBack: BMXCallBack
BMXErrorCode
Returns void
setPublicInfo
* public void setPublicInfo(final String publicInfo, final BMXCallBack callBack);
* 设置公开扩展信息
Parameters
* publicInfo: String
用户公开信息
* callBack: BMXCallBack
BMXErrorCode
Returns void
setPrivateInfo
* public void setPrivateInfo(final String privateInfo, final BMXCallBack callBack);
* 设置私有扩展信息
Parameters
* privateInfo: String
用户私有信息（只对自己可见）
* callBack: BMXCallBack
BMXErrorCode
Returns void
setAddFriendAuthMode
* public void setAddFriendAuthMode(final BMXUserProfile.AddFriendAuthMode mode, final BMXCallBack callBack);
* 设置加好友验证方式
Parameters
* mode: AddFriendAuthMode
添加好友时的验证方式
* callBack: BMXCallBack
BMXErrorCode
Returns void
setAuthQuestion
* public void setAuthQuestion(final BMXUserProfile.AuthQuestion authQuestion, final BMXCallBack callBack);
* 设置加好友验证问题
Parameters
* authQuestion: AuthQuestion
验证问题
* callBack: BMXCallBack
BMXErrorCode
Returns void
setEnablePush
* public void setEnablePush(final boolean enable, final BMXCallBack callBack);
* 设置是否允许推送
Parameters
* enable: boolean
是否允许推送，true推送，false不推送
* callBack: BMXCallBack
BMXErrorCode
Returns void
setEnablePushDetaile
* public void setEnablePushDetaile(final boolean enable, final BMXCallBack callBack);
* 设置是否推送详情
Parameters
* enable: boolean
是否推送详情，true推送，false不推送
* callBack: BMXCallBack
BMXErrorCode
Returns void
setPushNickname
* public void setPushNickname(final String nickname, final BMXCallBack callBack);
* 设置推送昵称
Parameters
* nickname: String
推送昵称
* callBack: BMXCallBack
BMXErrorCode
Returns void
setPushAlias
* public void setPushAlias(final String alias, final String bmxPushToken, final BMXCallBack callBack);
* 设置推送别名
Parameters
* alias: String
别名
* bmxPushToken: String
推送token
* callBack: BMXCallBack
BMXErrorCode
Returns void
setNotificationSound
* public void setNotificationSound(final boolean enable, final BMXCallBack callBack);
* 设置收到新消息是否声音提醒
Parameters
* enable: boolean
收到新消息是否声音提醒，true提醒，false不提醒
* callBack: BMXCallBack
BMXErrorCode
Returns void
setNotificationVibrate
* public void setNotificationVibrate(final boolean enable, final BMXCallBack callBack);
* 设置收到新消息是否震动
Parameters
* enable: boolean
收到新消息是否震动，true震动，false不震动
* callBack: BMXCallBack
BMXErrorCode
Returns void
setAutoDownloadAttachment
* public void setAutoDownloadAttachment(final boolean enable, final BMXCallBack callBack);
* 设置是否自动缩略图和语音附件
Parameters
* enable: boolean
是否自动缩略图和语音附件，true自动下载，false不会自动下载
* callBack: BMXCallBack
BMXErrorCode
Returns void
setAutoAcceptGroupInvite
* public void setAutoAcceptGroupInvite(final boolean enable, final BMXCallBack callBack);
* 设置是否自动同意入群邀请
Parameters
* enable: boolean
是否自动同意入群邀请，true同意，false不同意
* callBack: BMXCallBack
BMXErrorCode
Returns void
addUserListener
* public void addUserListener(BMXUserServiceListener listener);
* 添加用户状态监听者
Parameters
* listener: [BMXUserServiceListener](https://developer.qiniu.com/IM/api/8293/bmxuserservicelistener)
用户状态监听者
Returns void
removeUserListener
* public void removeUserListener(BMXUserServiceListener listener);
* 移除用户状态监听者
Parameters
* listener: [BMXUserServiceListener](https://developer.qiniu.com/IM/api/8293/bmxuserservicelistener)
用户状态监听者
Returns void
changeAppId
* public void changeAppId(final String appId, final BMXCallBack callBack);
* 切换appId
Parameters
* appId: String
appId
Returns void
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,909 |
BMXUserService | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXUserService
# BMXUserService
最近更新时间: 2022-07-22 22:50:54
class im.floo.floolib.BMXUserService
用户Service
Index
字段
* swigCMemOwn
方法
* getCPtr
* finalize
* delete
* bindDevice
* getDeviceList
* getProfile
* deleteDevice
* setNickname
* uploadAvatar
* downloadAvatar
* setPublicInfo
* setPrivateInfo
* setAddFriendAuthMode
* setAuthQuestion
* setEnablePush
* setEnablePushDetaile
* setPushNickname
* setPushAlias
* setNotificationSound
* setNotificationVibrate
* setAutoDownloadAttachment
* setAutoAcceptGroupInvite
* addUserListener
* removeUserListener
字段
swigCMemOwn
* protected transient boolean swigCMemOwn
*
方法
getCPtr
* protected static long getCPtr(BMXUserService obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
bindDevice
* public BMXErrorCode bindDevice(String token);
* 绑定设备推送token
Parameters
* token: String
设备token
Returns BMXErrorCode
getDeviceList
* public BMXErrorCode getDeviceList(BMXDeviceList deviceList);
* 获取设备列表
Parameters
* deviceList: BMXDeviceList
设备列表，传入空列表函数返回后从此处获取返回的设备列表
Returns BMXErrorCode
getProfile
* public BMXErrorCode getProfile(BMXUserProfile profile, boolean forceRefresh);
* 获取用户详情，如果forceRefresh == true，则强制从服务端拉取
Parameters
* profile: [BMXUserProfile](https://developer.qiniu.com/IM/api/8304/bmxuserprofile)
用户profile信息，初始传入指向为空的shared_ptr对象，函数返回后从此处获取用户profile信息。
* forceRefresh: boolean
是否强制从服务器拉取，本地获取失败的情况下会自动从服务器拉取
Returns BMXErrorCode
deleteDevice
* public BMXErrorCode deleteDevice(int device_sn);
* 删除设备
Parameters
* device_sn: int
设备序列号
Returns BMXErrorCode
setNickname
* public BMXErrorCode setNickname(String nickname);
* 设置昵称
Parameters
* nickname: String
用户昵称
Returns BMXErrorCode
uploadAvatar
* public BMXErrorCode uploadAvatar(String avatarPath, FileProgressListener callback);
* 上传头像
Parameters
* avatarPath: String
上传头像的本地地址
* callback: FileProgressListener
上传回调函数
Returns BMXErrorCode
downloadAvatar
* public BMXErrorCode downloadAvatar(BMXUserProfile profile, boolean thumbnail, FileProgressListener callback);
* 下载头像，默认下载缩略图
Parameters
* profile: [BMXUserProfile](https://developer.qiniu.com/IM/api/8304/bmxuserprofile)
用户profile
* thumbnail: boolean
是否下载缩略图，true下载缩略图，false下载原图
* callback: FileProgressListener
下载回调函数
Returns BMXErrorCode
setPublicInfo
* public BMXErrorCode setPublicInfo(String publicInfo);
* 设置公开扩展信息
Parameters
* publicInfo: String
公开扩展信息
Returns BMXErrorCode
setPrivateInfo
* public BMXErrorCode setPrivateInfo(String privateInfo);
* 设置私有扩展信息
Parameters
* privateInfo: String
私有扩展信息
Returns BMXErrorCode
setAddFriendAuthMode
* public BMXErrorCode setAddFriendAuthMode(BMXUserProfile.AddFriendAuthMode mode);
* 设置加好友验证方式
Parameters
* mode: AddFriendAuthMode
加好友验证方式
Returns BMXErrorCode
setAuthQuestion
* public BMXErrorCode setAuthQuestion(BMXUserProfile.AuthQuestion authQuestion);
* 设置加好友验证问题
Parameters
* authQuestion: AuthQuestion
加好友验证问题
Returns BMXErrorCode
setEnablePush
* public BMXErrorCode setEnablePush(boolean enable);
* 设置是否允许推送
Parameters
* enable: boolean
是否允许推送，true推送，false不推送
Returns BMXErrorCode
setEnablePushDetaile
* public BMXErrorCode setEnablePushDetaile(boolean enable);
* 设置是否推送详情
Parameters
* enable: boolean
是否推送详情，true推送，false不推送
Returns BMXErrorCode
setPushNickname
* public BMXErrorCode setPushNickname(String nickname);
* 设置推送昵称
Parameters
* nickname: String
推送昵称
Returns BMXErrorCode
setPushAlias
* public BMXErrorCode setPushAlias(String alias, String bmxPushToken);
* 设置推送别名
Parameters
* alias: String
别名
* bmxPushToken: String
推送token
Returns BMXErrorCode
setNotificationSound
* public BMXErrorCode setNotificationSound(boolean enable);
* 设置收到新消息是否声音提醒
Parameters
* enable: boolean
收到新消息是否声音提醒，true提醒，false不提醒
Returns BMXErrorCode
setNotificationVibrate
* public BMXErrorCode setNotificationVibrate(boolean enable);
* 设置收到新消息是否震动
Parameters
* enable: boolean
收到新消息是否震动，true震动，false不震动
Returns BMXErrorCode
setAutoDownloadAttachment
* public BMXErrorCode setAutoDownloadAttachment(boolean enable);
* 设置是否自动缩略图和语音附件
Parameters
* enable: boolean
是否自动缩略图和语音附件，true自动下载，false不会自动下载
Returns BMXErrorCode
setAutoAcceptGroupInvite
* public BMXErrorCode setAutoAcceptGroupInvite(boolean enable);
* 设置是否自动同意入群邀请
Parameters
* enable: boolean
是否自动同意入群邀请，true同意，false不同意
Returns BMXErrorCode
addUserListener
* public void addUserListener(BMXUserServiceListener listener);
* 添加用户状态监听者
Parameters
* listener: [BMXUserServiceListener](https://developer.qiniu.com/IM/api/8293/bmxuserservicelistener)
用户状态监听者
Returns void
removeUserListener
* public void removeUserListener(BMXUserServiceListener listener);
* 移除用户状态监听者
Parameters
* listener: [BMXUserServiceListener](https://developer.qiniu.com/IM/api/8293/bmxuserservicelistener)
用户状态监听者
Returns void
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXUserService
# BMXUserService
最近更新时间: 2022-07-22 22:50:54
class im.floo.floolib.BMXUserService
用户Service
Index
字段
* swigCMemOwn
方法
* getCPtr
* finalize
* delete
* bindDevice
* getDeviceList
* getProfile
* deleteDevice
* setNickname
* uploadAvatar
* downloadAvatar
* setPublicInfo
* setPrivateInfo
* setAddFriendAuthMode
* setAuthQuestion
* setEnablePush
* setEnablePushDetaile
* setPushNickname
* setPushAlias
* setNotificationSound
* setNotificationVibrate
* setAutoDownloadAttachment
* setAutoAcceptGroupInvite
* addUserListener
* removeUserListener
字段
swigCMemOwn
* protected transient boolean swigCMemOwn
*
方法
getCPtr
* protected static long getCPtr(BMXUserService obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
bindDevice
* public BMXErrorCode bindDevice(String token);
* 绑定设备推送token
Parameters
* token: String
设备token
Returns BMXErrorCode
getDeviceList
* public BMXErrorCode getDeviceList(BMXDeviceList deviceList);
* 获取设备列表
Parameters
* deviceList: BMXDeviceList
设备列表，传入空列表函数返回后从此处获取返回的设备列表
Returns BMXErrorCode
getProfile
* public BMXErrorCode getProfile(BMXUserProfile profile, boolean forceRefresh);
* 获取用户详情，如果forceRefresh == true，则强制从服务端拉取
Parameters
* profile: [BMXUserProfile](https://developer.qiniu.com/IM/api/8304/bmxuserprofile)
用户profile信息，初始传入指向为空的shared_ptr对象，函数返回后从此处获取用户profile信息。
* forceRefresh: boolean
是否强制从服务器拉取，本地获取失败的情况下会自动从服务器拉取
Returns BMXErrorCode
deleteDevice
* public BMXErrorCode deleteDevice(int device_sn);
* 删除设备
Parameters
* device_sn: int
设备序列号
Returns BMXErrorCode
setNickname
* public BMXErrorCode setNickname(String nickname);
* 设置昵称
Parameters
* nickname: String
用户昵称
Returns BMXErrorCode
uploadAvatar
* public BMXErrorCode uploadAvatar(String avatarPath, FileProgressListener callback);
* 上传头像
Parameters
* avatarPath: String
上传头像的本地地址
* callback: FileProgressListener
上传回调函数
Returns BMXErrorCode
downloadAvatar
* public BMXErrorCode downloadAvatar(BMXUserProfile profile, boolean thumbnail, FileProgressListener callback);
* 下载头像，默认下载缩略图
Parameters
* profile: [BMXUserProfile](https://developer.qiniu.com/IM/api/8304/bmxuserprofile)
用户profile
* thumbnail: boolean
是否下载缩略图，true下载缩略图，false下载原图
* callback: FileProgressListener
下载回调函数
Returns BMXErrorCode
setPublicInfo
* public BMXErrorCode setPublicInfo(String publicInfo);
* 设置公开扩展信息
Parameters
* publicInfo: String
公开扩展信息
Returns BMXErrorCode
setPrivateInfo
* public BMXErrorCode setPrivateInfo(String privateInfo);
* 设置私有扩展信息
Parameters
* privateInfo: String
私有扩展信息
Returns BMXErrorCode
setAddFriendAuthMode
* public BMXErrorCode setAddFriendAuthMode(BMXUserProfile.AddFriendAuthMode mode);
* 设置加好友验证方式
Parameters
* mode: AddFriendAuthMode
加好友验证方式
Returns BMXErrorCode
setAuthQuestion
* public BMXErrorCode setAuthQuestion(BMXUserProfile.AuthQuestion authQuestion);
* 设置加好友验证问题
Parameters
* authQuestion: AuthQuestion
加好友验证问题
Returns BMXErrorCode
setEnablePush
* public BMXErrorCode setEnablePush(boolean enable);
* 设置是否允许推送
Parameters
* enable: boolean
是否允许推送，true推送，false不推送
Returns BMXErrorCode
setEnablePushDetaile
* public BMXErrorCode setEnablePushDetaile(boolean enable);
* 设置是否推送详情
Parameters
* enable: boolean
是否推送详情，true推送，false不推送
Returns BMXErrorCode
setPushNickname
* public BMXErrorCode setPushNickname(String nickname);
* 设置推送昵称
Parameters
* nickname: String
推送昵称
Returns BMXErrorCode
setPushAlias
* public BMXErrorCode setPushAlias(String alias, String bmxPushToken);
* 设置推送别名
Parameters
* alias: String
别名
* bmxPushToken: String
推送token
Returns BMXErrorCode
setNotificationSound
* public BMXErrorCode setNotificationSound(boolean enable);
* 设置收到新消息是否声音提醒
Parameters
* enable: boolean
收到新消息是否声音提醒，true提醒，false不提醒
Returns BMXErrorCode
setNotificationVibrate
* public BMXErrorCode setNotificationVibrate(boolean enable);
* 设置收到新消息是否震动
Parameters
* enable: boolean
收到新消息是否震动，true震动，false不震动
Returns BMXErrorCode
setAutoDownloadAttachment
* public BMXErrorCode setAutoDownloadAttachment(boolean enable);
* 设置是否自动缩略图和语音附件
Parameters
* enable: boolean
是否自动缩略图和语音附件，true自动下载，false不会自动下载
Returns BMXErrorCode
setAutoAcceptGroupInvite
* public BMXErrorCode setAutoAcceptGroupInvite(boolean enable);
* 设置是否自动同意入群邀请
Parameters
* enable: boolean
是否自动同意入群邀请，true同意，false不同意
Returns BMXErrorCode
addUserListener
* public void addUserListener(BMXUserServiceListener listener);
* 添加用户状态监听者
Parameters
* listener: [BMXUserServiceListener](https://developer.qiniu.com/IM/api/8293/bmxuserservicelistener)
用户状态监听者
Returns void
removeUserListener
* public void removeUserListener(BMXUserServiceListener listener);
* 移除用户状态监听者
Parameters
* listener: [BMXUserServiceListener](https://developer.qiniu.com/IM/api/8293/bmxuserservicelistener)
用户状态监听者
Returns void
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,919 |
BMXUserServiceListener | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXUserServiceListener
# BMXUserServiceListener
最近更新时间: 2022-07-22 22:34:56
class im.floo.floolib.BMXUserServiceListener
用户状态监听者
Index
字段
* swigCMemOwn
方法
* getCPtr
* finalize
* delete
* swigDirectorDisconnect
* swigReleaseOwnership
* swigTakeOwnership
* onConnectStatusChanged
* onUserSignIn
* onUserSignOut
* onInfoUpdated
* onOtherDeviceSingIn
* onOtherDeviceSingOut
* registerUserService
字段
swigCMemOwn
* protected transient boolean swigCMemOwn
*
方法
getCPtr
* protected static long getCPtr(BMXUserServiceListener obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
swigDirectorDisconnect
* protected void swigDirectorDisconnect();
* Returns void
swigReleaseOwnership
* public void swigReleaseOwnership();
* Returns void
swigTakeOwnership
* public void swigTakeOwnership();
* Returns void
onConnectStatusChanged
* public void onConnectStatusChanged(BMXConnectStatus status);
* 链接状态发生变化
Parameters
* status: [BMXConnectStatus](https://developer.qiniu.com/IM/api/8202/bmxconnectstatus)
连接状态
Returns void
onUserSignIn
* public void onUserSignIn(BMXUserProfile profile);
* 用户登陆
Parameters
* profile: [BMXUserProfile](https://developer.qiniu.com/IM/api/8304/bmxuserprofile)
用户profile
Returns void
onUserSignOut
* public void onUserSignOut(BMXErrorCode error, long userId);
* 用户登出
Parameters
* error: BMXErrorCode
状态错误码
Returns void
onInfoUpdated
* public void onInfoUpdated(BMXUserProfile profile);
* 同步用户信息更新（其他设备操作发生用户信息变更）
Parameters
* profile: [BMXUserProfile](https://developer.qiniu.com/IM/api/8304/bmxuserprofile)
用户profile
Returns void
onOtherDeviceSingIn
* public void onOtherDeviceSingIn(int deviceSN);
* 用户在其他设备上登陆
Parameters
* deviceSN: int
设备序列号
Returns void
onOtherDeviceSingOut
* public void onOtherDeviceSingOut(int deviceSN);
* 用户在其他设备上登出
Parameters
* deviceSN: int
设备序列号
Returns void
registerUserService
* public void registerUserService(BMXUserService service);
* Returns void
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXUserServiceListener
# BMXUserServiceListener
最近更新时间: 2022-07-22 22:34:56
class im.floo.floolib.BMXUserServiceListener
用户状态监听者
Index
字段
* swigCMemOwn
方法
* getCPtr
* finalize
* delete
* swigDirectorDisconnect
* swigReleaseOwnership
* swigTakeOwnership
* onConnectStatusChanged
* onUserSignIn
* onUserSignOut
* onInfoUpdated
* onOtherDeviceSingIn
* onOtherDeviceSingOut
* registerUserService
字段
swigCMemOwn
* protected transient boolean swigCMemOwn
*
方法
getCPtr
* protected static long getCPtr(BMXUserServiceListener obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
swigDirectorDisconnect
* protected void swigDirectorDisconnect();
* Returns void
swigReleaseOwnership
* public void swigReleaseOwnership();
* Returns void
swigTakeOwnership
* public void swigTakeOwnership();
* Returns void
onConnectStatusChanged
* public void onConnectStatusChanged(BMXConnectStatus status);
* 链接状态发生变化
Parameters
* status: [BMXConnectStatus](https://developer.qiniu.com/IM/api/8202/bmxconnectstatus)
连接状态
Returns void
onUserSignIn
* public void onUserSignIn(BMXUserProfile profile);
* 用户登陆
Parameters
* profile: [BMXUserProfile](https://developer.qiniu.com/IM/api/8304/bmxuserprofile)
用户profile
Returns void
onUserSignOut
* public void onUserSignOut(BMXErrorCode error, long userId);
* 用户登出
Parameters
* error: BMXErrorCode
状态错误码
Returns void
onInfoUpdated
* public void onInfoUpdated(BMXUserProfile profile);
* 同步用户信息更新（其他设备操作发生用户信息变更）
Parameters
* profile: [BMXUserProfile](https://developer.qiniu.com/IM/api/8304/bmxuserprofile)
用户profile
Returns void
onOtherDeviceSingIn
* public void onOtherDeviceSingIn(int deviceSN);
* 用户在其他设备上登陆
Parameters
* deviceSN: int
设备序列号
Returns void
onOtherDeviceSingOut
* public void onOtherDeviceSingOut(int deviceSN);
* 用户在其他设备上登出
Parameters
* deviceSN: int
设备序列号
Returns void
registerUserService
* public void registerUserService(BMXUserService service);
* Returns void
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,928 |
BMXVideoAttachment | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXVideoAttachment
# BMXVideoAttachment
最近更新时间: 2022-07-22 22:43:44
class im.floo.floolib.BMXVideoAttachment
视频消息附件
Index
方法
* getCPtr
* finalize
* delete
* type
* clone
* size
* duration
* setThumbnail
* thumbnailPath
* thumbnailUrl
* setThumbnailRatelUrl
* thumbnailRatelUrl
* thumbnailDownloadStatus
* dynamic_cast
方法
getCPtr
* protected static long getCPtr(BMXVideoAttachment obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
type
* public BMXMessageAttachment.Type type();
* 返回文件类型
Returns Type
clone
* public BMXMessageAttachment clone();
* 克隆函数
Returns
[BMXMessageAttachment](https://developer.qiniu.com/IM/api/8244/bmxmessageattachment)
size
* public BMXMessageAttachment.Size size();
* 视频大小，宽度和高度
Returns Size
duration
* public int duration();
* 视频片段时长
Returns int
setThumbnail
* public void setThumbnail(String path);
* 设置发送视频片段消息缩略图
Parameters
* path: String
视频片段消息缩略图
Returns void
thumbnailPath
* public String thumbnailPath();
* 缩略图本地路径
Returns String
thumbnailUrl
* public String thumbnailUrl();
* 缩略图服务器路径
Returns String
setThumbnailRatelUrl
* public void setThumbnailRatelUrl(String thumbnailRatelUrl);
* Returns void
thumbnailRatelUrl
* public String thumbnailRatelUrl();
* Returns String
thumbnailDownloadStatus
* public BMXMessageAttachment.DownloadStatus thumbnailDownloadStatus();
* 缩略图下载状态
Returns DownloadStatus
dynamic_cast
* public static BMXVideoAttachment dynamic_cast(BMXMessageAttachment attachment);
* Returns [BMXVideoAttachment](https://developer.qiniu.com/IM/api/8294/bmxvideoattachment)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXVideoAttachment
# BMXVideoAttachment
最近更新时间: 2022-07-22 22:43:44
class im.floo.floolib.BMXVideoAttachment
视频消息附件
Index
方法
* getCPtr
* finalize
* delete
* type
* clone
* size
* duration
* setThumbnail
* thumbnailPath
* thumbnailUrl
* setThumbnailRatelUrl
* thumbnailRatelUrl
* thumbnailDownloadStatus
* dynamic_cast
方法
getCPtr
* protected static long getCPtr(BMXVideoAttachment obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
type
* public BMXMessageAttachment.Type type();
* 返回文件类型
Returns Type
clone
* public BMXMessageAttachment clone();
* 克隆函数
Returns
[BMXMessageAttachment](https://developer.qiniu.com/IM/api/8244/bmxmessageattachment)
size
* public BMXMessageAttachment.Size size();
* 视频大小，宽度和高度
Returns Size
duration
* public int duration();
* 视频片段时长
Returns int
setThumbnail
* public void setThumbnail(String path);
* 设置发送视频片段消息缩略图
Parameters
* path: String
视频片段消息缩略图
Returns void
thumbnailPath
* public String thumbnailPath();
* 缩略图本地路径
Returns String
thumbnailUrl
* public String thumbnailUrl();
* 缩略图服务器路径
Returns String
setThumbnailRatelUrl
* public void setThumbnailRatelUrl(String thumbnailRatelUrl);
* Returns void
thumbnailRatelUrl
* public String thumbnailRatelUrl();
* Returns String
thumbnailDownloadStatus
* public BMXMessageAttachment.DownloadStatus thumbnailDownloadStatus();
* 缩略图下载状态
Returns DownloadStatus
dynamic_cast
* public static BMXVideoAttachment dynamic_cast(BMXMessageAttachment attachment);
* Returns [BMXVideoAttachment](https://developer.qiniu.com/IM/api/8294/bmxvideoattachment)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,932 |
QNIMClient | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
QNIMClient
# QNIMClient
最近更新时间: 2022-07-22 22:45:05
class com.qiniu.droid.imsdk.QNIMClient
七牛im 客户端
Index
方法
* delete
* init
* isInit
* getChatRoomManager
* getChatRoomService
* getSDKConfig
* getUserService
* getChatService
* getGroupService
* getRosterService
* getPushService
* getUserManager
* getChatManager
* getGroupManager
* getRosterManager
* getPushManager
* signUpNewUser
* signInByName
* signInById
* fastSignInByName
* fastSignInById
* signOut
* signOut
* signOut
* connectStatus
* signInStatus
* reconnect
* onNetworkChanged
* disconnect
* changeAppId
* changeAppId
* initializeServerConfig
* sendMessage
方法
delete
* public static void delete();
* Returns void
init
* public static void init(BMXSDKConfig config);
* 创建 QNIMClient
Parameters
* config: [BMXSDKConfig](https://developer.qiniu.com/IM/api/8284/bmxsdkconfig)
im配置
Returns void
isInit
* public static boolean isInit();
* Returns boolean
getChatRoomManager
* public static BXMChatRoomManager getChatRoomManager();
* 获得聊天室管理
Returns
[BXMChatRoomManager](https://developer.qiniu.com/IM/api/8298/bxmchatroommanager)
getChatRoomService
* public static BXMChatRoomService getChatRoomService();
* 获得聊天室服务
Returns
[BXMChatRoomService](https://developer.qiniu.com/IM/api/8200/bxmchatroomservice)
getSDKConfig
* public static BMXSDKConfig getSDKConfig();
* 获取SDK设置
Returns [BMXSDKConfig](https://developer.qiniu.com/IM/api/8284/bmxsdkconfig)
getUserService
* public static BMXUserService getUserService();
* Returns [BMXUserService](https://developer.qiniu.com/IM/api/8292/bmxuserservice)
getChatService
* public static BMXChatService getChatService();
* 获取聊天Service
Returns
[BMXChatService](https://developer.qiniu.com/IM/api/8195/bmxchatservice)
getGroupService
* public static BMXGroupService getGroupService();
* 获取群组Service
Returns
[BMXGroupService](https://developer.qiniu.com/IM/api/8231/bmxgroupservice)
getRosterService
* public static BMXRosterService getRosterService();
* 获取好友Service
Returns
[BMXRosterService](https://developer.qiniu.com/IM/api/8299/bmxrosterservice)
getPushService
* public static BMXPushService getPushService();
* 获取推送Service
Returns
[BMXPushService](https://developer.qiniu.com/IM/api/8267/bmxpushservice)
getUserManager
* public static BMXUserManager getUserManager();
* 获取用户Manager
Returns
[BMXUserManager](https://developer.qiniu.com/IM/api/8287/bmxusermanager)
getChatManager
* public static BMXChatManager getChatManager();
* 获取聊天Manager
Returns
[BMXChatManager](https://developer.qiniu.com/IM/api/8201/bmxchatmanager)
getGroupManager
* public static BMXGroupManager getGroupManager();
* 获取群组Manager
Returns
[BMXGroupManager](https://developer.qiniu.com/IM/api/8230/bmxgroupmanager)
getRosterManager
* public static BMXRosterManager getRosterManager();
* 获取好友Manager
Returns
[BMXRosterManager](https://developer.qiniu.com/IM/api/8277/bmxrostermanager)
getPushManager
* public static BMXPushManager getPushManager();
* 获取推送Manager
Returns
[BMXPushManager](https://developer.qiniu.com/IM/api/8253/bmxpushmanager)
signUpNewUser
* public static BMXErrorCode signUpNewUser(String username, String password, BMXUserProfile bmxUserProfilePtr);
* 注册新用户，username和password是必填参数
Parameters
* username: String
用户名
* password: String
用户密码
* bmxUserProfilePtr: [BMXUserProfile](https://developer.qiniu.com/IM/api/8304/bmxuserprofile)
注册成功后从该函数处获取新注册用户的Profile信息，初始传入指向为空的shared_ptr对象即可
Returns BMXErrorCode
signInByName
* public static BMXErrorCode signInByName(String name, String password);
* 通过用户名登录
Parameters
* name: String
用户名
* password: String
用户密码
Returns BMXErrorCode
signInById
* public static BMXErrorCode signInById(long uid, String password);
* 通过用户ID登录
Parameters
* uid: long
用户id
* password: String
用户密码
Returns BMXErrorCode
fastSignInByName
* public static BMXErrorCode fastSignInByName(String name, String password);
* 通过用户名快速登录（要求之前成功登录过，登录速度较快）
Parameters
* name: String
用户名
* password: String
用户密码(用于sdk在内部token到期时自动更新用户token)
Returns BMXErrorCode
fastSignInById
* public static BMXErrorCode fastSignInById(long uid, String password);
* 通过用户ID快速登录（要求之前成功登录过，登录速度较快）
Parameters
* uid: long
用户id
* password: String
用户密码(用于sdk在内部token到期时自动更新用户token)
Returns BMXErrorCode
signOut
* public static BMXErrorCode signOut(long uid, boolean ignoreUnbindDevice);
* 退出登录
Parameters
* uid: long
退出用户的uid（默认输入0则退出当前登陆用户）
* ignoreUnbindDevice: boolean
Returns BMXErrorCode
signOut
* public static BMXErrorCode signOut(long uid);
* 退出登录
Parameters
* uid: long
退出用户的uid（默认输入0则退出当前登陆用户）
Returns BMXErrorCode
signOut
* public static BMXErrorCode signOut();
* 退出登录
Returns BMXErrorCode
connectStatus
* public static BMXConnectStatus connectStatus();
* 获取当前和服务器的连接状态
Returns
[BMXConnectStatus](https://developer.qiniu.com/IM/api/8202/bmxconnectstatus)
signInStatus
* public static BMXSignInStatus signInStatus();
* 获取当前的登录状态
Returns
[BMXSignInStatus](https://developer.qiniu.com/IM/api/8286/bmxsigninstatus)
reconnect
* public static void reconnect();
* 强制重新连接
Returns void
onNetworkChanged
* public static void onNetworkChanged(BMXNetworkType type, boolean reconnect);
* 处理网络状态发送变化
Parameters
* type: [BMXNetworkType](https://developer.qiniu.com/IM/api/8251/bmxnetworktype)
变化后的网络类型
* reconnect: boolean
网络是否需要重连
Returns void
disconnect
* public static void disconnect();
* 断开网络连接
Returns void
changeAppId
* public static BMXErrorCode changeAppId(String appId, String appSecret);
* 更改SDK的appId，本操作会同时更新BMXConfig中的appId。
Parameters
* appId: String
新变更的appId
* appSecret: String
新变更的appSecret
Returns BMXErrorCode
changeAppId
* public static BMXErrorCode changeAppId(String appId);
* 更改SDK的appId，本操作会同时更新BMXConfig中的appId。
Parameters
* appId: String
新变更的appId
Returns BMXErrorCode
initializeServerConfig
* public static BMXErrorCode initializeServerConfig(boolean isLocal);
* 获取app的服务器网络配置，在初始化SDK之后登陆之前调用，可以提前获取服务器配置加快登陆速度。
Parameters
* isLocal: boolean
\- 为true则使用本地缓存的dns配置，为false则从服务器获取最新的配置。
Returns BMXErrorCode
sendMessage
* public static void sendMessage(BMXMessage msg);
* 发送消息，消息状态变化会通过listener通知，在发送群组消息且指定的群组为开启群组已读回执的情况下， 该接口会自动获取群成员列表id并且填充到message config中去，无需客户端自己进行群组成员列表的填充操作。
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
消息实体
Returns void
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
QNIMClient
# QNIMClient
最近更新时间: 2022-07-22 22:45:05
class com.qiniu.droid.imsdk.QNIMClient
七牛im 客户端
Index
方法
* delete
* init
* isInit
* getChatRoomManager
* getChatRoomService
* getSDKConfig
* getUserService
* getChatService
* getGroupService
* getRosterService
* getPushService
* getUserManager
* getChatManager
* getGroupManager
* getRosterManager
* getPushManager
* signUpNewUser
* signInByName
* signInById
* fastSignInByName
* fastSignInById
* signOut
* signOut
* signOut
* connectStatus
* signInStatus
* reconnect
* onNetworkChanged
* disconnect
* changeAppId
* changeAppId
* initializeServerConfig
* sendMessage
方法
delete
* public static void delete();
* Returns void
init
* public static void init(BMXSDKConfig config);
* 创建 QNIMClient
Parameters
* config: [BMXSDKConfig](https://developer.qiniu.com/IM/api/8284/bmxsdkconfig)
im配置
Returns void
isInit
* public static boolean isInit();
* Returns boolean
getChatRoomManager
* public static BXMChatRoomManager getChatRoomManager();
* 获得聊天室管理
Returns
[BXMChatRoomManager](https://developer.qiniu.com/IM/api/8298/bxmchatroommanager)
getChatRoomService
* public static BXMChatRoomService getChatRoomService();
* 获得聊天室服务
Returns
[BXMChatRoomService](https://developer.qiniu.com/IM/api/8200/bxmchatroomservice)
getSDKConfig
* public static BMXSDKConfig getSDKConfig();
* 获取SDK设置
Returns [BMXSDKConfig](https://developer.qiniu.com/IM/api/8284/bmxsdkconfig)
getUserService
* public static BMXUserService getUserService();
* Returns [BMXUserService](https://developer.qiniu.com/IM/api/8292/bmxuserservice)
getChatService
* public static BMXChatService getChatService();
* 获取聊天Service
Returns
[BMXChatService](https://developer.qiniu.com/IM/api/8195/bmxchatservice)
getGroupService
* public static BMXGroupService getGroupService();
* 获取群组Service
Returns
[BMXGroupService](https://developer.qiniu.com/IM/api/8231/bmxgroupservice)
getRosterService
* public static BMXRosterService getRosterService();
* 获取好友Service
Returns
[BMXRosterService](https://developer.qiniu.com/IM/api/8299/bmxrosterservice)
getPushService
* public static BMXPushService getPushService();
* 获取推送Service
Returns
[BMXPushService](https://developer.qiniu.com/IM/api/8267/bmxpushservice)
getUserManager
* public static BMXUserManager getUserManager();
* 获取用户Manager
Returns
[BMXUserManager](https://developer.qiniu.com/IM/api/8287/bmxusermanager)
getChatManager
* public static BMXChatManager getChatManager();
* 获取聊天Manager
Returns
[BMXChatManager](https://developer.qiniu.com/IM/api/8201/bmxchatmanager)
getGroupManager
* public static BMXGroupManager getGroupManager();
* 获取群组Manager
Returns
[BMXGroupManager](https://developer.qiniu.com/IM/api/8230/bmxgroupmanager)
getRosterManager
* public static BMXRosterManager getRosterManager();
* 获取好友Manager
Returns
[BMXRosterManager](https://developer.qiniu.com/IM/api/8277/bmxrostermanager)
getPushManager
* public static BMXPushManager getPushManager();
* 获取推送Manager
Returns
[BMXPushManager](https://developer.qiniu.com/IM/api/8253/bmxpushmanager)
signUpNewUser
* public static BMXErrorCode signUpNewUser(String username, String password, BMXUserProfile bmxUserProfilePtr);
* 注册新用户，username和password是必填参数
Parameters
* username: String
用户名
* password: String
用户密码
* bmxUserProfilePtr: [BMXUserProfile](https://developer.qiniu.com/IM/api/8304/bmxuserprofile)
注册成功后从该函数处获取新注册用户的Profile信息，初始传入指向为空的shared_ptr对象即可
Returns BMXErrorCode
signInByName
* public static BMXErrorCode signInByName(String name, String password);
* 通过用户名登录
Parameters
* name: String
用户名
* password: String
用户密码
Returns BMXErrorCode
signInById
* public static BMXErrorCode signInById(long uid, String password);
* 通过用户ID登录
Parameters
* uid: long
用户id
* password: String
用户密码
Returns BMXErrorCode
fastSignInByName
* public static BMXErrorCode fastSignInByName(String name, String password);
* 通过用户名快速登录（要求之前成功登录过，登录速度较快）
Parameters
* name: String
用户名
* password: String
用户密码(用于sdk在内部token到期时自动更新用户token)
Returns BMXErrorCode
fastSignInById
* public static BMXErrorCode fastSignInById(long uid, String password);
* 通过用户ID快速登录（要求之前成功登录过，登录速度较快）
Parameters
* uid: long
用户id
* password: String
用户密码(用于sdk在内部token到期时自动更新用户token)
Returns BMXErrorCode
signOut
* public static BMXErrorCode signOut(long uid, boolean ignoreUnbindDevice);
* 退出登录
Parameters
* uid: long
退出用户的uid（默认输入0则退出当前登陆用户）
* ignoreUnbindDevice: boolean
Returns BMXErrorCode
signOut
* public static BMXErrorCode signOut(long uid);
* 退出登录
Parameters
* uid: long
退出用户的uid（默认输入0则退出当前登陆用户）
Returns BMXErrorCode
signOut
* public static BMXErrorCode signOut();
* 退出登录
Returns BMXErrorCode
connectStatus
* public static BMXConnectStatus connectStatus();
* 获取当前和服务器的连接状态
Returns
[BMXConnectStatus](https://developer.qiniu.com/IM/api/8202/bmxconnectstatus)
signInStatus
* public static BMXSignInStatus signInStatus();
* 获取当前的登录状态
Returns
[BMXSignInStatus](https://developer.qiniu.com/IM/api/8286/bmxsigninstatus)
reconnect
* public static void reconnect();
* 强制重新连接
Returns void
onNetworkChanged
* public static void onNetworkChanged(BMXNetworkType type, boolean reconnect);
* 处理网络状态发送变化
Parameters
* type: [BMXNetworkType](https://developer.qiniu.com/IM/api/8251/bmxnetworktype)
变化后的网络类型
* reconnect: boolean
网络是否需要重连
Returns void
disconnect
* public static void disconnect();
* 断开网络连接
Returns void
changeAppId
* public static BMXErrorCode changeAppId(String appId, String appSecret);
* 更改SDK的appId，本操作会同时更新BMXConfig中的appId。
Parameters
* appId: String
新变更的appId
* appSecret: String
新变更的appSecret
Returns BMXErrorCode
changeAppId
* public static BMXErrorCode changeAppId(String appId);
* 更改SDK的appId，本操作会同时更新BMXConfig中的appId。
Parameters
* appId: String
新变更的appId
Returns BMXErrorCode
initializeServerConfig
* public static BMXErrorCode initializeServerConfig(boolean isLocal);
* 获取app的服务器网络配置，在初始化SDK之后登陆之前调用，可以提前获取服务器配置加快登陆速度。
Parameters
* isLocal: boolean
\- 为true则使用本地缓存的dns配置，为false则从服务器获取最新的配置。
Returns BMXErrorCode
sendMessage
* public static void sendMessage(BMXMessage msg);
* 发送消息，消息状态变化会通过listener通知，在发送群组消息且指定的群组为开启群组已读回执的情况下， 该接口会自动获取群成员列表id并且填充到message config中去，无需客户端自己进行群组成员列表的填充操作。
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
消息实体
Returns void
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,935 |
BMXVoiceAttachment | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXVoiceAttachment
# BMXVoiceAttachment
最近更新时间: 2021-07-20 09:54:56
## 类 BMXVoiceAttachment
* java.lang.Object
* * BMXBaseObject
* * im.floo.floolib.BMXMessageAttachment
* * im.floo.floolib.BMXFileAttachment
* * im.floo.floolib.BMXVoiceAttachment
* * * *
public class BMXVoiceAttachment
extends BMXFileAttachment
音频消息附件
* * ### 嵌套类概要
* ### 从类继承的嵌套类/接口 im.floo.floolib.BMXMessageAttachment
`BMXMessageAttachment.DownloadStatus, BMXMessageAttachment.Size,
BMXMessageAttachment.Type`
* ### 构造器概要
构造器 限定符 | 构造器和说明
---|---
`protected ` | `BMXVoiceAttachment(long cPtr, boolean cMemoryOwn)`
` ` | `BMXVoiceAttachment(java.lang.String path, int duration)`
` ` | `BMXVoiceAttachment(java.lang.String path, int duration, java.lang.String displayName)` 构造函数，构建发送音频消息附件
` ` | `BMXVoiceAttachment(java.lang.String ratelUrl, int duration, java.lang.String displayName, long fileLength)` 构造函数，构建接收音频消息附件
* ### 方法概要
所有方法 静态方法 实例方法 具体方法 限定符和类型 | 方法和说明
---|---
`BMXMessageAttachment` | `clone()` 克隆函数
`void` | `delete()`
`int` | `duration()` 语音时长
`static BMXVoiceAttachment` | `dynamic_cast(BMXMessageAttachment attachment)`
`protected void` | `finalize()`
`protected static long` | `getCPtr(BMXVoiceAttachment obj)`
`BMXMessageAttachment.Type` | `type()` 返回文件类型
* ### 从类继承的方法 im.floo.floolib.BMXFileAttachment
`displayName, downloadStatus, fileLength, getCPtr, path, ratelUrl, url`
* ### 从类继承的方法 im.floo.floolib.BMXMessageAttachment
`getCPtr`
* ### 从类继承的方法 java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`
* * ### 构造器详细资料
* #### BMXVoiceAttachment
protected BMXVoiceAttachment(long cPtr,
boolean cMemoryOwn)
* #### BMXVoiceAttachment
public BMXVoiceAttachment(java.lang.String path,
int duration,
java.lang.String displayName)
构造函数，构建发送音频消息附件
参数:
`path` \- 文件的本地路径
`duration` \- 音频时长
`displayName` \- 文件展示名
* #### BMXVoiceAttachment
public BMXVoiceAttachment(java.lang.String path,
int duration)
* #### BMXVoiceAttachment
public BMXVoiceAttachment(java.lang.String ratelUrl,
int duration,
java.lang.String displayName,
long fileLength)
构造函数，构建接收音频消息附件
参数:
`ratelUrl` \- ratel服务器地址
`duration` \- 音频时长
`displayName` \- 文件展示名
`fileLength` \- 文件大小
* ### 方法详细资料
* #### getCPtr
protected static long getCPtr(BMXVoiceAttachment obj)
* #### finalize
protected void finalize()
覆盖:
`finalize` 在类中 `BMXFileAttachment`
* #### delete
public void delete()
覆盖:
`delete` 在类中 `BMXFileAttachment`
* #### type
public BMXMessageAttachment.Type type()
返回文件类型
覆盖:
`type` 在类中 `BMXFileAttachment`
返回:
Type
* #### clone
public BMXMessageAttachment clone()
克隆函数
覆盖:
`clone` 在类中 `BMXFileAttachment`
返回:
BMXMessageAttachmentPtr
* #### duration
public int duration()
语音时长
返回:
int32_t
* #### dynamic_cast
public static BMXVoiceAttachment dynamic_cast(BMXMessageAttachment attachment)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXVoiceAttachment
# BMXVoiceAttachment
最近更新时间: 2021-07-20 09:54:56
## 类 BMXVoiceAttachment
* java.lang.Object
* * BMXBaseObject
* * im.floo.floolib.BMXMessageAttachment
* * im.floo.floolib.BMXFileAttachment
* * im.floo.floolib.BMXVoiceAttachment
* * * *
public class BMXVoiceAttachment
extends BMXFileAttachment
音频消息附件
* * ### 嵌套类概要
* ### 从类继承的嵌套类/接口 im.floo.floolib.BMXMessageAttachment
`BMXMessageAttachment.DownloadStatus, BMXMessageAttachment.Size,
BMXMessageAttachment.Type`
* ### 构造器概要
构造器 限定符 | 构造器和说明
---|---
`protected ` | `BMXVoiceAttachment(long cPtr, boolean cMemoryOwn)`
` ` | `BMXVoiceAttachment(java.lang.String path, int duration)`
` ` | `BMXVoiceAttachment(java.lang.String path, int duration, java.lang.String displayName)` 构造函数，构建发送音频消息附件
` ` | `BMXVoiceAttachment(java.lang.String ratelUrl, int duration, java.lang.String displayName, long fileLength)` 构造函数，构建接收音频消息附件
* ### 方法概要
所有方法 静态方法 实例方法 具体方法 限定符和类型 | 方法和说明
---|---
`BMXMessageAttachment` | `clone()` 克隆函数
`void` | `delete()`
`int` | `duration()` 语音时长
`static BMXVoiceAttachment` | `dynamic_cast(BMXMessageAttachment attachment)`
`protected void` | `finalize()`
`protected static long` | `getCPtr(BMXVoiceAttachment obj)`
`BMXMessageAttachment.Type` | `type()` 返回文件类型
* ### 从类继承的方法 im.floo.floolib.BMXFileAttachment
`displayName, downloadStatus, fileLength, getCPtr, path, ratelUrl, url`
* ### 从类继承的方法 im.floo.floolib.BMXMessageAttachment
`getCPtr`
* ### 从类继承的方法 java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`
* * ### 构造器详细资料
* #### BMXVoiceAttachment
protected BMXVoiceAttachment(long cPtr,
boolean cMemoryOwn)
* #### BMXVoiceAttachment
public BMXVoiceAttachment(java.lang.String path,
int duration,
java.lang.String displayName)
构造函数，构建发送音频消息附件
参数:
`path` \- 文件的本地路径
`duration` \- 音频时长
`displayName` \- 文件展示名
* #### BMXVoiceAttachment
public BMXVoiceAttachment(java.lang.String path,
int duration)
* #### BMXVoiceAttachment
public BMXVoiceAttachment(java.lang.String ratelUrl,
int duration,
java.lang.String displayName,
long fileLength)
构造函数，构建接收音频消息附件
参数:
`ratelUrl` \- ratel服务器地址
`duration` \- 音频时长
`displayName` \- 文件展示名
`fileLength` \- 文件大小
* ### 方法详细资料
* #### getCPtr
protected static long getCPtr(BMXVoiceAttachment obj)
* #### finalize
protected void finalize()
覆盖:
`finalize` 在类中 `BMXFileAttachment`
* #### delete
public void delete()
覆盖:
`delete` 在类中 `BMXFileAttachment`
* #### type
public BMXMessageAttachment.Type type()
返回文件类型
覆盖:
`type` 在类中 `BMXFileAttachment`
返回:
Type
* #### clone
public BMXMessageAttachment clone()
克隆函数
覆盖:
`clone` 在类中 `BMXFileAttachment`
返回:
BMXMessageAttachmentPtr
* #### duration
public int duration()
语音时长
返回:
int32_t
* #### dynamic_cast
public static BMXVoiceAttachment dynamic_cast(BMXMessageAttachment attachment)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,944 |
BXMChatRoomManager | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BXMChatRoomManager
# BXMChatRoomManager
最近更新时间: 2022-07-22 22:46:23
class com.qiniu.droid.imsdk.BXMChatRoomManager
聊天室
Index
方法
* create
* join
* leave
* destroy
* getMembers
* getMembers
* addGroupListener
* removeGroupListener
方法
create
* public void create(String name, BMXDataCallBack<BMXGroup> callBack);
* 创建聊天室
Parameters
* name: String
聊天室名字
* callBack: <any>
回调
Returns void
join
* public void join(long groupId, BMXCallBack callBack);
* 加入聊天室
Parameters
* groupId: long
群ID
* callBack: BMXCallBack
回调
Returns void
leave
* public void leave(long groupId, BMXCallBack callBack);
* 退出聊天室
Parameters
* groupId: long
群ID
* callBack: BMXCallBack
回调
Returns void
destroy
* public void destroy(long groupId, BMXCallBack callBack);
* 销毁聊天室
Parameters
* groupId: long
群ID
* callBack: BMXCallBack
回调
Returns void
getMembers
* public void getMembers(long groupId, boolean forceUpdate, BMXDataCallBack<BMXGroupMemberList> callBack);
* 获取群成员
Parameters
* groupId: long
群ID
* callBack: boolean
回调
Returns void
getMembers
* public void getMembers(long groupId, String cursor, int pageSize, BMXDataCallBack<BMXGroupMemberResultPage> callBack);
* 获取群成员
Parameters
* groupId: long
群ID
* callBack: String
群成员列表
* cursor: int
分页获取的起始cursor，第一次传入为空，后续传入上次操作返回的result中的cursor
* pageSize: <any>
分页大小
Returns void
addGroupListener
* public void addGroupListener(BMXGroupServiceListener listener);
* 添加群监听
Parameters
* listener: [BMXGroupServiceListener](https://developer.qiniu.com/IM/api/8235/bmxgroupservicelistener)
群监听
Returns void
removeGroupListener
* public void removeGroupListener(BMXGroupServiceListener listener);
* 移除群组变化监听者
Parameters
* listener: [BMXGroupServiceListener](https://developer.qiniu.com/IM/api/8235/bmxgroupservicelistener)
群监听
Returns void
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BXMChatRoomManager
# BXMChatRoomManager
最近更新时间: 2022-07-22 22:46:23
class com.qiniu.droid.imsdk.BXMChatRoomManager
聊天室
Index
方法
* create
* join
* leave
* destroy
* getMembers
* getMembers
* addGroupListener
* removeGroupListener
方法
create
* public void create(String name, BMXDataCallBack<BMXGroup> callBack);
* 创建聊天室
Parameters
* name: String
聊天室名字
* callBack: <any>
回调
Returns void
join
* public void join(long groupId, BMXCallBack callBack);
* 加入聊天室
Parameters
* groupId: long
群ID
* callBack: BMXCallBack
回调
Returns void
leave
* public void leave(long groupId, BMXCallBack callBack);
* 退出聊天室
Parameters
* groupId: long
群ID
* callBack: BMXCallBack
回调
Returns void
destroy
* public void destroy(long groupId, BMXCallBack callBack);
* 销毁聊天室
Parameters
* groupId: long
群ID
* callBack: BMXCallBack
回调
Returns void
getMembers
* public void getMembers(long groupId, boolean forceUpdate, BMXDataCallBack<BMXGroupMemberList> callBack);
* 获取群成员
Parameters
* groupId: long
群ID
* callBack: boolean
回调
Returns void
getMembers
* public void getMembers(long groupId, String cursor, int pageSize, BMXDataCallBack<BMXGroupMemberResultPage> callBack);
* 获取群成员
Parameters
* groupId: long
群ID
* callBack: String
群成员列表
* cursor: int
分页获取的起始cursor，第一次传入为空，后续传入上次操作返回的result中的cursor
* pageSize: <any>
分页大小
Returns void
addGroupListener
* public void addGroupListener(BMXGroupServiceListener listener);
* 添加群监听
Parameters
* listener: [BMXGroupServiceListener](https://developer.qiniu.com/IM/api/8235/bmxgroupservicelistener)
群监听
Returns void
removeGroupListener
* public void removeGroupListener(BMXGroupServiceListener listener);
* 移除群组变化监听者
Parameters
* listener: [BMXGroupServiceListener](https://developer.qiniu.com/IM/api/8235/bmxgroupservicelistener)
群监听
Returns void
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,950 |
BMXRosterService | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXRosterService
# BMXRosterService
最近更新时间: 2022-07-22 22:43:28
class im.floo.floolib.BMXRosterService
好友Service
Index
字段
* swigCMemOwn
方法
* getCPtr
* finalize
* delete
* get
* fetchRosterById
* search
* fetchRosterByName
* search
* fetchRostersByIdList
* search
* setItemLocalExtension
* setItemExtension
* setItemAlias
* setItemMuteNotification
* getApplicationList
* apply
* apply
* remove
* accept
* decline
* block
* unblock
* getBlockList
* downloadAvatar
* addRosterListener
* removeRosterListener
字段
swigCMemOwn
* protected transient boolean swigCMemOwn
*
方法
getCPtr
* protected static long getCPtr(BMXRosterService obj);
* Returns long
finalize
* @Override() protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
get
* public BMXErrorCode get(ListOfLongLong list, boolean forceRefresh);
* 获取好友列表，如果forceRefresh == true，则强制从服务端拉取
Parameters
* list: ListOfLongLong
好友id列表，传入空列表函数返回后从此处获取返回的好友id列表
* forceRefresh: boolean
是否从服务器读取数据，true为强制从服务器获取，false情况下本地读取列表为空的情况下会自动从服务器读取
Returns BMXErrorCode
fetchRosterById
* public BMXErrorCode fetchRosterById(long rosterId, boolean forceRefresh, BMXRosterItem item);
* 搜索用户
Parameters
* rosterId: long
搜索的好友id
* forceRefresh: boolean
为true强制从服务器获取，为false情况下查询结果为空时自动从服务器获取。
* item: [BMXRosterItem](https://developer.qiniu.com/IM/api/8274/bmxrosteritem)
查询返回的用户的信息，传入指向为空的shared_ptr对象函数执行后会自动赋值。
Returns BMXErrorCode
search
* public BMXErrorCode search(long rosterId, boolean forceRefresh, BMXRosterItem item);
* 搜索用户
Parameters
* rosterId: long
搜索的好友id
* forceRefresh: boolean
为true强制从服务器获取，为false情况下查询结果为空时自动从服务器获取。
* item: [BMXRosterItem](https://developer.qiniu.com/IM/api/8274/bmxrosteritem)
查询返回的用户的信息，传入指向为空的shared_ptr对象函数执行后会自动赋值。
Returns BMXErrorCode
fetchRosterByName
* public BMXErrorCode fetchRosterByName(String name, boolean forceRefresh, BMXRosterItem item);
* 搜索用户
Parameters
* name: String
搜索的用户名
* forceRefresh: boolean
为true强制从服务器获取，为false情况下查询结果为空时自动从服务器获取。
* item: [BMXRosterItem](https://developer.qiniu.com/IM/api/8274/bmxrosteritem)
查询返回的用户的信息，传入指向为空的shared_ptr对象函数执行后会自动赋值。
Returns BMXErrorCode
search
* public BMXErrorCode search(String name, boolean forceRefresh, BMXRosterItem item);
* 搜索用户
Parameters
* name: String
搜索的用户名
* forceRefresh: boolean
为true强制从服务器获取，为false情况下查询结果为空时自动从服务器获取。
* item: [BMXRosterItem](https://developer.qiniu.com/IM/api/8274/bmxrosteritem)
查询返回的用户的信息，传入指向为空的shared_ptr对象函数执行后会自动赋值。
Returns BMXErrorCode
fetchRostersByIdList
* public BMXErrorCode fetchRostersByIdList(ListOfLongLong rosterIdList, BMXRosterItemList list, boolean forceRefresh);
* 批量搜索用户
Parameters
* rosterIdList: ListOfLongLong
需要搜索的用户id列表
* list: BMXRosterItemList
返回的好友信息列表，传入空列表函数返回后从此处获取返回的好友信息列表
* forceRefresh: boolean
是否强制从服务器获取，为true则强制从服务器获取
Returns BMXErrorCode
search
* public BMXErrorCode search(ListOfLongLong rosterIdList, BMXRosterItemList list, boolean forceRefresh);
* 批量搜索用户
Parameters
* rosterIdList: ListOfLongLong
需要搜索的用户id列表
* list: BMXRosterItemList
返回的好友信息列表，传入空列表函数返回后从此处获取返回的好友信息列表
* forceRefresh: boolean
是否强制从服务器获取，为true则强制从服务器获取
Returns BMXErrorCode
setItemLocalExtension
* public BMXErrorCode setItemLocalExtension(BMXRosterItem item, String extension);
* 更新好友本地扩展信息
Parameters
* item: [BMXRosterItem](https://developer.qiniu.com/IM/api/8274/bmxrosteritem)
用户信息
* extension: String
本地扩展信息
Returns BMXErrorCode
setItemExtension
* public BMXErrorCode setItemExtension(BMXRosterItem item, String extension);
* 更新好友服务器扩展信息
Parameters
* item: [BMXRosterItem](https://developer.qiniu.com/IM/api/8274/bmxrosteritem)
用户信息
* extension: String
服务器扩展信息
Returns BMXErrorCode
setItemAlias
* public BMXErrorCode setItemAlias(BMXRosterItem item, String alias);
* 更新好友别名
Parameters
* item: [BMXRosterItem](https://developer.qiniu.com/IM/api/8274/bmxrosteritem)
用户信息
* alias: String
好友别名
Returns BMXErrorCode
setItemMuteNotification
* public BMXErrorCode setItemMuteNotification(BMXRosterItem item, boolean status);
* 设置是否拒收用户消息
Parameters
* item: [BMXRosterItem](https://developer.qiniu.com/IM/api/8274/bmxrosteritem)
用户信息
* status: boolean
是否拒收用户消息，true拒收，false不拒收
Returns BMXErrorCode
getApplicationList
* public BMXErrorCode getApplicationList(ApplicationPage result, String cursor, int pageSize);
* 获取申请添加好友列表
Parameters
* result: ApplicationPage
返回的申请好友列表信息，传入指向为空的shared_ptr对象函数执行后会自动赋值。
* cursor: String
分页获取的起始cursor，第一次传入为空，后续传入上次操作返回的result中的cursor
* pageSize: int
分页大小
Returns BMXErrorCode
apply
* public BMXErrorCode apply(long rosterId, String message, String authAnswer);
* Returns BMXErrorCode
apply
* public BMXErrorCode apply(long rosterId, String message);
* 申请添加好友
Parameters
* rosterId: long
申请添加的用户id
* message: String
好友申请信息
Returns BMXErrorCode
remove
* public BMXErrorCode remove(long rosterId);
* 删除好友
Parameters
* rosterId: long
删除的好友id
Returns BMXErrorCode
accept
* public BMXErrorCode accept(long rosterId);
* 接受加好友申请
Parameters
* rosterId: long
申请加为好友的用户id
Returns BMXErrorCode
decline
* public BMXErrorCode decline(long rosterId, String reason);
* 拒绝加好友申请
Parameters
* rosterId: long
申请加为好友的用户id
* reason: String
拒绝的原因
Returns BMXErrorCode
block
* public BMXErrorCode block(long rosterId);
* 加入黑名单
Parameters
* rosterId: long
加入黑名单的用户id
Returns BMXErrorCode
unblock
* public BMXErrorCode unblock(long rosterId);
* 从黑名单移除
Parameters
* rosterId: long
从黑名单移除的用户id
Returns BMXErrorCode
getBlockList
* public BMXErrorCode getBlockList(ListOfLongLong list, boolean forceRefresh);
* 获取黑名单，如果forceRefresh == true，则强制从服务端拉取
Parameters
* list: ListOfLongLong
好友id列表，传入空列表函数返回后从此处获取返回的黑名单id列表
* forceRefresh: boolean
是否从服务器读取数据，true为强制从服务器获取，false情况下本地读取列表为空的情况下会自动从服务器读取
Returns BMXErrorCode
downloadAvatar
* public BMXErrorCode downloadAvatar(BMXRosterItem item, boolean thumbnail, FileProgressListener listener);
* 下载头像
Parameters
* item: [BMXRosterItem](https://developer.qiniu.com/IM/api/8274/bmxrosteritem)
用户信息
* thumbnail: boolean
是否下载缩略图，ture为缩略图，false为原图
* listener: FileProgressListener
下载回调函数
Returns BMXErrorCode
addRosterListener
* public void addRosterListener(BMXRosterServiceListener listener);
* 添加好友变化监听者
Parameters
* listener: [BMXRosterServiceListener](https://developer.qiniu.com/IM/api/8283/bmxrosterservicelistener)
好友变化监听者
Returns void
removeRosterListener
* public void removeRosterListener(BMXRosterServiceListener listener);
* 移除好友变化监听者
Parameters
* listener: [BMXRosterServiceListener](https://developer.qiniu.com/IM/api/8283/bmxrosterservicelistener)
好友变化监听者
Returns void
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXRosterService
# BMXRosterService
最近更新时间: 2022-07-22 22:43:28
class im.floo.floolib.BMXRosterService
好友Service
Index
字段
* swigCMemOwn
方法
* getCPtr
* finalize
* delete
* get
* fetchRosterById
* search
* fetchRosterByName
* search
* fetchRostersByIdList
* search
* setItemLocalExtension
* setItemExtension
* setItemAlias
* setItemMuteNotification
* getApplicationList
* apply
* apply
* remove
* accept
* decline
* block
* unblock
* getBlockList
* downloadAvatar
* addRosterListener
* removeRosterListener
字段
swigCMemOwn
* protected transient boolean swigCMemOwn
*
方法
getCPtr
* protected static long getCPtr(BMXRosterService obj);
* Returns long
finalize
* @Override() protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
get
* public BMXErrorCode get(ListOfLongLong list, boolean forceRefresh);
* 获取好友列表，如果forceRefresh == true，则强制从服务端拉取
Parameters
* list: ListOfLongLong
好友id列表，传入空列表函数返回后从此处获取返回的好友id列表
* forceRefresh: boolean
是否从服务器读取数据，true为强制从服务器获取，false情况下本地读取列表为空的情况下会自动从服务器读取
Returns BMXErrorCode
fetchRosterById
* public BMXErrorCode fetchRosterById(long rosterId, boolean forceRefresh, BMXRosterItem item);
* 搜索用户
Parameters
* rosterId: long
搜索的好友id
* forceRefresh: boolean
为true强制从服务器获取，为false情况下查询结果为空时自动从服务器获取。
* item: [BMXRosterItem](https://developer.qiniu.com/IM/api/8274/bmxrosteritem)
查询返回的用户的信息，传入指向为空的shared_ptr对象函数执行后会自动赋值。
Returns BMXErrorCode
search
* public BMXErrorCode search(long rosterId, boolean forceRefresh, BMXRosterItem item);
* 搜索用户
Parameters
* rosterId: long
搜索的好友id
* forceRefresh: boolean
为true强制从服务器获取，为false情况下查询结果为空时自动从服务器获取。
* item: [BMXRosterItem](https://developer.qiniu.com/IM/api/8274/bmxrosteritem)
查询返回的用户的信息，传入指向为空的shared_ptr对象函数执行后会自动赋值。
Returns BMXErrorCode
fetchRosterByName
* public BMXErrorCode fetchRosterByName(String name, boolean forceRefresh, BMXRosterItem item);
* 搜索用户
Parameters
* name: String
搜索的用户名
* forceRefresh: boolean
为true强制从服务器获取，为false情况下查询结果为空时自动从服务器获取。
* item: [BMXRosterItem](https://developer.qiniu.com/IM/api/8274/bmxrosteritem)
查询返回的用户的信息，传入指向为空的shared_ptr对象函数执行后会自动赋值。
Returns BMXErrorCode
search
* public BMXErrorCode search(String name, boolean forceRefresh, BMXRosterItem item);
* 搜索用户
Parameters
* name: String
搜索的用户名
* forceRefresh: boolean
为true强制从服务器获取，为false情况下查询结果为空时自动从服务器获取。
* item: [BMXRosterItem](https://developer.qiniu.com/IM/api/8274/bmxrosteritem)
查询返回的用户的信息，传入指向为空的shared_ptr对象函数执行后会自动赋值。
Returns BMXErrorCode
fetchRostersByIdList
* public BMXErrorCode fetchRostersByIdList(ListOfLongLong rosterIdList, BMXRosterItemList list, boolean forceRefresh);
* 批量搜索用户
Parameters
* rosterIdList: ListOfLongLong
需要搜索的用户id列表
* list: BMXRosterItemList
返回的好友信息列表，传入空列表函数返回后从此处获取返回的好友信息列表
* forceRefresh: boolean
是否强制从服务器获取，为true则强制从服务器获取
Returns BMXErrorCode
search
* public BMXErrorCode search(ListOfLongLong rosterIdList, BMXRosterItemList list, boolean forceRefresh);
* 批量搜索用户
Parameters
* rosterIdList: ListOfLongLong
需要搜索的用户id列表
* list: BMXRosterItemList
返回的好友信息列表，传入空列表函数返回后从此处获取返回的好友信息列表
* forceRefresh: boolean
是否强制从服务器获取，为true则强制从服务器获取
Returns BMXErrorCode
setItemLocalExtension
* public BMXErrorCode setItemLocalExtension(BMXRosterItem item, String extension);
* 更新好友本地扩展信息
Parameters
* item: [BMXRosterItem](https://developer.qiniu.com/IM/api/8274/bmxrosteritem)
用户信息
* extension: String
本地扩展信息
Returns BMXErrorCode
setItemExtension
* public BMXErrorCode setItemExtension(BMXRosterItem item, String extension);
* 更新好友服务器扩展信息
Parameters
* item: [BMXRosterItem](https://developer.qiniu.com/IM/api/8274/bmxrosteritem)
用户信息
* extension: String
服务器扩展信息
Returns BMXErrorCode
setItemAlias
* public BMXErrorCode setItemAlias(BMXRosterItem item, String alias);
* 更新好友别名
Parameters
* item: [BMXRosterItem](https://developer.qiniu.com/IM/api/8274/bmxrosteritem)
用户信息
* alias: String
好友别名
Returns BMXErrorCode
setItemMuteNotification
* public BMXErrorCode setItemMuteNotification(BMXRosterItem item, boolean status);
* 设置是否拒收用户消息
Parameters
* item: [BMXRosterItem](https://developer.qiniu.com/IM/api/8274/bmxrosteritem)
用户信息
* status: boolean
是否拒收用户消息，true拒收，false不拒收
Returns BMXErrorCode
getApplicationList
* public BMXErrorCode getApplicationList(ApplicationPage result, String cursor, int pageSize);
* 获取申请添加好友列表
Parameters
* result: ApplicationPage
返回的申请好友列表信息，传入指向为空的shared_ptr对象函数执行后会自动赋值。
* cursor: String
分页获取的起始cursor，第一次传入为空，后续传入上次操作返回的result中的cursor
* pageSize: int
分页大小
Returns BMXErrorCode
apply
* public BMXErrorCode apply(long rosterId, String message, String authAnswer);
* Returns BMXErrorCode
apply
* public BMXErrorCode apply(long rosterId, String message);
* 申请添加好友
Parameters
* rosterId: long
申请添加的用户id
* message: String
好友申请信息
Returns BMXErrorCode
remove
* public BMXErrorCode remove(long rosterId);
* 删除好友
Parameters
* rosterId: long
删除的好友id
Returns BMXErrorCode
accept
* public BMXErrorCode accept(long rosterId);
* 接受加好友申请
Parameters
* rosterId: long
申请加为好友的用户id
Returns BMXErrorCode
decline
* public BMXErrorCode decline(long rosterId, String reason);
* 拒绝加好友申请
Parameters
* rosterId: long
申请加为好友的用户id
* reason: String
拒绝的原因
Returns BMXErrorCode
block
* public BMXErrorCode block(long rosterId);
* 加入黑名单
Parameters
* rosterId: long
加入黑名单的用户id
Returns BMXErrorCode
unblock
* public BMXErrorCode unblock(long rosterId);
* 从黑名单移除
Parameters
* rosterId: long
从黑名单移除的用户id
Returns BMXErrorCode
getBlockList
* public BMXErrorCode getBlockList(ListOfLongLong list, boolean forceRefresh);
* 获取黑名单，如果forceRefresh == true，则强制从服务端拉取
Parameters
* list: ListOfLongLong
好友id列表，传入空列表函数返回后从此处获取返回的黑名单id列表
* forceRefresh: boolean
是否从服务器读取数据，true为强制从服务器获取，false情况下本地读取列表为空的情况下会自动从服务器读取
Returns BMXErrorCode
downloadAvatar
* public BMXErrorCode downloadAvatar(BMXRosterItem item, boolean thumbnail, FileProgressListener listener);
* 下载头像
Parameters
* item: [BMXRosterItem](https://developer.qiniu.com/IM/api/8274/bmxrosteritem)
用户信息
* thumbnail: boolean
是否下载缩略图，ture为缩略图，false为原图
* listener: FileProgressListener
下载回调函数
Returns BMXErrorCode
addRosterListener
* public void addRosterListener(BMXRosterServiceListener listener);
* 添加好友变化监听者
Parameters
* listener: [BMXRosterServiceListener](https://developer.qiniu.com/IM/api/8283/bmxrosterservicelistener)
好友变化监听者
Returns void
removeRosterListener
* public void removeRosterListener(BMXRosterServiceListener listener);
* 移除好友变化监听者
Parameters
* listener: [BMXRosterServiceListener](https://developer.qiniu.com/IM/api/8283/bmxrosterservicelistener)
好友变化监听者
Returns void
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,953 |
BMXRosterService.Application | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXRosterService](https://developer.qiniu.com/IM/api/8299/bmxrosterservice) >
BMXRosterService.Application
# BMXRosterService.Application
最近更新时间: 2022-07-22 22:45:24
class im.floo.floolib.BMXRosterService.Application
好友邀请
Index
字段
* swigCMemOwn
方法
* getCPtr
* finalize
* delete
* setMRosterId
* getMRosterId
* setMReason
* getMReason
* setMStatus
* getMStatus
* setMExpire
* getMExpire
字段
swigCMemOwn
* protected transient boolean swigCMemOwn
*
方法
getCPtr
* protected static long getCPtr(Application obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
setMRosterId
* public void setMRosterId(long value);
* Returns void
getMRosterId
* public long getMRosterId();
* Returns long
setMReason
* public void setMReason(String value);
* Returns void
getMReason
* public String getMReason();
* Returns String
setMStatus
* public void setMStatus(BMXRosterService.ApplicationStatus value);
* Returns void
getMStatus
* public BMXRosterService.ApplicationStatus getMStatus();
* Returns ApplicationStatus
setMExpire
* public void setMExpire(long value);
* Returns void
getMExpire
* public long getMExpire();
* Returns long
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXRosterService](https://developer.qiniu.com/IM/api/8299/bmxrosterservice) >
BMXRosterService.Application
# BMXRosterService.Application
最近更新时间: 2022-07-22 22:45:24
class im.floo.floolib.BMXRosterService.Application
好友邀请
Index
字段
* swigCMemOwn
方法
* getCPtr
* finalize
* delete
* setMRosterId
* getMRosterId
* setMReason
* getMReason
* setMStatus
* getMStatus
* setMExpire
* getMExpire
字段
swigCMemOwn
* protected transient boolean swigCMemOwn
*
方法
getCPtr
* protected static long getCPtr(Application obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
setMRosterId
* public void setMRosterId(long value);
* Returns void
getMRosterId
* public long getMRosterId();
* Returns long
setMReason
* public void setMReason(String value);
* Returns void
getMReason
* public String getMReason();
* Returns String
setMStatus
* public void setMStatus(BMXRosterService.ApplicationStatus value);
* Returns void
getMStatus
* public BMXRosterService.ApplicationStatus getMStatus();
* Returns ApplicationStatus
setMExpire
* public void setMExpire(long value);
* Returns void
getMExpire
* public long getMExpire();
* Returns long
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,965 |
BMXRosterService.ApplicationStatus | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXRosterService](https://developer.qiniu.com/IM/api/8299/bmxrosterservice) >
BMXRosterService.ApplicationStatus
# BMXRosterService.ApplicationStatus
最近更新时间: 2021-07-20 10:15:51
## 枚举 BMXRosterService.ApplicationStatus
* java.lang.Object
* * java.lang.Enum<BMXRosterService.ApplicationStatus>
* * im.floo.floolib.BMXRosterService.ApplicationStatus
* 所有已实现的接口:
java.io.Serializable, java.lang.Comparable<BMXRosterService.ApplicationStatus>
封闭类:
BMXRosterService
* * *
public static enum BMXRosterService.ApplicationStatus
extends java.lang.Enum<BMXRosterService.ApplicationStatus>
请求状态
* * ### 枚举常量概要
枚举常量 枚举常量和说明
---
`Accepted`
`Declined`
`Pending`
* ### 方法概要
所有方法 静态方法 实例方法 具体方法 限定符和类型 | 方法和说明
---|---
`static BMXRosterService.ApplicationStatus` | `swigToEnum(int swigValue)`
`int` | `swigValue()`
`static BMXRosterService.ApplicationStatus` | `valueOf(java.lang.String name)` 返回带有指定名称的该类型的枚举常量。
`static BMXRosterService.ApplicationStatus[]` | `values()` 按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。
* ### 从类继承的方法 java.lang.Enum
`clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name,
ordinal, toString, valueOf`
* ### 从类继承的方法 java.lang.Object
`getClass, notify, notifyAll, wait, wait, wait`
* * ### 枚举常量详细资料
* #### Pending
public static final BMXRosterService.ApplicationStatus Pending
* #### Accepted
public static final BMXRosterService.ApplicationStatus Accepted
* #### Declined
public static final BMXRosterService.ApplicationStatus Declined
* ### 方法详细资料
* #### values
public static BMXRosterService.ApplicationStatus[] values()
按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。该方法可用于迭代 常量, 如下所示:
for (BMXRosterService.ApplicationStatus c : BMXRosterService.ApplicationStatus.values())
System.out.println(c);
返回:
按照声明该枚举类型的常量的顺序返回的包含这些常量的数组
* #### valueOf
public static BMXRosterService.ApplicationStatus valueOf(java.lang.String name)
返回带有指定名称的该类型的枚举常量。 字符串必须与用于声明该类型的枚举常量的 标识符 _完全_ 匹配。(不允许有多余 的空格字符。)
参数:
`name` \- 要返回的枚举常量的名称。
返回:
返回带有指定名称的枚举常量
抛出:
`java.lang.IllegalArgumentException` \- 如果该枚举类型没有带有指定名称的常量
`java.lang.NullPointerException` \- 如果参数为空值
* #### swigValue
public final int swigValue()
* #### swigToEnum
public static BMXRosterService.ApplicationStatus swigToEnum(int swigValue)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXRosterService](https://developer.qiniu.com/IM/api/8299/bmxrosterservice) >
BMXRosterService.ApplicationStatus
# BMXRosterService.ApplicationStatus
最近更新时间: 2021-07-20 10:15:51
## 枚举 BMXRosterService.ApplicationStatus
* java.lang.Object
* * java.lang.Enum<BMXRosterService.ApplicationStatus>
* * im.floo.floolib.BMXRosterService.ApplicationStatus
* 所有已实现的接口:
java.io.Serializable, java.lang.Comparable<BMXRosterService.ApplicationStatus>
封闭类:
BMXRosterService
* * *
public static enum BMXRosterService.ApplicationStatus
extends java.lang.Enum<BMXRosterService.ApplicationStatus>
请求状态
* * ### 枚举常量概要
枚举常量 枚举常量和说明
---
`Accepted`
`Declined`
`Pending`
* ### 方法概要
所有方法 静态方法 实例方法 具体方法 限定符和类型 | 方法和说明
---|---
`static BMXRosterService.ApplicationStatus` | `swigToEnum(int swigValue)`
`int` | `swigValue()`
`static BMXRosterService.ApplicationStatus` | `valueOf(java.lang.String name)` 返回带有指定名称的该类型的枚举常量。
`static BMXRosterService.ApplicationStatus[]` | `values()` 按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。
* ### 从类继承的方法 java.lang.Enum
`clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name,
ordinal, toString, valueOf`
* ### 从类继承的方法 java.lang.Object
`getClass, notify, notifyAll, wait, wait, wait`
* * ### 枚举常量详细资料
* #### Pending
public static final BMXRosterService.ApplicationStatus Pending
* #### Accepted
public static final BMXRosterService.ApplicationStatus Accepted
* #### Declined
public static final BMXRosterService.ApplicationStatus Declined
* ### 方法详细资料
* #### values
public static BMXRosterService.ApplicationStatus[] values()
按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。该方法可用于迭代 常量, 如下所示:
for (BMXRosterService.ApplicationStatus c : BMXRosterService.ApplicationStatus.values())
System.out.println(c);
返回:
按照声明该枚举类型的常量的顺序返回的包含这些常量的数组
* #### valueOf
public static BMXRosterService.ApplicationStatus valueOf(java.lang.String name)
返回带有指定名称的该类型的枚举常量。 字符串必须与用于声明该类型的枚举常量的 标识符 _完全_ 匹配。(不允许有多余 的空格字符。)
参数:
`name` \- 要返回的枚举常量的名称。
返回:
返回带有指定名称的枚举常量
抛出:
`java.lang.IllegalArgumentException` \- 如果该枚举类型没有带有指定名称的常量
`java.lang.NullPointerException` \- 如果参数为空值
* #### swigValue
public final int swigValue()
* #### swigToEnum
public static BMXRosterService.ApplicationStatus swigToEnum(int swigValue)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,968 |
BMXUserProfile | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXUserProfile
# BMXUserProfile
最近更新时间: 2022-07-22 22:41:08
class im.floo.floolib.BMXUserProfile
用户Profile
Index
字段
* swigCPtr
方法
* getCPtr
* finalize
* delete
* userId
* category
* username
* nickname
* avatarRatelUrl
* avatarUrl
* avatarPath
* avatarThumbnailPath
* mobilePhone
* email
* publicInfo
* privateInfo
* addFriendAuthMode
* authQuestion
* messageSetting
* isAutoAcceptGroupInvite
字段
swigCPtr
* public transient long swigCPtr
*
方法
getCPtr
* protected static long getCPtr(BMXUserProfile obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
userId
* public long userId();
* 用户ID（唯一）
Returns long
category
* public BMXUserProfile.UserCategory category();
* 用户策略
Returns UserCategory
username
* public String username();
* 用户名（唯一）
Returns String
nickname
* public String nickname();
* 用户昵称
Returns String
avatarRatelUrl
* public String avatarRatelUrl();
* 用户头像ratel服务器地址
Returns String
avatarUrl
* public String avatarUrl();
* 用户头像
Returns String
avatarPath
* public String avatarPath();
* 用户头像本地存储路径
Returns String
avatarThumbnailPath
* public String avatarThumbnailPath();
* 用户头像缩略图本地存储路径
Returns String
mobilePhone
* public String mobilePhone();
* 用户手机
Returns String
email
* public String email();
* 用户邮箱
Returns String
publicInfo
* public String publicInfo();
* 用户公开扩展信息，好友可见
Returns String
privateInfo
* public String privateInfo();
* 用户私有扩展信息，好友不可见
Returns String
addFriendAuthMode
* public BMXUserProfile.AddFriendAuthMode addFriendAuthMode();
* 加好友校验方式
Returns AddFriendAuthMode
authQuestion
* public BMXUserProfile.AuthQuestion authQuestion();
* 添加好友时的验证问题
Returns AuthQuestion
messageSetting
* public BMXUserProfile.MessageSetting messageSetting();
* 用户消息设定
Returns MessageSetting
isAutoAcceptGroupInvite
* public boolean isAutoAcceptGroupInvite();
* 收到群组邀请进群时是否自动同意进群
Returns boolean
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXUserProfile
# BMXUserProfile
最近更新时间: 2022-07-22 22:41:08
class im.floo.floolib.BMXUserProfile
用户Profile
Index
字段
* swigCPtr
方法
* getCPtr
* finalize
* delete
* userId
* category
* username
* nickname
* avatarRatelUrl
* avatarUrl
* avatarPath
* avatarThumbnailPath
* mobilePhone
* email
* publicInfo
* privateInfo
* addFriendAuthMode
* authQuestion
* messageSetting
* isAutoAcceptGroupInvite
字段
swigCPtr
* public transient long swigCPtr
*
方法
getCPtr
* protected static long getCPtr(BMXUserProfile obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
userId
* public long userId();
* 用户ID（唯一）
Returns long
category
* public BMXUserProfile.UserCategory category();
* 用户策略
Returns UserCategory
username
* public String username();
* 用户名（唯一）
Returns String
nickname
* public String nickname();
* 用户昵称
Returns String
avatarRatelUrl
* public String avatarRatelUrl();
* 用户头像ratel服务器地址
Returns String
avatarUrl
* public String avatarUrl();
* 用户头像
Returns String
avatarPath
* public String avatarPath();
* 用户头像本地存储路径
Returns String
avatarThumbnailPath
* public String avatarThumbnailPath();
* 用户头像缩略图本地存储路径
Returns String
mobilePhone
* public String mobilePhone();
* 用户手机
Returns String
email
* public String email();
* 用户邮箱
Returns String
publicInfo
* public String publicInfo();
* 用户公开扩展信息，好友可见
Returns String
privateInfo
* public String privateInfo();
* 用户私有扩展信息，好友不可见
Returns String
addFriendAuthMode
* public BMXUserProfile.AddFriendAuthMode addFriendAuthMode();
* 加好友校验方式
Returns AddFriendAuthMode
authQuestion
* public BMXUserProfile.AuthQuestion authQuestion();
* 添加好友时的验证问题
Returns AuthQuestion
messageSetting
* public BMXUserProfile.MessageSetting messageSetting();
* 用户消息设定
Returns MessageSetting
isAutoAcceptGroupInvite
* public boolean isAutoAcceptGroupInvite();
* 收到群组邀请进群时是否自动同意进群
Returns boolean
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,972 |
BMXUserProfile.AddFriendAuthMode | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXUserProfile](https://developer.qiniu.com/IM/api/8304/bmxuserprofile) >
BMXUserProfile.AddFriendAuthMode
# BMXUserProfile.AddFriendAuthMode
最近更新时间: 2021-07-20 11:43:49
## 枚举 BMXUserProfile.AddFriendAuthMode
* java.lang.Object
* * java.lang.Enum<BMXUserProfile.AddFriendAuthMode>
* * im.floo.floolib.BMXUserProfile.AddFriendAuthMode
* 所有已实现的接口:
java.io.Serializable, java.lang.Comparable<BMXUserProfile.AddFriendAuthMode>
封闭类:
BMXUserProfile
* * *
public static enum BMXUserProfile.AddFriendAuthMode
extends java.lang.Enum<BMXUserProfile.AddFriendAuthMode>
对方申请加好友时的验证方式
* * ### 枚举常量概要
枚举常量 枚举常量和说明
---
`AnswerQuestion`
`NeedApproval`
`Open`
`RejectAll`
* ### 方法概要
所有方法 静态方法 实例方法 具体方法 限定符和类型 | 方法和说明
---|---
`static BMXUserProfile.AddFriendAuthMode` | `swigToEnum(int swigValue)`
`int` | `swigValue()`
`static BMXUserProfile.AddFriendAuthMode` | `valueOf(java.lang.String name)` 返回带有指定名称的该类型的枚举常量。
`static BMXUserProfile.AddFriendAuthMode[]` | `values()` 按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。
* ### 从类继承的方法 java.lang.Enum
`clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name,
ordinal, toString, valueOf`
* ### 从类继承的方法 java.lang.Object
`getClass, notify, notifyAll, wait, wait, wait`
* * ### 枚举常量详细资料
* #### Open
public static final BMXUserProfile.AddFriendAuthMode Open
* #### NeedApproval
public static final BMXUserProfile.AddFriendAuthMode NeedApproval
* #### AnswerQuestion
public static final BMXUserProfile.AddFriendAuthMode AnswerQuestion
* #### RejectAll
public static final BMXUserProfile.AddFriendAuthMode RejectAll
* ### 方法详细资料
* #### values
public static BMXUserProfile.AddFriendAuthMode[] values()
按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。该方法可用于迭代 常量, 如下所示:
for (BMXUserProfile.AddFriendAuthMode c : BMXUserProfile.AddFriendAuthMode.values())
System.out.println(c);
返回:
按照声明该枚举类型的常量的顺序返回的包含这些常量的数组
* #### valueOf
public static BMXUserProfile.AddFriendAuthMode valueOf(java.lang.String name)
返回带有指定名称的该类型的枚举常量。 字符串必须与用于声明该类型的枚举常量的 标识符 _完全_ 匹配。(不允许有多余 的空格字符。)
参数:
`name` \- 要返回的枚举常量的名称。
返回:
返回带有指定名称的枚举常量
抛出:
`java.lang.IllegalArgumentException` \- 如果该枚举类型没有带有指定名称的常量
`java.lang.NullPointerException` \- 如果参数为空值
* #### swigValue
public final int swigValue()
* #### swigToEnum
public static BMXUserProfile.AddFriendAuthMode swigToEnum(int swigValue)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXUserProfile](https://developer.qiniu.com/IM/api/8304/bmxuserprofile) >
BMXUserProfile.AddFriendAuthMode
# BMXUserProfile.AddFriendAuthMode
最近更新时间: 2021-07-20 11:43:49
## 枚举 BMXUserProfile.AddFriendAuthMode
* java.lang.Object
* * java.lang.Enum<BMXUserProfile.AddFriendAuthMode>
* * im.floo.floolib.BMXUserProfile.AddFriendAuthMode
* 所有已实现的接口:
java.io.Serializable, java.lang.Comparable<BMXUserProfile.AddFriendAuthMode>
封闭类:
BMXUserProfile
* * *
public static enum BMXUserProfile.AddFriendAuthMode
extends java.lang.Enum<BMXUserProfile.AddFriendAuthMode>
对方申请加好友时的验证方式
* * ### 枚举常量概要
枚举常量 枚举常量和说明
---
`AnswerQuestion`
`NeedApproval`
`Open`
`RejectAll`
* ### 方法概要
所有方法 静态方法 实例方法 具体方法 限定符和类型 | 方法和说明
---|---
`static BMXUserProfile.AddFriendAuthMode` | `swigToEnum(int swigValue)`
`int` | `swigValue()`
`static BMXUserProfile.AddFriendAuthMode` | `valueOf(java.lang.String name)` 返回带有指定名称的该类型的枚举常量。
`static BMXUserProfile.AddFriendAuthMode[]` | `values()` 按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。
* ### 从类继承的方法 java.lang.Enum
`clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name,
ordinal, toString, valueOf`
* ### 从类继承的方法 java.lang.Object
`getClass, notify, notifyAll, wait, wait, wait`
* * ### 枚举常量详细资料
* #### Open
public static final BMXUserProfile.AddFriendAuthMode Open
* #### NeedApproval
public static final BMXUserProfile.AddFriendAuthMode NeedApproval
* #### AnswerQuestion
public static final BMXUserProfile.AddFriendAuthMode AnswerQuestion
* #### RejectAll
public static final BMXUserProfile.AddFriendAuthMode RejectAll
* ### 方法详细资料
* #### values
public static BMXUserProfile.AddFriendAuthMode[] values()
按照声明该枚举类型的常量的顺序, 返回 包含这些常量的数组。该方法可用于迭代 常量, 如下所示:
for (BMXUserProfile.AddFriendAuthMode c : BMXUserProfile.AddFriendAuthMode.values())
System.out.println(c);
返回:
按照声明该枚举类型的常量的顺序返回的包含这些常量的数组
* #### valueOf
public static BMXUserProfile.AddFriendAuthMode valueOf(java.lang.String name)
返回带有指定名称的该类型的枚举常量。 字符串必须与用于声明该类型的枚举常量的 标识符 _完全_ 匹配。(不允许有多余 的空格字符。)
参数:
`name` \- 要返回的枚举常量的名称。
返回:
返回带有指定名称的枚举常量
抛出:
`java.lang.IllegalArgumentException` \- 如果该枚举类型没有带有指定名称的常量
`java.lang.NullPointerException` \- 如果参数为空值
* #### swigValue
public final int swigValue()
* #### swigToEnum
public static BMXUserProfile.AddFriendAuthMode swigToEnum(int swigValue)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,976 |
BMXUserProfile.AuthQuestion | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXUserProfile](https://developer.qiniu.com/IM/api/8304/bmxuserprofile) >
BMXUserProfile.AuthQuestion
# BMXUserProfile.AuthQuestion
最近更新时间: 2022-07-22 23:00:30
class im.floo.floolib.BMXUserProfile.AuthQuestion
添加好友时的校验问题
Index
字段
* swigCMemOwn
方法
* getCPtr
* finalize
* delete
* setMQuestion
* getMQuestion
* setMAnswer
* getMAnswer
字段
swigCMemOwn
* protected transient boolean swigCMemOwn
*
方法
getCPtr
* protected static long getCPtr(AuthQuestion obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
setMQuestion
* public void setMQuestion(String value);
* Returns void
getMQuestion
* public String getMQuestion();
* Returns String
setMAnswer
* public void setMAnswer(String value);
* Returns void
getMAnswer
* public String getMAnswer();
* Returns String
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXUserProfile](https://developer.qiniu.com/IM/api/8304/bmxuserprofile) >
BMXUserProfile.AuthQuestion
# BMXUserProfile.AuthQuestion
最近更新时间: 2022-07-22 23:00:30
class im.floo.floolib.BMXUserProfile.AuthQuestion
添加好友时的校验问题
Index
字段
* swigCMemOwn
方法
* getCPtr
* finalize
* delete
* setMQuestion
* getMQuestion
* setMAnswer
* getMAnswer
字段
swigCMemOwn
* protected transient boolean swigCMemOwn
*
方法
getCPtr
* protected static long getCPtr(AuthQuestion obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
setMQuestion
* public void setMQuestion(String value);
* Returns void
getMQuestion
* public String getMQuestion();
* Returns String
setMAnswer
* public void setMAnswer(String value);
* Returns void
getMAnswer
* public String getMAnswer();
* Returns String
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,981 |
BMXUserProfile.UserCategory | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXUserProfile](https://developer.qiniu.com/IM/api/8304/bmxuserprofile) >
BMXUserProfile.UserCategory
# BMXUserProfile.UserCategory
最近更新时间: 2022-07-22 22:52:49
class im.floo.floolib.BMXUserProfile.UserCategory
用户类型
Index
字段
* Normal
* Advanced
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
Normal
* public static final UserCategory Normal
*
Advanced
* public static final UserCategory Advanced
*
方法
values
* public static im.floo.floolib.BMXUserProfile.UserCategory[] values();
* Returns UserCategory
valueOf
* public static im.floo.floolib.BMXUserProfile.UserCategory valueOf(java.lang.String name);
* Returns UserCategory
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static UserCategory swigToEnum(int swigValue);
* Returns UserCategory
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXUserProfile](https://developer.qiniu.com/IM/api/8304/bmxuserprofile) >
BMXUserProfile.UserCategory
# BMXUserProfile.UserCategory
最近更新时间: 2022-07-22 22:52:49
class im.floo.floolib.BMXUserProfile.UserCategory
用户类型
Index
字段
* Normal
* Advanced
方法
* values
* valueOf
* swigValue
* swigToEnum
字段
Normal
* public static final UserCategory Normal
*
Advanced
* public static final UserCategory Advanced
*
方法
values
* public static im.floo.floolib.BMXUserProfile.UserCategory[] values();
* Returns UserCategory
valueOf
* public static im.floo.floolib.BMXUserProfile.UserCategory valueOf(java.lang.String name);
* Returns UserCategory
swigValue
* public final int swigValue();
* Returns int
swigToEnum
* public static UserCategory swigToEnum(int swigValue);
* Returns UserCategory
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,983 |
BMXUserProfile.MessageSetting | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXUserProfile](https://developer.qiniu.com/IM/api/8304/bmxuserprofile) >
BMXUserProfile.MessageSetting
# BMXUserProfile.MessageSetting
最近更新时间: 2022-07-22 22:52:43
class im.floo.floolib.BMXUserProfile.MessageSetting
用户消息设置
Index
字段
* swigCMemOwn
方法
* getCPtr
* finalize
* delete
* setMPushEnabled
* getMPushEnabled
* setMPushDetail
* getMPushDetail
* setMPushNickname
* getMPushNickname
* setMNotificationSound
* getMNotificationSound
* setMNotificationVibrate
* getMNotificationVibrate
* setMAutoDownloadAttachment
* getMAutoDownloadAttachment
* setMSilenceStartTime
* getMSilenceStartTime
* setMSilenceEndTime
* getMSilenceEndTime
* setMPushStartTime
* getMPushStartTime
* setMPushEndTime
* getMPushEndTime
字段
swigCMemOwn
* protected transient boolean swigCMemOwn
*
方法
getCPtr
* protected static long getCPtr(MessageSetting obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
setMPushEnabled
* public void setMPushEnabled(boolean value);
* Returns void
getMPushEnabled
* public boolean getMPushEnabled();
* Returns boolean
setMPushDetail
* public void setMPushDetail(boolean value);
* Returns void
getMPushDetail
* public boolean getMPushDetail();
* Returns boolean
setMPushNickname
* public void setMPushNickname(String value);
* Returns void
getMPushNickname
* public String getMPushNickname();
* Returns String
setMNotificationSound
* public void setMNotificationSound(boolean value);
* Returns void
getMNotificationSound
* public boolean getMNotificationSound();
* Returns boolean
setMNotificationVibrate
* public void setMNotificationVibrate(boolean value);
* Returns void
getMNotificationVibrate
* public boolean getMNotificationVibrate();
* Returns boolean
setMAutoDownloadAttachment
* public void setMAutoDownloadAttachment(boolean value);
* Returns void
getMAutoDownloadAttachment
* public boolean getMAutoDownloadAttachment();
* Returns boolean
setMSilenceStartTime
* public void setMSilenceStartTime(int value);
* Returns void
getMSilenceStartTime
* public int getMSilenceStartTime();
* Returns int
setMSilenceEndTime
* public void setMSilenceEndTime(int value);
* Returns void
getMSilenceEndTime
* public int getMSilenceEndTime();
* Returns int
setMPushStartTime
* public void setMPushStartTime(int value);
* Returns void
getMPushStartTime
* public int getMPushStartTime();
* Returns int
setMPushEndTime
* public void setMPushEndTime(int value);
* Returns void
getMPushEndTime
* public int getMPushEndTime();
* Returns int
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
[BMXUserProfile](https://developer.qiniu.com/IM/api/8304/bmxuserprofile) >
BMXUserProfile.MessageSetting
# BMXUserProfile.MessageSetting
最近更新时间: 2022-07-22 22:52:43
class im.floo.floolib.BMXUserProfile.MessageSetting
用户消息设置
Index
字段
* swigCMemOwn
方法
* getCPtr
* finalize
* delete
* setMPushEnabled
* getMPushEnabled
* setMPushDetail
* getMPushDetail
* setMPushNickname
* getMPushNickname
* setMNotificationSound
* getMNotificationSound
* setMNotificationVibrate
* getMNotificationVibrate
* setMAutoDownloadAttachment
* getMAutoDownloadAttachment
* setMSilenceStartTime
* getMSilenceStartTime
* setMSilenceEndTime
* getMSilenceEndTime
* setMPushStartTime
* getMPushStartTime
* setMPushEndTime
* getMPushEndTime
字段
swigCMemOwn
* protected transient boolean swigCMemOwn
*
方法
getCPtr
* protected static long getCPtr(MessageSetting obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
setMPushEnabled
* public void setMPushEnabled(boolean value);
* Returns void
getMPushEnabled
* public boolean getMPushEnabled();
* Returns boolean
setMPushDetail
* public void setMPushDetail(boolean value);
* Returns void
getMPushDetail
* public boolean getMPushDetail();
* Returns boolean
setMPushNickname
* public void setMPushNickname(String value);
* Returns void
getMPushNickname
* public String getMPushNickname();
* Returns String
setMNotificationSound
* public void setMNotificationSound(boolean value);
* Returns void
getMNotificationSound
* public boolean getMNotificationSound();
* Returns boolean
setMNotificationVibrate
* public void setMNotificationVibrate(boolean value);
* Returns void
getMNotificationVibrate
* public boolean getMNotificationVibrate();
* Returns boolean
setMAutoDownloadAttachment
* public void setMAutoDownloadAttachment(boolean value);
* Returns void
getMAutoDownloadAttachment
* public boolean getMAutoDownloadAttachment();
* Returns boolean
setMSilenceStartTime
* public void setMSilenceStartTime(int value);
* Returns void
getMSilenceStartTime
* public int getMSilenceStartTime();
* Returns int
setMSilenceEndTime
* public void setMSilenceEndTime(int value);
* Returns void
getMSilenceEndTime
* public int getMSilenceEndTime();
* Returns int
setMPushStartTime
* public void setMPushStartTime(int value);
* Returns void
getMPushStartTime
* public int getMPushStartTime();
* Returns int
setMPushEndTime
* public void setMPushEndTime(int value);
* Returns void
getMPushEndTime
* public int getMPushEndTime();
* Returns int
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,985 |
BMXPushServiceListener | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXPushServiceListener
# BMXPushServiceListener
最近更新时间: 2022-07-22 22:41:56
class im.floo.floolib.BMXPushServiceListener
Index
字段
* swigCMemOwn
方法
* getCPtr
* finalize
* delete
* swigDirectorDisconnect
* swigReleaseOwnership
* swigTakeOwnership
* onPushStart
* onPushStop
* onCertRetrieved
* onSetTags
* onGetTags
* onDeleteTags
* onClearTags
* onReceivePush
* onStatusChanged
* registerPushService
字段
swigCMemOwn
* protected transient boolean swigCMemOwn
*
方法
getCPtr
* protected static long getCPtr(BMXPushServiceListener obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
swigDirectorDisconnect
* protected void swigDirectorDisconnect();
* Returns void
swigReleaseOwnership
* public void swigReleaseOwnership();
* Returns void
swigTakeOwnership
* public void swigTakeOwnership();
* Returns void
onPushStart
* public void onPushStart(String bmxToken);
* Push初始化完成通知。
Parameters
* bmxToken: String
当前push使用bmxToken
Returns void
onPushStop
* public void onPushStop();
* Push功能停止通知。
Returns void
onCertRetrieved
* public void onCertRetrieved(String cert);
* Push初始化完成后获取推送证书。
Parameters
* cert: String
从服务器获取的推送证书
Returns void
onSetTags
* public void onSetTags(String operationId);
* 设置用户推送成功回调。
Parameters
* operationId: String
操作id
Returns void
onGetTags
* public void onGetTags(String operationId);
* 获取用户推送成功回调。
Parameters
* operationId: String
操作id
Returns void
onDeleteTags
* public void onDeleteTags(String operationId);
* 删除用户推送成功回调。
Parameters
* operationId: String
操作id
Returns void
onClearTags
* public void onClearTags(String operationId);
* 清空用户推送成功回调。
Parameters
* operationId: String
操作id
Returns void
onReceivePush
* public void onReceivePush(BMXMessageList list);
* 接收到新的Push通知。
Parameters
* list: BMXMessageList
Push通知列表
Returns void
onStatusChanged
* public void onStatusChanged(BMXMessage msg, BMXErrorCode error);
* 发送Push上行消息状态变化通知。
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
发生状态变化的上行消息
* error: BMXErrorCode
状态错误码
Returns void
registerPushService
* public void registerPushService(BMXPushService service);
* Returns void
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [ANDROID
API](https://developer.qiniu.com/IM/api/8191/android-im-class-indexes) >
BMXPushServiceListener
# BMXPushServiceListener
最近更新时间: 2022-07-22 22:41:56
class im.floo.floolib.BMXPushServiceListener
Index
字段
* swigCMemOwn
方法
* getCPtr
* finalize
* delete
* swigDirectorDisconnect
* swigReleaseOwnership
* swigTakeOwnership
* onPushStart
* onPushStop
* onCertRetrieved
* onSetTags
* onGetTags
* onDeleteTags
* onClearTags
* onReceivePush
* onStatusChanged
* registerPushService
字段
swigCMemOwn
* protected transient boolean swigCMemOwn
*
方法
getCPtr
* protected static long getCPtr(BMXPushServiceListener obj);
* Returns long
finalize
* protected void finalize();
* Returns void
delete
* public synchronized void delete();
* Returns void
swigDirectorDisconnect
* protected void swigDirectorDisconnect();
* Returns void
swigReleaseOwnership
* public void swigReleaseOwnership();
* Returns void
swigTakeOwnership
* public void swigTakeOwnership();
* Returns void
onPushStart
* public void onPushStart(String bmxToken);
* Push初始化完成通知。
Parameters
* bmxToken: String
当前push使用bmxToken
Returns void
onPushStop
* public void onPushStop();
* Push功能停止通知。
Returns void
onCertRetrieved
* public void onCertRetrieved(String cert);
* Push初始化完成后获取推送证书。
Parameters
* cert: String
从服务器获取的推送证书
Returns void
onSetTags
* public void onSetTags(String operationId);
* 设置用户推送成功回调。
Parameters
* operationId: String
操作id
Returns void
onGetTags
* public void onGetTags(String operationId);
* 获取用户推送成功回调。
Parameters
* operationId: String
操作id
Returns void
onDeleteTags
* public void onDeleteTags(String operationId);
* 删除用户推送成功回调。
Parameters
* operationId: String
操作id
Returns void
onClearTags
* public void onClearTags(String operationId);
* 清空用户推送成功回调。
Parameters
* operationId: String
操作id
Returns void
onReceivePush
* public void onReceivePush(BMXMessageList list);
* 接收到新的Push通知。
Parameters
* list: BMXMessageList
Push通知列表
Returns void
onStatusChanged
* public void onStatusChanged(BMXMessage msg, BMXErrorCode error);
* 发送Push上行消息状态变化通知。
Parameters
* msg: [BMXMessage](https://developer.qiniu.com/IM/api/8239/bmxmessage)
发生状态变化的上行消息
* error: BMXErrorCode
状态错误码
Returns void
registerPushService
* public void registerPushService(BMXPushService service);
* Returns void
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,991 |
IM Web 文档 | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > IM Web 文档
# IM Web 文档
最近更新时间: 2022-05-24 16:44:53
## 初始化
首先设置 AppID
首先设置 AppID
const config = {
appid: "YOUR_APP_ID",
ws: false,
autoLogin: true
};
然后创建im对象，供全局调用。
const im = QNIM.init(config);
## base 基础部分
登录
im.login({
mobile:String, #与name 2选1
name:String,
password:String,
})
监听
具体事件列表见本文档的"事件通知"部分
im.on('events', (ret) => {
//do something with ret
})
// or
im.on({
eventName: (ret) => {
//do something with ret
},
...
})
取消监听
im.off('events', (ret) => {
//do something with ret
})
// or
im.off({
eventName: (ret) => {
//do something with ret
},
...
})
二维码登录
im.qrlogin({
password,
user_id
});
token登录
im.tokenLogin(user_id, token)
## rosterManager
获取好友id列表
im.rosterManage.asyncGetRosterIdList().then(res => {
//
});
获取好友信息
im.rosterManage.asyncGetRosterInfo(state.sid).then(res => {
//
})
用户注册
rosterManage.asyncRegester({
username,
password
}).then(() => {
//
});
根据id列表获取用户详细信息
im.rosterManage.asnycGetRosterListDetailByIds(rosterIdList).then(res => {
//
});
根据id获取聊天信息
const rosterMessages = im.rosterManage.getRosterMessageByRid(uid);
读取消息
im.rosterManage.readRosterMessage(uid);
删除好友
im.rosterManage
.asyncDeleteRoster({ user_id})
.then(() => {
alert("好友已删除");
});
获取缓存的所有新用户
const userMaps = im.rosterManage.getAllRosterDetail();
撤回消息，只能撤回5分钟内的
im.rosterManage.recallMessage(user_id, message_id);
删除消息
im.rosterManage.deleteMessage(user_id, message_id);
获取用户的未读数
const unreadCount = im.rosterManage.getUnreadCount(user_id) :
设置消息成未读
im.rosterManage.unreadMessage(user_id, message_id);
获取好友信息
const roserInfo = im.rosterManage.getRosterInfo(user_id);
获取好友申请列表
im.rosterManage
.asyncGetApplyList({ cursor: "" })
.then((res = []) => {
//
});
获取黑名单
im.rosterManage
.asyncGetBlockedlist()
.then((res = []) => {
//
});
加入黑名单
im.rosterManage
.asyncBlockeAdd(user_id)
.then((res = []) => {
//
});
移除黑名单
im.rosterManage
.asyncBlockeRemove(user_id)
.then((res = []) => {
//
});
请求加为好友
im.rosterManage
.asyncApply({ user_id, alias })
.then((res = []) => {
//
});
通过好友申请
im.rosterManage
.asyncAccept({ user_id })
.then((res = []) => {
//
});
拒绝好友申请
im.rosterManage
.asyncDecline({ user_id })
.then((res = []) => {
//
});
按名称搜索用户
im.rosterManage
.asyncSearchRosterByName({ username })
.then((res = []) => {
//
});
按ID搜索用户
im.rosterManage
.asyncSearchRosterById({ user_id })
.then((res = []) => {
//
});
## groupManager
获取群信息
im.groupManage.asyncGetGroupInfo(group_id, fromServer).then(res => {
//
})
获取加入的群组
im.groupManage.asyncGetJoinedGroups().then(res => {
//
});
打开群组
// 此方法会准备群组聊天界面的一些必备信息。
im.groupManage.openGroup(group_id);
获取缓存的所有群组详情
const allGroupMap = im.groupManage.getAllGroupDetail();
获取群组成员（异步）
im.groupManage.asyncGetGroupMembers(group_id, fromServer).then(res => {
//
});
获取群组成员（同步）
const members = im.groupManage.getGroupMembers(group_id);
按id获取群组详情
im.groupManage.asyncGetGroupListDetail(groupIds).then(res => {
//
});
获取群消息
const groupMessages = rootState.im.groupManage.getGruopMessage(group_id);
将群消息设置已读
im.groupManage.readGroupMessage(group_id)
撤回消息
im.groupManage.recallMessage(group_id, message_id)
获取群未读消息数
const unreadCount = im.groupManage.getUnreadCount(group_id);
获取群管理员列表
im.groupManage.asyncGetAdminList({ group_id }).then(res => {
//
})
群添加管理员
im.groupManage.asyncAdminAdd({
group_id,
user_list
})
.then(() => {
//
});
移除管理员
im.groupManage.asyncAdminRemove({ group_id, user_list }).then(() => {
//
});
获取群公告详情
im.groupManage.asyncGetAnouncementById( {announcement_id, group_id} ).then(res => {
//
});
删除群公告
im.groupManage
.asyncAnouncementDelete({ group_id, announcement_id })
.then(() => {
//
});
添加群公告
im.groupManage.asyncAnnouncementEdit({ title, content, group_id })
.then(() => {
//
});
群公告列表
im.groupManage.asyncGetAnnouncementList({ group_id }).then((res = []) => {
//
});
创建群组
im.groupManage.asyncCreate({
name,
type,
avatar,
description,
user_list,
})
.then(() => {
//
});
解散群组
im.groupManage.asyncDestroy({ group_id })
.then(() => {
alert("您已解散了此群。。");
});
获取群组详情
im.groupManage.asyncGetInfo({ group_id }).then(res => {
//
});
更新群头像
im.groupManage.asyncUpdateAvatar({
group_id,
value,
})
.then(() => {
alert("更新头像完成");
});
更新群描述
im.groupManage.asyncUpdateDescription({
group_id,
value
})
.then(() => {
//
});
更新群名称
im.groupManage.asyncUpdateName({
group_id,
value
})
.then(() => {
//
});
获取群成员
im.groupManage.asyncGetMemberList(group_id, fromServer).then(res => {
//
});
设置群消息免打扰情况
im.groupManage.asyncGroupMsgMutemode({
group_id,
msg_mute_mode
})
.then(() => {
this.groupInfo.msg_mute_mode = this.groupInfo.msg_mute_mode ? 0 : 2;
});
获取群黑名单
im.groupManage.asyncGroupBannedList({ group_id }).then(res => {
//
});
禁言群成员
im.groupManage.asyncGroupBab({ group_id, duration, user_list }).then(() => {
//
});
解除成员
im.groupManage.asyncGroupUnban({ group_id, user_list }).then(() => {
//
});
设置群成员是否可以邀请
im.groupManage.asyncUpdateAllowMemberInvitation({
group_id,
value
})
.then(() => {
//
});
设置群成员是否可以修改群信息
im.groupManage.asyncUpdateAllowMemberModify({
group_id,
value
})
.then(() => {
//
});
设置群是否开启已读模式
im.groupManage.asyncUpdateEnableReadack({
group_id,
value
})
.then(() => {
//
});
设置群历史是否可见
im.groupManage.asyncUpdateHistoryVisible({
group_id,
value
})
.then(() => {
//
});
设置入群是否需要申请
im.groupManage.asyncUpdateRequireadminapproval({
group_id,
apply_approval
})
.then(() => {
//
});
更换群主
im.groupManage.asyncOwnerTransfer({
group_id,
new_owner
})
.then(() => {
//
});
申请加入群
im.groupManage.asyncApply({ group_id, reason })
.then(() => {
//
});
同意/拒绝申请用户加入群
im.groupManage.asyncApplyHandle({
approval: true/false,
user_id,
group_id
}).then(() => {
//
});
获取群黑名单
im.groupManage.asyncGroupBockedlist({ group_id }).then(res => {
//
});
将成员加入黑名单
im.groupManage.asyncGroupBlock({ group_id, user_list }).then(() => {
//
});
解除黑名单
im.groupManage.asyncGroupUnblock({ group_id, user_list })
.then(() => {
//
});
踢出群组
im.groupManage.asyncKick({ group_id, user_list }).then(() => {
//
});
获取群邀请列表
this.im.groupManage.asyncGetInvitationList().then(res => {
//
});
邀请成员加入群
im.groupManage.asyncInvite({ group_id, user_list }).then(() => {
/
});
同意/拒绝群邀请
im.groupManage.asyncInviteHandle({
approval: true,
user_id,
group_id
}).then(() => {
//
});
退出群
im.groupManage.asyncLeave({ group_id })
.then(() => {
//
});
修改群名片
im.groupManage.asyncUpdateDisplayName({
group_id,
value
})
.then(() => {
//
});
获取群申请列表
im.groupManage.asncGetApplicationList({ group_list }).then(rs => {
//
});
获取群文件
im.groupManage.asyncGetFileList({ group_id }).then((res = []) => {
//
});
删除群文件
im.groupManage.asyncFileDelete({ file_list, group_id }).then(() => {
//
});
## sysManager
发送好友消息
im.sysManage.sendRosterMessage({
type,
uid,
content,
attachment
});
发送群消息
im.sysManage.sendGroupMessage({
type,
gid,
content,
attachment
});
群发送@消息
im.sysManage.sendMentionMessage({
gid,
txt,
mentionAll,
mentionList,
mentionedMessage,
pushMessage,
senderNickname
});
发送输入状态消息
im.sysManage.sendInputStatusMessage(roster_id, "nothing"/"typing");
转发消息
im.sysManage.forwardMessage({
uid,
gid, //2选1
mid,
});
请求历史消息
im.sysManage.requireHistoryMessage(roster_id/group_id, mid, amount);
// mid：消息ID， 从哪条消息往前取历史，0表示最新一条消息。 amount：最多取多少条消息。
获取所有消息未读状态
const allAcks = im.sysManage.getAllMessageStatus() || {};
获取群文件上传url
im.sysManage.asyncGetGroupAvatarUploadUrl({
group_id,
"access-token"
})
.then(res => {
//
});
获取聊天文件上传地址
im.sysManage.asyncGetFileUploadChatFileUrl({
file_type,
to_id,
to_type
})
.then(res => {
//
});
上传文件
im.sysManage.asyncFileUpload({
file,
fileType,
to_id,
toType: "chat",
chatType: "roster"
})
.then(res => {
//
})
拼装图片路径
const image = im.sysManage.getImage({ avatar, type='roster', thumbnail=true });
## userManager
获取登录用户的token
const token = im.userManage.getToken();
获取登录用户的uid
const cuid = im.userManage.getUid();
获取appid
const appid = im.userManage.getAppid();
获取最近回话列表
const list = im.userManage.getConversationList();
发送验证码
im.userManage
.asyncUserSendSms({
mobile,
})
.then(() => {
//
});
发送验证码（通过图片验证码）
im.userManage
.asyncCaptchaSms({
captcha,
image_id,
mobile,
})
.then(() => {
//
});
检查用户名是否可用
im.userManage.asyncUserNameCheck(username).then(() => {
//
});
绑定手机号-使用签名绑定
im.userManage.asyncUserMobileBindSign({
mobile,
sign,
}).then(() => {
//
});
手机号验证码登录
im.userManage.asyncUserMobileLogin({
captcha,
mobile
})
.then(res => {
//
});
更新手机号
im.userManage
.asyncUpdateMobile({ mobile })
.then(() => {
//
});
更新头像
im.userManage
.asyncUpdateAvatar({
avatar
})
.then(() => {
//
});
更新昵称
im.userManage.asyncUpdateNickName({ nick_name }).then(() => {
//
});
获取用户profile
im.userManage.asyncGetProfile(true).then(res => {
//
})
更新用户profile
im.userManage.asyncUpdateProfile({
username,
avatar
}).then(res => {
//
})
获取用户设置信息
im.userManage.asyncGetSettings().then(res => {
//
})
修改用户设置
im.userManage
.asyncUpdateSettings({
"auth_answer": "string",
"auth_mode": 0,
"auth_question": "string",
"auto_download": true,
"group_confirm": true,
"id": 0,
"no_push": true,
"no_push_detail": true,
"no_push_end_hour": 0,
"no_push_start_hour": 0,
"no_sounds": true,
"push_nick_name": "string",
"user_id",
"vibratory": true
}).then(() => {
//
});
## 事件通知
1. Floo通知
事件名称：flooNotice
事件内容：({category, desc})
{category: 'loginMessage',desc: 'socket connecting...'} // 开始建连接
{category: 'loginMessage',desc: 'socket connect success...'} // 连接成功
{category: 'loginMessage',desc: 'logining socket service...'} // 开始登录
{category: 'loginMessage',desc: 'login socket failure ......'} // 登录失败
{category: 'loginMessage',desc: 'login socket success.....'} // 登录成功
{category: 'loginMessage', desc: 'getting token...' } //获取token
{category: 'loginMessage',desc: 'token sucecc, getting roster lists..'} // 获取token成功，开始获取好友列表
{category: 'loginMessage',desc: 'get roster list failure:' + ex.message} // 获取好友列表失败
{category: 'action', desc: 'relogin' } // 需要自动登录
{category: 'action', desc: 'relogin_manually' } // 需要手动登录
{category: 'conversation_deleted',desc: { id, source:'user_operation' }} // 会话被删除。ID：会话ID， source: 来源
{category: 'userNotice', desc:'PASSWORD_CHANGED'} // 用户密码改变
{category: 'userNotice', desc:'FROZEN'} // 用户账户被封禁
{category: 'userNotice', desc:'REMOVED'} // 用户被删除
{category: 'userNotice', desc:'KICK_BY_SAME_DEVICE'} // 当前设备被相同设备踢下线
{category: 'userNotice', desc:'KICKED_BY_OTHER_DEVICE'} // 当前设备被其它设备踢下线
{category: 'userNotice', desc:'INFO_UPDATED'} // 用户信息改变：profile或setting
{category: 'userNotice', desc:'DEVICE_LOGIN'} // 用户其它设备上线
{category: 'userNotice', desc:'DEVICE_LOGOUT'} // 用户其它设备下线
{category: 'userNotice', desc:'DEVICE_ADDED'} // 新设备通知
{category: 'userNotice', desc:'DEVICE_REMOVED'} // 设备被移除的通知
{category: 'userNotice', desc:'CLUSTER_CHANGED'} // 用户所在集群改变 需要重新登录
2. Floo错误
事件名称：flooError
事件内容：({category, desc})
{category: 'USER_BANNED', desc:'用户被禁言'}
{category: 'USER_FROZEN', desc:'用户被冻结，请联系App管理员。'}
{category: 'APP_FROZEN', desc:'APP 被冻结，请登陆蓝莺IM控制台查看详情。'}
{category: 'LICENSE', desc:'无效 LICENSE，请确认服务已按时付费。'}
{category: 'LICENSE', desc:'超出 LICENSE 用户数限制，请购买更高规格服务。'}
{category: 'DNS_FAILED', desc: dnsServer } // DNS错误: 无法访问
3. 登录失败
事件名称: loginFail
事件内容：(desc) 失败原因的描述
4. 登录成功
事件名称：loginSuccess
事件内容：({})
5. 群列表更新
事件名称：onGroupListUpdate
事件内容：()
6. 群成员列表更新
事件名称：onGroupMemberChanged
事件内容: (groupId) 群ID
7. 收到群消息
事件名称: onGroupMessage
事件内容: (meta) 消息的内容
8. 对方正在输入
事件名称: onInputStatusMessage
事件内容: ({ext,from,to}) ext:扩展字段 from: 发送者用户ID to: 接收者用户ID
9. 收到群组@消息
事件名称: onMentionMessage
事件内容: (meta) 消息的内容
10. 消息被取消已读
事件名称: onMessageCanceled
事件内容: ({uid,mid}) uid: 会话ID， mid: 消息ID
11. 消息被删除
事件名称: onMessageDeleted
事件内容: ({uid,mid}) uid: 会话ID， mid: 消息ID
12. 消息被撤回
事件名称: onMessageRecalled
事件内容: ({uid,mid}) uid: 会话ID， mid: 消息ID
13. 消息状态变更：撤回/删除/已读
事件名称: onMessageStatusChanged
事件内容: ({uid,mid}) uid: 会话ID， mid: 消息ID
14. 收到历史消息
事件名称: onReceiveHistoryMsg
事件内容: ({next}) next: 下次取历史消息的key
15. 好友信息变更
事件名称: onRosterInfoUpdate
事件内容: (rosterIds) rosterIds: 好友的用户ID列表
16. 好友列表变更
事件名称: onRosterListUpdate
事件内容: (meta) 好友通知的消息内容
17. 收到单聊消息
事件名称: onRosterMessage
事件内容: (meta) 好友通知的消息内容
18. 消息发送状态变更
事件名称: onSendingMessageStatusChanged
事件内容: ({status,mid}) status: 发送状态，取值为sending|failed|sent， mid: 客户端生成的client_mid
19. 未读数改变
事件名称: onUnreadChange
事件内容: (cid) 会话ID
20. 最近会话更新
事件名称: recentlistUpdate
事件内容: ()
21. 群组创建通知
事件名称: onGroupCreated
事件内容: (meta) 群通知的消息内容
22. 群组解散通知
事件名称: onGroupDestoryed
事件内容: (meta) 群通知的消息内容
23. 成员入群通知
事件名称: onGroupJoined
事件内容: (meta) 群通知的消息内容
24. 群申请被通过
事件名称: onGroupApplyAccepted
事件内容: (meta) 群通知的消息内容
25. 群申请被拒绝
事件名称: onGroupApplyDeclined
事件内容: (meta) 群通知的消息内容
26. 被群禁言
事件名称: onGroupBaned
事件内容: (meta) 群通知的消息内容
27. 被群取消禁言
事件名称: onGroupUnbaned
事件内容: (meta) 群通知的消息内容
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > IM Web 文档
# IM Web 文档
最近更新时间: 2022-05-24 16:44:53
## 初始化
首先设置 AppID
首先设置 AppID
const config = {
appid: "YOUR_APP_ID",
ws: false,
autoLogin: true
};
然后创建im对象，供全局调用。
const im = QNIM.init(config);
## base 基础部分
登录
im.login({
mobile:String, #与name 2选1
name:String,
password:String,
})
监听
具体事件列表见本文档的"事件通知"部分
im.on('events', (ret) => {
//do something with ret
})
// or
im.on({
eventName: (ret) => {
//do something with ret
},
...
})
取消监听
im.off('events', (ret) => {
//do something with ret
})
// or
im.off({
eventName: (ret) => {
//do something with ret
},
...
})
二维码登录
im.qrlogin({
password,
user_id
});
token登录
im.tokenLogin(user_id, token)
## rosterManager
获取好友id列表
im.rosterManage.asyncGetRosterIdList().then(res => {
//
});
获取好友信息
im.rosterManage.asyncGetRosterInfo(state.sid).then(res => {
//
})
用户注册
rosterManage.asyncRegester({
username,
password
}).then(() => {
//
});
根据id列表获取用户详细信息
im.rosterManage.asnycGetRosterListDetailByIds(rosterIdList).then(res => {
//
});
根据id获取聊天信息
const rosterMessages = im.rosterManage.getRosterMessageByRid(uid);
读取消息
im.rosterManage.readRosterMessage(uid);
删除好友
im.rosterManage
.asyncDeleteRoster({ user_id})
.then(() => {
alert("好友已删除");
});
获取缓存的所有新用户
const userMaps = im.rosterManage.getAllRosterDetail();
撤回消息，只能撤回5分钟内的
im.rosterManage.recallMessage(user_id, message_id);
删除消息
im.rosterManage.deleteMessage(user_id, message_id);
获取用户的未读数
const unreadCount = im.rosterManage.getUnreadCount(user_id) :
设置消息成未读
im.rosterManage.unreadMessage(user_id, message_id);
获取好友信息
const roserInfo = im.rosterManage.getRosterInfo(user_id);
获取好友申请列表
im.rosterManage
.asyncGetApplyList({ cursor: "" })
.then((res = []) => {
//
});
获取黑名单
im.rosterManage
.asyncGetBlockedlist()
.then((res = []) => {
//
});
加入黑名单
im.rosterManage
.asyncBlockeAdd(user_id)
.then((res = []) => {
//
});
移除黑名单
im.rosterManage
.asyncBlockeRemove(user_id)
.then((res = []) => {
//
});
请求加为好友
im.rosterManage
.asyncApply({ user_id, alias })
.then((res = []) => {
//
});
通过好友申请
im.rosterManage
.asyncAccept({ user_id })
.then((res = []) => {
//
});
拒绝好友申请
im.rosterManage
.asyncDecline({ user_id })
.then((res = []) => {
//
});
按名称搜索用户
im.rosterManage
.asyncSearchRosterByName({ username })
.then((res = []) => {
//
});
按ID搜索用户
im.rosterManage
.asyncSearchRosterById({ user_id })
.then((res = []) => {
//
});
## groupManager
获取群信息
im.groupManage.asyncGetGroupInfo(group_id, fromServer).then(res => {
//
})
获取加入的群组
im.groupManage.asyncGetJoinedGroups().then(res => {
//
});
打开群组
// 此方法会准备群组聊天界面的一些必备信息。
im.groupManage.openGroup(group_id);
获取缓存的所有群组详情
const allGroupMap = im.groupManage.getAllGroupDetail();
获取群组成员（异步）
im.groupManage.asyncGetGroupMembers(group_id, fromServer).then(res => {
//
});
获取群组成员（同步）
const members = im.groupManage.getGroupMembers(group_id);
按id获取群组详情
im.groupManage.asyncGetGroupListDetail(groupIds).then(res => {
//
});
获取群消息
const groupMessages = rootState.im.groupManage.getGruopMessage(group_id);
将群消息设置已读
im.groupManage.readGroupMessage(group_id)
撤回消息
im.groupManage.recallMessage(group_id, message_id)
获取群未读消息数
const unreadCount = im.groupManage.getUnreadCount(group_id);
获取群管理员列表
im.groupManage.asyncGetAdminList({ group_id }).then(res => {
//
})
群添加管理员
im.groupManage.asyncAdminAdd({
group_id,
user_list
})
.then(() => {
//
});
移除管理员
im.groupManage.asyncAdminRemove({ group_id, user_list }).then(() => {
//
});
获取群公告详情
im.groupManage.asyncGetAnouncementById( {announcement_id, group_id} ).then(res => {
//
});
删除群公告
im.groupManage
.asyncAnouncementDelete({ group_id, announcement_id })
.then(() => {
//
});
添加群公告
im.groupManage.asyncAnnouncementEdit({ title, content, group_id })
.then(() => {
//
});
群公告列表
im.groupManage.asyncGetAnnouncementList({ group_id }).then((res = []) => {
//
});
创建群组
im.groupManage.asyncCreate({
name,
type,
avatar,
description,
user_list,
})
.then(() => {
//
});
解散群组
im.groupManage.asyncDestroy({ group_id })
.then(() => {
alert("您已解散了此群。。");
});
获取群组详情
im.groupManage.asyncGetInfo({ group_id }).then(res => {
//
});
更新群头像
im.groupManage.asyncUpdateAvatar({
group_id,
value,
})
.then(() => {
alert("更新头像完成");
});
更新群描述
im.groupManage.asyncUpdateDescription({
group_id,
value
})
.then(() => {
//
});
更新群名称
im.groupManage.asyncUpdateName({
group_id,
value
})
.then(() => {
//
});
获取群成员
im.groupManage.asyncGetMemberList(group_id, fromServer).then(res => {
//
});
设置群消息免打扰情况
im.groupManage.asyncGroupMsgMutemode({
group_id,
msg_mute_mode
})
.then(() => {
this.groupInfo.msg_mute_mode = this.groupInfo.msg_mute_mode ? 0 : 2;
});
获取群黑名单
im.groupManage.asyncGroupBannedList({ group_id }).then(res => {
//
});
禁言群成员
im.groupManage.asyncGroupBab({ group_id, duration, user_list }).then(() => {
//
});
解除成员
im.groupManage.asyncGroupUnban({ group_id, user_list }).then(() => {
//
});
设置群成员是否可以邀请
im.groupManage.asyncUpdateAllowMemberInvitation({
group_id,
value
})
.then(() => {
//
});
设置群成员是否可以修改群信息
im.groupManage.asyncUpdateAllowMemberModify({
group_id,
value
})
.then(() => {
//
});
设置群是否开启已读模式
im.groupManage.asyncUpdateEnableReadack({
group_id,
value
})
.then(() => {
//
});
设置群历史是否可见
im.groupManage.asyncUpdateHistoryVisible({
group_id,
value
})
.then(() => {
//
});
设置入群是否需要申请
im.groupManage.asyncUpdateRequireadminapproval({
group_id,
apply_approval
})
.then(() => {
//
});
更换群主
im.groupManage.asyncOwnerTransfer({
group_id,
new_owner
})
.then(() => {
//
});
申请加入群
im.groupManage.asyncApply({ group_id, reason })
.then(() => {
//
});
同意/拒绝申请用户加入群
im.groupManage.asyncApplyHandle({
approval: true/false,
user_id,
group_id
}).then(() => {
//
});
获取群黑名单
im.groupManage.asyncGroupBockedlist({ group_id }).then(res => {
//
});
将成员加入黑名单
im.groupManage.asyncGroupBlock({ group_id, user_list }).then(() => {
//
});
解除黑名单
im.groupManage.asyncGroupUnblock({ group_id, user_list })
.then(() => {
//
});
踢出群组
im.groupManage.asyncKick({ group_id, user_list }).then(() => {
//
});
获取群邀请列表
this.im.groupManage.asyncGetInvitationList().then(res => {
//
});
邀请成员加入群
im.groupManage.asyncInvite({ group_id, user_list }).then(() => {
/
});
同意/拒绝群邀请
im.groupManage.asyncInviteHandle({
approval: true,
user_id,
group_id
}).then(() => {
//
});
退出群
im.groupManage.asyncLeave({ group_id })
.then(() => {
//
});
修改群名片
im.groupManage.asyncUpdateDisplayName({
group_id,
value
})
.then(() => {
//
});
获取群申请列表
im.groupManage.asncGetApplicationList({ group_list }).then(rs => {
//
});
获取群文件
im.groupManage.asyncGetFileList({ group_id }).then((res = []) => {
//
});
删除群文件
im.groupManage.asyncFileDelete({ file_list, group_id }).then(() => {
//
});
## sysManager
发送好友消息
im.sysManage.sendRosterMessage({
type,
uid,
content,
attachment
});
发送群消息
im.sysManage.sendGroupMessage({
type,
gid,
content,
attachment
});
群发送@消息
im.sysManage.sendMentionMessage({
gid,
txt,
mentionAll,
mentionList,
mentionedMessage,
pushMessage,
senderNickname
});
发送输入状态消息
im.sysManage.sendInputStatusMessage(roster_id, "nothing"/"typing");
转发消息
im.sysManage.forwardMessage({
uid,
gid, //2选1
mid,
});
请求历史消息
im.sysManage.requireHistoryMessage(roster_id/group_id, mid, amount);
// mid：消息ID， 从哪条消息往前取历史，0表示最新一条消息。 amount：最多取多少条消息。
获取所有消息未读状态
const allAcks = im.sysManage.getAllMessageStatus() || {};
获取群文件上传url
im.sysManage.asyncGetGroupAvatarUploadUrl({
group_id,
"access-token"
})
.then(res => {
//
});
获取聊天文件上传地址
im.sysManage.asyncGetFileUploadChatFileUrl({
file_type,
to_id,
to_type
})
.then(res => {
//
});
上传文件
im.sysManage.asyncFileUpload({
file,
fileType,
to_id,
toType: "chat",
chatType: "roster"
})
.then(res => {
//
})
拼装图片路径
const image = im.sysManage.getImage({ avatar, type='roster', thumbnail=true });
## userManager
获取登录用户的token
const token = im.userManage.getToken();
获取登录用户的uid
const cuid = im.userManage.getUid();
获取appid
const appid = im.userManage.getAppid();
获取最近回话列表
const list = im.userManage.getConversationList();
发送验证码
im.userManage
.asyncUserSendSms({
mobile,
})
.then(() => {
//
});
发送验证码（通过图片验证码）
im.userManage
.asyncCaptchaSms({
captcha,
image_id,
mobile,
})
.then(() => {
//
});
检查用户名是否可用
im.userManage.asyncUserNameCheck(username).then(() => {
//
});
绑定手机号-使用签名绑定
im.userManage.asyncUserMobileBindSign({
mobile,
sign,
}).then(() => {
//
});
手机号验证码登录
im.userManage.asyncUserMobileLogin({
captcha,
mobile
})
.then(res => {
//
});
更新手机号
im.userManage
.asyncUpdateMobile({ mobile })
.then(() => {
//
});
更新头像
im.userManage
.asyncUpdateAvatar({
avatar
})
.then(() => {
//
});
更新昵称
im.userManage.asyncUpdateNickName({ nick_name }).then(() => {
//
});
获取用户profile
im.userManage.asyncGetProfile(true).then(res => {
//
})
更新用户profile
im.userManage.asyncUpdateProfile({
username,
avatar
}).then(res => {
//
})
获取用户设置信息
im.userManage.asyncGetSettings().then(res => {
//
})
修改用户设置
im.userManage
.asyncUpdateSettings({
"auth_answer": "string",
"auth_mode": 0,
"auth_question": "string",
"auto_download": true,
"group_confirm": true,
"id": 0,
"no_push": true,
"no_push_detail": true,
"no_push_end_hour": 0,
"no_push_start_hour": 0,
"no_sounds": true,
"push_nick_name": "string",
"user_id",
"vibratory": true
}).then(() => {
//
});
## 事件通知
1. Floo通知
事件名称：flooNotice
事件内容：({category, desc})
{category: 'loginMessage',desc: 'socket connecting...'} // 开始建连接
{category: 'loginMessage',desc: 'socket connect success...'} // 连接成功
{category: 'loginMessage',desc: 'logining socket service...'} // 开始登录
{category: 'loginMessage',desc: 'login socket failure ......'} // 登录失败
{category: 'loginMessage',desc: 'login socket success.....'} // 登录成功
{category: 'loginMessage', desc: 'getting token...' } //获取token
{category: 'loginMessage',desc: 'token sucecc, getting roster lists..'} // 获取token成功，开始获取好友列表
{category: 'loginMessage',desc: 'get roster list failure:' + ex.message} // 获取好友列表失败
{category: 'action', desc: 'relogin' } // 需要自动登录
{category: 'action', desc: 'relogin_manually' } // 需要手动登录
{category: 'conversation_deleted',desc: { id, source:'user_operation' }} // 会话被删除。ID：会话ID， source: 来源
{category: 'userNotice', desc:'PASSWORD_CHANGED'} // 用户密码改变
{category: 'userNotice', desc:'FROZEN'} // 用户账户被封禁
{category: 'userNotice', desc:'REMOVED'} // 用户被删除
{category: 'userNotice', desc:'KICK_BY_SAME_DEVICE'} // 当前设备被相同设备踢下线
{category: 'userNotice', desc:'KICKED_BY_OTHER_DEVICE'} // 当前设备被其它设备踢下线
{category: 'userNotice', desc:'INFO_UPDATED'} // 用户信息改变：profile或setting
{category: 'userNotice', desc:'DEVICE_LOGIN'} // 用户其它设备上线
{category: 'userNotice', desc:'DEVICE_LOGOUT'} // 用户其它设备下线
{category: 'userNotice', desc:'DEVICE_ADDED'} // 新设备通知
{category: 'userNotice', desc:'DEVICE_REMOVED'} // 设备被移除的通知
{category: 'userNotice', desc:'CLUSTER_CHANGED'} // 用户所在集群改变 需要重新登录
2. Floo错误
事件名称：flooError
事件内容：({category, desc})
{category: 'USER_BANNED', desc:'用户被禁言'}
{category: 'USER_FROZEN', desc:'用户被冻结，请联系App管理员。'}
{category: 'APP_FROZEN', desc:'APP 被冻结，请登陆蓝莺IM控制台查看详情。'}
{category: 'LICENSE', desc:'无效 LICENSE，请确认服务已按时付费。'}
{category: 'LICENSE', desc:'超出 LICENSE 用户数限制，请购买更高规格服务。'}
{category: 'DNS_FAILED', desc: dnsServer } // DNS错误: 无法访问
3. 登录失败
事件名称: loginFail
事件内容：(desc) 失败原因的描述
4. 登录成功
事件名称：loginSuccess
事件内容：({})
5. 群列表更新
事件名称：onGroupListUpdate
事件内容：()
6. 群成员列表更新
事件名称：onGroupMemberChanged
事件内容: (groupId) 群ID
7. 收到群消息
事件名称: onGroupMessage
事件内容: (meta) 消息的内容
8. 对方正在输入
事件名称: onInputStatusMessage
事件内容: ({ext,from,to}) ext:扩展字段 from: 发送者用户ID to: 接收者用户ID
9. 收到群组@消息
事件名称: onMentionMessage
事件内容: (meta) 消息的内容
10. 消息被取消已读
事件名称: onMessageCanceled
事件内容: ({uid,mid}) uid: 会话ID， mid: 消息ID
11. 消息被删除
事件名称: onMessageDeleted
事件内容: ({uid,mid}) uid: 会话ID， mid: 消息ID
12. 消息被撤回
事件名称: onMessageRecalled
事件内容: ({uid,mid}) uid: 会话ID， mid: 消息ID
13. 消息状态变更：撤回/删除/已读
事件名称: onMessageStatusChanged
事件内容: ({uid,mid}) uid: 会话ID， mid: 消息ID
14. 收到历史消息
事件名称: onReceiveHistoryMsg
事件内容: ({next}) next: 下次取历史消息的key
15. 好友信息变更
事件名称: onRosterInfoUpdate
事件内容: (rosterIds) rosterIds: 好友的用户ID列表
16. 好友列表变更
事件名称: onRosterListUpdate
事件内容: (meta) 好友通知的消息内容
17. 收到单聊消息
事件名称: onRosterMessage
事件内容: (meta) 好友通知的消息内容
18. 消息发送状态变更
事件名称: onSendingMessageStatusChanged
事件内容: ({status,mid}) status: 发送状态，取值为sending|failed|sent， mid: 客户端生成的client_mid
19. 未读数改变
事件名称: onUnreadChange
事件内容: (cid) 会话ID
20. 最近会话更新
事件名称: recentlistUpdate
事件内容: ()
21. 群组创建通知
事件名称: onGroupCreated
事件内容: (meta) 群通知的消息内容
22. 群组解散通知
事件名称: onGroupDestoryed
事件内容: (meta) 群通知的消息内容
23. 成员入群通知
事件名称: onGroupJoined
事件内容: (meta) 群通知的消息内容
24. 群申请被通过
事件名称: onGroupApplyAccepted
事件内容: (meta) 群通知的消息内容
25. 群申请被拒绝
事件名称: onGroupApplyDeclined
事件内容: (meta) 群通知的消息内容
26. 被群禁言
事件名称: onGroupBaned
事件内容: (meta) 群通知的消息内容
27. 被群取消禁言
事件名称: onGroupUnbaned
事件内容: (meta) 群通知的消息内容
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 10,995 |
API 概览 | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [IM Web
文档](https://developer.qiniu.com/IM/api/8325/im-web-document) > API 概览
# API 概览
最近更新时间: 2022-05-24 16:45:02
## 初始化
首先设置 AppID
首先设置 AppID
const config = {
appid: "YOUR_APP_ID",
ws: false,
autoLogin: true
};
然后创建im对象，供全局调用。
const im = QNIM.init(config);
## base 基础部分
登录
im.login({
mobile:String, #与name 2选1
name:String,
password:String,
})
监听
具体事件列表见本文档的"事件通知"部分
im.on('events', (ret) => {
//do something with ret
})
// or
im.on({
eventName: (ret) => {
//do something with ret
},
...
})
取消监听
im.off('events', (ret) => {
//do something with ret
})
// or
im.off({
eventName: (ret) => {
//do something with ret
},
...
})
二维码登录
im.qrlogin({
password,
user_id
});
token登录
im.tokenLogin(user_id, token)
## rosterManager
获取好友id列表
im.rosterManage.asyncGetRosterIdList().then(res => {
//
});
获取好友信息
im.rosterManage.asyncGetRosterInfo(state.sid).then(res => {
//
})
用户注册
rosterManage.asyncRegester({
username,
password
}).then(() => {
//
});
根据id列表获取用户详细信息
im.rosterManage.asnycGetRosterListDetailByIds(rosterIdList).then(res => {
//
});
根据id获取聊天信息
const rosterMessages = im.rosterManage.getRosterMessageByRid(uid);
读取消息
im.rosterManage.readRosterMessage(uid);
删除好友
im.rosterManage
.asyncDeleteRoster({ user_id})
.then(() => {
alert("好友已删除");
});
获取缓存的所有新用户
const userMaps = im.rosterManage.getAllRosterDetail();
撤回消息，只能撤回5分钟内的
im.rosterManage.recallMessage(user_id, message_id);
删除消息
im.rosterManage.deleteMessage(user_id, message_id);
获取用户的未读数
const unreadCount = im.rosterManage.getUnreadCount(user_id) :
设置消息成未读
im.rosterManage.unreadMessage(user_id, message_id);
获取好友信息
const roserInfo = im.rosterManage.getRosterInfo(user_id);
获取好友申请列表
im.rosterManage
.asyncGetApplyList({ cursor: "" })
.then((res = []) => {
//
});
获取黑名单
im.rosterManage
.asyncGetBlockedlist()
.then((res = []) => {
//
});
加入黑名单
im.rosterManage
.asyncBlockeAdd(user_id)
.then((res = []) => {
//
});
移除黑名单
im.rosterManage
.asyncBlockeRemove(user_id)
.then((res = []) => {
//
});
请求加为好友
im.rosterManage
.asyncApply({ user_id, alias })
.then((res = []) => {
//
});
通过好友申请
im.rosterManage
.asyncAccept({ user_id })
.then((res = []) => {
//
});
拒绝好友申请
im.rosterManage
.asyncDecline({ user_id })
.then((res = []) => {
//
});
按名称搜索用户
im.rosterManage
.asyncSearchRosterByName({ username })
.then((res = []) => {
//
});
按ID搜索用户
im.rosterManage
.asyncSearchRosterById({ user_id })
.then((res = []) => {
//
});
## groupManager
获取群信息
im.groupManage.asyncGetGroupInfo(group_id, fromServer).then(res => {
//
})
获取加入的群组
im.groupManage.asyncGetJoinedGroups().then(res => {
//
});
打开群组
// 此方法会准备群组聊天界面的一些必备信息。
im.groupManage.openGroup(group_id);
获取缓存的所有群组详情
const allGroupMap = im.groupManage.getAllGroupDetail();
获取群组成员（异步）
im.groupManage.asyncGetGroupMembers(group_id, fromServer).then(res => {
//
});
获取群组成员（同步）
const members = im.groupManage.getGroupMembers(group_id);
按id获取群组详情
im.groupManage.asyncGetGroupListDetail(groupIds).then(res => {
//
});
获取群消息
const groupMessages = rootState.im.groupManage.getGruopMessage(group_id);
将群消息设置已读
im.groupManage.readGroupMessage(group_id)
撤回消息
im.groupManage.recallMessage(group_id, message_id)
获取群未读消息数
const unreadCount = im.groupManage.getUnreadCount(group_id);
获取群管理员列表
im.groupManage.asyncGetAdminList({ group_id }).then(res => {
//
})
群添加管理员
im.groupManage.asyncAdminAdd({
group_id,
user_list
})
.then(() => {
//
});
移除管理员
im.groupManage.asyncAdminRemove({ group_id, user_list }).then(() => {
//
});
获取群公告详情
im.groupManage.asyncGetAnouncementById( {announcement_id, group_id} ).then(res => {
//
});
删除群公告
im.groupManage
.asyncAnouncementDelete({ group_id, announcement_id })
.then(() => {
//
});
添加群公告
im.groupManage.asyncAnnouncementEdit({ title, content, group_id })
.then(() => {
//
});
群公告列表
im.groupManage.asyncGetAnnouncementList({ group_id }).then((res = []) => {
//
});
创建群组
im.groupManage.asyncCreate({
name,
type,
avatar,
description,
user_list,
})
.then(() => {
//
});
解散群组
im.groupManage.asyncDestroy({ group_id })
.then(() => {
alert("您已解散了此群。。");
});
获取群组详情
im.groupManage.asyncGetInfo({ group_id }).then(res => {
//
});
更新群头像
im.groupManage.asyncUpdateAvatar({
group_id,
value,
})
.then(() => {
alert("更新头像完成");
});
更新群描述
im.groupManage.asyncUpdateDescription({
group_id,
value
})
.then(() => {
//
});
更新群名称
im.groupManage.asyncUpdateName({
group_id,
value
})
.then(() => {
//
});
获取群成员
im.groupManage.asyncGetMemberList(group_id, fromServer).then(res => {
//
});
设置群消息免打扰情况
im.groupManage.asyncGroupMsgMutemode({
group_id,
msg_mute_mode
})
.then(() => {
this.groupInfo.msg_mute_mode = this.groupInfo.msg_mute_mode ? 0 : 2;
});
获取群黑名单
im.groupManage.asyncGroupBannedList({ group_id }).then(res => {
//
});
禁言群成员
im.groupManage.asyncGroupBab({ group_id, duration, user_list }).then(() => {
//
});
解除成员
im.groupManage.asyncGroupUnban({ group_id, user_list }).then(() => {
//
});
设置群成员是否可以邀请
im.groupManage.asyncUpdateAllowMemberInvitation({
group_id,
value
})
.then(() => {
//
});
设置群成员是否可以修改群信息
im.groupManage.asyncUpdateAllowMemberModify({
group_id,
value
})
.then(() => {
//
});
设置群是否开启已读模式
im.groupManage.asyncUpdateEnableReadack({
group_id,
value
})
.then(() => {
//
});
设置群历史是否可见
im.groupManage.asyncUpdateHistoryVisible({
group_id,
value
})
.then(() => {
//
});
设置入群是否需要申请
im.groupManage.asyncUpdateRequireadminapproval({
group_id,
apply_approval
})
.then(() => {
//
});
更换群主
im.groupManage.asyncOwnerTransfer({
group_id,
new_owner
})
.then(() => {
//
});
申请加入群
im.groupManage.asyncApply({ group_id, reason })
.then(() => {
//
});
同意/拒绝申请用户加入群
im.groupManage.asyncApplyHandle({
approval: true/false,
user_id,
group_id
}).then(() => {
//
});
获取群黑名单
im.groupManage.asyncGroupBockedlist({ group_id }).then(res => {
//
});
将成员加入黑名单
im.groupManage.asyncGroupBlock({ group_id, user_list }).then(() => {
//
});
解除黑名单
im.groupManage.asyncGroupUnblock({ group_id, user_list })
.then(() => {
//
});
踢出群组
im.groupManage.asyncKick({ group_id, user_list }).then(() => {
//
});
获取群邀请列表
this.im.groupManage.asyncGetInvitationList().then(res => {
//
});
邀请成员加入群
im.groupManage.asyncInvite({ group_id, user_list }).then(() => {
/
});
同意/拒绝群邀请
im.groupManage.asyncInviteHandle({
approval: true,
user_id,
group_id
}).then(() => {
//
});
退出群
im.groupManage.asyncLeave({ group_id })
.then(() => {
//
});
修改群名片
im.groupManage.asyncUpdateDisplayName({
group_id,
value
})
.then(() => {
//
});
获取群申请列表
im.groupManage.asncGetApplicationList({ group_list }).then(rs => {
//
});
获取群文件
im.groupManage.asyncGetFileList({ group_id }).then((res = []) => {
//
});
删除群文件
im.groupManage.asyncFileDelete({ file_list, group_id }).then(() => {
//
});
## sysManager
发送好友消息
im.sysManage.sendRosterMessage({
type,
uid,
content,
attachment
});
发送群消息
im.sysManage.sendGroupMessage({
type,
gid,
content,
attachment
});
群发送@消息
im.sysManage.sendMentionMessage({
gid,
txt,
mentionAll,
mentionList,
mentionedMessage,
pushMessage,
senderNickname
});
发送输入状态消息
im.sysManage.sendInputStatusMessage(roster_id, "nothing"/"typing");
转发消息
im.sysManage.forwardMessage({
uid,
gid, //2选1
mid,
});
请求历史消息
im.sysManage.requireHistoryMessage(roster_id/group_id, mid, amount);
// mid：消息ID， 从哪条消息往前取历史，0表示最新一条消息。 amount：最多取多少条消息。
获取所有消息未读状态
const allAcks = im.sysManage.getAllMessageStatus() || {};
获取群文件上传url
im.sysManage.asyncGetGroupAvatarUploadUrl({
group_id,
"access-token"
})
.then(res => {
//
});
获取聊天文件上传地址
im.sysManage.asyncGetFileUploadChatFileUrl({
file_type,
to_id,
to_type
})
.then(res => {
//
});
上传文件
im.sysManage.asyncFileUpload({
file,
fileType,
to_id,
toType: "chat",
chatType: "roster"
})
.then(res => {
//
})
拼装图片路径
const image = im.sysManage.getImage({ avatar, type='roster', thumbnail=true });
## userManager
获取登录用户的token
const token = im.userManage.getToken();
获取登录用户的uid
const cuid = im.userManage.getUid();
获取appid
const appid = im.userManage.getAppid();
获取最近回话列表
const list = im.userManage.getConversationList();
发送验证码
im.userManage
.asyncUserSendSms({
mobile,
})
.then(() => {
//
});
发送验证码（通过图片验证码）
im.userManage
.asyncCaptchaSms({
captcha,
image_id,
mobile,
})
.then(() => {
//
});
检查用户名是否可用
im.userManage.asyncUserNameCheck(username).then(() => {
//
});
绑定手机号-使用签名绑定
im.userManage.asyncUserMobileBindSign({
mobile,
sign,
}).then(() => {
//
});
手机号验证码登录
im.userManage.asyncUserMobileLogin({
captcha,
mobile
})
.then(res => {
//
});
更新手机号
im.userManage
.asyncUpdateMobile({ mobile })
.then(() => {
//
});
更新头像
im.userManage
.asyncUpdateAvatar({
avatar
})
.then(() => {
//
});
更新昵称
im.userManage.asyncUpdateNickName({ nick_name }).then(() => {
//
});
获取用户profile
im.userManage.asyncGetProfile(true).then(res => {
//
})
更新用户profile
im.userManage.asyncUpdateProfile({
username,
avatar
}).then(res => {
//
})
获取用户设置信息
im.userManage.asyncGetSettings().then(res => {
//
})
修改用户设置
im.userManage
.asyncUpdateSettings({
"auth_answer": "string",
"auth_mode": 0,
"auth_question": "string",
"auto_download": true,
"group_confirm": true,
"id": 0,
"no_push": true,
"no_push_detail": true,
"no_push_end_hour": 0,
"no_push_start_hour": 0,
"no_sounds": true,
"push_nick_name": "string",
"user_id",
"vibratory": true
}).then(() => {
//
});
## 事件通知
1. Floo通知
事件名称：flooNotice
事件内容：({category, desc})
{category: 'loginMessage',desc: 'socket connecting...'} // 开始建连接
{category: 'loginMessage',desc: 'socket connect success...'} // 连接成功
{category: 'loginMessage',desc: 'logining socket service...'} // 开始登录
{category: 'loginMessage',desc: 'login socket failure ......'} // 登录失败
{category: 'loginMessage',desc: 'login socket success.....'} // 登录成功
{category: 'loginMessage', desc: 'getting token...' } //获取token
{category: 'loginMessage',desc: 'token sucecc, getting roster lists..'} // 获取token成功，开始获取好友列表
{category: 'loginMessage',desc: 'get roster list failure:' + ex.message} // 获取好友列表失败
{category: 'action', desc: 'relogin' } // 需要自动登录
{category: 'action', desc: 'relogin_manually' } // 需要手动登录
{category: 'conversation_deleted',desc: { id, source:'user_operation' }} // 会话被删除。ID：会话ID， source: 来源
{category: 'userNotice', desc:'PASSWORD_CHANGED'} // 用户密码改变
{category: 'userNotice', desc:'FROZEN'} // 用户账户被封禁
{category: 'userNotice', desc:'REMOVED'} // 用户被删除
{category: 'userNotice', desc:'KICK_BY_SAME_DEVICE'} // 当前设备被相同设备踢下线
{category: 'userNotice', desc:'KICKED_BY_OTHER_DEVICE'} // 当前设备被其它设备踢下线
{category: 'userNotice', desc:'INFO_UPDATED'} // 用户信息改变：profile或setting
{category: 'userNotice', desc:'DEVICE_LOGIN'} // 用户其它设备上线
{category: 'userNotice', desc:'DEVICE_LOGOUT'} // 用户其它设备下线
{category: 'userNotice', desc:'DEVICE_ADDED'} // 新设备通知
{category: 'userNotice', desc:'DEVICE_REMOVED'} // 设备被移除的通知
{category: 'userNotice', desc:'CLUSTER_CHANGED'} // 用户所在集群改变 需要重新登录
2. Floo错误
事件名称：flooError
事件内容：({category, desc})
{category: 'USER_BANNED', desc:'用户被禁言'}
{category: 'USER_FROZEN', desc:'用户被冻结，请联系App管理员。'}
{category: 'APP_FROZEN', desc:'APP 被冻结，请登陆蓝莺IM控制台查看详情。'}
{category: 'LICENSE', desc:'无效 LICENSE，请确认服务已按时付费。'}
{category: 'LICENSE', desc:'超出 LICENSE 用户数限制，请购买更高规格服务。'}
{category: 'DNS_FAILED', desc: dnsServer } // DNS错误: 无法访问
3. 登录失败
事件名称: loginFail
事件内容：(desc) 失败原因的描述
4. 登录成功
事件名称：loginSuccess
事件内容：({})
5. 群列表更新
事件名称：onGroupListUpdate
事件内容：()
6. 群成员列表更新
事件名称：onGroupMemberChanged
事件内容: (groupId) 群ID
7. 收到群消息
事件名称: onGroupMessage
事件内容: (meta) 消息的内容
8. 对方正在输入
事件名称: onInputStatusMessage
事件内容: ({ext,from,to}) ext:扩展字段 from: 发送者用户ID to: 接收者用户ID
9. 收到群组@消息
事件名称: onMentionMessage
事件内容: (meta) 消息的内容
10. 消息被取消已读
事件名称: onMessageCanceled
事件内容: ({uid,mid}) uid: 会话ID， mid: 消息ID
11. 消息被删除
事件名称: onMessageDeleted
事件内容: ({uid,mid}) uid: 会话ID， mid: 消息ID
12. 消息被撤回
事件名称: onMessageRecalled
事件内容: ({uid,mid}) uid: 会话ID， mid: 消息ID
13. 消息状态变更：撤回/删除/已读
事件名称: onMessageStatusChanged
事件内容: ({uid,mid}) uid: 会话ID， mid: 消息ID
14. 收到历史消息
事件名称: onReceiveHistoryMsg
事件内容: ({next}) next: 下次取历史消息的key
15. 好友信息变更
事件名称: onRosterInfoUpdate
事件内容: (rosterIds) rosterIds: 好友的用户ID列表
16. 好友列表变更
事件名称: onRosterListUpdate
事件内容: (meta) 好友通知的消息内容
17. 收到单聊消息
事件名称: onRosterMessage
事件内容: (meta) 好友通知的消息内容
18. 消息发送状态变更
事件名称: onSendingMessageStatusChanged
事件内容: ({status,mid}) status: 发送状态，取值为sending|failed|sent， mid: 客户端生成的client_mid
19. 未读数改变
事件名称: onUnreadChange
事件内容: (cid) 会话ID
20. 最近会话更新
事件名称: recentlistUpdate
事件内容: ()
21. 群组创建通知
事件名称: onGroupCreated
事件内容: (meta) 群通知的消息内容
22. 群组解散通知
事件名称: onGroupDestoryed
事件内容: (meta) 群通知的消息内容
23. 成员入群通知
事件名称: onGroupJoined
事件内容: (meta) 群通知的消息内容
24. 群申请被通过
事件名称: onGroupApplyAccepted
事件内容: (meta) 群通知的消息内容
25. 群申请被拒绝
事件名称: onGroupApplyDeclined
事件内容: (meta) 群通知的消息内容
26. 被群禁言
事件名称: onGroupBaned
事件内容: (meta) 群通知的消息内容
27. 被群取消禁言
事件名称: onGroupUnbaned
事件内容: (meta) 群通知的消息内容
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [IM Web
文档](https://developer.qiniu.com/IM/api/8325/im-web-document) > API 概览
# API 概览
最近更新时间: 2022-05-24 16:45:02
## 初始化
首先设置 AppID
首先设置 AppID
const config = {
appid: "YOUR_APP_ID",
ws: false,
autoLogin: true
};
然后创建im对象，供全局调用。
const im = QNIM.init(config);
## base 基础部分
登录
im.login({
mobile:String, #与name 2选1
name:String,
password:String,
})
监听
具体事件列表见本文档的"事件通知"部分
im.on('events', (ret) => {
//do something with ret
})
// or
im.on({
eventName: (ret) => {
//do something with ret
},
...
})
取消监听
im.off('events', (ret) => {
//do something with ret
})
// or
im.off({
eventName: (ret) => {
//do something with ret
},
...
})
二维码登录
im.qrlogin({
password,
user_id
});
token登录
im.tokenLogin(user_id, token)
## rosterManager
获取好友id列表
im.rosterManage.asyncGetRosterIdList().then(res => {
//
});
获取好友信息
im.rosterManage.asyncGetRosterInfo(state.sid).then(res => {
//
})
用户注册
rosterManage.asyncRegester({
username,
password
}).then(() => {
//
});
根据id列表获取用户详细信息
im.rosterManage.asnycGetRosterListDetailByIds(rosterIdList).then(res => {
//
});
根据id获取聊天信息
const rosterMessages = im.rosterManage.getRosterMessageByRid(uid);
读取消息
im.rosterManage.readRosterMessage(uid);
删除好友
im.rosterManage
.asyncDeleteRoster({ user_id})
.then(() => {
alert("好友已删除");
});
获取缓存的所有新用户
const userMaps = im.rosterManage.getAllRosterDetail();
撤回消息，只能撤回5分钟内的
im.rosterManage.recallMessage(user_id, message_id);
删除消息
im.rosterManage.deleteMessage(user_id, message_id);
获取用户的未读数
const unreadCount = im.rosterManage.getUnreadCount(user_id) :
设置消息成未读
im.rosterManage.unreadMessage(user_id, message_id);
获取好友信息
const roserInfo = im.rosterManage.getRosterInfo(user_id);
获取好友申请列表
im.rosterManage
.asyncGetApplyList({ cursor: "" })
.then((res = []) => {
//
});
获取黑名单
im.rosterManage
.asyncGetBlockedlist()
.then((res = []) => {
//
});
加入黑名单
im.rosterManage
.asyncBlockeAdd(user_id)
.then((res = []) => {
//
});
移除黑名单
im.rosterManage
.asyncBlockeRemove(user_id)
.then((res = []) => {
//
});
请求加为好友
im.rosterManage
.asyncApply({ user_id, alias })
.then((res = []) => {
//
});
通过好友申请
im.rosterManage
.asyncAccept({ user_id })
.then((res = []) => {
//
});
拒绝好友申请
im.rosterManage
.asyncDecline({ user_id })
.then((res = []) => {
//
});
按名称搜索用户
im.rosterManage
.asyncSearchRosterByName({ username })
.then((res = []) => {
//
});
按ID搜索用户
im.rosterManage
.asyncSearchRosterById({ user_id })
.then((res = []) => {
//
});
## groupManager
获取群信息
im.groupManage.asyncGetGroupInfo(group_id, fromServer).then(res => {
//
})
获取加入的群组
im.groupManage.asyncGetJoinedGroups().then(res => {
//
});
打开群组
// 此方法会准备群组聊天界面的一些必备信息。
im.groupManage.openGroup(group_id);
获取缓存的所有群组详情
const allGroupMap = im.groupManage.getAllGroupDetail();
获取群组成员（异步）
im.groupManage.asyncGetGroupMembers(group_id, fromServer).then(res => {
//
});
获取群组成员（同步）
const members = im.groupManage.getGroupMembers(group_id);
按id获取群组详情
im.groupManage.asyncGetGroupListDetail(groupIds).then(res => {
//
});
获取群消息
const groupMessages = rootState.im.groupManage.getGruopMessage(group_id);
将群消息设置已读
im.groupManage.readGroupMessage(group_id)
撤回消息
im.groupManage.recallMessage(group_id, message_id)
获取群未读消息数
const unreadCount = im.groupManage.getUnreadCount(group_id);
获取群管理员列表
im.groupManage.asyncGetAdminList({ group_id }).then(res => {
//
})
群添加管理员
im.groupManage.asyncAdminAdd({
group_id,
user_list
})
.then(() => {
//
});
移除管理员
im.groupManage.asyncAdminRemove({ group_id, user_list }).then(() => {
//
});
获取群公告详情
im.groupManage.asyncGetAnouncementById( {announcement_id, group_id} ).then(res => {
//
});
删除群公告
im.groupManage
.asyncAnouncementDelete({ group_id, announcement_id })
.then(() => {
//
});
添加群公告
im.groupManage.asyncAnnouncementEdit({ title, content, group_id })
.then(() => {
//
});
群公告列表
im.groupManage.asyncGetAnnouncementList({ group_id }).then((res = []) => {
//
});
创建群组
im.groupManage.asyncCreate({
name,
type,
avatar,
description,
user_list,
})
.then(() => {
//
});
解散群组
im.groupManage.asyncDestroy({ group_id })
.then(() => {
alert("您已解散了此群。。");
});
获取群组详情
im.groupManage.asyncGetInfo({ group_id }).then(res => {
//
});
更新群头像
im.groupManage.asyncUpdateAvatar({
group_id,
value,
})
.then(() => {
alert("更新头像完成");
});
更新群描述
im.groupManage.asyncUpdateDescription({
group_id,
value
})
.then(() => {
//
});
更新群名称
im.groupManage.asyncUpdateName({
group_id,
value
})
.then(() => {
//
});
获取群成员
im.groupManage.asyncGetMemberList(group_id, fromServer).then(res => {
//
});
设置群消息免打扰情况
im.groupManage.asyncGroupMsgMutemode({
group_id,
msg_mute_mode
})
.then(() => {
this.groupInfo.msg_mute_mode = this.groupInfo.msg_mute_mode ? 0 : 2;
});
获取群黑名单
im.groupManage.asyncGroupBannedList({ group_id }).then(res => {
//
});
禁言群成员
im.groupManage.asyncGroupBab({ group_id, duration, user_list }).then(() => {
//
});
解除成员
im.groupManage.asyncGroupUnban({ group_id, user_list }).then(() => {
//
});
设置群成员是否可以邀请
im.groupManage.asyncUpdateAllowMemberInvitation({
group_id,
value
})
.then(() => {
//
});
设置群成员是否可以修改群信息
im.groupManage.asyncUpdateAllowMemberModify({
group_id,
value
})
.then(() => {
//
});
设置群是否开启已读模式
im.groupManage.asyncUpdateEnableReadack({
group_id,
value
})
.then(() => {
//
});
设置群历史是否可见
im.groupManage.asyncUpdateHistoryVisible({
group_id,
value
})
.then(() => {
//
});
设置入群是否需要申请
im.groupManage.asyncUpdateRequireadminapproval({
group_id,
apply_approval
})
.then(() => {
//
});
更换群主
im.groupManage.asyncOwnerTransfer({
group_id,
new_owner
})
.then(() => {
//
});
申请加入群
im.groupManage.asyncApply({ group_id, reason })
.then(() => {
//
});
同意/拒绝申请用户加入群
im.groupManage.asyncApplyHandle({
approval: true/false,
user_id,
group_id
}).then(() => {
//
});
获取群黑名单
im.groupManage.asyncGroupBockedlist({ group_id }).then(res => {
//
});
将成员加入黑名单
im.groupManage.asyncGroupBlock({ group_id, user_list }).then(() => {
//
});
解除黑名单
im.groupManage.asyncGroupUnblock({ group_id, user_list })
.then(() => {
//
});
踢出群组
im.groupManage.asyncKick({ group_id, user_list }).then(() => {
//
});
获取群邀请列表
this.im.groupManage.asyncGetInvitationList().then(res => {
//
});
邀请成员加入群
im.groupManage.asyncInvite({ group_id, user_list }).then(() => {
/
});
同意/拒绝群邀请
im.groupManage.asyncInviteHandle({
approval: true,
user_id,
group_id
}).then(() => {
//
});
退出群
im.groupManage.asyncLeave({ group_id })
.then(() => {
//
});
修改群名片
im.groupManage.asyncUpdateDisplayName({
group_id,
value
})
.then(() => {
//
});
获取群申请列表
im.groupManage.asncGetApplicationList({ group_list }).then(rs => {
//
});
获取群文件
im.groupManage.asyncGetFileList({ group_id }).then((res = []) => {
//
});
删除群文件
im.groupManage.asyncFileDelete({ file_list, group_id }).then(() => {
//
});
## sysManager
发送好友消息
im.sysManage.sendRosterMessage({
type,
uid,
content,
attachment
});
发送群消息
im.sysManage.sendGroupMessage({
type,
gid,
content,
attachment
});
群发送@消息
im.sysManage.sendMentionMessage({
gid,
txt,
mentionAll,
mentionList,
mentionedMessage,
pushMessage,
senderNickname
});
发送输入状态消息
im.sysManage.sendInputStatusMessage(roster_id, "nothing"/"typing");
转发消息
im.sysManage.forwardMessage({
uid,
gid, //2选1
mid,
});
请求历史消息
im.sysManage.requireHistoryMessage(roster_id/group_id, mid, amount);
// mid：消息ID， 从哪条消息往前取历史，0表示最新一条消息。 amount：最多取多少条消息。
获取所有消息未读状态
const allAcks = im.sysManage.getAllMessageStatus() || {};
获取群文件上传url
im.sysManage.asyncGetGroupAvatarUploadUrl({
group_id,
"access-token"
})
.then(res => {
//
});
获取聊天文件上传地址
im.sysManage.asyncGetFileUploadChatFileUrl({
file_type,
to_id,
to_type
})
.then(res => {
//
});
上传文件
im.sysManage.asyncFileUpload({
file,
fileType,
to_id,
toType: "chat",
chatType: "roster"
})
.then(res => {
//
})
拼装图片路径
const image = im.sysManage.getImage({ avatar, type='roster', thumbnail=true });
## userManager
获取登录用户的token
const token = im.userManage.getToken();
获取登录用户的uid
const cuid = im.userManage.getUid();
获取appid
const appid = im.userManage.getAppid();
获取最近回话列表
const list = im.userManage.getConversationList();
发送验证码
im.userManage
.asyncUserSendSms({
mobile,
})
.then(() => {
//
});
发送验证码（通过图片验证码）
im.userManage
.asyncCaptchaSms({
captcha,
image_id,
mobile,
})
.then(() => {
//
});
检查用户名是否可用
im.userManage.asyncUserNameCheck(username).then(() => {
//
});
绑定手机号-使用签名绑定
im.userManage.asyncUserMobileBindSign({
mobile,
sign,
}).then(() => {
//
});
手机号验证码登录
im.userManage.asyncUserMobileLogin({
captcha,
mobile
})
.then(res => {
//
});
更新手机号
im.userManage
.asyncUpdateMobile({ mobile })
.then(() => {
//
});
更新头像
im.userManage
.asyncUpdateAvatar({
avatar
})
.then(() => {
//
});
更新昵称
im.userManage.asyncUpdateNickName({ nick_name }).then(() => {
//
});
获取用户profile
im.userManage.asyncGetProfile(true).then(res => {
//
})
更新用户profile
im.userManage.asyncUpdateProfile({
username,
avatar
}).then(res => {
//
})
获取用户设置信息
im.userManage.asyncGetSettings().then(res => {
//
})
修改用户设置
im.userManage
.asyncUpdateSettings({
"auth_answer": "string",
"auth_mode": 0,
"auth_question": "string",
"auto_download": true,
"group_confirm": true,
"id": 0,
"no_push": true,
"no_push_detail": true,
"no_push_end_hour": 0,
"no_push_start_hour": 0,
"no_sounds": true,
"push_nick_name": "string",
"user_id",
"vibratory": true
}).then(() => {
//
});
## 事件通知
1. Floo通知
事件名称：flooNotice
事件内容：({category, desc})
{category: 'loginMessage',desc: 'socket connecting...'} // 开始建连接
{category: 'loginMessage',desc: 'socket connect success...'} // 连接成功
{category: 'loginMessage',desc: 'logining socket service...'} // 开始登录
{category: 'loginMessage',desc: 'login socket failure ......'} // 登录失败
{category: 'loginMessage',desc: 'login socket success.....'} // 登录成功
{category: 'loginMessage', desc: 'getting token...' } //获取token
{category: 'loginMessage',desc: 'token sucecc, getting roster lists..'} // 获取token成功，开始获取好友列表
{category: 'loginMessage',desc: 'get roster list failure:' + ex.message} // 获取好友列表失败
{category: 'action', desc: 'relogin' } // 需要自动登录
{category: 'action', desc: 'relogin_manually' } // 需要手动登录
{category: 'conversation_deleted',desc: { id, source:'user_operation' }} // 会话被删除。ID：会话ID， source: 来源
{category: 'userNotice', desc:'PASSWORD_CHANGED'} // 用户密码改变
{category: 'userNotice', desc:'FROZEN'} // 用户账户被封禁
{category: 'userNotice', desc:'REMOVED'} // 用户被删除
{category: 'userNotice', desc:'KICK_BY_SAME_DEVICE'} // 当前设备被相同设备踢下线
{category: 'userNotice', desc:'KICKED_BY_OTHER_DEVICE'} // 当前设备被其它设备踢下线
{category: 'userNotice', desc:'INFO_UPDATED'} // 用户信息改变：profile或setting
{category: 'userNotice', desc:'DEVICE_LOGIN'} // 用户其它设备上线
{category: 'userNotice', desc:'DEVICE_LOGOUT'} // 用户其它设备下线
{category: 'userNotice', desc:'DEVICE_ADDED'} // 新设备通知
{category: 'userNotice', desc:'DEVICE_REMOVED'} // 设备被移除的通知
{category: 'userNotice', desc:'CLUSTER_CHANGED'} // 用户所在集群改变 需要重新登录
2. Floo错误
事件名称：flooError
事件内容：({category, desc})
{category: 'USER_BANNED', desc:'用户被禁言'}
{category: 'USER_FROZEN', desc:'用户被冻结，请联系App管理员。'}
{category: 'APP_FROZEN', desc:'APP 被冻结，请登陆蓝莺IM控制台查看详情。'}
{category: 'LICENSE', desc:'无效 LICENSE，请确认服务已按时付费。'}
{category: 'LICENSE', desc:'超出 LICENSE 用户数限制，请购买更高规格服务。'}
{category: 'DNS_FAILED', desc: dnsServer } // DNS错误: 无法访问
3. 登录失败
事件名称: loginFail
事件内容：(desc) 失败原因的描述
4. 登录成功
事件名称：loginSuccess
事件内容：({})
5. 群列表更新
事件名称：onGroupListUpdate
事件内容：()
6. 群成员列表更新
事件名称：onGroupMemberChanged
事件内容: (groupId) 群ID
7. 收到群消息
事件名称: onGroupMessage
事件内容: (meta) 消息的内容
8. 对方正在输入
事件名称: onInputStatusMessage
事件内容: ({ext,from,to}) ext:扩展字段 from: 发送者用户ID to: 接收者用户ID
9. 收到群组@消息
事件名称: onMentionMessage
事件内容: (meta) 消息的内容
10. 消息被取消已读
事件名称: onMessageCanceled
事件内容: ({uid,mid}) uid: 会话ID， mid: 消息ID
11. 消息被删除
事件名称: onMessageDeleted
事件内容: ({uid,mid}) uid: 会话ID， mid: 消息ID
12. 消息被撤回
事件名称: onMessageRecalled
事件内容: ({uid,mid}) uid: 会话ID， mid: 消息ID
13. 消息状态变更：撤回/删除/已读
事件名称: onMessageStatusChanged
事件内容: ({uid,mid}) uid: 会话ID， mid: 消息ID
14. 收到历史消息
事件名称: onReceiveHistoryMsg
事件内容: ({next}) next: 下次取历史消息的key
15. 好友信息变更
事件名称: onRosterInfoUpdate
事件内容: (rosterIds) rosterIds: 好友的用户ID列表
16. 好友列表变更
事件名称: onRosterListUpdate
事件内容: (meta) 好友通知的消息内容
17. 收到单聊消息
事件名称: onRosterMessage
事件内容: (meta) 好友通知的消息内容
18. 消息发送状态变更
事件名称: onSendingMessageStatusChanged
事件内容: ({status,mid}) status: 发送状态，取值为sending|failed|sent， mid: 客户端生成的client_mid
19. 未读数改变
事件名称: onUnreadChange
事件内容: (cid) 会话ID
20. 最近会话更新
事件名称: recentlistUpdate
事件内容: ()
21. 群组创建通知
事件名称: onGroupCreated
事件内容: (meta) 群通知的消息内容
22. 群组解散通知
事件名称: onGroupDestoryed
事件内容: (meta) 群通知的消息内容
23. 成员入群通知
事件名称: onGroupJoined
事件内容: (meta) 群通知的消息内容
24. 群申请被通过
事件名称: onGroupApplyAccepted
事件内容: (meta) 群通知的消息内容
25. 群申请被拒绝
事件名称: onGroupApplyDeclined
事件内容: (meta) 群通知的消息内容
26. 被群禁言
事件名称: onGroupBaned
事件内容: (meta) 群通知的消息内容
27. 被群取消禁言
事件名称: onGroupUnbaned
事件内容: (meta) 群通知的消息内容
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,016 |
im | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [IM Web
文档](https://developer.qiniu.com/IM/api/8325/im-web-document) > im
# im
最近更新时间: 2022-05-24 16:51:01
## im
* QNIM
* .init(config)
* im
* .login(opt)
* .qrlogin(opt)
* .tokenLogin(opt)
* .idLogin(opt)
* .isLogin()
* .on
* .off
* .logout()
### QNIM.init(config) ⇒ im
初始化SDK
**Kind** : static method of QNIM
**Returns** : `im` \- im 对象
Param | Type | Description
---|---|---
config | `object` | SDK初始化设置
config.appid | `string` | APPID
config.ws | `boolean` | 连接地址前缀是否为ws/wss: true - 连接地址前缀为ws或wss, false - 连接地址前缀为http/https
config.autoLogin | `boolean` | 是否自动登录
**Example**
import QNIM from 'qnweb-im';
const config = {
appid: "YOUR_APP_ID",
ws: false,
autoLogin: true
};
const im = QNIM.init(config);
### im.login(opt)
登录
**Kind** : method of im
Param | Type | Description
---|---|---
opt | `object` |
opt.name | `string` | 用户名
opt.password | `string` | 密码
### im.qrlogin(opt)
二维码登录
**Kind** : method of im
Param | Type | Description
---|---|---
opt | `object` |
opt.user_id | `number` | 用户ID
opt.password | `string` | 密码
### im.tokenLogin(opt)
token登录
**Kind** : method of im
Param | Type | Description
---|---|---
opt | `object` |
opt.user_id | `number` | 用户ID
opt.token | `string` | Token
### im.idLogin(opt)
使用用户ID和密码登录
**Kind** : method of im
Param | Type | Description
---|---|---
opt | `object` |
opt.user_id | `number` | 用户ID
opt.password | `string` | 密码
### im.isLogin() ⇒ `boolean`
是否已登录
**Kind** : method of im
**Returns** : `boolean` \- 是否已登录
### im.on(options, ext)
事件监听
**Kind** : method of im
Param | Type | Description
---|---|---
options | [`Event`](https://developer.qiniu.com/IM/11901/im) | Object.<[`Event`](https://developer.qiniu.com/IM/11901/im), [`EventCallback`](https://developer.qiniu.com/IM/11901/im)>
ext | [`EventCallback`](https://developer.qiniu.com/IM/11901/im) | `undefined`
**Example**
im.on('event', (ret) => {
//do something with ret
})
// or
im.on({
eventName: (ret) => {
//do something with ret
},
...
})
### im.off(options, ext)
取消监听
**Kind** : method of im
Param | Type | Description
---|---|---
options | [`Event`](https://developer.qiniu.com/IM/11901/im) | Object.<[`Event`](https://developer.qiniu.com/IM/11901/im), [`EventCallback`](https://developer.qiniu.com/IM/11901/im)>
ext | [`EventCallback`](https://developer.qiniu.com/IM/11901/im) | `undefined`
**Example**
im.off('events', (ret) => {
//do something with ret
})
// or
im.off({
eventName: (ret) => {
//do something with ret
},
...
})
### im.logout()
退出账户
**Kind** : method of im
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [IM Web
文档](https://developer.qiniu.com/IM/api/8325/im-web-document) > im
# im
最近更新时间: 2022-05-24 16:51:01
## im
* QNIM
* .init(config)
* im
* .login(opt)
* .qrlogin(opt)
* .tokenLogin(opt)
* .idLogin(opt)
* .isLogin()
* .on
* .off
* .logout()
### QNIM.init(config) ⇒ im
初始化SDK
**Kind** : static method of QNIM
**Returns** : `im` \- im 对象
Param | Type | Description
---|---|---
config | `object` | SDK初始化设置
config.appid | `string` | APPID
config.ws | `boolean` | 连接地址前缀是否为ws/wss: true - 连接地址前缀为ws或wss, false - 连接地址前缀为http/https
config.autoLogin | `boolean` | 是否自动登录
**Example**
import QNIM from 'qnweb-im';
const config = {
appid: "YOUR_APP_ID",
ws: false,
autoLogin: true
};
const im = QNIM.init(config);
### im.login(opt)
登录
**Kind** : method of im
Param | Type | Description
---|---|---
opt | `object` |
opt.name | `string` | 用户名
opt.password | `string` | 密码
### im.qrlogin(opt)
二维码登录
**Kind** : method of im
Param | Type | Description
---|---|---
opt | `object` |
opt.user_id | `number` | 用户ID
opt.password | `string` | 密码
### im.tokenLogin(opt)
token登录
**Kind** : method of im
Param | Type | Description
---|---|---
opt | `object` |
opt.user_id | `number` | 用户ID
opt.token | `string` | Token
### im.idLogin(opt)
使用用户ID和密码登录
**Kind** : method of im
Param | Type | Description
---|---|---
opt | `object` |
opt.user_id | `number` | 用户ID
opt.password | `string` | 密码
### im.isLogin() ⇒ `boolean`
是否已登录
**Kind** : method of im
**Returns** : `boolean` \- 是否已登录
### im.on(options, ext)
事件监听
**Kind** : method of im
Param | Type | Description
---|---|---
options | [`Event`](https://developer.qiniu.com/IM/11901/im) | Object.<[`Event`](https://developer.qiniu.com/IM/11901/im), [`EventCallback`](https://developer.qiniu.com/IM/11901/im)>
ext | [`EventCallback`](https://developer.qiniu.com/IM/11901/im) | `undefined`
**Example**
im.on('event', (ret) => {
//do something with ret
})
// or
im.on({
eventName: (ret) => {
//do something with ret
},
...
})
### im.off(options, ext)
取消监听
**Kind** : method of im
Param | Type | Description
---|---|---
options | [`Event`](https://developer.qiniu.com/IM/11901/im) | Object.<[`Event`](https://developer.qiniu.com/IM/11901/im), [`EventCallback`](https://developer.qiniu.com/IM/11901/im)>
ext | [`EventCallback`](https://developer.qiniu.com/IM/11901/im) | `undefined`
**Example**
im.off('events', (ret) => {
//do something with ret
})
// or
im.off({
eventName: (ret) => {
//do something with ret
},
...
})
### im.logout()
退出账户
**Kind** : method of im
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,037 |
userManage | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [IM Web
文档](https://developer.qiniu.com/IM/api/8325/im-web-document) > userManage
# userManage
最近更新时间: 2022-05-24 16:45:48
## userManage
* userManage
* [.getToken()](https://developer.qiniu.com/IM/11907/usermanage)
* [.getUid()](https://developer.qiniu.com/IM/11907/usermanage)
* [.getAppid()](https://developer.qiniu.com/IM/11907/usermanage)
* [.getConversationList()](https://developer.qiniu.com/IM/11907/usermanage)
* [.asyncUpdateAvatar(params)](https://developer.qiniu.com/IM/11907/usermanage)
* [.asyncUpdateNickName(params)](https://developer.qiniu.com/IM/11907/usermanage)
* [.asyncGetProfile()](https://developer.qiniu.com/IM/11907/usermanage)
* [.asyncUpdateProfile(params)](https://developer.qiniu.com/IM/11907/usermanage)
* [.asyncGetSettings()](https://developer.qiniu.com/IM/11907/usermanage)
* [.asyncUpdateSettings(settings)](https://developer.qiniu.com/IM/11907/usermanage)
### userManage.getToken() ⇒ `string`
获取登录用户的token
**Kind** : static method of userManage
**Returns** : `string` \- 用户的token
### userManage.getUid() ⇒ `number`
获取登录用户的uid
**Kind** : static method of userManage
**Returns** : `number` \- 用户ID
### userManage.getAppid() ⇒ `string`
获取appid
**Kind** : static method of userManage
**Returns** : `string` \- APP ID
### userManage.getConversationList() ⇒ `Array.<ConversationItem>`
获取最近会话列表
**Kind** : static method of userManage
### userManage.asyncUpdateAvatar(params) ⇒ `Promise.<boolean>`
更新头像
**Kind** : static method of userManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
params | `object` | 参数
params.avatar | `string` | 头像 url
### userManage.asyncUpdateNickName(params) ⇒ `Promise.<boolean>`
更新昵称
**Kind** : static method of userManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
params | `object` | 参数
params.nick_name | `string` | 昵称
### userManage.asyncGetProfile() ⇒ `Promise.<UserProfile>`
获取用户profile
**Kind** : static method of userManage
**Returns** : Promise. \- 用户信息
### userManage.asyncUpdateProfile(params) ⇒ `Promise.<boolean>`
更新用户profile
**Kind** : static method of userManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
params | `object` |
params.description | `string` | 描述信息
params.nick_name | `string` | 昵称
params.private_info | `string` | 私有信息，仅自己可见
params.public_info | `string` | 公开信息，好友和陌生人可见
### userManage.asyncGetSettings() ⇒ `Promise.<UserSettings>`
获取用户设置信息
**Kind** : static method of userManage
**Returns** : Promise. \- 用户信息
### userManage.asyncUpdateSettings(settings) ⇒ `Promise.<boolean>`
修改用户设置
**Kind** : static method of userManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
settings | [`UserSettings`](https://developer.qiniu.com/IM/11907/usermanage) | 更新的设置
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [IM Web
文档](https://developer.qiniu.com/IM/api/8325/im-web-document) > userManage
# userManage
最近更新时间: 2022-05-24 16:45:48
## userManage
* userManage
* [.getToken()](https://developer.qiniu.com/IM/11907/usermanage)
* [.getUid()](https://developer.qiniu.com/IM/11907/usermanage)
* [.getAppid()](https://developer.qiniu.com/IM/11907/usermanage)
* [.getConversationList()](https://developer.qiniu.com/IM/11907/usermanage)
* [.asyncUpdateAvatar(params)](https://developer.qiniu.com/IM/11907/usermanage)
* [.asyncUpdateNickName(params)](https://developer.qiniu.com/IM/11907/usermanage)
* [.asyncGetProfile()](https://developer.qiniu.com/IM/11907/usermanage)
* [.asyncUpdateProfile(params)](https://developer.qiniu.com/IM/11907/usermanage)
* [.asyncGetSettings()](https://developer.qiniu.com/IM/11907/usermanage)
* [.asyncUpdateSettings(settings)](https://developer.qiniu.com/IM/11907/usermanage)
### userManage.getToken() ⇒ `string`
获取登录用户的token
**Kind** : static method of userManage
**Returns** : `string` \- 用户的token
### userManage.getUid() ⇒ `number`
获取登录用户的uid
**Kind** : static method of userManage
**Returns** : `number` \- 用户ID
### userManage.getAppid() ⇒ `string`
获取appid
**Kind** : static method of userManage
**Returns** : `string` \- APP ID
### userManage.getConversationList() ⇒ `Array.<ConversationItem>`
获取最近会话列表
**Kind** : static method of userManage
### userManage.asyncUpdateAvatar(params) ⇒ `Promise.<boolean>`
更新头像
**Kind** : static method of userManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
params | `object` | 参数
params.avatar | `string` | 头像 url
### userManage.asyncUpdateNickName(params) ⇒ `Promise.<boolean>`
更新昵称
**Kind** : static method of userManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
params | `object` | 参数
params.nick_name | `string` | 昵称
### userManage.asyncGetProfile() ⇒ `Promise.<UserProfile>`
获取用户profile
**Kind** : static method of userManage
**Returns** : Promise. \- 用户信息
### userManage.asyncUpdateProfile(params) ⇒ `Promise.<boolean>`
更新用户profile
**Kind** : static method of userManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
params | `object` |
params.description | `string` | 描述信息
params.nick_name | `string` | 昵称
params.private_info | `string` | 私有信息，仅自己可见
params.public_info | `string` | 公开信息，好友和陌生人可见
### userManage.asyncGetSettings() ⇒ `Promise.<UserSettings>`
获取用户设置信息
**Kind** : static method of userManage
**Returns** : Promise. \- 用户信息
### userManage.asyncUpdateSettings(settings) ⇒ `Promise.<boolean>`
修改用户设置
**Kind** : static method of userManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
settings | [`UserSettings`](https://developer.qiniu.com/IM/11907/usermanage) | 更新的设置
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,043 |
rosterManage | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [IM Web
文档](https://developer.qiniu.com/IM/api/8325/im-web-document) > rosterManage
# rosterManage
最近更新时间: 2022-06-17 10:54:03
## rosterManage
好友管理
* rosterManage
* [.asyncGetRosterIdList(force)](https://developer.qiniu.com/IM/11904/rostermanage)
* [.asyncGetRosterInfo(roster_id, force)](https://developer.qiniu.com/IM/11904/rostermanage)
* [.asyncRegester(opt)](https://developer.qiniu.com/IM/11904/rostermanage)
* [.asyncDeleteRoster(param)](https://developer.qiniu.com/IM/11904/rostermanage)
* [.asnycGetRosterListDetailByIds(roster_ids)](https://developer.qiniu.com/IM/11904/rostermanage)
* [.getAllRosterDetail()](https://developer.qiniu.com/IM/11904/rostermanage)
* [.asyncGetUserProfile(force)](https://developer.qiniu.com/IM/11904/rostermanage)
* [.getRosterMessageByRid(uid)](https://developer.qiniu.com/IM/11904/rostermanage)
* [.readRosterMessage(roster_id, mid)](https://developer.qiniu.com/IM/11904/rostermanage)
* [.recallMessage(uid, mid)](https://developer.qiniu.com/IM/11904/rostermanage)
* [.unreadMessage(uid, mid)](https://developer.qiniu.com/IM/11904/rostermanage)
* [.deleteMessage(uid, mid)](https://developer.qiniu.com/IM/11904/rostermanage)
* [.getRosterInfo(rid)](https://developer.qiniu.com/IM/11904/rostermanage)
* [.getUnreadCount(uid)](https://developer.qiniu.com/IM/11904/rostermanage)
* [.asyncGetApplyList(params)](https://developer.qiniu.com/IM/11904/rostermanage)
* [.asyncGetBlockedlist(params)](https://developer.qiniu.com/IM/11904/rostermanage)
* [.asyncBlockeAdd(params)](https://developer.qiniu.com/IM/11904/rostermanage)
* [.asyncBlockeRemove(params)](https://developer.qiniu.com/IM/11904/rostermanage)
* [.asyncApply(params)](https://developer.qiniu.com/IM/11904/rostermanage)
* [.asyncAccept(params)](https://developer.qiniu.com/IM/11904/rostermanage)
* [.asyncDecline(params)](https://developer.qiniu.com/IM/11904/rostermanage)
* [.asyncUpdateRosterExt(params)](https://developer.qiniu.com/IM/11904/rostermanage)
* [.asyncSearchRosterByName(params)](https://developer.qiniu.com/IM/11904/rostermanage)
* [.asyncSearchRosterById(params)](https://developer.qiniu.com/IM/11904/rostermanage)
### rosterManage.asyncGetRosterIdList(force) ⇒ `Promise.<Array.<number>>`
获取好友id列表
**Kind** : static method of rosterManage
**Returns** : `Promise.<Array.<number>>` \- 用户ID列表
Param | Type | Description
---|---|---
force | `boolean` | 是否强制从服务器拉取：true - 从服务器获取， false - 从本地存储获取
### rosterManage.asyncGetRosterInfo(roster_id, force) ⇒ `Promise.<RosterItem>`
获取好友信息
**Kind** : static method of rosterManage
**Returns** : Promise. \- 好友信息
Param | Type | Description
---|---|---
roster_id | `number` | 好友ID
force | `boolean` | 是否强制从服务器拉取： true - 从服务器拉取， false - 优先从本地存储获取
### rosterManage.asyncRegester(opt) ⇒ `Promise.<UserSettings>`
用户注册
**Kind** : static method of rosterManage
**Returns** : Promise. \- 用户设置
Param | Type | Description
---|---|---
opt | `object` | 用户信息
opt.username | `string` | 用户名
opt.password | `string` | 密码
### rosterManage.asyncDeleteRoster(param) ⇒ `Promise.<boolean>`
删除好友
**Kind** : static method of rosterManage
**Returns** : `Promise.<boolean>` \- 请求结果
Param | Type | Description
---|---|---
param | `object` | 参数
param.user_id | `number` | 好友的用户ID
### rosterManage.asnycGetRosterListDetailByIds(roster_ids) ⇒
`Promise.<Array.<module:types~RosterItem>>`
根据id列表获取用户详细信息
**Kind** : static method of rosterManage
**Returns** : `Promise.<Array.<module:types~RosterItem>>` \- 用户详细信息列表
Param | Type | Description
---|---|---
roster_ids | `Array.<number>` | 用户ID列表
### rosterManage.getAllRosterDetail() ⇒ `Array.<RosterItem>`
获取缓存的所有用户详细信息
**Kind** : static method of rosterManage
**Returns** : `Array.<RosterItem>` \- 用户详细信息列表
### rosterManage.asyncGetUserProfile(force) ⇒ `Promise.<UserProfile>`
获取自己的用户信息
**Kind** : static method of rosterManage
**Returns** : `Promise.<UserProfile>` \- 用户信息
Param | Type | Description
---|---|---
force | `boolean` | 是否强制从服务器拉取： true - 从服务器拉取， false - 优先从本地存储获取
### rosterManage.getRosterMessageByRid(uid) ⇒ `Array.<Meta>`
根据会话ID获取聊天消息
**Kind** : static method of rosterManage
**Returns** : `Array.<Meta>` \- 聊天消息列表
Param | Type | Description
---|---|---
uid | `number` | 会话ID
### rosterManage.readRosterMessage(roster_id, mid)
修改消息状态为已读
**Kind** : static method of rosterManage
Param | Type | Description
---|---|---
roster_id | `number` | 会话ID
mid | `number` | 消息ID
### rosterManage.recallMessage(uid, mid)
撤回消息，只能撤回5分钟内的
**Kind** : static method of rosterManage
Param | Type | Description
---|---|---
uid | `number` | 会话ID
mid | `number` | 消息ID
### rosterManage.unreadMessage(uid, mid)
设置消息成未读
**Kind** : static method of rosterManage
Param | Type | Description
---|---|---
uid | `number` | 会话ID
mid | `number` | 消息ID
### rosterManage.deleteMessage(uid, mid)
删除消息
**Kind** : static method of rosterManage
Param | Type | Description
---|---|---
uid | `number` | 会话ID
mid | `number` | 消息ID
### rosterManage.getRosterInfo(rid) ⇒ `RosterItem`
获取好友信息
**Kind** : static method of rosterManage
**Returns** : `RosterItem` \- 好友信息
Param | Type | Description
---|---|---
rid | `number` | 好友ID
### rosterManage.getUnreadCount(uid) ⇒ `number`
获取指定会话的未读数
**Kind** : static method of rosterManage
**Returns** : `number` \- 未读数
Param | Type | Description
---|---|---
uid | `number` | 会话ID
### rosterManage.asyncGetApplyList(params) ⇒
`Promise.<Array.<module:types~RosterApplication>>`
获取好友申请列表
**Kind** : static method of rosterManage
**Returns** : `Promise.<Array.<module:types~RosterApplication>>` \- 好友申请列表
Param | Type | Description
---|---|---
params | `object` | 参数
params.cursor | `number` | 从哪开始获取：可以传空字符串表示从头开始取
### rosterManage.asyncGetBlockedlist(params) ⇒ `Promise.<Array.<number>>`
获取黑名单
**Kind** : static method of rosterManage
**Returns** : `Promise.<Array.<number>>` \- 用户ID列表
Param | Type | Description
---|---|---
params | `object` | 参数：空对象
### rosterManage.asyncBlockeAdd(params) ⇒ `Promise.<boolean>`
加入黑名单
**Kind** : static method of rosterManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
params | `object` | 参数
params.user_id | `number` | 用户ID
### rosterManage.asyncBlockeRemove(params) ⇒ `Promise.<boolean>`
移除黑名单
**Kind** : static method of rosterManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
params | `object` | 参数
params.user_id | `number` | 用户ID
### rosterManage.asyncApply(params) ⇒ `Promise.<boolean>`
请求加为好友
**Kind** : static method of rosterManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
params | `object` | 参数
params.user_id | `number` | 用户ID
params.alias | `string` | 备注
### rosterManage.asyncAccept(params) ⇒ `Promise.<boolean>`
通过好友申请
**Kind** : static method of rosterManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
params | `object` | 参数
params.user_id | `number` | 用户ID
### rosterManage.asyncDecline(params) ⇒ `Promise.<boolean>`
拒绝好友申请
**Kind** : static method of rosterManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
params | `object` | 参数
params.user_id | `number` | 用户ID
### rosterManage.asyncUpdateRosterExt(params) ⇒ `Promise.<boolean>`
修改好友扩展字段
**Kind** : static method of rosterManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
params | `object` | 参数
params.user_id | `number` | 用户ID
params.ext | `string` | 扩展字段
### rosterManage.asyncSearchRosterByName(params) ⇒ `Promise.<RosterItem>`
按名称搜索用户
**Kind** : static method of rosterManage
**Returns** : `Promise.<RosterItem>` \- 用户信息
Param | Type | Description
---|---|---
params | `object` | 参数
params.username | `string` | 用户名
### rosterManage.asyncSearchRosterById(params) ⇒ `Promise.<RosterItem>`
按ID搜索用户
**Kind** : static method of rosterManage
**Returns** : `Promise.<RosterItem>` \- 用户信息
Param | Type | Description
---|---|---
params | `object` | 参数
params.user_id | `number` | 用户ID
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [IM Web
文档](https://developer.qiniu.com/IM/api/8325/im-web-document) > rosterManage
# rosterManage
最近更新时间: 2022-06-17 10:54:03
## rosterManage
好友管理
* rosterManage
* [.asyncGetRosterIdList(force)](https://developer.qiniu.com/IM/11904/rostermanage)
* [.asyncGetRosterInfo(roster_id, force)](https://developer.qiniu.com/IM/11904/rostermanage)
* [.asyncRegester(opt)](https://developer.qiniu.com/IM/11904/rostermanage)
* [.asyncDeleteRoster(param)](https://developer.qiniu.com/IM/11904/rostermanage)
* [.asnycGetRosterListDetailByIds(roster_ids)](https://developer.qiniu.com/IM/11904/rostermanage)
* [.getAllRosterDetail()](https://developer.qiniu.com/IM/11904/rostermanage)
* [.asyncGetUserProfile(force)](https://developer.qiniu.com/IM/11904/rostermanage)
* [.getRosterMessageByRid(uid)](https://developer.qiniu.com/IM/11904/rostermanage)
* [.readRosterMessage(roster_id, mid)](https://developer.qiniu.com/IM/11904/rostermanage)
* [.recallMessage(uid, mid)](https://developer.qiniu.com/IM/11904/rostermanage)
* [.unreadMessage(uid, mid)](https://developer.qiniu.com/IM/11904/rostermanage)
* [.deleteMessage(uid, mid)](https://developer.qiniu.com/IM/11904/rostermanage)
* [.getRosterInfo(rid)](https://developer.qiniu.com/IM/11904/rostermanage)
* [.getUnreadCount(uid)](https://developer.qiniu.com/IM/11904/rostermanage)
* [.asyncGetApplyList(params)](https://developer.qiniu.com/IM/11904/rostermanage)
* [.asyncGetBlockedlist(params)](https://developer.qiniu.com/IM/11904/rostermanage)
* [.asyncBlockeAdd(params)](https://developer.qiniu.com/IM/11904/rostermanage)
* [.asyncBlockeRemove(params)](https://developer.qiniu.com/IM/11904/rostermanage)
* [.asyncApply(params)](https://developer.qiniu.com/IM/11904/rostermanage)
* [.asyncAccept(params)](https://developer.qiniu.com/IM/11904/rostermanage)
* [.asyncDecline(params)](https://developer.qiniu.com/IM/11904/rostermanage)
* [.asyncUpdateRosterExt(params)](https://developer.qiniu.com/IM/11904/rostermanage)
* [.asyncSearchRosterByName(params)](https://developer.qiniu.com/IM/11904/rostermanage)
* [.asyncSearchRosterById(params)](https://developer.qiniu.com/IM/11904/rostermanage)
### rosterManage.asyncGetRosterIdList(force) ⇒ `Promise.<Array.<number>>`
获取好友id列表
**Kind** : static method of rosterManage
**Returns** : `Promise.<Array.<number>>` \- 用户ID列表
Param | Type | Description
---|---|---
force | `boolean` | 是否强制从服务器拉取：true - 从服务器获取， false - 从本地存储获取
### rosterManage.asyncGetRosterInfo(roster_id, force) ⇒ `Promise.<RosterItem>`
获取好友信息
**Kind** : static method of rosterManage
**Returns** : Promise. \- 好友信息
Param | Type | Description
---|---|---
roster_id | `number` | 好友ID
force | `boolean` | 是否强制从服务器拉取： true - 从服务器拉取， false - 优先从本地存储获取
### rosterManage.asyncRegester(opt) ⇒ `Promise.<UserSettings>`
用户注册
**Kind** : static method of rosterManage
**Returns** : Promise. \- 用户设置
Param | Type | Description
---|---|---
opt | `object` | 用户信息
opt.username | `string` | 用户名
opt.password | `string` | 密码
### rosterManage.asyncDeleteRoster(param) ⇒ `Promise.<boolean>`
删除好友
**Kind** : static method of rosterManage
**Returns** : `Promise.<boolean>` \- 请求结果
Param | Type | Description
---|---|---
param | `object` | 参数
param.user_id | `number` | 好友的用户ID
### rosterManage.asnycGetRosterListDetailByIds(roster_ids) ⇒
`Promise.<Array.<module:types~RosterItem>>`
根据id列表获取用户详细信息
**Kind** : static method of rosterManage
**Returns** : `Promise.<Array.<module:types~RosterItem>>` \- 用户详细信息列表
Param | Type | Description
---|---|---
roster_ids | `Array.<number>` | 用户ID列表
### rosterManage.getAllRosterDetail() ⇒ `Array.<RosterItem>`
获取缓存的所有用户详细信息
**Kind** : static method of rosterManage
**Returns** : `Array.<RosterItem>` \- 用户详细信息列表
### rosterManage.asyncGetUserProfile(force) ⇒ `Promise.<UserProfile>`
获取自己的用户信息
**Kind** : static method of rosterManage
**Returns** : `Promise.<UserProfile>` \- 用户信息
Param | Type | Description
---|---|---
force | `boolean` | 是否强制从服务器拉取： true - 从服务器拉取， false - 优先从本地存储获取
### rosterManage.getRosterMessageByRid(uid) ⇒ `Array.<Meta>`
根据会话ID获取聊天消息
**Kind** : static method of rosterManage
**Returns** : `Array.<Meta>` \- 聊天消息列表
Param | Type | Description
---|---|---
uid | `number` | 会话ID
### rosterManage.readRosterMessage(roster_id, mid)
修改消息状态为已读
**Kind** : static method of rosterManage
Param | Type | Description
---|---|---
roster_id | `number` | 会话ID
mid | `number` | 消息ID
### rosterManage.recallMessage(uid, mid)
撤回消息，只能撤回5分钟内的
**Kind** : static method of rosterManage
Param | Type | Description
---|---|---
uid | `number` | 会话ID
mid | `number` | 消息ID
### rosterManage.unreadMessage(uid, mid)
设置消息成未读
**Kind** : static method of rosterManage
Param | Type | Description
---|---|---
uid | `number` | 会话ID
mid | `number` | 消息ID
### rosterManage.deleteMessage(uid, mid)
删除消息
**Kind** : static method of rosterManage
Param | Type | Description
---|---|---
uid | `number` | 会话ID
mid | `number` | 消息ID
### rosterManage.getRosterInfo(rid) ⇒ `RosterItem`
获取好友信息
**Kind** : static method of rosterManage
**Returns** : `RosterItem` \- 好友信息
Param | Type | Description
---|---|---
rid | `number` | 好友ID
### rosterManage.getUnreadCount(uid) ⇒ `number`
获取指定会话的未读数
**Kind** : static method of rosterManage
**Returns** : `number` \- 未读数
Param | Type | Description
---|---|---
uid | `number` | 会话ID
### rosterManage.asyncGetApplyList(params) ⇒
`Promise.<Array.<module:types~RosterApplication>>`
获取好友申请列表
**Kind** : static method of rosterManage
**Returns** : `Promise.<Array.<module:types~RosterApplication>>` \- 好友申请列表
Param | Type | Description
---|---|---
params | `object` | 参数
params.cursor | `number` | 从哪开始获取：可以传空字符串表示从头开始取
### rosterManage.asyncGetBlockedlist(params) ⇒ `Promise.<Array.<number>>`
获取黑名单
**Kind** : static method of rosterManage
**Returns** : `Promise.<Array.<number>>` \- 用户ID列表
Param | Type | Description
---|---|---
params | `object` | 参数：空对象
### rosterManage.asyncBlockeAdd(params) ⇒ `Promise.<boolean>`
加入黑名单
**Kind** : static method of rosterManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
params | `object` | 参数
params.user_id | `number` | 用户ID
### rosterManage.asyncBlockeRemove(params) ⇒ `Promise.<boolean>`
移除黑名单
**Kind** : static method of rosterManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
params | `object` | 参数
params.user_id | `number` | 用户ID
### rosterManage.asyncApply(params) ⇒ `Promise.<boolean>`
请求加为好友
**Kind** : static method of rosterManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
params | `object` | 参数
params.user_id | `number` | 用户ID
params.alias | `string` | 备注
### rosterManage.asyncAccept(params) ⇒ `Promise.<boolean>`
通过好友申请
**Kind** : static method of rosterManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
params | `object` | 参数
params.user_id | `number` | 用户ID
### rosterManage.asyncDecline(params) ⇒ `Promise.<boolean>`
拒绝好友申请
**Kind** : static method of rosterManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
params | `object` | 参数
params.user_id | `number` | 用户ID
### rosterManage.asyncUpdateRosterExt(params) ⇒ `Promise.<boolean>`
修改好友扩展字段
**Kind** : static method of rosterManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
params | `object` | 参数
params.user_id | `number` | 用户ID
params.ext | `string` | 扩展字段
### rosterManage.asyncSearchRosterByName(params) ⇒ `Promise.<RosterItem>`
按名称搜索用户
**Kind** : static method of rosterManage
**Returns** : `Promise.<RosterItem>` \- 用户信息
Param | Type | Description
---|---|---
params | `object` | 参数
params.username | `string` | 用户名
### rosterManage.asyncSearchRosterById(params) ⇒ `Promise.<RosterItem>`
按ID搜索用户
**Kind** : static method of rosterManage
**Returns** : `Promise.<RosterItem>` \- 用户信息
Param | Type | Description
---|---|---
params | `object` | 参数
params.user_id | `number` | 用户ID
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,049 |
groupManage | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [IM Web
文档](https://developer.qiniu.com/IM/api/8325/im-web-document) > groupManage
# groupManage
最近更新时间: 2022-05-24 16:45:29
## groupManage
群管理
* groupManage
* [.asyncGetGroupInfo(group_id, froce)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncGetJoinedGroups(froce)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.openGroup(group_id)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.getAllGroupDetail()](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncGetGroupMembers(group_id)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.getGroupMembers(group_id)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncGetGroupListDetail(gids)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.getGruopMessage(gid)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncGetInfo(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncGetMemberList(param)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.readGroupMessage(group_id, mid)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.recallMessage(uid, mid)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.getUnreadCount(gid)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncGetAdminList(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncAdminAdd(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncAdminRemove(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncGetAnouncementById(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncAnouncementDelete(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncAnnouncementEdit(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncGetAnnouncementList(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncCreate(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncDestroy(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncUpdateAvatar(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncUpdateDescription(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncUpdateExt(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncUpdateName(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncGroupMsgMutemode(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncGroupBannedList(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncGroupBab(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncGroupUnban(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncGetSettings(group_id)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncUpdateAllowMemberInvitation(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncUpdateAllowMemberModify(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncUpdateEnableReadack(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncUpdateHistoryVisible(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncUpdateRequireadminapproval(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncBanAll(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncUnBanAll(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncOwnerTransfer(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncGetUserJoined(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncApply(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncApplyHandle(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncGroupBockedlist(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncGroupBlock(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncGroupUnblock(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncKick(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncGetInvitationList()](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncInvite(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncInviteHandle(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncGetMemberDisplayName(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncLeave(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncUpdateDisplayName(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asncGetApplicationList(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncGetFileList(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncFileDelete(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncFileUpload(params)](https://developer.qiniu.com/IM/11903/groupmanage)
### groupManage.asyncGetGroupInfo(group_id, froce) ⇒
`Promise.<GroupInfoAndSettings>`
获取群信息
**Kind** : static method of groupManage
**Returns** : `Promise.<GroupInfoAndSettings>` \- 群信息
Param | Type | Description
---|---|---
group_id | `number` | 群ID
froce | `boolean` | 是否强制从服务器拉取： true - 从服务器拉取， false - 优先从本地存储获取
### groupManage.asyncGetJoinedGroups(froce) ⇒ `Promise.<Array.<number>>`
获取加入的群组
**Kind** : static method of groupManage
**Returns** : `Promise.<Array.<number>>` \- 群组ID列表
Param | Type | Description
---|---|---
froce | `boolean` | 是否强制从服务器拉取： true - 从服务器拉取， false - 优先从本地存储获取
### groupManage.openGroup(group_id)
打开群组， 此方法会准备群组聊天界面的一些必备信息。
**Kind** : static method of groupManage
Param | Type | Description
---|---|---
group_id | `number` | 群组ID
### groupManage.getAllGroupDetail() ⇒ `Object.<number,
module:types~GroupInfoAndSettings>`
获取缓存的所有群组详情
**Kind** : static method of groupManage
**Returns** : `Object.<number, module:types~GroupInfoAndSettings>` \- 群组详情
### groupManage.asyncGetGroupMembers(group_id) ⇒
`Promise.<Array.<module:types~GroupMember>>`
获取群组成员（异步）
**Kind** : static method of groupManage
**Returns** : `Promise.<Array.<module:types~GroupMember>>` \- 群成员列表
Param | Type | Description
---|---|---
group_id | `number` | 群组ID
### groupManage.getGroupMembers(group_id) ⇒ `Array.<GroupMember>`
获取群组成员（同步）
**Kind** : static method of groupManage
**Returns** : `Array.<GroupMember>` \- 群成员列表
Param | Type | Description
---|---|---
group_id | `number` | 群组ID
### groupManage.asyncGetGroupListDetail(gids) ⇒
`Promise.<Array.<module:types~BriefGroupInfoAndSettings>>`
按id获取群组详情
**Kind** : static method of groupManage
**Returns** : `Promise.<Array.<module:types~BriefGroupInfoAndSettings>>` \-
群组详情列表
Param | Type | Description
---|---|---
gids | `Array.<number>` | 群组ID列表
### groupManage.getGruopMessage(gid) ⇒ `Array.<Meta>`
获取群消息
**Kind** : static method of groupManage
**Returns** : `Array.<Meta>` \- 群消息列表
Param | Type | Description
---|---|---
gid | `number` | 群ID
### groupManage.asyncGetInfo(params) ⇒ `Promise.<GroupInfoAndSettings>`
获取群组详情
**Kind** : static method of groupManage
**Returns** : `Promise.<GroupInfoAndSettings>` \- 群组详情
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
### groupManage.asyncGetMemberList(param) ⇒
`Promise.<Array.<module:types~GroupMember>>`
获取群成员列表
**Kind** : static method of groupManage
**Returns** : `Promise.<Array.<module:types~GroupMember>>` \- 群成员列表
Param | Type | Description
---|---|---
param | `object` | 参数
params.group_id | `number` | 群组ID
### groupManage.readGroupMessage(group_id, mid)
将群消息设置已读
**Kind** : static method of groupManage
Param | Type | Description
---|---|---
group_id | `number` | 群组ID
mid | `number` | 消息ID
### groupManage.recallMessage(uid, mid)
撤回消息
**Kind** : static method of groupManage
Param | Type | Description
---|---|---
uid | `number` | 群组ID
mid | `number` | 消息ID
### groupManage.getUnreadCount(gid) ⇒ `number`
获取群未读消息数
**Kind** : static method of groupManage
**Returns** : `number` \- 未读消息数
Param | Type | Description
---|---|---
gid | `number` | 群组ID
### groupManage.asyncGetAdminList(params) ⇒
`Promise.<Array.<module:types~GroupMember>>`
获取群管理员列表
**Kind** : static method of groupManage
**Returns** : `Promise.<Array.<module:types~GroupMember>>` \- 群管理员列表
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
### groupManage.asyncAdminAdd(params) ⇒
`Promise.<Array.<module:types~GroupUserRelationResponse>>`
群添加管理员
**Kind** : static method of groupManage
**Returns** : `Promise.<Array.<module:types~GroupUserRelationResponse>>` \-
结果列表
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.user_list | `Array.<number>` | 群成员列表
### groupManage.asyncAdminRemove(params) ⇒
`Promise.<Array.<module:types~GroupUserRelationResponse>>`
移除管理员
**Kind** : static method of groupManage
**Returns** : `Promise.<Array.<module:types~GroupUserRelationResponse>>` \-
结果列表
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.user_list | `Array.<number>` | 群成员列表
### groupManage.asyncGetAnouncementById(params) ⇒
`Promise.<GroupAnnouncement>`
获取群公告详情
**Kind** : static method of groupManage
**Returns** : `Promise.<GroupAnnouncement>` \- 群公告详情
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.announcement_id | `Array.<number>` | 公告ID
### groupManage.asyncAnouncementDelete(params) ⇒ `Promise.<boolean>`
删除群公告
**Kind** : static method of groupManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.announcement_id | `Array.<number>` | 公告ID
### groupManage.asyncAnnouncementEdit(params) ⇒ `Promise.<GroupAnnouncement>`
编辑群公告
**Kind** : static method of groupManage
**Returns** : `Promise.<GroupAnnouncement>` \- 群公告详情
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.title | `string` | 公告标题
params.content | `string` | 公告内容
### groupManage.asyncGetAnnouncementList(params) ⇒
`Promise.<Array.<module:types~GroupAnnouncement>>`
群公告列表
**Kind** : static method of groupManage
**Returns** : `Promise.<Array.<module:types~GroupAnnouncement>>` \- 群公告详情列表
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
### groupManage.asyncCreate(params) ⇒ `Promise.<GroupInfoAndSettings>`
创建群组
**Kind** : static method of groupManage
**Returns** : `Promise.<GroupInfoAndSettings>` \- 群详情
Param | Type | Description
---|---|---
params | [`GroupInfoRequest`](https://developer.qiniu.com/IM/11903/groupmanage) | 请求参数
### groupManage.asyncDestroy(params) ⇒ `Promise.<boolean>`
解散群组
**Kind** : static method of groupManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
### groupManage.asyncUpdateAvatar(params) ⇒ `Promise.<boolean>`
更新群头像
**Kind** : static method of groupManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.value | `string` | 头像地址
### groupManage.asyncUpdateDescription(params) ⇒ `Promise.<boolean>`
更新群描述
**Kind** : static method of groupManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.value | `string` | 群组描述
### groupManage.asyncUpdateExt(params) ⇒ `Promise.<boolean>`
更新群扩展信息
**Kind** : static method of groupManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.value | `string` | 扩展信息
### groupManage.asyncUpdateName(params) ⇒ `Promise.<boolean>`
更新群名称
**Kind** : static method of groupManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.value | `string` | 群名称
### groupManage.asyncGroupMsgMutemode(params) ⇒ `Promise.<boolean>`
设置群消息免打扰情况
**Kind** : static method of groupManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.msg_mute_mode | `number` | 群消息屏蔽模式: 0 - 表示不屏蔽, 1 - 表示屏蔽本地消息通知, 2 - 表示屏蔽消息，不接收消息
### groupManage.asyncGroupBannedList(params) ⇒
`Promise.<Array.<module:types~GroupMemberBanned>>`
获取群禁言列表
**Kind** : static method of groupManage
**Returns** : `Promise.<Array.<module:types~GroupMemberBanned>>` \- 禁言成员列表
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
### groupManage.asyncGroupBab(params) ⇒
`Promise.<Array.<module:types~GroupUserRelationResponse>>`
禁言群成员
**Kind** : static method of groupManage
**Returns** : `Promise.<Array.<module:types~GroupUserRelationResponse>>` \-
请求结果列表
Param | Type | Description
---|---|---
params | [`GroupBannedMemberRequest`](https://developer.qiniu.com/IM/11903/groupmanage) | 请求参数
### groupManage.asyncGroupUnban(params) ⇒
`Promise.<Array.<module:types~GroupUserRelationResponse>>`
解除成员禁言
**Kind** : static method of groupManage
**Returns** : `Promise.<Array.<module:types~GroupUserRelationResponse>>` \-
请求结果列表
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.user_list | `Array.<number>` | 群成员列表
### groupManage.asyncGetSettings(group_id) ⇒ `Promise.<GroupInfoAndSettings>`
获取群设置
**Kind** : static method of groupManage
**Returns** : `Promise.<GroupInfoAndSettings>` \- 群设置
Param | Type | Description
---|---|---
group_id | `number` | 群ID
### groupManage.asyncUpdateAllowMemberInvitation(params) ⇒ `Promise.<boolean>`
设置群成员是否可以邀请
**Kind** : static method of groupManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.value | `boolean` | 群成员邀请设置: false - 不允许邀请, true - 允许邀请(默认)
### groupManage.asyncUpdateAllowMemberModify(params) ⇒ `Promise.<boolean>`
设置群成员是否可以修改群信息
**Kind** : static method of groupManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.value | `boolean` | 群成员修改群信息设置: false - 群成员不能修改群信息(默认), true - 群成员可以修改群信息
### groupManage.asyncUpdateEnableReadack(params) ⇒ `Promise.<boolean>`
设置群是否开启已读模式
**Kind** : static method of groupManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.value | `boolean` | 是否开启群消息已读功能: false - 不开启, true - 开启
### groupManage.asyncUpdateHistoryVisible(params) ⇒ `Promise.<boolean>`
设置群历史是否可见
**Kind** : static method of groupManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.value | `boolean` | 设置群历史是否可见: false - 不可见, true - 可见
### groupManage.asyncUpdateRequireadminapproval(params) ⇒ `Promise.<boolean>`
设置入群是否需要申请
**Kind** : static method of groupManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.apply_approval | `boolean` | 入群申请审批设置, 0:同意所有申请 1:需要管理员确认 2:拒绝所有申请
### groupManage.asyncBanAll(params) ⇒ `Promise.<GroupBanAllResponse>`
全员禁言，只允许管理员发消息
**Kind** : static method of groupManage
**Returns** : `Promise.<GroupBanAllResponse>` \- 结果
Param | Type | Description
---|---|---
params | `object` | 参数
params.duration | `number` | 禁言时长，单位为分钟,int64
params.group_id | `number` | 群id,int64
### groupManage.asyncUnBanAll(params) ⇒ `Promise.<boolean>`
取消全员禁言
**Kind** : static method of groupManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群id,int64
### groupManage.asyncOwnerTransfer(params) ⇒
`Promise.<GroupUserRelationResponse>`
更换群主
**Kind** : static method of groupManage
**Returns** : `Promise.<GroupUserRelationResponse>` \- 结果
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.new_owner | `number` | 新群主的用户ID
### groupManage.asyncGetUserJoined(params) ⇒ `Promise.<Array.<number>>`
获取用户的群组列表
**Kind** : static method of groupManage
**Returns** : `Promise.<Array.<number>>` \- 群ID的列表
Param | Type | Description
---|---|---
params | `object` | 参数, 空对象
### groupManage.asyncApply(params) ⇒ `Promise.<GroupUserRelationResponse>`
申请加入群
**Kind** : static method of groupManage
**Returns** : `Promise.<GroupUserRelationResponse>` \- 结果
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.reason | `string` | 申请入群原因
### groupManage.asyncApplyHandle(params) ⇒
`Promise.<GroupUserRelationResponse>`
处理用户的入群申请
**Kind** : static method of groupManage
**Returns** : `Promise.<GroupUserRelationResponse>` \- 结果
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.user_id | `number` | 用户ID
params.approval | `boolean` | 审批结果：true为同意，false为拒绝
### groupManage.asyncGroupBockedlist(params) ⇒
`Promise.<Array.<module:types~GroupBlockedListItem>>`
获取群黑名单
**Kind** : static method of groupManage
**Returns** : `Promise.<Array.<module:types~GroupBlockedListItem>>` \- 群黑名单列表
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
### groupManage.asyncGroupBlock(params) ⇒
`Promise.<Array.<module:types~GroupUserRelationResponse>>`
将成员加入黑名单
**Kind** : static method of groupManage
**Returns** : `Promise.<Array.<module:types~GroupUserRelationResponse>>` \-
结果列表
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.user_list | `Array.<number>` | 群成员列表
### groupManage.asyncGroupUnblock(params) ⇒
`Promise.<Array.<module:types~GroupUserRelationResponse>>`
解除黑名单
**Kind** : static method of groupManage
**Returns** : `Promise.<Array.<module:types~GroupUserRelationResponse>>` \-
结果列表
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.user_list | `Array.<number>` | 群成员列表
### groupManage.asyncKick(params) ⇒
`Promise.<Array.<module:types~GroupUserRelationResponse>>`
踢出群组
**Kind** : static method of groupManage
**Returns** : `Promise.<Array.<module:types~GroupUserRelationResponse>>` \-
结果列表
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.user_list | `Array.<number>` | 群成员列表
### groupManage.asyncGetInvitationList() ⇒
`Promise.<Array.<module:types~GroupInvitation>>`
获取群邀请列表
**Kind** : static method of groupManage
**Returns** : `Promise.<Array.<module:types~GroupInvitation>>` \- 群邀请列表
### groupManage.asyncInvite(params) ⇒
`Promise.<Array.<module:types~GroupUserRelationResponse>>`
邀请成员加入群
**Kind** : static method of groupManage
**Returns** : `Promise.<Array.<module:types~GroupUserRelationResponse>>` \-
结果列表
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.user_list | `Array.<number>` | 群成员列表
### groupManage.asyncInviteHandle(params) ⇒ `Promise.<boolean>`
处理群邀请
**Kind** : static method of groupManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.user_id | `number` | 用户ID
params.approval | `boolean` | 审批结果：true为同意，false为拒绝
### groupManage.asyncGetMemberDisplayName(params) ⇒
`Promise.<Array.<module:types~GroupMember>>`
批量获取群成员的群名片
**Kind** : static method of groupManage
**Returns** : `Promise.<Array.<module:types~GroupMember>>` \- 群成员列表
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.user_list | `Array.<number>` | 群成员列表
### groupManage.asyncLeave(params) ⇒ `Promise.<boolean>`
退出群
**Kind** : static method of groupManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
### groupManage.asyncUpdateDisplayName(params) ⇒ `Promise.<boolean>`
修改群名片
**Kind** : static method of groupManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.value | `string` | 新名片
### groupManage.asncGetApplicationList(params) ⇒
`Promise.<Array.<module:types~GroupApplication>>`
获取群申请列表
**Kind** : static method of groupManage
**Returns** : `Promise.<Array.<module:types~GroupApplication>>` \- 群申请列表
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_list | `Array.<number>` | 群列表
### groupManage.asyncGetFileList(params) ⇒
`Promise.<Array.<module:types~GroupSharedFile>>`
获取群文件列表
**Kind** : static method of groupManage
**Returns** : `Promise.<Array.<module:types~GroupSharedFile>>` \- 群文件列表
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
### groupManage.asyncFileDelete(params) ⇒
`Promise.<Array.<module:types~GroupSharedFileResponse>>`
删除群文件
**Kind** : static method of groupManage
**Returns** : `Promise.<Array.<module:types~GroupSharedFileResponse>>` \- 结果列表
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.file_list | `Array.<number>` | 文件ID列表
### groupManage.asyncFileUpload(params) ⇒
`Promise.<Array.<module:types~GroupSharedFile>>`
上传群文件
**Kind** : static method of groupManage
**Returns** : `Promise.<Array.<module:types~GroupSharedFile>>` \- 群文件列表
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群id,int64
params.name | `string` | 文件名称
params.size | `number` | 文件大小,int64
params.type | `string` | 文件类型
params.url | `string` | 文件url
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [IM Web
文档](https://developer.qiniu.com/IM/api/8325/im-web-document) > groupManage
# groupManage
最近更新时间: 2022-05-24 16:45:29
## groupManage
群管理
* groupManage
* [.asyncGetGroupInfo(group_id, froce)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncGetJoinedGroups(froce)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.openGroup(group_id)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.getAllGroupDetail()](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncGetGroupMembers(group_id)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.getGroupMembers(group_id)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncGetGroupListDetail(gids)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.getGruopMessage(gid)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncGetInfo(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncGetMemberList(param)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.readGroupMessage(group_id, mid)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.recallMessage(uid, mid)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.getUnreadCount(gid)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncGetAdminList(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncAdminAdd(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncAdminRemove(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncGetAnouncementById(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncAnouncementDelete(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncAnnouncementEdit(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncGetAnnouncementList(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncCreate(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncDestroy(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncUpdateAvatar(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncUpdateDescription(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncUpdateExt(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncUpdateName(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncGroupMsgMutemode(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncGroupBannedList(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncGroupBab(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncGroupUnban(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncGetSettings(group_id)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncUpdateAllowMemberInvitation(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncUpdateAllowMemberModify(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncUpdateEnableReadack(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncUpdateHistoryVisible(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncUpdateRequireadminapproval(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncBanAll(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncUnBanAll(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncOwnerTransfer(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncGetUserJoined(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncApply(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncApplyHandle(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncGroupBockedlist(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncGroupBlock(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncGroupUnblock(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncKick(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncGetInvitationList()](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncInvite(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncInviteHandle(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncGetMemberDisplayName(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncLeave(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncUpdateDisplayName(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asncGetApplicationList(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncGetFileList(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncFileDelete(params)](https://developer.qiniu.com/IM/11903/groupmanage)
* [.asyncFileUpload(params)](https://developer.qiniu.com/IM/11903/groupmanage)
### groupManage.asyncGetGroupInfo(group_id, froce) ⇒
`Promise.<GroupInfoAndSettings>`
获取群信息
**Kind** : static method of groupManage
**Returns** : `Promise.<GroupInfoAndSettings>` \- 群信息
Param | Type | Description
---|---|---
group_id | `number` | 群ID
froce | `boolean` | 是否强制从服务器拉取： true - 从服务器拉取， false - 优先从本地存储获取
### groupManage.asyncGetJoinedGroups(froce) ⇒ `Promise.<Array.<number>>`
获取加入的群组
**Kind** : static method of groupManage
**Returns** : `Promise.<Array.<number>>` \- 群组ID列表
Param | Type | Description
---|---|---
froce | `boolean` | 是否强制从服务器拉取： true - 从服务器拉取， false - 优先从本地存储获取
### groupManage.openGroup(group_id)
打开群组， 此方法会准备群组聊天界面的一些必备信息。
**Kind** : static method of groupManage
Param | Type | Description
---|---|---
group_id | `number` | 群组ID
### groupManage.getAllGroupDetail() ⇒ `Object.<number,
module:types~GroupInfoAndSettings>`
获取缓存的所有群组详情
**Kind** : static method of groupManage
**Returns** : `Object.<number, module:types~GroupInfoAndSettings>` \- 群组详情
### groupManage.asyncGetGroupMembers(group_id) ⇒
`Promise.<Array.<module:types~GroupMember>>`
获取群组成员（异步）
**Kind** : static method of groupManage
**Returns** : `Promise.<Array.<module:types~GroupMember>>` \- 群成员列表
Param | Type | Description
---|---|---
group_id | `number` | 群组ID
### groupManage.getGroupMembers(group_id) ⇒ `Array.<GroupMember>`
获取群组成员（同步）
**Kind** : static method of groupManage
**Returns** : `Array.<GroupMember>` \- 群成员列表
Param | Type | Description
---|---|---
group_id | `number` | 群组ID
### groupManage.asyncGetGroupListDetail(gids) ⇒
`Promise.<Array.<module:types~BriefGroupInfoAndSettings>>`
按id获取群组详情
**Kind** : static method of groupManage
**Returns** : `Promise.<Array.<module:types~BriefGroupInfoAndSettings>>` \-
群组详情列表
Param | Type | Description
---|---|---
gids | `Array.<number>` | 群组ID列表
### groupManage.getGruopMessage(gid) ⇒ `Array.<Meta>`
获取群消息
**Kind** : static method of groupManage
**Returns** : `Array.<Meta>` \- 群消息列表
Param | Type | Description
---|---|---
gid | `number` | 群ID
### groupManage.asyncGetInfo(params) ⇒ `Promise.<GroupInfoAndSettings>`
获取群组详情
**Kind** : static method of groupManage
**Returns** : `Promise.<GroupInfoAndSettings>` \- 群组详情
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
### groupManage.asyncGetMemberList(param) ⇒
`Promise.<Array.<module:types~GroupMember>>`
获取群成员列表
**Kind** : static method of groupManage
**Returns** : `Promise.<Array.<module:types~GroupMember>>` \- 群成员列表
Param | Type | Description
---|---|---
param | `object` | 参数
params.group_id | `number` | 群组ID
### groupManage.readGroupMessage(group_id, mid)
将群消息设置已读
**Kind** : static method of groupManage
Param | Type | Description
---|---|---
group_id | `number` | 群组ID
mid | `number` | 消息ID
### groupManage.recallMessage(uid, mid)
撤回消息
**Kind** : static method of groupManage
Param | Type | Description
---|---|---
uid | `number` | 群组ID
mid | `number` | 消息ID
### groupManage.getUnreadCount(gid) ⇒ `number`
获取群未读消息数
**Kind** : static method of groupManage
**Returns** : `number` \- 未读消息数
Param | Type | Description
---|---|---
gid | `number` | 群组ID
### groupManage.asyncGetAdminList(params) ⇒
`Promise.<Array.<module:types~GroupMember>>`
获取群管理员列表
**Kind** : static method of groupManage
**Returns** : `Promise.<Array.<module:types~GroupMember>>` \- 群管理员列表
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
### groupManage.asyncAdminAdd(params) ⇒
`Promise.<Array.<module:types~GroupUserRelationResponse>>`
群添加管理员
**Kind** : static method of groupManage
**Returns** : `Promise.<Array.<module:types~GroupUserRelationResponse>>` \-
结果列表
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.user_list | `Array.<number>` | 群成员列表
### groupManage.asyncAdminRemove(params) ⇒
`Promise.<Array.<module:types~GroupUserRelationResponse>>`
移除管理员
**Kind** : static method of groupManage
**Returns** : `Promise.<Array.<module:types~GroupUserRelationResponse>>` \-
结果列表
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.user_list | `Array.<number>` | 群成员列表
### groupManage.asyncGetAnouncementById(params) ⇒
`Promise.<GroupAnnouncement>`
获取群公告详情
**Kind** : static method of groupManage
**Returns** : `Promise.<GroupAnnouncement>` \- 群公告详情
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.announcement_id | `Array.<number>` | 公告ID
### groupManage.asyncAnouncementDelete(params) ⇒ `Promise.<boolean>`
删除群公告
**Kind** : static method of groupManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.announcement_id | `Array.<number>` | 公告ID
### groupManage.asyncAnnouncementEdit(params) ⇒ `Promise.<GroupAnnouncement>`
编辑群公告
**Kind** : static method of groupManage
**Returns** : `Promise.<GroupAnnouncement>` \- 群公告详情
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.title | `string` | 公告标题
params.content | `string` | 公告内容
### groupManage.asyncGetAnnouncementList(params) ⇒
`Promise.<Array.<module:types~GroupAnnouncement>>`
群公告列表
**Kind** : static method of groupManage
**Returns** : `Promise.<Array.<module:types~GroupAnnouncement>>` \- 群公告详情列表
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
### groupManage.asyncCreate(params) ⇒ `Promise.<GroupInfoAndSettings>`
创建群组
**Kind** : static method of groupManage
**Returns** : `Promise.<GroupInfoAndSettings>` \- 群详情
Param | Type | Description
---|---|---
params | [`GroupInfoRequest`](https://developer.qiniu.com/IM/11903/groupmanage) | 请求参数
### groupManage.asyncDestroy(params) ⇒ `Promise.<boolean>`
解散群组
**Kind** : static method of groupManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
### groupManage.asyncUpdateAvatar(params) ⇒ `Promise.<boolean>`
更新群头像
**Kind** : static method of groupManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.value | `string` | 头像地址
### groupManage.asyncUpdateDescription(params) ⇒ `Promise.<boolean>`
更新群描述
**Kind** : static method of groupManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.value | `string` | 群组描述
### groupManage.asyncUpdateExt(params) ⇒ `Promise.<boolean>`
更新群扩展信息
**Kind** : static method of groupManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.value | `string` | 扩展信息
### groupManage.asyncUpdateName(params) ⇒ `Promise.<boolean>`
更新群名称
**Kind** : static method of groupManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.value | `string` | 群名称
### groupManage.asyncGroupMsgMutemode(params) ⇒ `Promise.<boolean>`
设置群消息免打扰情况
**Kind** : static method of groupManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.msg_mute_mode | `number` | 群消息屏蔽模式: 0 - 表示不屏蔽, 1 - 表示屏蔽本地消息通知, 2 - 表示屏蔽消息，不接收消息
### groupManage.asyncGroupBannedList(params) ⇒
`Promise.<Array.<module:types~GroupMemberBanned>>`
获取群禁言列表
**Kind** : static method of groupManage
**Returns** : `Promise.<Array.<module:types~GroupMemberBanned>>` \- 禁言成员列表
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
### groupManage.asyncGroupBab(params) ⇒
`Promise.<Array.<module:types~GroupUserRelationResponse>>`
禁言群成员
**Kind** : static method of groupManage
**Returns** : `Promise.<Array.<module:types~GroupUserRelationResponse>>` \-
请求结果列表
Param | Type | Description
---|---|---
params | [`GroupBannedMemberRequest`](https://developer.qiniu.com/IM/11903/groupmanage) | 请求参数
### groupManage.asyncGroupUnban(params) ⇒
`Promise.<Array.<module:types~GroupUserRelationResponse>>`
解除成员禁言
**Kind** : static method of groupManage
**Returns** : `Promise.<Array.<module:types~GroupUserRelationResponse>>` \-
请求结果列表
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.user_list | `Array.<number>` | 群成员列表
### groupManage.asyncGetSettings(group_id) ⇒ `Promise.<GroupInfoAndSettings>`
获取群设置
**Kind** : static method of groupManage
**Returns** : `Promise.<GroupInfoAndSettings>` \- 群设置
Param | Type | Description
---|---|---
group_id | `number` | 群ID
### groupManage.asyncUpdateAllowMemberInvitation(params) ⇒ `Promise.<boolean>`
设置群成员是否可以邀请
**Kind** : static method of groupManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.value | `boolean` | 群成员邀请设置: false - 不允许邀请, true - 允许邀请(默认)
### groupManage.asyncUpdateAllowMemberModify(params) ⇒ `Promise.<boolean>`
设置群成员是否可以修改群信息
**Kind** : static method of groupManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.value | `boolean` | 群成员修改群信息设置: false - 群成员不能修改群信息(默认), true - 群成员可以修改群信息
### groupManage.asyncUpdateEnableReadack(params) ⇒ `Promise.<boolean>`
设置群是否开启已读模式
**Kind** : static method of groupManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.value | `boolean` | 是否开启群消息已读功能: false - 不开启, true - 开启
### groupManage.asyncUpdateHistoryVisible(params) ⇒ `Promise.<boolean>`
设置群历史是否可见
**Kind** : static method of groupManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.value | `boolean` | 设置群历史是否可见: false - 不可见, true - 可见
### groupManage.asyncUpdateRequireadminapproval(params) ⇒ `Promise.<boolean>`
设置入群是否需要申请
**Kind** : static method of groupManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.apply_approval | `boolean` | 入群申请审批设置, 0:同意所有申请 1:需要管理员确认 2:拒绝所有申请
### groupManage.asyncBanAll(params) ⇒ `Promise.<GroupBanAllResponse>`
全员禁言，只允许管理员发消息
**Kind** : static method of groupManage
**Returns** : `Promise.<GroupBanAllResponse>` \- 结果
Param | Type | Description
---|---|---
params | `object` | 参数
params.duration | `number` | 禁言时长，单位为分钟,int64
params.group_id | `number` | 群id,int64
### groupManage.asyncUnBanAll(params) ⇒ `Promise.<boolean>`
取消全员禁言
**Kind** : static method of groupManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群id,int64
### groupManage.asyncOwnerTransfer(params) ⇒
`Promise.<GroupUserRelationResponse>`
更换群主
**Kind** : static method of groupManage
**Returns** : `Promise.<GroupUserRelationResponse>` \- 结果
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.new_owner | `number` | 新群主的用户ID
### groupManage.asyncGetUserJoined(params) ⇒ `Promise.<Array.<number>>`
获取用户的群组列表
**Kind** : static method of groupManage
**Returns** : `Promise.<Array.<number>>` \- 群ID的列表
Param | Type | Description
---|---|---
params | `object` | 参数, 空对象
### groupManage.asyncApply(params) ⇒ `Promise.<GroupUserRelationResponse>`
申请加入群
**Kind** : static method of groupManage
**Returns** : `Promise.<GroupUserRelationResponse>` \- 结果
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.reason | `string` | 申请入群原因
### groupManage.asyncApplyHandle(params) ⇒
`Promise.<GroupUserRelationResponse>`
处理用户的入群申请
**Kind** : static method of groupManage
**Returns** : `Promise.<GroupUserRelationResponse>` \- 结果
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.user_id | `number` | 用户ID
params.approval | `boolean` | 审批结果：true为同意，false为拒绝
### groupManage.asyncGroupBockedlist(params) ⇒
`Promise.<Array.<module:types~GroupBlockedListItem>>`
获取群黑名单
**Kind** : static method of groupManage
**Returns** : `Promise.<Array.<module:types~GroupBlockedListItem>>` \- 群黑名单列表
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
### groupManage.asyncGroupBlock(params) ⇒
`Promise.<Array.<module:types~GroupUserRelationResponse>>`
将成员加入黑名单
**Kind** : static method of groupManage
**Returns** : `Promise.<Array.<module:types~GroupUserRelationResponse>>` \-
结果列表
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.user_list | `Array.<number>` | 群成员列表
### groupManage.asyncGroupUnblock(params) ⇒
`Promise.<Array.<module:types~GroupUserRelationResponse>>`
解除黑名单
**Kind** : static method of groupManage
**Returns** : `Promise.<Array.<module:types~GroupUserRelationResponse>>` \-
结果列表
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.user_list | `Array.<number>` | 群成员列表
### groupManage.asyncKick(params) ⇒
`Promise.<Array.<module:types~GroupUserRelationResponse>>`
踢出群组
**Kind** : static method of groupManage
**Returns** : `Promise.<Array.<module:types~GroupUserRelationResponse>>` \-
结果列表
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.user_list | `Array.<number>` | 群成员列表
### groupManage.asyncGetInvitationList() ⇒
`Promise.<Array.<module:types~GroupInvitation>>`
获取群邀请列表
**Kind** : static method of groupManage
**Returns** : `Promise.<Array.<module:types~GroupInvitation>>` \- 群邀请列表
### groupManage.asyncInvite(params) ⇒
`Promise.<Array.<module:types~GroupUserRelationResponse>>`
邀请成员加入群
**Kind** : static method of groupManage
**Returns** : `Promise.<Array.<module:types~GroupUserRelationResponse>>` \-
结果列表
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.user_list | `Array.<number>` | 群成员列表
### groupManage.asyncInviteHandle(params) ⇒ `Promise.<boolean>`
处理群邀请
**Kind** : static method of groupManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.user_id | `number` | 用户ID
params.approval | `boolean` | 审批结果：true为同意，false为拒绝
### groupManage.asyncGetMemberDisplayName(params) ⇒
`Promise.<Array.<module:types~GroupMember>>`
批量获取群成员的群名片
**Kind** : static method of groupManage
**Returns** : `Promise.<Array.<module:types~GroupMember>>` \- 群成员列表
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.user_list | `Array.<number>` | 群成员列表
### groupManage.asyncLeave(params) ⇒ `Promise.<boolean>`
退出群
**Kind** : static method of groupManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
### groupManage.asyncUpdateDisplayName(params) ⇒ `Promise.<boolean>`
修改群名片
**Kind** : static method of groupManage
**Returns** : `Promise.<boolean>` \- 是否成功
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.value | `string` | 新名片
### groupManage.asncGetApplicationList(params) ⇒
`Promise.<Array.<module:types~GroupApplication>>`
获取群申请列表
**Kind** : static method of groupManage
**Returns** : `Promise.<Array.<module:types~GroupApplication>>` \- 群申请列表
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_list | `Array.<number>` | 群列表
### groupManage.asyncGetFileList(params) ⇒
`Promise.<Array.<module:types~GroupSharedFile>>`
获取群文件列表
**Kind** : static method of groupManage
**Returns** : `Promise.<Array.<module:types~GroupSharedFile>>` \- 群文件列表
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
### groupManage.asyncFileDelete(params) ⇒
`Promise.<Array.<module:types~GroupSharedFileResponse>>`
删除群文件
**Kind** : static method of groupManage
**Returns** : `Promise.<Array.<module:types~GroupSharedFileResponse>>` \- 结果列表
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
params.file_list | `Array.<number>` | 文件ID列表
### groupManage.asyncFileUpload(params) ⇒
`Promise.<Array.<module:types~GroupSharedFile>>`
上传群文件
**Kind** : static method of groupManage
**Returns** : `Promise.<Array.<module:types~GroupSharedFile>>` \- 群文件列表
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群id,int64
params.name | `string` | 文件名称
params.size | `number` | 文件大小,int64
params.type | `string` | 文件类型
params.url | `string` | 文件url
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,066 |
chatroomManage | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [IM Web
文档](https://developer.qiniu.com/IM/api/8325/im-web-document) > chatroomManage
# chatroomManage
最近更新时间: 2022-06-17 10:47:20
## chatroomManage
聊天室
### 创建聊天室
im.chatroomManage.create(name).then(() => {
//
});
### 加入聊天室
im.chatroomManage.join(group_id).then(() => {
//
})
### 退出聊天室
im.chatroomManage.leave(group_id).then(() => {
//
})
### 解散聊天室
im.chatroomManage.destroy(group_id).then(() => {
//
})
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [IM Web
文档](https://developer.qiniu.com/IM/api/8325/im-web-document) > chatroomManage
# chatroomManage
最近更新时间: 2022-06-17 10:47:20
## chatroomManage
聊天室
### 创建聊天室
im.chatroomManage.create(name).then(() => {
//
});
### 加入聊天室
im.chatroomManage.join(group_id).then(() => {
//
})
### 退出聊天室
im.chatroomManage.leave(group_id).then(() => {
//
})
### 解散聊天室
im.chatroomManage.destroy(group_id).then(() => {
//
})
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,110 |
sysManage | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [IM Web
文档](https://developer.qiniu.com/IM/api/8325/im-web-document) > sysManage
# sysManage
最近更新时间: 2022-05-24 16:45:36
## sysManage
* sysManage
* [.sendRosterMessage(msg)](https://developer.qiniu.com/IM/11905/sysmanage)
* [.sendGroupMessage(msg)](https://developer.qiniu.com/IM/11905/sysmanage)
* [.requireHistoryMessage(uid, sid, amount)](https://developer.qiniu.com/IM/11905/sysmanage)
* [.sendMentionMessage(params)](https://developer.qiniu.com/IM/11905/sysmanage)
* [.sendInputStatusMessage(uid, status)](https://developer.qiniu.com/IM/11905/sysmanage)
* [.forwardMessage(param)](https://developer.qiniu.com/IM/11905/sysmanage)
* [.getMessageStatus(cid, mid, isGroup)](https://developer.qiniu.com/IM/11905/sysmanage)
* [.asyncFileUpload(param)](https://developer.qiniu.com/IM/11905/sysmanage)
* [.getImage(param)](https://developer.qiniu.com/IM/11905/sysmanage)
* [.deleteConversation(id, other_devices)](https://developer.qiniu.com/IM/11905/sysmanage)
* [.asyncGetGroupAvatarUploadUrl(params)](https://developer.qiniu.com/IM/11905/sysmanage)
* [.asyncGetFileUploadChatFileUrl(params)](https://developer.qiniu.com/IM/11905/sysmanage)
### sysManage.sendRosterMessage(msg) ⇒ `number`
发送单聊消息
**Kind** : static method of sysManage
**Returns** : `number` \- 客户端生成的消息ID
Param | Type | Description
---|---|---
msg | `object` | 消息体
msg.uid | `string` | 接收者ID
msg.content | `string` | 消息内容
msg.type | `string` | 消息类型： text - 文本, image - 图片， audio - 语音, video - 视频，file - 文件, location - 位置， command - 命令, forward - 转发
msg.ext | `string` | `object`
msg.attachment | `string` | `object`
### sysManage.sendGroupMessage(msg) ⇒ `number`
发送群聊消息
**Kind** : static method of sysManage
**Returns** : `number` \- 客户端生成的消息ID
Param | Type | Description
---|---|---
msg | `object` | 发送消息体
msg.gid | `string` | 群组ID
msg.content | `string` | 消息内容
msg.type | `string` | 消息类型： text - 文本, image - 图片， audio - 语音, video - 视频，file - 文件, location - 位置， command - 命令, forward - 转发
msg.ext | `string` | `object`
msg.attachment | `string` | `object`
msg.priority | `number` | 设置消息的扩散优先级，默认为0。0表示扩散，数字越小扩散的越多。
### sysManage.requireHistoryMessage(uid, sid, amount)
请求历史消息
**Kind** : static method of sysManage
Param | Type | Description
---|---|---
uid | `number` | 会话ID
sid | `number` | 消息ID: 从哪个消息向前拉取，传0表示从最新一条消息开始拉取。
amount | `number` | 拉取的条数
### sysManage.sendMentionMessage(params) ⇒ `number`
群发送@消息
**Kind** : static method of sysManage
**Returns** : `number` \- 客户端生成的消息ID
Param | Type | Description
---|---|---
params | `object` |
params.gid | `number` | 群ID
params.txt | `string` | 消息文本内容
params.mentionAll | `boolean` | 是否@所有人
params.mentionList | `Array.<number>` | @的成员ID列表
params.mentionedMessage | `string` | @消息的显示内容
params.mentionedMessage | `string` | @消息的推送内容
params.senderNickname | `string` | 发送者昵称
### sysManage.sendInputStatusMessage(uid, status) ⇒ `number`
发送输入状态消息
**Kind** : static method of sysManage
**Returns** : `number` \- 客户端生成的消息ID
Param | Type | Description
---|---|---
uid | `number` | 会话ID
status | `string` | 状态： nothing - 未输入， typing - 正在输入
### sysManage.forwardMessage(param) ⇒ `number`
转发消息
**Kind** : static method of sysManage
**Returns** : `number` \- 客户端生成的消息ID
Param | Type | Description
---|---|---
param | `object` | 参数
param.uid | `number` | 接收方用户ID（仅转发单聊时设置）
param.gid | `number` | 接收方群组ID（仅转发群聊时设置）
param.mid | `number` | 要转发的消息ID
### sysManage.getMessageStatus(cid, mid, isGroup) ⇒ `string`
获取消息的状态
**Kind** : static method of sysManage
**Returns** : `string` \- 消息状态: unread - 未读， delivered - 已投递， read - 已读
Param | Type | Default | Description
---|---|---|---
cid | `number` | | 会话ID
mid | `number` | | 消息ID
isGroup | `boolean` | `false` | 是否是群聊
### sysManage.asyncFileUpload(param) ⇒ `Promise.<FileUploadResult>`
上传文件
**Kind** : static method of sysManage
**Returns** : `Promise.<FileUploadResult>` \- 文件上传结果
Param | Type | Description
---|---|---
param | `object` | 参数
param.group_d | `number` | 群组ID
param.toType | `number` | 接收者类型：rosterAvatar - 用户头像， chat - 聊天文件， groupAvatar - 群头像
param.to_id | `number` | 接收者ID
param.file | `File` | 文件
param.fileType | `string` | 文件类型：file - 普通聊天文件, audio - 语音聊天文件(amr格式),image - 图片聊天文件, video - 视频聊天文件, audio-mp3 - 语音聊天文件(mp3格式), shareFile - 普通共享文件, shareAudio - 语音共享文件, shareImage - 图片共享文件, shareVideo - 视频共享文件
param.chatType | `number` | 聊天类型： roster - 单聊, group - 群聊
param.processCallback | [`fileUploadProgress`](https://developer.qiniu.com/IM/11905/sysmanage) | 上传进度回调
### sysManage.getImage(param) ⇒ `string`
拼装图片路径
**Kind** : static method of sysManage
**Returns** : `string` \- 图片地址
Param | Type | Description
---|---|---
param | `object` |
param.avatar | `string` | 文件地址
param.type | `string` | 类型： roster - 用户, group - 群
param.thumbnail | `boolean` | 是否缩略图：默认为true
param.sdefault | `string` | 默认图片地址
### sysManage.deleteConversation(id, other_devices)
删除会话
**Kind** : static method of sysManage
Param | Type | Default | Description
---|---|---|---
id | `number` | | 会话ID
other_devices | `boolean` | `true` | 是否同时删除其它设备上的会话
### sysManage.asyncGetGroupAvatarUploadUrl(params) ⇒ `Promise.<FileUpload>`
获取上传群头像URL
**Kind** : static method of sysManage
**Returns** : `Promise.<FileUpload>` \- 文件上传信息
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
### sysManage.asyncGetFileUploadChatFileUrl(params) ⇒ `Promise.<FileUpload>`
获取聊天文件上传地址
**Kind** : static method of sysManage
**Returns** : `Promise.<FileUpload>` \- 文件上传信息
Param | Type | Description
---|---|---
params | `object` | 参数
params.file_type | `number` | 文件类型: 100 - 普通聊天文件, 101 - 语音聊天文件(amr格式),102 - 图片聊天文件, 103 - 视频聊天文件, 104 - 语音聊天文件(mp3格式)200 - 普通共享文件, 201 - 语音共享文件, 202 - 图片共享文件, 203 - 视频共享文件
params.to_type | `number` | 会话类型： 1 - 用户，2 - 群组
params.to_id | `number` | 会话ID
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [IM Web
文档](https://developer.qiniu.com/IM/api/8325/im-web-document) > sysManage
# sysManage
最近更新时间: 2022-05-24 16:45:36
## sysManage
* sysManage
* [.sendRosterMessage(msg)](https://developer.qiniu.com/IM/11905/sysmanage)
* [.sendGroupMessage(msg)](https://developer.qiniu.com/IM/11905/sysmanage)
* [.requireHistoryMessage(uid, sid, amount)](https://developer.qiniu.com/IM/11905/sysmanage)
* [.sendMentionMessage(params)](https://developer.qiniu.com/IM/11905/sysmanage)
* [.sendInputStatusMessage(uid, status)](https://developer.qiniu.com/IM/11905/sysmanage)
* [.forwardMessage(param)](https://developer.qiniu.com/IM/11905/sysmanage)
* [.getMessageStatus(cid, mid, isGroup)](https://developer.qiniu.com/IM/11905/sysmanage)
* [.asyncFileUpload(param)](https://developer.qiniu.com/IM/11905/sysmanage)
* [.getImage(param)](https://developer.qiniu.com/IM/11905/sysmanage)
* [.deleteConversation(id, other_devices)](https://developer.qiniu.com/IM/11905/sysmanage)
* [.asyncGetGroupAvatarUploadUrl(params)](https://developer.qiniu.com/IM/11905/sysmanage)
* [.asyncGetFileUploadChatFileUrl(params)](https://developer.qiniu.com/IM/11905/sysmanage)
### sysManage.sendRosterMessage(msg) ⇒ `number`
发送单聊消息
**Kind** : static method of sysManage
**Returns** : `number` \- 客户端生成的消息ID
Param | Type | Description
---|---|---
msg | `object` | 消息体
msg.uid | `string` | 接收者ID
msg.content | `string` | 消息内容
msg.type | `string` | 消息类型： text - 文本, image - 图片， audio - 语音, video - 视频，file - 文件, location - 位置， command - 命令, forward - 转发
msg.ext | `string` | `object`
msg.attachment | `string` | `object`
### sysManage.sendGroupMessage(msg) ⇒ `number`
发送群聊消息
**Kind** : static method of sysManage
**Returns** : `number` \- 客户端生成的消息ID
Param | Type | Description
---|---|---
msg | `object` | 发送消息体
msg.gid | `string` | 群组ID
msg.content | `string` | 消息内容
msg.type | `string` | 消息类型： text - 文本, image - 图片， audio - 语音, video - 视频，file - 文件, location - 位置， command - 命令, forward - 转发
msg.ext | `string` | `object`
msg.attachment | `string` | `object`
msg.priority | `number` | 设置消息的扩散优先级，默认为0。0表示扩散，数字越小扩散的越多。
### sysManage.requireHistoryMessage(uid, sid, amount)
请求历史消息
**Kind** : static method of sysManage
Param | Type | Description
---|---|---
uid | `number` | 会话ID
sid | `number` | 消息ID: 从哪个消息向前拉取，传0表示从最新一条消息开始拉取。
amount | `number` | 拉取的条数
### sysManage.sendMentionMessage(params) ⇒ `number`
群发送@消息
**Kind** : static method of sysManage
**Returns** : `number` \- 客户端生成的消息ID
Param | Type | Description
---|---|---
params | `object` |
params.gid | `number` | 群ID
params.txt | `string` | 消息文本内容
params.mentionAll | `boolean` | 是否@所有人
params.mentionList | `Array.<number>` | @的成员ID列表
params.mentionedMessage | `string` | @消息的显示内容
params.mentionedMessage | `string` | @消息的推送内容
params.senderNickname | `string` | 发送者昵称
### sysManage.sendInputStatusMessage(uid, status) ⇒ `number`
发送输入状态消息
**Kind** : static method of sysManage
**Returns** : `number` \- 客户端生成的消息ID
Param | Type | Description
---|---|---
uid | `number` | 会话ID
status | `string` | 状态： nothing - 未输入， typing - 正在输入
### sysManage.forwardMessage(param) ⇒ `number`
转发消息
**Kind** : static method of sysManage
**Returns** : `number` \- 客户端生成的消息ID
Param | Type | Description
---|---|---
param | `object` | 参数
param.uid | `number` | 接收方用户ID（仅转发单聊时设置）
param.gid | `number` | 接收方群组ID（仅转发群聊时设置）
param.mid | `number` | 要转发的消息ID
### sysManage.getMessageStatus(cid, mid, isGroup) ⇒ `string`
获取消息的状态
**Kind** : static method of sysManage
**Returns** : `string` \- 消息状态: unread - 未读， delivered - 已投递， read - 已读
Param | Type | Default | Description
---|---|---|---
cid | `number` | | 会话ID
mid | `number` | | 消息ID
isGroup | `boolean` | `false` | 是否是群聊
### sysManage.asyncFileUpload(param) ⇒ `Promise.<FileUploadResult>`
上传文件
**Kind** : static method of sysManage
**Returns** : `Promise.<FileUploadResult>` \- 文件上传结果
Param | Type | Description
---|---|---
param | `object` | 参数
param.group_d | `number` | 群组ID
param.toType | `number` | 接收者类型：rosterAvatar - 用户头像， chat - 聊天文件， groupAvatar - 群头像
param.to_id | `number` | 接收者ID
param.file | `File` | 文件
param.fileType | `string` | 文件类型：file - 普通聊天文件, audio - 语音聊天文件(amr格式),image - 图片聊天文件, video - 视频聊天文件, audio-mp3 - 语音聊天文件(mp3格式), shareFile - 普通共享文件, shareAudio - 语音共享文件, shareImage - 图片共享文件, shareVideo - 视频共享文件
param.chatType | `number` | 聊天类型： roster - 单聊, group - 群聊
param.processCallback | [`fileUploadProgress`](https://developer.qiniu.com/IM/11905/sysmanage) | 上传进度回调
### sysManage.getImage(param) ⇒ `string`
拼装图片路径
**Kind** : static method of sysManage
**Returns** : `string` \- 图片地址
Param | Type | Description
---|---|---
param | `object` |
param.avatar | `string` | 文件地址
param.type | `string` | 类型： roster - 用户, group - 群
param.thumbnail | `boolean` | 是否缩略图：默认为true
param.sdefault | `string` | 默认图片地址
### sysManage.deleteConversation(id, other_devices)
删除会话
**Kind** : static method of sysManage
Param | Type | Default | Description
---|---|---|---
id | `number` | | 会话ID
other_devices | `boolean` | `true` | 是否同时删除其它设备上的会话
### sysManage.asyncGetGroupAvatarUploadUrl(params) ⇒ `Promise.<FileUpload>`
获取上传群头像URL
**Kind** : static method of sysManage
**Returns** : `Promise.<FileUpload>` \- 文件上传信息
Param | Type | Description
---|---|---
params | `object` | 参数
params.group_id | `number` | 群组ID
### sysManage.asyncGetFileUploadChatFileUrl(params) ⇒ `Promise.<FileUpload>`
获取聊天文件上传地址
**Kind** : static method of sysManage
**Returns** : `Promise.<FileUpload>` \- 文件上传信息
Param | Type | Description
---|---|---
params | `object` | 参数
params.file_type | `number` | 文件类型: 100 - 普通聊天文件, 101 - 语音聊天文件(amr格式),102 - 图片聊天文件, 103 - 视频聊天文件, 104 - 语音聊天文件(mp3格式)200 - 普通共享文件, 201 - 语音共享文件, 202 - 图片共享文件, 203 - 视频共享文件
params.to_type | `number` | 会话类型： 1 - 用户，2 - 群组
params.to_id | `number` | 会话ID
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,111 |
types | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > [IM Web
文档](https://developer.qiniu.com/IM/api/8325/im-web-document) > types
# types
最近更新时间: 2022-05-24 16:45:57
## types
* types
* “flooNotice” (res)
* “flooError” (res)
* “loginFail” (desc)
* “loginSuccess” (res)
* “onGroupListUpdate” (meta)
* “onGroupMemberChanged” (groupId)
* “onGroupMessage” (meta)
* “onInputStatusMessage” (res)
* “onMentionMessage” (meta)
* “onMessageCanceled” (res)
* “onMessageDeleted” (res)
* “onMessageRecalled” (res)
* “onMessageStatusChanged” (res)
* “onReceiveHistoryMsg” (res)
* “onRosterInfoUpdate” (res)
* “onRosterListUpdate” (meta)
* “onRosterMessage” (meta)
* “onSendingMessageStatusChanged” (res)
* “onUnreadChange” (cid)
* “recentlistUpdate”
* “onGroupCreated” (meta)
* “onGroupDestoryed” (meta)
* “onGroupJoined” (meta)
* “onGroupApplyAccepted” (meta)
* “onGroupApplyDeclined” (meta)
* “onGroupBaned” (meta)
* “onGroupUnbaned” (meta)
* ~RosterItem
* ~UserSettings
* ~UserProfile
* ~Meta
* ~RosterApplication
* ~GroupInfoAndSettings
* ~BriefGroupInfoAndSettings
* ~GroupMember
* ~GroupMemberBanned
* ~GroupUserRelationResponse
* ~GroupAnnouncement
* ~GroupInfoRequest
* ~GroupBannedMemberRequest
* ~GroupBlockedListItem
* ~GroupInvitation
* ~GroupApplication
* ~GroupSharedFile
* ~GroupSharedFileResponse
* ~GroupBanAllResponse
* ~FileUpload
* ~FileUploadResult
* ~fileUploadProgress
* ~ConversationItem
* ~UserProfile
* ~UserSettings
* ~Event
* ~EventCallback
### “flooNotice” (res)
Floo通知
**Kind** : event emitted by types
Param | Type | Description
---|---|---
res | `object` | 结果
res.category | `string` | 类别
res.desc | `string` | 描述
**Example**
{category: 'loginMessage',desc: 'socket connecting...'} // 开始建连接
{category: 'loginMessage',desc: 'socket connect success...'} // 连接成功
{category: 'loginMessage',desc: 'logining socket service...'} // 开始登录
{category: 'loginMessage',desc: 'login socket failure ......'} // 登录失败
{category: 'loginMessage',desc: 'login socket success.....'} // 登录成功
{category: 'loginMessage', desc: 'getting token...' } //获取token
{category: 'loginMessage',desc: 'token sucecc, getting roster lists..'} // 获取token成功，开始获取好友列表
{category: 'loginMessage',desc: 'get roster list failure:' + ex.message} // 获取好友列表失败
{category: 'action', desc: 'relogin' } // 需要自动登录
{category: 'action', desc: 'relogin_manually' } // 需要手动登录
{category: 'conversation_deleted',desc: { id, source:'user_operation' }} // 会话被删除。ID：会话ID， source: 来源
{category: 'userNotice', desc:'PASSWORD_CHANGED'} // 用户密码改变
{category: 'userNotice', desc:'FROZEN'} // 用户账户被封禁
{category: 'userNotice', desc:'REMOVED'} // 用户被删除
{category: 'userNotice', desc:'KICK_BY_SAME_DEVICE'} // 当前设备被相同设备踢下线
{category: 'userNotice', desc:'KICKED_BY_OTHER_DEVICE'} // 当前设备被其它设备踢下线
{category: 'userNotice', desc:'INFO_UPDATED'} // 用户信息改变：profile或setting
{category: 'userNotice', desc:'DEVICE_LOGIN'} // 用户其它设备上线
{category: 'userNotice', desc:'DEVICE_LOGOUT'} // 用户其它设备下线
{category: 'userNotice', desc:'DEVICE_ADDED'} // 新设备通知
{category: 'userNotice', desc:'DEVICE_REMOVED'} // 设备被移除的通知
{category: 'userNotice', desc:'CLUSTER_CHANGED'} // 用户所在集群改变 需要重新登录
### “flooError” (res)
Floo错误
**Kind** : event emitted by types
Param | Type | Description
---|---|---
res | `object` |
res.category | `string` | 类别
res.desc | `string` | 描述
**Example**
{category: 'USER_BANNED', desc:'用户被禁言'}
{category: 'USER_FROZEN', desc:'用户被冻结，请联系App管理员。'}
{category: 'APP_FROZEN', desc:'APP 被冻结，请登陆蓝莺IM控制台查看详情。'}
{category: 'LICENSE', desc:'无效 LICENSE，请确认服务已按时付费。'}
{category: 'LICENSE', desc:'超出 LICENSE 用户数限制，请购买更高规格服务。'}
{category: 'DNS_FAILED', desc: dnsServer } // DNS错误: 无法访问
### “loginFail” (desc)
登录失败
**Kind** : event emitted by types
Param | Type | Description
---|---|---
desc | `string` | 失败原因
### “loginSuccess” (res)
登录成功
**Kind** : event emitted by types
Param | Type | Description
---|---|---
res | `object` | 空对象
### “onGroupListUpdate” (meta)
群列表更新
**Kind** : event emitted by types
Param | Type | Description
---|---|---
meta | [`Meta`](https://developer.qiniu.com/IM/11906/types) | `undefined`
### “onGroupMemberChanged” (groupId)
群成员列表更新
**Kind** : event emitted by types
Param | Type | Description
---|---|---
groupId | `number` | 群ID
### “onGroupMessage” (meta)
收到群消息
**Kind** : event emitted by types
Param | Type | Description
---|---|---
meta | [`Meta`](https://developer.qiniu.com/IM/11906/types) | 消息内容
### “onInputStatusMessage” (res)
对方正在输入
**Kind** : event emitted by types
Param | Type | Description
---|---|---
res | `object` |
res.ext | `string` | 扩展字段
res.from | `string` | 发送者用户ID
res.to | `string` | 接收者用户ID
### “onMentionMessage” (meta)
收到群组@消息
**Kind** : event emitted by types
Param | Type | Description
---|---|---
meta | [`Meta`](https://developer.qiniu.com/IM/11906/types) | 消息内容
### “onMessageCanceled” (res)
消息被取消已读
**Kind** : event emitted by types
Param | Type | Description
---|---|---
res | `object` |
res.uid | `string` | 会话ID
res.mid | `string` | 消息ID
### “onMessageDeleted” (res)
消息被删除
**Kind** : event emitted by types
Param | Type | Description
---|---|---
res | `object` |
res.uid | `string` | 会话ID
res.mid | `string` | 消息ID
### “onMessageRecalled” (res)
消息被撤回
**Kind** : event emitted by types
Param | Type | Description
---|---|---
res | `object` |
res.uid | `string` | 会话ID
res.mid | `string` | 消息ID
### “onMessageStatusChanged” (res)
消息状态变更：撤回/删除/已读
**Kind** : event emitted by types
Param | Type | Description
---|---|---
res | `object` |
res.uid | `string` | 会话ID
res.mid | `string` | 消息ID
### “onReceiveHistoryMsg” (res)
收到历史消息
**Kind** : event emitted by types
Param | Type | Description
---|---|---
res | `object` |
res.next | `number` | 下次取历史消息的key
### “onRosterInfoUpdate” (res)
好友信息变更
**Kind** : event emitted by types
Param | Type | Description
---|---|---
res | `object` |
res.rosterIds | `Array.<number>` | 好友的用户ID列表
### “onRosterListUpdate” (meta)
好友列表变更
**Kind** : event emitted by types
Param | Type | Description
---|---|---
meta | [`Meta`](https://developer.qiniu.com/IM/11906/types) | 好友通知的消息内容
### “onRosterMessage” (meta)
收到单聊消息
**Kind** : event emitted by types
Param | Type | Description
---|---|---
meta | [`Meta`](https://developer.qiniu.com/IM/11906/types) | 消息内容
### “onSendingMessageStatusChanged” (res)
消息发送状态变更
**Kind** : event emitted by types
Param | Type | Description | |
---|---|---|---|---
res | `object` | | |
res.status: | `number` | 发送状态，取值为sending | failed | sent
res.mid: | `number` | 客户端生成的client_mid | |
### “onUnreadChange” (cid)
未读数改变
**Kind** : event emitted by types
Param | Type | Description
---|---|---
cid | `number` | 会话ID
### “recentlistUpdate”
最近会话更新
**Kind** : event emitted by types
### “onGroupCreated” (meta)
群组创建通知
**Kind** : event emitted by types
Param | Type | Description
---|---|---
meta | [`Meta`](https://developer.qiniu.com/IM/11906/types) | 群通知的消息内容
### “onGroupDestoryed” (meta)
群组解散通知
**Kind** : event emitted by types
Param | Type | Description
---|---|---
meta | [`Meta`](https://developer.qiniu.com/IM/11906/types) | 群通知的消息内容
### “onGroupJoined” (meta)
成员入群通知
**Kind** : event emitted by types
Param | Type | Description
---|---|---
meta | [`Meta`](https://developer.qiniu.com/IM/11906/types) | 群通知的消息内容
### “onGroupApplyAccepted” (meta)
群申请被通过
**Kind** : event emitted by types
Param | Type | Description
---|---|---
meta | [`Meta`](https://developer.qiniu.com/IM/11906/types) | 群通知的消息内容
### “onGroupApplyDeclined” (meta)
群申请被拒绝
**Kind** : event emitted by types
Param | Type | Description
---|---|---
meta | [`Meta`](https://developer.qiniu.com/IM/11906/types) | 群通知的消息内容
### “onGroupBaned” (meta)
被群禁言
**Kind** : event emitted by types
Param | Type | Description
---|---|---
meta | [`Meta`](https://developer.qiniu.com/IM/11906/types) | 群通知的消息内容
### “onGroupUnbaned” (meta)
被群取消禁言
**Kind** : event emitted by types
Param | Type | Description
---|---|---
meta | [`Meta`](https://developer.qiniu.com/IM/11906/types) | 群通知的消息内容
### types~RosterItem : `object`
好友信息
**Kind** : inner typedef of types
**Properties**
Name | Type | Description
---|---|---
alias | `string` | 别名
auth_mode | `number` | 验证方式, 0 - 无需验证，任何人可以加为好友, 1 - 需要同意方可加为好友, 2 - 需要回答问题正确方可加为好友, 3 - 拒绝所有加好友申请,int32
auth_question | `string` | 验证问题
avatar | `string` | 头像
description | `string` | 描述信息
ext | `string` | 扩展信息
mute_notification | `boolean` | 是否接收消息提醒
nick_name | `string` | 昵称或名称
public_info | `string` | 公开信息，好友和陌生人可见
relation | `number` | 关系: 0 - 好友，1 - 被删除，2 - 陌生人, int32
user_id | `number` | 好友用户ID,int64
username | `string` | 用户名
### types~UserSettings : `object`
用户设置信息
**Kind** : inner typedef of types
**Properties**
Name | Type | Description
---|---|---
auth_answer | `string` | 验证问题答案
auth_mode | `number` | 验证方式, 0 - 无需验证，任何人可以加为好友, 1 - 需要同意方可加为好友, 2 - 需要回答问题正确方可加为好友, 3 - 拒绝所有加好友申请,int32
auth_question | `string` | 验证问题
auto_download | `boolean` | 是否自动下载
group_confirm | `boolean` | 邀请入群时是否需要用户确认: true - 需要用户同意才可加入， false - 自动同意邀请
id | `number` | 用户ID, int64
no_push | `boolean` | 是否关闭推送消息
no_push_detail | `boolean` | 是否推送详情
no_push_end_hour | `number` | 推送免打扰结束时间,int32
no_push_start_hour | `number` | 推送免打扰开始时间,int32
no_sounds | `boolean` | 收到消息时是否静音
push_nick_name | `string` | 推送昵称
push_token | `string` | 推送token
silence_end_time | `number` | 推送不提醒结束时间,int32
silence_start_time | `number` | 推送不提醒开始时间,int32
user_id | `number` | 用户ID,int64
vibratory | `boolean` | 收到消息时否振动
### types~UserProfile : `object`
用户信息
**Kind** : inner typedef of types
**Properties**
Name | Type | Description
---|---|---
avatar | `string` | 头像 url
description | `string` | 描述信息
email | `string` | 邮箱
mobile | `string` | 手机号码
nick_name | `string` | 昵称
private_info | `string` | 私有信息，仅自己可见
public_info | `string` | 公开信息，好友和陌生人可见
user_id | `number` | 用户ID,int64
username | `string` | 用户名
### types~Meta : `object`
消息体
**Kind** : inner typedef of types
**Properties**
Name | Type | Description
---|---|---
id | `string` | 消息ID
from | `string` | 发送者
to | `string` | 接收者
content | `string` | 消息内容
type | `string` | 消息类型： text - 文本, image - 图片， audio - 语音, video - 视频，file - 文件, location - 位置， command - 命令, forward - 转发
ext | `string` | `object`
config | `string` | `object`
attach | `string` | `object`
status | `number` | 消息状态： 0 - 未读, 1 - 已投递, 2 - 已读
timestamp | `string` | 消息发送时间戳（毫秒）
toType | `string` | 接收者类型： roster - 好友， group - 群组
### types~RosterApplication : `object`
加好友申请列表项
**Kind** : inner typedef of types
**Properties**
Name | Type | Description
---|---|---
expired_time | `number` | 过期时间,int64
reason | `string` | 申请描述
status | `number` | 状态： 0 - 等待确认， 1 - 接受， 2 - 拒绝。 int32
user_id | `number` | 发起加好友申请的用户ID,int64
### types~GroupInfoAndSettings : `object`
群信息
**Kind** : inner typedef of types
**Properties**
Name | Type | Description
---|---|---
apply_approval | `number` | 入群申请审批设置, 0:同意所有申请 1:需要管理员确认 2:拒绝所有申请
avatar | `string` | 群头像
ban_expire_time | `number` | 全员禁言过期时间（秒），禁言期间只允许管理员发消息， 为0或小于当前时间表示不禁言, -1表示永久禁言
created_at | `number` | 创建时间
description | `string` | 群描述
ext | `string` | 群扩展信息
group_id | `number` | 群id,int64
history_visible | `boolean` | 新成员可见历史聊天记录设置
member_invite | `boolean` | 群成员邀请设置: false - 不允许邀请, true - 允许邀请(默认)
member_modify | `boolean` | 群成员修改群信息设置: false - 群成员不能修改群信息(默认), true - 群成员可以修改群信息
msg_mute_mode | `number` | 群消息屏蔽模式: 0 - 表示不屏蔽, 1 - 表示屏蔽本地消息通知, 2 - 表示屏蔽消息，不接收消息
msg_push_mode | `number` | 群消息推送模式：0 - 接收所有推送，1 - 不接受推送，2 - 接收管理员和@消息推送， 3 - 只接收管理员消息推送， 4 - 只接收@消息推送
name | `string` | 群名称
owner_id | `number` | 群主id,int64
read_ack | `boolean` | 群消息已读功能设置
status | `number` | 群状态, 0：正常, 1：已解散
type | `number` | 群类型: 1表示公开群，0表示私有群, 2表示聊天室
updated_at | `number` | 更新时间,int64
count | `number` | 群成员数
capacity | `number` | 群容量
### types~BriefGroupInfoAndSettings : `object`
群简要信息及用户设置
**Kind** : inner typedef of types
**Properties**
Name | Type | Description
---|---|---
apply_approval | `number` | 入群申请审批设置, 0:同意所有申请 1:需要管理员确认 2:拒绝所有申请
avatar | `string` | 群头像
capacity | `number` | 群容量
count | `number` | 群成员数
group_id | `number` | 群id,int64
msg_mute_mode | `number` | 群消息屏蔽模式: 0 - 表示不屏蔽, 1 - 表示屏蔽本地消息通知, 2 - 表示屏蔽消息，不接收消息
msg_push_mode | `number` | 群消息推送模式：0 - 接收所有推送，1 - 不接受推送，2 - 接收管理员和@消息推送， 3 - 只接收管理员消息推送， 4 - 只接收@消息推送
name | `string` | 群名称
owner | `number` | 群主id,int64
status | `number` | 群状态, 0：正常, 1：已解散,int32
type | `number` | 群类型: 1表示公开群，0表示私有群, 2表示聊天室。int32
### types~GroupMember : `object`
群成员格式
**Kind** : inner typedef of types
**Properties**
Name | Type | Description
---|---|---
display_name | `string` | 成员群名片
join_time | `number` | 成员入群时间,int64
user_id | `number` | 用户id,int64
avatar | `string` | 头像地址
### types~GroupMemberBanned : `object`
禁言成员
**Kind** : inner typedef of types
**Properties**
Name | Type | Description
---|---|---
display_name | `string` | 成员群名片
join_time | `number` | 成员入群时间,int64
user_id | `number` | 用户id,int64
avatar | `string` | 头像地址
expired_time | `number` | 禁言过期时间
### types~GroupUserRelationResponse : `object`
群用户请求结果
**Kind** : inner typedef of types
**Properties**
Name | Type | Description
---|---|---
reason | `string` | 原因
result | `string` | 结果
user_id | `number` | 用户ID，int64
### types~GroupAnnouncement : `object`
群公告内容
**Kind** : inner typedef of types
**Properties**
Name | Type | Description
---|---|---
author | `number` | 公告发布者,int64
content | `string` | 公告内容
created_at | `number` | 公告发布时间,int64
group_id | `number` | 群id,int64
id | `number` | 公告id,int64
title | `string` | 公告标题
### types~GroupInfoRequest : `object`
创建群
**Kind** : inner typedef of types
**Properties**
Name | Type | Description
---|---|---
avatar | `string` | 群头像
description | `string` | 群描述
name | `string` | 群名称
type | `number` | 群类型 1表示公开群，0表示私有群, 2表示聊天室,int32
user_list | `Array.<number>` | 邀请入群的用户id列表
### types~GroupBannedMemberRequest : `object`
禁言请求
**Kind** : inner typedef of types
**Properties**
Name | Type | Description
---|---|---
duration | `number` | 禁言时长，单位为分钟,int64
group_id | `number` | 群id,int64
user_list | `Array.<number>` | 用户id列表
### types~GroupBlockedListItem : `object`
群组黑名单
**Kind** : inner typedef of types
**Properties**
Name | Type | Description
---|---|---
user_id | `number` | 用户id,int64
group_id | `number` | 群id,int64
create_at | `string` | 创建时间
### types~GroupInvitation : `object`
群组邀请信息
**Kind** : inner typedef of types
**Properties**
Name | Type | Description
---|---|---
group_id | `number` | 群ID
inviter_id | `number` | 邀请者ID
invitee_id | `number` | 被邀请者ID
reason | `string` | 原因
status | `number` | 状态： 0 - 待处理，1 - 用户同意，2 - 用户拒绝
expire_time | `number` | 过期时间
create_at | `string` | 创建时间
### types~GroupApplication : `object`
群申请信息
**Kind** : inner typedef of types
**Properties**
Name | Type | Description
---|---|---
group_id | `number` | 群ID
applicant_id | `number` | 申请者ID
reason | `string` | 原因
expire_time | `number` | 过期时间
status | `number` | 状态： 0 - 待处理，1 - 同意，2 - 拒绝
### types~GroupSharedFile : `object`
群共享文件返回格式
**Kind** : inner typedef of types
**Properties**
Name | Type | Description
---|---|---
created_at | `number` | int64
file_id | `number` | 共享文件id,int64
group_id | `number` | 群id,int64
name | `string` | 共享文件名称
size | `number` | 共享文件大小,int64
type | `string` | 共享文件类型
updated_at | `number` | int64
uploader | `number` | 共享文件上传者,int64
url | `string` | 共享文件url
### types~GroupSharedFileResponse : `object`
删除群共享文件结果
**Kind** : inner typedef of types
**Properties**
Name | Type | Description
---|---|---
file_id | `number` | 文件ID
reason | `string` | 原因
result | `string` | 结果
### types~GroupBanAllResponse : `object`
全员禁言结果
**Kind** : inner typedef of types
**Properties**
Name | Type | Description
---|---|---
ban_expire_time | `number` | 全员禁言过期时间,int64
### types~FileUpload : `object`
文件上传信息
**Kind** : inner typedef of types
**Properties**
Name | Type | Description
---|---|---
download_url | `string` | 下载地址
oss_body_param | `object.<string, string>` | 额外参数
upload_url | `string` | 上传地址
### types~FileUploadResult : `object`
文件上传结果
**Kind** : inner typedef of types
**Properties**
Name | Type | Description
---|---|---
url | `string` | 下载地址
### types~fileUploadProgress : `function`
文件上传进度回调
**Kind** : inner typedef of types
Param | Type | Description
---|---|---
res | `object` | 进度
res.loaded | `number` | 已下载字节数
res.total | `number` | 总字节数
### types~ConversationItem : `object`
会话信息
**Kind** : inner typedef of types
**Properties**
Name | Type | Description
---|---|---
id | `number` | 会话ID
content | `string` | 消息内容
timestamp | `string` | 消息发送时间戳（毫秒）
type | `string` | 会话类型： roster - 单聊， group - 群聊
### types~UserProfile : `object`
用户信息
**Kind** : inner typedef of types
**Properties**
Name | Type | Description
---|---|---
avatar | `string` | 头像 url
description | `string` | 描述信息
email | `string` | 邮箱
mobile | `string` | 手机号码
nick_name | `string` | 昵称
private_info | `string` | 私有信息，仅自己可见
public_info | `string` | 公开信息，好友和陌生人可见
user_id | `number` | 用户ID,int64
username | `string` | 用户名
### types~UserSettings : `object`
用户设置信息
**Kind** : inner typedef of types
**Properties**
Name | Type | Description
---|---|---
auth_answer | `string` | 验证问题答案
auth_mode | `number` | 验证方式, 0 - 无需验证，任何人可以加为好友, 1 - 需要同意方可加为好友, 2 - 需要回答问题正确方可加为好友, 3 - 拒绝所有加好友申请,int32
auth_question | `string` | 验证问题
auto_download | `boolean` | 是否自动下载
group_confirm | `boolean` | 邀请入群时是否需要用户确认: true - 需要用户同意才可加入， false - 自动同意邀请
id | `number` | 设置ID
no_push | `boolean` | 是否关闭推送消息
no_push_detail | `boolean` | 是否推送详情
no_push_end_hour | `number` | 推送免打扰结束时间,int32
no_push_start_hour | `number` | 推送免打扰开始时间,int32
no_sounds | `boolean` | 收到消息时是否静音
push_nick_name | `string` | 推送昵称
push_token | `string` | 推送token
silence_end_time | `number` | 推送不提醒结束时间,int32
silence_start_time | `number` | 推送不提醒开始时间,int32
user_id | `number` | 用户ID,int64
vibratory | `boolean` | 收到消息时否振动
### types~Event : `string`
监听事件名称
**Kind** : inner typedef of types
### types~EventCallback : `function`
监听事件回调
**Kind** : inner typedef of types
Param | Type | Description
---|---|---
res | [`flooNotice`](https://developer.qiniu.com/IM/11906/types) | [`flooError`](https://developer.qiniu.com/IM/11906/types)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > [IM Web
文档](https://developer.qiniu.com/IM/api/8325/im-web-document) > types
# types
最近更新时间: 2022-05-24 16:45:57
## types
* types
* “flooNotice” (res)
* “flooError” (res)
* “loginFail” (desc)
* “loginSuccess” (res)
* “onGroupListUpdate” (meta)
* “onGroupMemberChanged” (groupId)
* “onGroupMessage” (meta)
* “onInputStatusMessage” (res)
* “onMentionMessage” (meta)
* “onMessageCanceled” (res)
* “onMessageDeleted” (res)
* “onMessageRecalled” (res)
* “onMessageStatusChanged” (res)
* “onReceiveHistoryMsg” (res)
* “onRosterInfoUpdate” (res)
* “onRosterListUpdate” (meta)
* “onRosterMessage” (meta)
* “onSendingMessageStatusChanged” (res)
* “onUnreadChange” (cid)
* “recentlistUpdate”
* “onGroupCreated” (meta)
* “onGroupDestoryed” (meta)
* “onGroupJoined” (meta)
* “onGroupApplyAccepted” (meta)
* “onGroupApplyDeclined” (meta)
* “onGroupBaned” (meta)
* “onGroupUnbaned” (meta)
* ~RosterItem
* ~UserSettings
* ~UserProfile
* ~Meta
* ~RosterApplication
* ~GroupInfoAndSettings
* ~BriefGroupInfoAndSettings
* ~GroupMember
* ~GroupMemberBanned
* ~GroupUserRelationResponse
* ~GroupAnnouncement
* ~GroupInfoRequest
* ~GroupBannedMemberRequest
* ~GroupBlockedListItem
* ~GroupInvitation
* ~GroupApplication
* ~GroupSharedFile
* ~GroupSharedFileResponse
* ~GroupBanAllResponse
* ~FileUpload
* ~FileUploadResult
* ~fileUploadProgress
* ~ConversationItem
* ~UserProfile
* ~UserSettings
* ~Event
* ~EventCallback
### “flooNotice” (res)
Floo通知
**Kind** : event emitted by types
Param | Type | Description
---|---|---
res | `object` | 结果
res.category | `string` | 类别
res.desc | `string` | 描述
**Example**
{category: 'loginMessage',desc: 'socket connecting...'} // 开始建连接
{category: 'loginMessage',desc: 'socket connect success...'} // 连接成功
{category: 'loginMessage',desc: 'logining socket service...'} // 开始登录
{category: 'loginMessage',desc: 'login socket failure ......'} // 登录失败
{category: 'loginMessage',desc: 'login socket success.....'} // 登录成功
{category: 'loginMessage', desc: 'getting token...' } //获取token
{category: 'loginMessage',desc: 'token sucecc, getting roster lists..'} // 获取token成功，开始获取好友列表
{category: 'loginMessage',desc: 'get roster list failure:' + ex.message} // 获取好友列表失败
{category: 'action', desc: 'relogin' } // 需要自动登录
{category: 'action', desc: 'relogin_manually' } // 需要手动登录
{category: 'conversation_deleted',desc: { id, source:'user_operation' }} // 会话被删除。ID：会话ID， source: 来源
{category: 'userNotice', desc:'PASSWORD_CHANGED'} // 用户密码改变
{category: 'userNotice', desc:'FROZEN'} // 用户账户被封禁
{category: 'userNotice', desc:'REMOVED'} // 用户被删除
{category: 'userNotice', desc:'KICK_BY_SAME_DEVICE'} // 当前设备被相同设备踢下线
{category: 'userNotice', desc:'KICKED_BY_OTHER_DEVICE'} // 当前设备被其它设备踢下线
{category: 'userNotice', desc:'INFO_UPDATED'} // 用户信息改变：profile或setting
{category: 'userNotice', desc:'DEVICE_LOGIN'} // 用户其它设备上线
{category: 'userNotice', desc:'DEVICE_LOGOUT'} // 用户其它设备下线
{category: 'userNotice', desc:'DEVICE_ADDED'} // 新设备通知
{category: 'userNotice', desc:'DEVICE_REMOVED'} // 设备被移除的通知
{category: 'userNotice', desc:'CLUSTER_CHANGED'} // 用户所在集群改变 需要重新登录
### “flooError” (res)
Floo错误
**Kind** : event emitted by types
Param | Type | Description
---|---|---
res | `object` |
res.category | `string` | 类别
res.desc | `string` | 描述
**Example**
{category: 'USER_BANNED', desc:'用户被禁言'}
{category: 'USER_FROZEN', desc:'用户被冻结，请联系App管理员。'}
{category: 'APP_FROZEN', desc:'APP 被冻结，请登陆蓝莺IM控制台查看详情。'}
{category: 'LICENSE', desc:'无效 LICENSE，请确认服务已按时付费。'}
{category: 'LICENSE', desc:'超出 LICENSE 用户数限制，请购买更高规格服务。'}
{category: 'DNS_FAILED', desc: dnsServer } // DNS错误: 无法访问
### “loginFail” (desc)
登录失败
**Kind** : event emitted by types
Param | Type | Description
---|---|---
desc | `string` | 失败原因
### “loginSuccess” (res)
登录成功
**Kind** : event emitted by types
Param | Type | Description
---|---|---
res | `object` | 空对象
### “onGroupListUpdate” (meta)
群列表更新
**Kind** : event emitted by types
Param | Type | Description
---|---|---
meta | [`Meta`](https://developer.qiniu.com/IM/11906/types) | `undefined`
### “onGroupMemberChanged” (groupId)
群成员列表更新
**Kind** : event emitted by types
Param | Type | Description
---|---|---
groupId | `number` | 群ID
### “onGroupMessage” (meta)
收到群消息
**Kind** : event emitted by types
Param | Type | Description
---|---|---
meta | [`Meta`](https://developer.qiniu.com/IM/11906/types) | 消息内容
### “onInputStatusMessage” (res)
对方正在输入
**Kind** : event emitted by types
Param | Type | Description
---|---|---
res | `object` |
res.ext | `string` | 扩展字段
res.from | `string` | 发送者用户ID
res.to | `string` | 接收者用户ID
### “onMentionMessage” (meta)
收到群组@消息
**Kind** : event emitted by types
Param | Type | Description
---|---|---
meta | [`Meta`](https://developer.qiniu.com/IM/11906/types) | 消息内容
### “onMessageCanceled” (res)
消息被取消已读
**Kind** : event emitted by types
Param | Type | Description
---|---|---
res | `object` |
res.uid | `string` | 会话ID
res.mid | `string` | 消息ID
### “onMessageDeleted” (res)
消息被删除
**Kind** : event emitted by types
Param | Type | Description
---|---|---
res | `object` |
res.uid | `string` | 会话ID
res.mid | `string` | 消息ID
### “onMessageRecalled” (res)
消息被撤回
**Kind** : event emitted by types
Param | Type | Description
---|---|---
res | `object` |
res.uid | `string` | 会话ID
res.mid | `string` | 消息ID
### “onMessageStatusChanged” (res)
消息状态变更：撤回/删除/已读
**Kind** : event emitted by types
Param | Type | Description
---|---|---
res | `object` |
res.uid | `string` | 会话ID
res.mid | `string` | 消息ID
### “onReceiveHistoryMsg” (res)
收到历史消息
**Kind** : event emitted by types
Param | Type | Description
---|---|---
res | `object` |
res.next | `number` | 下次取历史消息的key
### “onRosterInfoUpdate” (res)
好友信息变更
**Kind** : event emitted by types
Param | Type | Description
---|---|---
res | `object` |
res.rosterIds | `Array.<number>` | 好友的用户ID列表
### “onRosterListUpdate” (meta)
好友列表变更
**Kind** : event emitted by types
Param | Type | Description
---|---|---
meta | [`Meta`](https://developer.qiniu.com/IM/11906/types) | 好友通知的消息内容
### “onRosterMessage” (meta)
收到单聊消息
**Kind** : event emitted by types
Param | Type | Description
---|---|---
meta | [`Meta`](https://developer.qiniu.com/IM/11906/types) | 消息内容
### “onSendingMessageStatusChanged” (res)
消息发送状态变更
**Kind** : event emitted by types
Param | Type | Description | |
---|---|---|---|---
res | `object` | | |
res.status: | `number` | 发送状态，取值为sending | failed | sent
res.mid: | `number` | 客户端生成的client_mid | |
### “onUnreadChange” (cid)
未读数改变
**Kind** : event emitted by types
Param | Type | Description
---|---|---
cid | `number` | 会话ID
### “recentlistUpdate”
最近会话更新
**Kind** : event emitted by types
### “onGroupCreated” (meta)
群组创建通知
**Kind** : event emitted by types
Param | Type | Description
---|---|---
meta | [`Meta`](https://developer.qiniu.com/IM/11906/types) | 群通知的消息内容
### “onGroupDestoryed” (meta)
群组解散通知
**Kind** : event emitted by types
Param | Type | Description
---|---|---
meta | [`Meta`](https://developer.qiniu.com/IM/11906/types) | 群通知的消息内容
### “onGroupJoined” (meta)
成员入群通知
**Kind** : event emitted by types
Param | Type | Description
---|---|---
meta | [`Meta`](https://developer.qiniu.com/IM/11906/types) | 群通知的消息内容
### “onGroupApplyAccepted” (meta)
群申请被通过
**Kind** : event emitted by types
Param | Type | Description
---|---|---
meta | [`Meta`](https://developer.qiniu.com/IM/11906/types) | 群通知的消息内容
### “onGroupApplyDeclined” (meta)
群申请被拒绝
**Kind** : event emitted by types
Param | Type | Description
---|---|---
meta | [`Meta`](https://developer.qiniu.com/IM/11906/types) | 群通知的消息内容
### “onGroupBaned” (meta)
被群禁言
**Kind** : event emitted by types
Param | Type | Description
---|---|---
meta | [`Meta`](https://developer.qiniu.com/IM/11906/types) | 群通知的消息内容
### “onGroupUnbaned” (meta)
被群取消禁言
**Kind** : event emitted by types
Param | Type | Description
---|---|---
meta | [`Meta`](https://developer.qiniu.com/IM/11906/types) | 群通知的消息内容
### types~RosterItem : `object`
好友信息
**Kind** : inner typedef of types
**Properties**
Name | Type | Description
---|---|---
alias | `string` | 别名
auth_mode | `number` | 验证方式, 0 - 无需验证，任何人可以加为好友, 1 - 需要同意方可加为好友, 2 - 需要回答问题正确方可加为好友, 3 - 拒绝所有加好友申请,int32
auth_question | `string` | 验证问题
avatar | `string` | 头像
description | `string` | 描述信息
ext | `string` | 扩展信息
mute_notification | `boolean` | 是否接收消息提醒
nick_name | `string` | 昵称或名称
public_info | `string` | 公开信息，好友和陌生人可见
relation | `number` | 关系: 0 - 好友，1 - 被删除，2 - 陌生人, int32
user_id | `number` | 好友用户ID,int64
username | `string` | 用户名
### types~UserSettings : `object`
用户设置信息
**Kind** : inner typedef of types
**Properties**
Name | Type | Description
---|---|---
auth_answer | `string` | 验证问题答案
auth_mode | `number` | 验证方式, 0 - 无需验证，任何人可以加为好友, 1 - 需要同意方可加为好友, 2 - 需要回答问题正确方可加为好友, 3 - 拒绝所有加好友申请,int32
auth_question | `string` | 验证问题
auto_download | `boolean` | 是否自动下载
group_confirm | `boolean` | 邀请入群时是否需要用户确认: true - 需要用户同意才可加入， false - 自动同意邀请
id | `number` | 用户ID, int64
no_push | `boolean` | 是否关闭推送消息
no_push_detail | `boolean` | 是否推送详情
no_push_end_hour | `number` | 推送免打扰结束时间,int32
no_push_start_hour | `number` | 推送免打扰开始时间,int32
no_sounds | `boolean` | 收到消息时是否静音
push_nick_name | `string` | 推送昵称
push_token | `string` | 推送token
silence_end_time | `number` | 推送不提醒结束时间,int32
silence_start_time | `number` | 推送不提醒开始时间,int32
user_id | `number` | 用户ID,int64
vibratory | `boolean` | 收到消息时否振动
### types~UserProfile : `object`
用户信息
**Kind** : inner typedef of types
**Properties**
Name | Type | Description
---|---|---
avatar | `string` | 头像 url
description | `string` | 描述信息
email | `string` | 邮箱
mobile | `string` | 手机号码
nick_name | `string` | 昵称
private_info | `string` | 私有信息，仅自己可见
public_info | `string` | 公开信息，好友和陌生人可见
user_id | `number` | 用户ID,int64
username | `string` | 用户名
### types~Meta : `object`
消息体
**Kind** : inner typedef of types
**Properties**
Name | Type | Description
---|---|---
id | `string` | 消息ID
from | `string` | 发送者
to | `string` | 接收者
content | `string` | 消息内容
type | `string` | 消息类型： text - 文本, image - 图片， audio - 语音, video - 视频，file - 文件, location - 位置， command - 命令, forward - 转发
ext | `string` | `object`
config | `string` | `object`
attach | `string` | `object`
status | `number` | 消息状态： 0 - 未读, 1 - 已投递, 2 - 已读
timestamp | `string` | 消息发送时间戳（毫秒）
toType | `string` | 接收者类型： roster - 好友， group - 群组
### types~RosterApplication : `object`
加好友申请列表项
**Kind** : inner typedef of types
**Properties**
Name | Type | Description
---|---|---
expired_time | `number` | 过期时间,int64
reason | `string` | 申请描述
status | `number` | 状态： 0 - 等待确认， 1 - 接受， 2 - 拒绝。 int32
user_id | `number` | 发起加好友申请的用户ID,int64
### types~GroupInfoAndSettings : `object`
群信息
**Kind** : inner typedef of types
**Properties**
Name | Type | Description
---|---|---
apply_approval | `number` | 入群申请审批设置, 0:同意所有申请 1:需要管理员确认 2:拒绝所有申请
avatar | `string` | 群头像
ban_expire_time | `number` | 全员禁言过期时间（秒），禁言期间只允许管理员发消息， 为0或小于当前时间表示不禁言, -1表示永久禁言
created_at | `number` | 创建时间
description | `string` | 群描述
ext | `string` | 群扩展信息
group_id | `number` | 群id,int64
history_visible | `boolean` | 新成员可见历史聊天记录设置
member_invite | `boolean` | 群成员邀请设置: false - 不允许邀请, true - 允许邀请(默认)
member_modify | `boolean` | 群成员修改群信息设置: false - 群成员不能修改群信息(默认), true - 群成员可以修改群信息
msg_mute_mode | `number` | 群消息屏蔽模式: 0 - 表示不屏蔽, 1 - 表示屏蔽本地消息通知, 2 - 表示屏蔽消息，不接收消息
msg_push_mode | `number` | 群消息推送模式：0 - 接收所有推送，1 - 不接受推送，2 - 接收管理员和@消息推送， 3 - 只接收管理员消息推送， 4 - 只接收@消息推送
name | `string` | 群名称
owner_id | `number` | 群主id,int64
read_ack | `boolean` | 群消息已读功能设置
status | `number` | 群状态, 0：正常, 1：已解散
type | `number` | 群类型: 1表示公开群，0表示私有群, 2表示聊天室
updated_at | `number` | 更新时间,int64
count | `number` | 群成员数
capacity | `number` | 群容量
### types~BriefGroupInfoAndSettings : `object`
群简要信息及用户设置
**Kind** : inner typedef of types
**Properties**
Name | Type | Description
---|---|---
apply_approval | `number` | 入群申请审批设置, 0:同意所有申请 1:需要管理员确认 2:拒绝所有申请
avatar | `string` | 群头像
capacity | `number` | 群容量
count | `number` | 群成员数
group_id | `number` | 群id,int64
msg_mute_mode | `number` | 群消息屏蔽模式: 0 - 表示不屏蔽, 1 - 表示屏蔽本地消息通知, 2 - 表示屏蔽消息，不接收消息
msg_push_mode | `number` | 群消息推送模式：0 - 接收所有推送，1 - 不接受推送，2 - 接收管理员和@消息推送， 3 - 只接收管理员消息推送， 4 - 只接收@消息推送
name | `string` | 群名称
owner | `number` | 群主id,int64
status | `number` | 群状态, 0：正常, 1：已解散,int32
type | `number` | 群类型: 1表示公开群，0表示私有群, 2表示聊天室。int32
### types~GroupMember : `object`
群成员格式
**Kind** : inner typedef of types
**Properties**
Name | Type | Description
---|---|---
display_name | `string` | 成员群名片
join_time | `number` | 成员入群时间,int64
user_id | `number` | 用户id,int64
avatar | `string` | 头像地址
### types~GroupMemberBanned : `object`
禁言成员
**Kind** : inner typedef of types
**Properties**
Name | Type | Description
---|---|---
display_name | `string` | 成员群名片
join_time | `number` | 成员入群时间,int64
user_id | `number` | 用户id,int64
avatar | `string` | 头像地址
expired_time | `number` | 禁言过期时间
### types~GroupUserRelationResponse : `object`
群用户请求结果
**Kind** : inner typedef of types
**Properties**
Name | Type | Description
---|---|---
reason | `string` | 原因
result | `string` | 结果
user_id | `number` | 用户ID，int64
### types~GroupAnnouncement : `object`
群公告内容
**Kind** : inner typedef of types
**Properties**
Name | Type | Description
---|---|---
author | `number` | 公告发布者,int64
content | `string` | 公告内容
created_at | `number` | 公告发布时间,int64
group_id | `number` | 群id,int64
id | `number` | 公告id,int64
title | `string` | 公告标题
### types~GroupInfoRequest : `object`
创建群
**Kind** : inner typedef of types
**Properties**
Name | Type | Description
---|---|---
avatar | `string` | 群头像
description | `string` | 群描述
name | `string` | 群名称
type | `number` | 群类型 1表示公开群，0表示私有群, 2表示聊天室,int32
user_list | `Array.<number>` | 邀请入群的用户id列表
### types~GroupBannedMemberRequest : `object`
禁言请求
**Kind** : inner typedef of types
**Properties**
Name | Type | Description
---|---|---
duration | `number` | 禁言时长，单位为分钟,int64
group_id | `number` | 群id,int64
user_list | `Array.<number>` | 用户id列表
### types~GroupBlockedListItem : `object`
群组黑名单
**Kind** : inner typedef of types
**Properties**
Name | Type | Description
---|---|---
user_id | `number` | 用户id,int64
group_id | `number` | 群id,int64
create_at | `string` | 创建时间
### types~GroupInvitation : `object`
群组邀请信息
**Kind** : inner typedef of types
**Properties**
Name | Type | Description
---|---|---
group_id | `number` | 群ID
inviter_id | `number` | 邀请者ID
invitee_id | `number` | 被邀请者ID
reason | `string` | 原因
status | `number` | 状态： 0 - 待处理，1 - 用户同意，2 - 用户拒绝
expire_time | `number` | 过期时间
create_at | `string` | 创建时间
### types~GroupApplication : `object`
群申请信息
**Kind** : inner typedef of types
**Properties**
Name | Type | Description
---|---|---
group_id | `number` | 群ID
applicant_id | `number` | 申请者ID
reason | `string` | 原因
expire_time | `number` | 过期时间
status | `number` | 状态： 0 - 待处理，1 - 同意，2 - 拒绝
### types~GroupSharedFile : `object`
群共享文件返回格式
**Kind** : inner typedef of types
**Properties**
Name | Type | Description
---|---|---
created_at | `number` | int64
file_id | `number` | 共享文件id,int64
group_id | `number` | 群id,int64
name | `string` | 共享文件名称
size | `number` | 共享文件大小,int64
type | `string` | 共享文件类型
updated_at | `number` | int64
uploader | `number` | 共享文件上传者,int64
url | `string` | 共享文件url
### types~GroupSharedFileResponse : `object`
删除群共享文件结果
**Kind** : inner typedef of types
**Properties**
Name | Type | Description
---|---|---
file_id | `number` | 文件ID
reason | `string` | 原因
result | `string` | 结果
### types~GroupBanAllResponse : `object`
全员禁言结果
**Kind** : inner typedef of types
**Properties**
Name | Type | Description
---|---|---
ban_expire_time | `number` | 全员禁言过期时间,int64
### types~FileUpload : `object`
文件上传信息
**Kind** : inner typedef of types
**Properties**
Name | Type | Description
---|---|---
download_url | `string` | 下载地址
oss_body_param | `object.<string, string>` | 额外参数
upload_url | `string` | 上传地址
### types~FileUploadResult : `object`
文件上传结果
**Kind** : inner typedef of types
**Properties**
Name | Type | Description
---|---|---
url | `string` | 下载地址
### types~fileUploadProgress : `function`
文件上传进度回调
**Kind** : inner typedef of types
Param | Type | Description
---|---|---
res | `object` | 进度
res.loaded | `number` | 已下载字节数
res.total | `number` | 总字节数
### types~ConversationItem : `object`
会话信息
**Kind** : inner typedef of types
**Properties**
Name | Type | Description
---|---|---
id | `number` | 会话ID
content | `string` | 消息内容
timestamp | `string` | 消息发送时间戳（毫秒）
type | `string` | 会话类型： roster - 单聊， group - 群聊
### types~UserProfile : `object`
用户信息
**Kind** : inner typedef of types
**Properties**
Name | Type | Description
---|---|---
avatar | `string` | 头像 url
description | `string` | 描述信息
email | `string` | 邮箱
mobile | `string` | 手机号码
nick_name | `string` | 昵称
private_info | `string` | 私有信息，仅自己可见
public_info | `string` | 公开信息，好友和陌生人可见
user_id | `number` | 用户ID,int64
username | `string` | 用户名
### types~UserSettings : `object`
用户设置信息
**Kind** : inner typedef of types
**Properties**
Name | Type | Description
---|---|---
auth_answer | `string` | 验证问题答案
auth_mode | `number` | 验证方式, 0 - 无需验证，任何人可以加为好友, 1 - 需要同意方可加为好友, 2 - 需要回答问题正确方可加为好友, 3 - 拒绝所有加好友申请,int32
auth_question | `string` | 验证问题
auto_download | `boolean` | 是否自动下载
group_confirm | `boolean` | 邀请入群时是否需要用户确认: true - 需要用户同意才可加入， false - 自动同意邀请
id | `number` | 设置ID
no_push | `boolean` | 是否关闭推送消息
no_push_detail | `boolean` | 是否推送详情
no_push_end_hour | `number` | 推送免打扰结束时间,int32
no_push_start_hour | `number` | 推送免打扰开始时间,int32
no_sounds | `boolean` | 收到消息时是否静音
push_nick_name | `string` | 推送昵称
push_token | `string` | 推送token
silence_end_time | `number` | 推送不提醒结束时间,int32
silence_start_time | `number` | 推送不提醒开始时间,int32
user_id | `number` | 用户ID,int64
vibratory | `boolean` | 收到消息时否振动
### types~Event : `string`
监听事件名称
**Kind** : inner typedef of types
### types~EventCallback : `function`
监听事件回调
**Kind** : inner typedef of types
Param | Type | Description
---|---|---
res | [`flooNotice`](https://developer.qiniu.com/IM/11906/types) | [`flooError`](https://developer.qiniu.com/IM/11906/types)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,123 |
IM Weapp 文档 | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > IM Weapp 文档
# IM Weapp 文档
最近更新时间: 2021-10-21 16:24:55
# qnweapp-im-demo
七牛 IM 微信小程序 demo
SDK 文档同 Web 端：https://developer.qiniu.com/IM/8325/im-web-document
DEMO 地址：https://github.com/pili-engineering/QNWeappIMSDK
SDK 文件下载地址：[qnweapp-im.js __](https://raw.githubusercontent.com/pili-
engineering/QNWeappIMSDK/main/im/qnweapp-im.js)
## 如何运行
1. 安装依赖
$ yarn
2. 打开文件 project.config.json，修改其中的 appid 为你的小程序在微信后台的 AppID。
3. 打开微信开发者工具，选择 「工具」 => 「构建 npm」
## 目录结构介绍
├── README.md
├── api // api 目录
├── app.js
├── app.json
├── app.wxss
├── im // SDK
├── package.json
├── pages
├── project.config.json
├── project.private.config.json
├── sitemap.json
├── store
└── utils // 工具函数
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > IM Weapp 文档
# IM Weapp 文档
最近更新时间: 2021-10-21 16:24:55
# qnweapp-im-demo
七牛 IM 微信小程序 demo
SDK 文档同 Web 端：https://developer.qiniu.com/IM/8325/im-web-document
DEMO 地址：https://github.com/pili-engineering/QNWeappIMSDK
SDK 文件下载地址：[qnweapp-im.js __](https://raw.githubusercontent.com/pili-
engineering/QNWeappIMSDK/main/im/qnweapp-im.js)
## 如何运行
1. 安装依赖
$ yarn
2. 打开文件 project.config.json，修改其中的 appid 为你的小程序在微信后台的 AppID。
3. 打开微信开发者工具，选择 「工具」 => 「构建 npm」
## 目录结构介绍
├── README.md
├── api // api 目录
├── app.js
├── app.json
├── app.wxss
├── im // SDK
├── package.json
├── pages
├── project.config.json
├── project.private.config.json
├── sitemap.json
├── store
└── utils // 工具函数
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,167 |
IM Uniapp 文档 | 即时通讯 | [即时通讯](https://developer.qiniu.com/IM) > API 文档 > IM Uniapp 文档
# IM Uniapp 文档
最近更新时间: 2021-10-21 16:25:06
# qnuniapp-im-demo
七牛 IM uniapp 版
SDK 文档同 Web 端：https://developer.qiniu.com/IM/8325/im-web-document
DEMO 地址：https://github.com/pili-engineering/QNUniappIMSDK
SDK 文件下载地址：[qnuniapp-im.js __](https://raw.githubusercontent.com/pili-
engineering/QNUniappIMSDK/main/im/qnuniapp-im.js)
## 如何运行
1. 打开 HBuilder
2. 导入项目
3. 打开 manifest.json 并修改基础配置各端的配置(如果是运行到微信小程序则需将「微信小程序配置」的 AppID 修改为你的小程序在微信后台的 AppID)
4. 选择 「运行」=> 「运行到 xxx」
## 目录结构介绍
.
├── App.vue // 根组件
├── README.md
├── common
├── config // 配置项
├── im // SDK
├── index.html
├── main.js
├── manifest.json
├── pages // 页面
├── pages.json
├── static
├── uni.scss
├── uni_modules
├── unpackage
└── utils // 工具函数
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[即时通讯](https://developer.qiniu.com/IM) > API 文档 > IM Uniapp 文档
# IM Uniapp 文档
最近更新时间: 2021-10-21 16:25:06
# qnuniapp-im-demo
七牛 IM uniapp 版
SDK 文档同 Web 端：https://developer.qiniu.com/IM/8325/im-web-document
DEMO 地址：https://github.com/pili-engineering/QNUniappIMSDK
SDK 文件下载地址：[qnuniapp-im.js __](https://raw.githubusercontent.com/pili-
engineering/QNUniappIMSDK/main/im/qnuniapp-im.js)
## 如何运行
1. 打开 HBuilder
2. 导入项目
3. 打开 manifest.json 并修改基础配置各端的配置(如果是运行到微信小程序则需将「微信小程序配置」的 AppID 修改为你的小程序在微信后台的 AppID)
4. 选择 「运行」=> 「运行到 xxx」
## 目录结构介绍
.
├── App.vue // 根组件
├── README.md
├── common
├── config // 配置项
├── im // SDK
├── index.html
├── main.js
├── manifest.json
├── pages // 页面
├── pages.json
├── static
├── uni.scss
├── uni_modules
├── unpackage
└── utils // 工具函数
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,169 |
动态加速升级全站加速 | 全站加速 | [全站加速](https://developer.qiniu.com/dcdn) > 产品动态 > 动态加速升级全站加速
# 动态加速升级全站加速
最近更新时间: 2022-02-21 18:49:47
自2022年03月01日起，动态加速全面升级为全站加速DCDN。
全站加速在动态加速的基础上融合静态加速的能力，通过资源动静态分离、智能缓存、路由优化等核心技术一站式解决动静态资源混合站点内容分发慢的问题。您可通过配置静态缓存规则，实现纯动态加速的业务场景。本次升级主要影响包括（红色部分需要您重新适配）：
## 页面功能
1. CDN产品页面保留网页/下载/点播平台的域名业务，动态加速域名统一迁移至在DCDN产品页面进行管理，若创建动态加速域名请移步DCDN产品页面；
2. DCDN产品页面，新增「缓存配置」模块，默认关闭，即动态加速不缓存；打开后配置静态缓存规则，命中规则遵循静态边缘缓存逻辑，未命中部门使用最优线路动态回源，实现全站加速的效果。
3. DCDN支持IAM功能，**`若您有动态加速域名且对动态加速域名进行了IAM授权，本次升级影响原来的授权，需对DCDN服务域名重新授权`** ，可前往[策略管理处 __](https://portal.qiniu.com/iam/policy/create)，其他场景域名授权不受影响。
## 配置说明
1. 本次迁移不影响域名默认配置，若您的动态加速域名有特殊静态缓存规则，原配置依旧保留不影响线上业务，但不在控制台展示。为方便管理，建议您在控制台重新配置缓存规则，新规则将覆盖老规则；
2. 接口层面，DCDN提供了新接口，原有接口依旧适配，若您有动态加速业务，建议对接新接口；
## 账单说明
1. 计费项
升级前，动态加速计费项包括：基础流量费用（动态）、动态请求次数费用，若您申请配置过特殊静态缓存规则，产生的静态流量计入CDN流量计费项；
升级后，全站加速计费项包括：基础流量费用（动态和静态）、动态请求次数费用；
其中，DCDN 流量、 动态加速流量、CDN静态流量价格相同，理论上不影响客户费用，若因流量过大产生了阶梯计费差，可联系商务单独处理；
2. 价格
基础流量、动态请求次数单价不变，可参考[官网 __](https://www.qiniu.com/prices/qcdn)；
3. 资源包
本次升级不影响历史融合资源包的抵扣，购买资源包可前往[商城
__](https://qmall.qiniu.com/template/NTI?spec_combo=MTk0OA)选购。
## 常见问题
**Q：使用了动态加速域名，并且特殊配置了静态缓存规则，2月份对账时， CDN 账单流量与控制台查询的流量有出入。**
A：升级前动态加速域名产生的静态流量计入到 CDN ，故2月份账单中的 CDN
静态流量计费项包含了动态加速域名产生的静态流量。升级后新逻辑调整为动态加速域名产生的静态流量计入到 DCDN
（原动态加速流量计费项），故升级后控制台/接口查询历史 CDN
流量时，调用接口走新的逻辑，查询的结果不包含动态加速域名产生的静态流量。2月份账单对账时，应结合控制台/接口查询到的 CDN 静态流量、DCDN
静态流量来与 CDN 流量账单进行比对。升级后的账单与控制台查询用量预期一致。
**Q：网页/下载/点播平台域名是否可以转为全站加速域名。**
A：控制台不支持直接转换，可提交工单联系售后人员进行处理。以下几点还请关注：
* 由于网页/下载/点播平台域名和全站加速域名的默认缓存规则不同，转换前后缓存规则有所变化，需要您重新适配；
* 全站加速和普通CDN域名实现逻辑有区别，功能支持情况有所区别，建议您先前往DCDN控制台了解功能支持情况；
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[全站加速](https://developer.qiniu.com/dcdn) > 产品动态 > 动态加速升级全站加速
# 动态加速升级全站加速
最近更新时间: 2022-02-21 18:49:47
自2022年03月01日起，动态加速全面升级为全站加速DCDN。
全站加速在动态加速的基础上融合静态加速的能力，通过资源动静态分离、智能缓存、路由优化等核心技术一站式解决动静态资源混合站点内容分发慢的问题。您可通过配置静态缓存规则，实现纯动态加速的业务场景。本次升级主要影响包括（红色部分需要您重新适配）：
## 页面功能
1. CDN产品页面保留网页/下载/点播平台的域名业务，动态加速域名统一迁移至在DCDN产品页面进行管理，若创建动态加速域名请移步DCDN产品页面；
2. DCDN产品页面，新增「缓存配置」模块，默认关闭，即动态加速不缓存；打开后配置静态缓存规则，命中规则遵循静态边缘缓存逻辑，未命中部门使用最优线路动态回源，实现全站加速的效果。
3. DCDN支持IAM功能，**`若您有动态加速域名且对动态加速域名进行了IAM授权，本次升级影响原来的授权，需对DCDN服务域名重新授权`** ，可前往[策略管理处 __](https://portal.qiniu.com/iam/policy/create)，其他场景域名授权不受影响。
## 配置说明
1. 本次迁移不影响域名默认配置，若您的动态加速域名有特殊静态缓存规则，原配置依旧保留不影响线上业务，但不在控制台展示。为方便管理，建议您在控制台重新配置缓存规则，新规则将覆盖老规则；
2. 接口层面，DCDN提供了新接口，原有接口依旧适配，若您有动态加速业务，建议对接新接口；
## 账单说明
1. 计费项
升级前，动态加速计费项包括：基础流量费用（动态）、动态请求次数费用，若您申请配置过特殊静态缓存规则，产生的静态流量计入CDN流量计费项；
升级后，全站加速计费项包括：基础流量费用（动态和静态）、动态请求次数费用；
其中，DCDN 流量、 动态加速流量、CDN静态流量价格相同，理论上不影响客户费用，若因流量过大产生了阶梯计费差，可联系商务单独处理；
2. 价格
基础流量、动态请求次数单价不变，可参考[官网 __](https://www.qiniu.com/prices/qcdn)；
3. 资源包
本次升级不影响历史融合资源包的抵扣，购买资源包可前往[商城
__](https://qmall.qiniu.com/template/NTI?spec_combo=MTk0OA)选购。
## 常见问题
**Q：使用了动态加速域名，并且特殊配置了静态缓存规则，2月份对账时， CDN 账单流量与控制台查询的流量有出入。**
A：升级前动态加速域名产生的静态流量计入到 CDN ，故2月份账单中的 CDN
静态流量计费项包含了动态加速域名产生的静态流量。升级后新逻辑调整为动态加速域名产生的静态流量计入到 DCDN
（原动态加速流量计费项），故升级后控制台/接口查询历史 CDN
流量时，调用接口走新的逻辑，查询的结果不包含动态加速域名产生的静态流量。2月份账单对账时，应结合控制台/接口查询到的 CDN 静态流量、DCDN
静态流量来与 CDN 流量账单进行比对。升级后的账单与控制台查询用量预期一致。
**Q：网页/下载/点播平台域名是否可以转为全站加速域名。**
A：控制台不支持直接转换，可提交工单联系售后人员进行处理。以下几点还请关注：
* 由于网页/下载/点播平台域名和全站加速域名的默认缓存规则不同，转换前后缓存规则有所变化，需要您重新适配；
* 全站加速和普通CDN域名实现逻辑有区别，功能支持情况有所区别，建议您先前往DCDN控制台了解功能支持情况；
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,170 |
产品概述 | 全站加速 | [全站加速](https://developer.qiniu.com/dcdn) > 产品简介 > 产品概述
# 产品概述
最近更新时间: 2022-01-11 10:43:45
## 产品简介
七牛全站加速 DCDN
在CDN静态加速的基础上融合了动态加速的能力，通过资源动静态分离、智能缓存、路由优化等核心技术一站式解决动静态资源混合站点内容分发慢的问题。适用于动态资源或动静态资源混合的加速场景。
## 产品架构
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[全站加速](https://developer.qiniu.com/dcdn) > 产品简介 > 产品概述
# 产品概述
最近更新时间: 2022-01-11 10:43:45
## 产品简介
七牛全站加速 DCDN
在CDN静态加速的基础上融合了动态加速的能力，通过资源动静态分离、智能缓存、路由优化等核心技术一站式解决动静态资源混合站点内容分发慢的问题。适用于动态资源或动静态资源混合的加速场景。
## 产品架构
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,174 |
功能特性 | 全站加速 | [全站加速](https://developer.qiniu.com/dcdn) > 产品简介 > 功能特性
# 功能特性
最近更新时间: 2022-01-27 11:42:02
# 动静混合加速
采用动静混合智能分离技术，自动识别动静态资源，静态资源边缘缓存高效分发，动态资源决策最优链路回源，实现资源精准加速。
# 资源覆盖全球
沉淀多年 CDN 管控经验，精选核心高质量节点，实现覆盖全球的边缘节点架构体系，国内无盲区覆盖各地、各运营商，海外广泛覆盖70多个国家和地区。
# 智能调度系统
基于全网请求来源的智能调度系统，支持 DNS、HttpDNS、Http302 调度模式，有效提高访问响应速度，防止劫持，实现全网实时精准调度调度。
# 私有协议优化
使用私有传输协议作为 DCDN 内部数据交换的基础，确保客户资源安全、快速的传输到各个节点，实现客户内容高效、可靠的进行分发。
# 链路优化
七牛自研探测 AGENT，精确探测点到点之间的链路质量，凭借特有的链路决策算法，可以保证边缘节点到源站之间的所有链路最优。
# 立体品控
基于权威 APM 的全网覆盖「性能监控」和七牛自研的监控数据为基础上自研的全网「实时可用性监控」，打造七牛 DCDN 立体品控体系。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[全站加速](https://developer.qiniu.com/dcdn) > 产品简介 > 功能特性
# 功能特性
最近更新时间: 2022-01-27 11:42:02
# 动静混合加速
采用动静混合智能分离技术，自动识别动静态资源，静态资源边缘缓存高效分发，动态资源决策最优链路回源，实现资源精准加速。
# 资源覆盖全球
沉淀多年 CDN 管控经验，精选核心高质量节点，实现覆盖全球的边缘节点架构体系，国内无盲区覆盖各地、各运营商，海外广泛覆盖70多个国家和地区。
# 智能调度系统
基于全网请求来源的智能调度系统，支持 DNS、HttpDNS、Http302 调度模式，有效提高访问响应速度，防止劫持，实现全网实时精准调度调度。
# 私有协议优化
使用私有传输协议作为 DCDN 内部数据交换的基础，确保客户资源安全、快速的传输到各个节点，实现客户内容高效、可靠的进行分发。
# 链路优化
七牛自研探测 AGENT，精确探测点到点之间的链路质量，凭借特有的链路决策算法，可以保证边缘节点到源站之间的所有链路最优。
# 立体品控
基于权威 APM 的全网覆盖「性能监控」和七牛自研的监控数据为基础上自研的全网「实时可用性监控」，打造七牛 DCDN 立体品控体系。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,175 |
计费说明 | 全站加速 | [全站加速](https://developer.qiniu.com/dcdn) > 购买指南 > 计费说明
# 计费说明
最近更新时间: 2023-09-18 10:32:24
七牛云 DCDN 计费组成包括：**动态请求数计费** 和**流量计费** 。
# 1\. 动态请求数计费
## 1.1 价格说明
动态加速请求次数不分区域，全球统一价格。
动态请求数
---
名目 | 请求数 | 价格
动态加速请求数 | 第 0 次至 5 万次 | 免费
第 5 万次及以上 | 0.19 元/万次
## 1.2 计费方式
默认后付费按量计费。
## 1.3 细则说明
* 该计费项仅对动态请求计费，静态请求不额外收费。
* 请求次数以每万次请求为单位进行计算，不足万按万计算。
# 2\. 流量计费
## 2.1 价格说明
七牛云 DCDN 默认按国内海外[不同区域阶梯流量价格
__](https://www.qiniu.com/prices/qcdn)计费，当月分别超额累进，每个自然月为一个累计周期。其他计费方式请联系七牛商务（400-808-9176
转 2 号线）或工单咨询。
**2.1.1 国内流量价格**
名目 | 流量阶梯 （元/GB） | 价格
---|---|---
HTTP 下载流量/动态加速 HTTP 流量
第 0 GB 至 100 TB | 0.24
第 100 TB 至 1 PB | 0.19
第 1PB 以上 | 0.14
HTTPS 下载流量/动态加速 HTTPS 流量 | 第 0 GB 至 100 TB | 0.28
第 100 TB 至 1 PB | 0.23
第 1PB 以上 | 0.18
**2.1.2 海外流量价格**
名目 | 流量阶梯 （元/GB） | 亚洲（港澳台/东南亚/印度） | 亚洲（其他地区） | 欧洲/北美洲 | 南美洲 | 大洋洲与其他
---|---|---|---|---|---|---
HTTP 下载流量/动态加速 HTTP 流量
第 0 GB 至 10 TB | 0.76 | 0.50 | 0.34 | 0.76 | 0.94
第 10 TB 至 50 TB | 0.66 | 0.44 | 0.30 | 0.66 | 0.82
第 50 TB 至 100 TB | 0.57 | 0.38 | 0.26 | 0.57 | 0.71
第 100TB 以上 | 请联系我们 400-808-9176 转 1
HTTPS 下载流量/动态加速 HTTPS 流量 | 第 0 GB 至 10 TB | 0.91 | 0.60 | 0.40 | 0.91 | 1.12
第 10 TB 至 50 TB | 0.79 | 0.52 | 0.36 | 0.79 | 0.98
第 50 TB 至 100TB | 0.68 | 0.45 | 0.31 | 0.68 | 0.85
第 100TB 以上 | 请联系我们 400-808-9176 转 1
## 2.2 计费方式
针对流量计费，七牛云 DCDN 提供两种付费方式，即后付费按量计费和预付费资源包，默认计费方式为后付费按量计费。
**2.2.1 按量后付费**
您可使用[CDN价格计算器 __](https://www.qiniu.com/prices/qcdn?tab=calc)进行用量预估；
**2.2.2 按资源包预付费**
七牛云 DCDN 可与 CDN 共用融合资源包，同时共享每月各分区 10GB HTTP
下载流量的免费额度，历史已购买的融合资源包支持抵扣。购买时请根据域名的加速范围选择类型：[CDN 中国大陆资源包
__](https://qmall.qiniu.com/template/NTI?spec_combo=MTk0OA)或[CDN 海外资源包
__](https://qmall.qiniu.com/template/NTU?ref=category&spec_combo=MjEzNA)
（1）资源包类型
“CDN 下行通用流量”适用于 http 和 https 的静态或全站加速下行流量，其中 http 和 https 协议按照1: 1.15
的系数抵扣，https 协议不额外收取静态加速请求次数费用。
> **如何理解系数？** 实际使用 https
> 流量100GB，相当于抵扣资源包流量115GB。资源包的额度可以理解成诸如“点数”的概念，同单位的不同商品需要抵扣的点数不同。
> **按什么顺序抵扣？**
> 当资源包额度充足时（账单额度<资源包余量），资源包可全部抵扣金额；当资源包额度不够时（账单额度<资源包余量），按以下顺序抵扣：静态加速
> HTTP、静态加速 HTTPS、动态加速 HTTP、动态加速 HTTPS。
（2）可用区域
可根据域名的实际加速区域选择资源包的可用区域；如果加速区域为全球，可能同时产生国内流量和海外流量。
（3）可用时段
为方便不同类型的用户优化 CDN 成本，七牛提供以下几种时段的资源包：
* **全时段流量包** ：全时段指每天 0:00 - 24:00
* **日间时段流量包** ：日间时段指每天 09:00 - 18:00
* **闲时流量包** ：闲时段指每天 00:00 - 09:00
叠加使用规则和抵扣顺序参考 资源包可以叠加使用吗？抵扣顺序是什么？
（4）用量额度（用量预估）
可根据历史用量和实际使用需求预估资源包大小，建议可预估一年用量购买。
（5）分配方式
一次性分配资源包的流量在生效期内均可使用。
（6）余量查询
七牛云按量付费资源采取月结算模式，实时消费明细仅为预估账单和余额预扣除，没有实际完成扣除，所以资源包使用情况最终以月账单更新为准，我们可通过以下方法预估资源包使用情况：
* [资源包管理 __](https://portal.qiniu.com/financial/orders/respack-mgr/current)，查看估算资源包的使用情况
* [实时消费明细 __](https://portal.qiniu.com/financial/bills/estimated-consume)，查看本月资源包抵扣明细
注：实时消费明细每日8点更新一次，非实时动态更新，更新用量的使用时间截止为本日0点。
# 3\. 常见问题
**Q：开启 HTTPS 以后如何收费？**
域名开启 HTTPS 配置以后，该域名下所有流量（包括 HTTPS 和 HTTP 请求）即开始按照 HTTPS 协议的价格进行收费。静态加速下 HTTPS
协议不额外收请求次数费用。对于月中升级为 https 的用户，本月计量都按照https计算。
默认配置下可兼容 HTTP 和 HTTPS 两种协议的请求，如需强制 HTTPS 访问，请在控制台开启“强制 HTTPS 访问”配置。
**Q：欠费以后还可以继续使用吗？**
欠费以后，无法新增域名和修改域名。更多信息请见：
[欠费状态下各产品的限制功能 __](https://developer.qiniu.com/af/manual/6650/owe-the-
protection-limit-function)
[新版欠费流程 __](https://developer.qiniu.com/af/kb/5996/new-owe-the-process-
description)
**Q：资源包可以叠加使用吗？抵扣顺序是什么？**
资源包可叠加购买，出账时将按照以下规则进行抵扣：
**Q：使用量超出资源包后如何计费？**
在资源包生效期间内，若当月用量超出可用资源包额度，出账时将优先抵扣完资源包额度，超出部分再按照官网 [CDN 后付费价格
__](https://www.qiniu.com/prices)结算。
**Q：今天8点后购买的资源包，为什么没有进行抵扣？**
实时消费明细 每日8点更新，更新用量的使用时间是截止本日0点，非实时动态更新，当月生效的资源包，您可以在购买后第二天，在财务中心查看实时消费明细账单。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[全站加速](https://developer.qiniu.com/dcdn) > 购买指南 > 计费说明
# 计费说明
最近更新时间: 2023-09-18 10:32:24
七牛云 DCDN 计费组成包括：**动态请求数计费** 和**流量计费** 。
# 1\. 动态请求数计费
## 1.1 价格说明
动态加速请求次数不分区域，全球统一价格。
动态请求数
---
名目 | 请求数 | 价格
动态加速请求数 | 第 0 次至 5 万次 | 免费
第 5 万次及以上 | 0.19 元/万次
## 1.2 计费方式
默认后付费按量计费。
## 1.3 细则说明
* 该计费项仅对动态请求计费，静态请求不额外收费。
* 请求次数以每万次请求为单位进行计算，不足万按万计算。
# 2\. 流量计费
## 2.1 价格说明
七牛云 DCDN 默认按国内海外[不同区域阶梯流量价格
__](https://www.qiniu.com/prices/qcdn)计费，当月分别超额累进，每个自然月为一个累计周期。其他计费方式请联系七牛商务（400-808-9176
转 2 号线）或工单咨询。
**2.1.1 国内流量价格**
名目 | 流量阶梯 （元/GB） | 价格
---|---|---
HTTP 下载流量/动态加速 HTTP 流量
第 0 GB 至 100 TB | 0.24
第 100 TB 至 1 PB | 0.19
第 1PB 以上 | 0.14
HTTPS 下载流量/动态加速 HTTPS 流量 | 第 0 GB 至 100 TB | 0.28
第 100 TB 至 1 PB | 0.23
第 1PB 以上 | 0.18
**2.1.2 海外流量价格**
名目 | 流量阶梯 （元/GB） | 亚洲（港澳台/东南亚/印度） | 亚洲（其他地区） | 欧洲/北美洲 | 南美洲 | 大洋洲与其他
---|---|---|---|---|---|---
HTTP 下载流量/动态加速 HTTP 流量
第 0 GB 至 10 TB | 0.76 | 0.50 | 0.34 | 0.76 | 0.94
第 10 TB 至 50 TB | 0.66 | 0.44 | 0.30 | 0.66 | 0.82
第 50 TB 至 100 TB | 0.57 | 0.38 | 0.26 | 0.57 | 0.71
第 100TB 以上 | 请联系我们 400-808-9176 转 1
HTTPS 下载流量/动态加速 HTTPS 流量 | 第 0 GB 至 10 TB | 0.91 | 0.60 | 0.40 | 0.91 | 1.12
第 10 TB 至 50 TB | 0.79 | 0.52 | 0.36 | 0.79 | 0.98
第 50 TB 至 100TB | 0.68 | 0.45 | 0.31 | 0.68 | 0.85
第 100TB 以上 | 请联系我们 400-808-9176 转 1
## 2.2 计费方式
针对流量计费，七牛云 DCDN 提供两种付费方式，即后付费按量计费和预付费资源包，默认计费方式为后付费按量计费。
**2.2.1 按量后付费**
您可使用[CDN价格计算器 __](https://www.qiniu.com/prices/qcdn?tab=calc)进行用量预估；
**2.2.2 按资源包预付费**
七牛云 DCDN 可与 CDN 共用融合资源包，同时共享每月各分区 10GB HTTP
下载流量的免费额度，历史已购买的融合资源包支持抵扣。购买时请根据域名的加速范围选择类型：[CDN 中国大陆资源包
__](https://qmall.qiniu.com/template/NTI?spec_combo=MTk0OA)或[CDN 海外资源包
__](https://qmall.qiniu.com/template/NTU?ref=category&spec_combo=MjEzNA)
（1）资源包类型
“CDN 下行通用流量”适用于 http 和 https 的静态或全站加速下行流量，其中 http 和 https 协议按照1: 1.15
的系数抵扣，https 协议不额外收取静态加速请求次数费用。
> **如何理解系数？** 实际使用 https
> 流量100GB，相当于抵扣资源包流量115GB。资源包的额度可以理解成诸如“点数”的概念，同单位的不同商品需要抵扣的点数不同。
> **按什么顺序抵扣？**
> 当资源包额度充足时（账单额度<资源包余量），资源包可全部抵扣金额；当资源包额度不够时（账单额度<资源包余量），按以下顺序抵扣：静态加速
> HTTP、静态加速 HTTPS、动态加速 HTTP、动态加速 HTTPS。
（2）可用区域
可根据域名的实际加速区域选择资源包的可用区域；如果加速区域为全球，可能同时产生国内流量和海外流量。
（3）可用时段
为方便不同类型的用户优化 CDN 成本，七牛提供以下几种时段的资源包：
* **全时段流量包** ：全时段指每天 0:00 - 24:00
* **日间时段流量包** ：日间时段指每天 09:00 - 18:00
* **闲时流量包** ：闲时段指每天 00:00 - 09:00
叠加使用规则和抵扣顺序参考 资源包可以叠加使用吗？抵扣顺序是什么？
（4）用量额度（用量预估）
可根据历史用量和实际使用需求预估资源包大小，建议可预估一年用量购买。
（5）分配方式
一次性分配资源包的流量在生效期内均可使用。
（6）余量查询
七牛云按量付费资源采取月结算模式，实时消费明细仅为预估账单和余额预扣除，没有实际完成扣除，所以资源包使用情况最终以月账单更新为准，我们可通过以下方法预估资源包使用情况：
* [资源包管理 __](https://portal.qiniu.com/financial/orders/respack-mgr/current)，查看估算资源包的使用情况
* [实时消费明细 __](https://portal.qiniu.com/financial/bills/estimated-consume)，查看本月资源包抵扣明细
注：实时消费明细每日8点更新一次，非实时动态更新，更新用量的使用时间截止为本日0点。
# 3\. 常见问题
**Q：开启 HTTPS 以后如何收费？**
域名开启 HTTPS 配置以后，该域名下所有流量（包括 HTTPS 和 HTTP 请求）即开始按照 HTTPS 协议的价格进行收费。静态加速下 HTTPS
协议不额外收请求次数费用。对于月中升级为 https 的用户，本月计量都按照https计算。
默认配置下可兼容 HTTP 和 HTTPS 两种协议的请求，如需强制 HTTPS 访问，请在控制台开启“强制 HTTPS 访问”配置。
**Q：欠费以后还可以继续使用吗？**
欠费以后，无法新增域名和修改域名。更多信息请见：
[欠费状态下各产品的限制功能 __](https://developer.qiniu.com/af/manual/6650/owe-the-
protection-limit-function)
[新版欠费流程 __](https://developer.qiniu.com/af/kb/5996/new-owe-the-process-
description)
**Q：资源包可以叠加使用吗？抵扣顺序是什么？**
资源包可叠加购买，出账时将按照以下规则进行抵扣：
**Q：使用量超出资源包后如何计费？**
在资源包生效期间内，若当月用量超出可用资源包额度，出账时将优先抵扣完资源包额度，超出部分再按照官网 [CDN 后付费价格
__](https://www.qiniu.com/prices)结算。
**Q：今天8点后购买的资源包，为什么没有进行抵扣？**
实时消费明细 每日8点更新，更新用量的使用时间是截止本日0点，非实时动态更新，当月生效的资源包，您可以在购买后第二天，在财务中心查看实时消费明细账单。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,176 |
控制台指南 | 全站加速 | [全站加速](https://developer.qiniu.com/dcdn) > 快速入门 > 控制台指南
# 控制台指南
最近更新时间: 2022-02-18 15:02:00
欢迎查看 DCDN 帮助文档。您可以在任意时间地点使用七牛云全站加速，以提供稳定快速的网络访问质量。使用七牛云全站资源加速的整个流程共分以下几步：
* 注册七牛云
* 添加自定义域名
* 配置域名
* 配置CNAME
七牛云为空间资源提供测试域名，该类域名的源站为域名所在空间，默认缓存设置时间 1个月，无法自定义配置，也无法用于全站加速产品，建议您添加自定义域名使用。
为了顺利完成快速入门，您需要一个七牛云账号。如果您还没有七牛云账号，请通过以下步骤创建七牛云账号。
# 1\. 注册七牛云
（1）打开 [七牛开发者平台 __](https://portal.qiniu.com/)，选择**注册** 。
（2）遵循在线使用说明，完成实名认证。
# 2\. 添加自定义域名
## 2.1 配置要求
配置域名不产生任何费用，要求具备：
* 已备案域名，且允许做域名解析，可在[域名信息备案系统 __](http://beian.miit.gov.cn/state/outPortal/loginPortal.action)查询
* 账号已完成实名认证；
## 2.2 配置入口
方式1：登陆[七牛开发者平台 __](https://portal.qiniu.com/signin)，选择**添加加速域名** 。
**方式2** :登陆[七牛开发者平台 __](https://portal.qiniu.com/signin)，点击**所有产品** ，选择
**DCDN** ，点击添加域名。
**注意** ：如果您界面上方显示的是 **未完成实名认证** ，如下图所示：
此时您需要在 **个人中心** 进行实名认证
## 2.3 配置项说明
（1）**域名类型**
* 普通域名，是指您的主域名下的子域名。例如主域名qiniu.com，developer.qiniu.com是其二级域名，a.developer.qiniu.com是其三级域名,…,这些都属于普通域名。
* 泛域名，是指域名*.主域名，配置成功后可任意指定前缀进行访问；可基于该泛域名创建多个泛子域名来指定不同源站，例如泛域名 *.qiniu.com。
（2）**加速域名** ：要求填写**已备案** 的域名
（3）**通信协议** ：支持http或https通信协议
如果您选择 https协议，您还需上传有效期≥30天的 HTTPS 证书。（注：为不影响正常使用，证书到期后请及时续期）
（4）**覆盖范围** ：分为国内、海外、全球，根据业务范围选择节点覆盖区域。不同区域流量价格不同，可参考[官网价格
__](https://www.qiniu.com/prices/qcdn)。
（5） **IP协议**
* IPv4/IPv6，同时支持IPv4和IPv6的请求，该协议支持国内/全球，海外默认仅支持ipv4，海外IPv6的需求可联系[工单 __](https://support.qiniu.com/tickets/new)配置。
* IPv4，仅支持IPv4请求，不支持IPv6请求。
（6）**源站配置**
* 源站域名，填写您的源站域名，不能与**加速域名** 相同。**源站测试** 中需要您填写您需要加速的资源名，通过源站测试，表明源站配置正确。
* IP地址，填写您源站的IP地址，**源站测试** 中需要您填写您需要加速的资源名，通过源站测试，表明源站配置正确。
（7）**缓存配置**
* 关闭，默认关闭状态，即纯动态加速场景，不做任何缓存。
* 开启，适用动静态资源混合的场景，开启后可配置不同后缀或目录的静态缓存规则，命中规则部分遵循静态边缘缓存逻辑，未命中部分使用最优链路动态回源。
（8）**忽略 URL 参数**
* 关闭，默认关闭状态，完全按照参数缓存
* 开启，适用于提高边缘命中率且URL「?」后的参数不影响文件内容的场景。可配置「忽略全部参数」或「忽略指定参数」，静态资源会去除 URL「?」后的全部参数或指定参数进行缓存。
## 2.4 点击「创建」，提交配置
# 3\. 配置域名
若除创建域名的基础配置外，您还有其他配置需求，**返回域名管理** ，在域名管理页面单击目标域名对应配置，此时您可以设置：
* [回源配置 __](http://developer.qiniu.com/dcdn/development_guidelines/10778/dcdn-back-to-the-source-configuration)
* [缓存配置 __](http://developer.qiniu.com/dcdn/development_guidelines/10786/dcdn-cache-configuration)
* [访问控制 __](http://developer.qiniu.com/dcdn/development_guidelines/10791/dcdn-ip-black-and-white-list)
* [HTTPS配置 __](http://developer.qiniu.com/dcdn/development_guidelines/10792/dcdn-https-configuration)
* [HTTP响应头 __](http://developer.qiniu.com/dcdn/development_guidelines/10793/dcdn-the-http-response-header-configuration)
# 4\. 配置CNAME
(1)获取cname地址
方式1：创建加速域名成功后，七牛云会提供cname地址。
方式2：在 **域名管理** 界面选择创建好的 【域名】 ，点击 【配置】 ，提供的cname在红框中标注。
（2）配置cname，详情见文档[如何配置域名的CNAME
__](https://developer.qiniu.com/fusion/kb/1322/how-to-configure-cname-domain-
name)。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[全站加速](https://developer.qiniu.com/dcdn) > 快速入门 > 控制台指南
# 控制台指南
最近更新时间: 2022-02-18 15:02:00
欢迎查看 DCDN 帮助文档。您可以在任意时间地点使用七牛云全站加速，以提供稳定快速的网络访问质量。使用七牛云全站资源加速的整个流程共分以下几步：
* 注册七牛云
* 添加自定义域名
* 配置域名
* 配置CNAME
七牛云为空间资源提供测试域名，该类域名的源站为域名所在空间，默认缓存设置时间 1个月，无法自定义配置，也无法用于全站加速产品，建议您添加自定义域名使用。
为了顺利完成快速入门，您需要一个七牛云账号。如果您还没有七牛云账号，请通过以下步骤创建七牛云账号。
# 1\. 注册七牛云
（1）打开 [七牛开发者平台 __](https://portal.qiniu.com/)，选择**注册** 。
（2）遵循在线使用说明，完成实名认证。
# 2\. 添加自定义域名
## 2.1 配置要求
配置域名不产生任何费用，要求具备：
* 已备案域名，且允许做域名解析，可在[域名信息备案系统 __](http://beian.miit.gov.cn/state/outPortal/loginPortal.action)查询
* 账号已完成实名认证；
## 2.2 配置入口
方式1：登陆[七牛开发者平台 __](https://portal.qiniu.com/signin)，选择**添加加速域名** 。
**方式2** :登陆[七牛开发者平台 __](https://portal.qiniu.com/signin)，点击**所有产品** ，选择
**DCDN** ，点击添加域名。
**注意** ：如果您界面上方显示的是 **未完成实名认证** ，如下图所示：
此时您需要在 **个人中心** 进行实名认证
## 2.3 配置项说明
（1）**域名类型**
* 普通域名，是指您的主域名下的子域名。例如主域名qiniu.com，developer.qiniu.com是其二级域名，a.developer.qiniu.com是其三级域名,…,这些都属于普通域名。
* 泛域名，是指域名*.主域名，配置成功后可任意指定前缀进行访问；可基于该泛域名创建多个泛子域名来指定不同源站，例如泛域名 *.qiniu.com。
（2）**加速域名** ：要求填写**已备案** 的域名
（3）**通信协议** ：支持http或https通信协议
如果您选择 https协议，您还需上传有效期≥30天的 HTTPS 证书。（注：为不影响正常使用，证书到期后请及时续期）
（4）**覆盖范围** ：分为国内、海外、全球，根据业务范围选择节点覆盖区域。不同区域流量价格不同，可参考[官网价格
__](https://www.qiniu.com/prices/qcdn)。
（5） **IP协议**
* IPv4/IPv6，同时支持IPv4和IPv6的请求，该协议支持国内/全球，海外默认仅支持ipv4，海外IPv6的需求可联系[工单 __](https://support.qiniu.com/tickets/new)配置。
* IPv4，仅支持IPv4请求，不支持IPv6请求。
（6）**源站配置**
* 源站域名，填写您的源站域名，不能与**加速域名** 相同。**源站测试** 中需要您填写您需要加速的资源名，通过源站测试，表明源站配置正确。
* IP地址，填写您源站的IP地址，**源站测试** 中需要您填写您需要加速的资源名，通过源站测试，表明源站配置正确。
（7）**缓存配置**
* 关闭，默认关闭状态，即纯动态加速场景，不做任何缓存。
* 开启，适用动静态资源混合的场景，开启后可配置不同后缀或目录的静态缓存规则，命中规则部分遵循静态边缘缓存逻辑，未命中部分使用最优链路动态回源。
（8）**忽略 URL 参数**
* 关闭，默认关闭状态，完全按照参数缓存
* 开启，适用于提高边缘命中率且URL「?」后的参数不影响文件内容的场景。可配置「忽略全部参数」或「忽略指定参数」，静态资源会去除 URL「?」后的全部参数或指定参数进行缓存。
## 2.4 点击「创建」，提交配置
# 3\. 配置域名
若除创建域名的基础配置外，您还有其他配置需求，**返回域名管理** ，在域名管理页面单击目标域名对应配置，此时您可以设置：
* [回源配置 __](http://developer.qiniu.com/dcdn/development_guidelines/10778/dcdn-back-to-the-source-configuration)
* [缓存配置 __](http://developer.qiniu.com/dcdn/development_guidelines/10786/dcdn-cache-configuration)
* [访问控制 __](http://developer.qiniu.com/dcdn/development_guidelines/10791/dcdn-ip-black-and-white-list)
* [HTTPS配置 __](http://developer.qiniu.com/dcdn/development_guidelines/10792/dcdn-https-configuration)
* [HTTP响应头 __](http://developer.qiniu.com/dcdn/development_guidelines/10793/dcdn-the-http-response-header-configuration)
# 4\. 配置CNAME
(1)获取cname地址
方式1：创建加速域名成功后，七牛云会提供cname地址。
方式2：在 **域名管理** 界面选择创建好的 【域名】 ，点击 【配置】 ，提供的cname在红框中标注。
（2）配置cname，详情见文档[如何配置域名的CNAME
__](https://developer.qiniu.com/fusion/kb/1322/how-to-configure-cname-domain-
name)。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,184 |
域名归属校验 | 全站加速 | [全站加速](https://developer.qiniu.com/dcdn) > 使用指南 > 域名归属校验
# 域名归属校验
最近更新时间: 2022-04-18 17:49:40
每个域名仅需做一次归属权校验，子域名无需重复校验。校验方法有两种：
* DNS解析验证
* 文件验证
# DNS解析验证
通过配置待加速域名的txt记录的方式，通过域名校验，具体方式如下
1. 通过 https://portal.qiniu.com/dcdn/domain/create 创建域名，提交之后系统会判断该域名是否曾经校验过。若校验过则会进入域名创建结果页。若未校验过则会进入域名验证页，如下：
2. 在您的域名解析服务商，添加TXT记录
3. 等待TXT解析生效，返回CDN控制台，单击「点击验证」，完成验证
若如果系统提示“验证失败”，请检查TXT记录是否正确填写，并等待DNS记录生效后重新验证
# 文件验证
通过在域名源站上传验证文件，并保证外网的可访问性，具体方式如下
1. 在域名验证页面点击「文件验证」，进入获取验证的页面，如下图：
2. 点击下载验证文件
3. 将验证文件上传到源站服务器的根目录，并确保通过域名根目录可访问
例如：配置加速域名verify.qiniu.com，需要将文件上传到qiniu.com所在的服务器源站，并确保
http://qiniu.com/verification.html 的外网访问性，我们将根据该文件的访问结果判断是否验证通过
4. 单击「点击验证」，完成验证
以上所有功能均可通过接口完成，详见：https://developer.qiniu.com/dcdn/11857/domain-verify-
information
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[全站加速](https://developer.qiniu.com/dcdn) > 使用指南 > 域名归属校验
# 域名归属校验
最近更新时间: 2022-04-18 17:49:40
每个域名仅需做一次归属权校验，子域名无需重复校验。校验方法有两种：
* DNS解析验证
* 文件验证
# DNS解析验证
通过配置待加速域名的txt记录的方式，通过域名校验，具体方式如下
1. 通过 https://portal.qiniu.com/dcdn/domain/create 创建域名，提交之后系统会判断该域名是否曾经校验过。若校验过则会进入域名创建结果页。若未校验过则会进入域名验证页，如下：
2. 在您的域名解析服务商，添加TXT记录
3. 等待TXT解析生效，返回CDN控制台，单击「点击验证」，完成验证
若如果系统提示“验证失败”，请检查TXT记录是否正确填写，并等待DNS记录生效后重新验证
# 文件验证
通过在域名源站上传验证文件，并保证外网的可访问性，具体方式如下
1. 在域名验证页面点击「文件验证」，进入获取验证的页面，如下图：
2. 点击下载验证文件
3. 将验证文件上传到源站服务器的根目录，并确保通过域名根目录可访问
例如：配置加速域名verify.qiniu.com，需要将文件上传到qiniu.com所在的服务器源站，并确保
http://qiniu.com/verification.html 的外网访问性，我们将根据该文件的访问结果判断是否验证通过
4. 单击「点击验证」，完成验证
以上所有功能均可通过接口完成，详见：https://developer.qiniu.com/dcdn/11857/domain-verify-
information
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,190 |
日志下载 | 全站加速 | [全站加速](https://developer.qiniu.com/dcdn) > 使用指南 > 日志下载
# 日志下载
最近更新时间: 2022-02-16 15:04:02
日志下载可以查询域名日志列表，下载所需的日志数据，。您可以登录**七牛开发者平台** 选择**DCDN控制台** ，进行下载。
# 操作说明
登录**七牛开发者平台** 后，进入**DCDN控制台**
，选择【日志下载】，进入管理页面，选择要获取日志的时间及对应的域名，点击【查看日志】，获取可下载的日志，点击【下载】即可。
注意事项：
（1）日志默认保留时间为 30 天；
（2）日志生成大概延迟 6 小时；
（3）备选域名列表最多只展示 100 个，其余域名可通过前缀搜索；
（4）如果日志文件过大，您可以参见[API
__](https://developer.qiniu.com/fusion/api/1226/download-the-log)文档下载日志。
（5）日志大概延迟6小时，举例：1月18日0点-1点的日志，会在1月18日8点-10点左右可下载。
（6）日志文件默认按小时下载，如果单小时内日志过大会进行切分(分片大小128MB)，日志文件采用gzip压缩。
# 日志字段说明
将下载好的日志数据包解压，以文本方式查看日志文件，可以看到各字段信息以空格隔开。部分信息如下图所示。 
日志中对应的字段顺序及含义如下表所示： 顺序|日志内容|说明 -|- 1|客户端IP|ClientIP 2|命中情况|Hit/Miss/UNKNOWN
3|响应时长(ms)|ResponseTime(ms) 4|请求时间|[Time Zone] 5|请求方法|Method 6|请求URL|URL
7|请求协议|Protocol 8|状态码|StatusCode 9|响应大小(Byte)|TrafficSize(Byte)
10|referer|Referer 11|用户代理|UserAgent
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[全站加速](https://developer.qiniu.com/dcdn) > 使用指南 > 日志下载
# 日志下载
最近更新时间: 2022-02-16 15:04:02
日志下载可以查询域名日志列表，下载所需的日志数据，。您可以登录**七牛开发者平台** 选择**DCDN控制台** ，进行下载。
# 操作说明
登录**七牛开发者平台** 后，进入**DCDN控制台**
，选择【日志下载】，进入管理页面，选择要获取日志的时间及对应的域名，点击【查看日志】，获取可下载的日志，点击【下载】即可。
注意事项：
（1）日志默认保留时间为 30 天；
（2）日志生成大概延迟 6 小时；
（3）备选域名列表最多只展示 100 个，其余域名可通过前缀搜索；
（4）如果日志文件过大，您可以参见[API
__](https://developer.qiniu.com/fusion/api/1226/download-the-log)文档下载日志。
（5）日志大概延迟6小时，举例：1月18日0点-1点的日志，会在1月18日8点-10点左右可下载。
（6）日志文件默认按小时下载，如果单小时内日志过大会进行切分(分片大小128MB)，日志文件采用gzip压缩。
# 日志字段说明
将下载好的日志数据包解压，以文本方式查看日志文件，可以看到各字段信息以空格隔开。部分信息如下图所示。 
日志中对应的字段顺序及含义如下表所示： 顺序|日志内容|说明 -|- 1|客户端IP|ClientIP 2|命中情况|Hit/Miss/UNKNOWN
3|响应时长(ms)|ResponseTime(ms) 4|请求时间|[Time Zone] 5|请求方法|Method 6|请求URL|URL
7|请求协议|Protocol 8|状态码|StatusCode 9|响应大小(Byte)|TrafficSize(Byte)
10|referer|Referer 11|用户代理|UserAgent
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,192 |
刷新预取 | 全站加速 | [全站加速](https://developer.qiniu.com/dcdn) > 使用指南 > 刷新预取
# 刷新预取
最近更新时间: 2022-02-18 14:33:51
刷新分为刷新文件、刷新目录两种方式，刷新文件是以文件为单位将缓存在DCDN节点上对应的资源进行清除。刷新目录是以目录为单位，将目录下的所有缓存在DCDN节点上的文件进行清除。文件预取是以文件为单位进行资源预热。
# 操作说明
登录**七牛开发者平台** 后，进入**DCDN控制台** ，选择【刷新预取】，进入配置界面：
### 1\. 文件刷新
选择【文件刷新】后，在输入框中输入需要刷新的URL。提交后，您可以在页面中看到今日剩余的目录刷新量。
* 输入时，多个记录请用回车换行分隔；
* 每个 URL 应当以 `http://` 或 `https:// `开头,如 `http://www.example.com/index.html`;
* 文件刷新每天限额 500 个，单次提交文件刷新最多20个。
### 2\. 刷新目录
选择【刷新目录】后，在输入框中输入需要刷新的目录，提交后，您可以在页面中看到今日剩余的目录刷新量。
* 输入时，多个记录请用回车换行分隔；
* 目录必须以 `「/」` 结尾例如：`http://www.example.com/`；
* 目录刷新每天限额 10 个。
### 3\. 文件预取
选择【文件预取】后，输入框中输入需要预取的文件路径，提交后，您可以在页面中看到今日剩余的目录刷新量。
* 输入时，多个记录请用回车换行分隔；
* 每个 URL 应当以 `http://` 或 `https:// `开头，如 `http://www.example.com/index.html`
* 文件预取每天限额 100 个，单次提交文件刷新最多20个。
### 4\. 操作记录
选择【操作记录】可以查询最近14天左右提交的刷新或预取的操作记录，可以查询具体的URL，以及提交时间、操作类型、状态信息，状态信息包含：正在处理、成功、失败三种类型。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[全站加速](https://developer.qiniu.com/dcdn) > 使用指南 > 刷新预取
# 刷新预取
最近更新时间: 2022-02-18 14:33:51
刷新分为刷新文件、刷新目录两种方式，刷新文件是以文件为单位将缓存在DCDN节点上对应的资源进行清除。刷新目录是以目录为单位，将目录下的所有缓存在DCDN节点上的文件进行清除。文件预取是以文件为单位进行资源预热。
# 操作说明
登录**七牛开发者平台** 后，进入**DCDN控制台** ，选择【刷新预取】，进入配置界面：
### 1\. 文件刷新
选择【文件刷新】后，在输入框中输入需要刷新的URL。提交后，您可以在页面中看到今日剩余的目录刷新量。
* 输入时，多个记录请用回车换行分隔；
* 每个 URL 应当以 `http://` 或 `https:// `开头,如 `http://www.example.com/index.html`;
* 文件刷新每天限额 500 个，单次提交文件刷新最多20个。
### 2\. 刷新目录
选择【刷新目录】后，在输入框中输入需要刷新的目录，提交后，您可以在页面中看到今日剩余的目录刷新量。
* 输入时，多个记录请用回车换行分隔；
* 目录必须以 `「/」` 结尾例如：`http://www.example.com/`；
* 目录刷新每天限额 10 个。
### 3\. 文件预取
选择【文件预取】后，输入框中输入需要预取的文件路径，提交后，您可以在页面中看到今日剩余的目录刷新量。
* 输入时，多个记录请用回车换行分隔；
* 每个 URL 应当以 `http://` 或 `https:// `开头，如 `http://www.example.com/index.html`
* 文件预取每天限额 100 个，单次提交文件刷新最多20个。
### 4\. 操作记录
选择【操作记录】可以查询最近14天左右提交的刷新或预取的操作记录，可以查询具体的URL，以及提交时间、操作类型、状态信息，状态信息包含：正在处理、成功、失败三种类型。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,194 |
统计分析 | 全站加速 | [全站加速](https://developer.qiniu.com/dcdn) > 使用指南 > 统计分析
# 统计分析
最近更新时间: 2022-02-16 11:32:39
CDN 统计分析模块提供[用量统计
__](https://portal.qiniu.com/cdn/statistics-v2/usage/flow)和[日志分析
__](https://portal.qiniu.com/cdn/statistics-v2/log/access)两大分析模块。
# 用量统计
用量统计基于服务端访问数据统计，提供流量、带宽、请求次数等产品用量相关的统计数据。
模块 | 说明
---|---
[流量统计 __](https://developer.qiniu.com/fusion/manual/5029/usage-
statistics#traffic)| 提供全量、日间、闲时的流量统计，主要给流量计费型（默认）客户提供用量参考。
[带宽统计 __](https://developer.qiniu.com/fusion/manual/5029/usage-
statistics#width)| 提供峰值带宽、95峰值带宽统计，主要给带宽计费型客户提供用量参考。
[请求次数统计 __](https://developer.qiniu.com/fusion/manual/5029/usage-
statistics#querry)| 提供静态、动态请求次数统计，其中仅动态请求次数收费。
# 日志分析
日志分析功能基于用户访问数据统计，提供以下用户访问的统计分析数据，便于您进行业务洞察分析：
模块 | 说明
---|---
[地区运营商分布 ](https://developer.qiniu.com/fusion/manual/7445/distribution-of-regional-operators) | 提供终端用户的地区分布和运营商分布的数据统计。
[ 状态码](https://developer.qiniu.com/fusion/manual/5031/status-code) | 提供用户访问的状态码的数据统计。
[TOP URL/IP ](https://developer.qiniu.com/fusion/manual/7446/top-url-ip) | 提供热点资源 URL 和用户 IP 的相关数据统计。
[独立 IP ](https://developer.qiniu.com/fusion/manual/5033/independent-ip) | 独立IP提供了域名的UV的统计数据分析。
由于日志分析数据采用客户端 ip 统计，相关数据仅用于业务分析，具体账单相关计量数据参考[用量统计
__](https://portal.qiniu.com/dcdn/statistics-v2/usage/traffic)模块。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[全站加速](https://developer.qiniu.com/dcdn) > 使用指南 > 统计分析
# 统计分析
最近更新时间: 2022-02-16 11:32:39
CDN 统计分析模块提供[用量统计
__](https://portal.qiniu.com/cdn/statistics-v2/usage/flow)和[日志分析
__](https://portal.qiniu.com/cdn/statistics-v2/log/access)两大分析模块。
# 用量统计
用量统计基于服务端访问数据统计，提供流量、带宽、请求次数等产品用量相关的统计数据。
模块 | 说明
---|---
[流量统计 __](https://developer.qiniu.com/fusion/manual/5029/usage-
statistics#traffic)| 提供全量、日间、闲时的流量统计，主要给流量计费型（默认）客户提供用量参考。
[带宽统计 __](https://developer.qiniu.com/fusion/manual/5029/usage-
statistics#width)| 提供峰值带宽、95峰值带宽统计，主要给带宽计费型客户提供用量参考。
[请求次数统计 __](https://developer.qiniu.com/fusion/manual/5029/usage-
statistics#querry)| 提供静态、动态请求次数统计，其中仅动态请求次数收费。
# 日志分析
日志分析功能基于用户访问数据统计，提供以下用户访问的统计分析数据，便于您进行业务洞察分析：
模块 | 说明
---|---
[地区运营商分布 ](https://developer.qiniu.com/fusion/manual/7445/distribution-of-regional-operators) | 提供终端用户的地区分布和运营商分布的数据统计。
[ 状态码](https://developer.qiniu.com/fusion/manual/5031/status-code) | 提供用户访问的状态码的数据统计。
[TOP URL/IP ](https://developer.qiniu.com/fusion/manual/7446/top-url-ip) | 提供热点资源 URL 和用户 IP 的相关数据统计。
[独立 IP ](https://developer.qiniu.com/fusion/manual/5033/independent-ip) | 独立IP提供了域名的UV的统计数据分析。
由于日志分析数据采用客户端 ip 统计，相关数据仅用于业务分析，具体账单相关计量数据参考[用量统计
__](https://portal.qiniu.com/dcdn/statistics-v2/usage/traffic)模块。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,197 |
用量统计 | 全站加速 | [全站加速](https://developer.qiniu.com/dcdn) > 使用指南 >
[统计分析](https://developer.qiniu.com/dcdn/development_guidelines/10795/dcdn-
statistical-analysis) > 用量统计
# 用量统计
最近更新时间: 2023-08-09 15:29:57
用量统计提供了流量、带宽、请求次数的用量情况，您可以登录**七牛开发者平台** ，进入[DCDN-统计分析-用量统计
__](https://portal.qiniu.com/dcdn/statistics/usage/flow "DCDN-统计分析-
用量统计")模块进行查询。
# 1\. 流量统计
## 查询条件
* 域名：默认为域名全选状态，支持自定义指定域名查询，当域名超过1000时可选择“全部域名”。
* 时间粒度：包含5分钟、1小时、1天三种方式，默认为1小时。
* 时间范围：默认为最近7天，最大时间范围为3个月。
* 计费区域：默认为全部地区，支持自定义指定计费区域查询。
## 查询结果
* 访问总流量：时间范围内的总流量。
* 日均流量：：时间范围内的日平均流量，不满一天按一天计算。
* 闲时总流量：每日 0:00 - 9:00 时段的总流量。
* 日间总流量：每日 9:00 - 18:00 时段的总流量。
* 可分别查看静态加速和动态加速的流量明细。
## 按域名或地区堆叠
图表支持按域名（不能超过15个）、计量区域堆叠展示；支持数据导出功能。
# 2\. 带宽统计
## 查询条件
* 域名：默认为域名全选状态，支持自定义指定域名查询，当域名超过1000时可选择“全部域名”。
* 时间粒度：包含5分钟、1小时、1天三种方式，默认为1小时。
* 时间范围：默认为最近7天，最大时间范围为3个月。
* 计费区域：默认为全部地区，支持自定义指定计费区域查询。
## 查询结果
* 带宽峰值：选择时间区域内的最大带宽值。
* 可分别查看静态加速和动态加速的带宽统计明细。
## 按域名或地区堆叠
图表支持按域名（不能超过15个）、计量区域堆叠展示；支持数据导出功能。
# 3\. 请求次数统计
## 查询条件
* 域名：默认为域名全选状态，支持自定义指定域名查询。
* 时间粒度：包含5分钟、1小时、1天三种方式，默认为1小时。
* 时间范围：默认为最近7天，最大时间范围为3个月。
由于静态请求次数不收费、动态请求次数全球价格相同，所以请求次数的计量统计暂不提供分区域统计，若需参考用户请求次数的地区分布，可至[日志分析-地区和运营商分布
__](https://portal.qiniu.com/cdn/statistics-v2/log/access)模块查询日志分析结果。
## 查询结果
* 动态访问次数：时间范围内动态请求的总次数。
* 访问总次数：时间范围内的总次数。
* 日均访问次数：：时间范围内的日平均次数，不满一天按一天计算。
* 闲时访问总次数：每日 0:00 - 9:00 时段的访问次数。
* 日间访问总次数：每日 9:00 - 18:00 时段的访问次数。
* 可分别查看静态加速和动态加速的访问次数明细。
## 按域名堆叠
图表支持按域名（不能超过15个）展示；支持数据导出功能。
# 4\. 常见问题
**在域名筛选的条件中，域名“全选”和“全部域名”的差异是什么** ？
域名“全选”和点击“全部域名”按钮在绝大多数场景完全的数据统计结果完全一致，但在以下场景下会产生计量结果差异:
（1）对于域名数量超过 1000 个的场景，“全选”域名的统计结果仅为当前选中的 1000
个域名，“全部域名”的统计结果则为当前账号下的所有域名产生的用量。
（2）点击“全部域名”的统计结果为当前账号下的所有DCDN域名产生的用量结果。
七牛账单上的计量数据以点击“全部域名”的结果为准，即账户下产生的所有使用量。
由于“请求次数”下的静态请求次数不收费，所以“请求次数”下目前暂无“全部域名”选项，若域名超过 1000
可以联系七牛技术售后拉取全部域名的动态请求次数的统计明细。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[全站加速](https://developer.qiniu.com/dcdn) > 使用指南 >
[统计分析](https://developer.qiniu.com/dcdn/development_guidelines/10795/dcdn-
statistical-analysis) > 用量统计
# 用量统计
最近更新时间: 2023-08-09 15:29:57
用量统计提供了流量、带宽、请求次数的用量情况，您可以登录**七牛开发者平台** ，进入[DCDN-统计分析-用量统计
__](https://portal.qiniu.com/dcdn/statistics/usage/flow "DCDN-统计分析-
用量统计")模块进行查询。
# 1\. 流量统计
## 查询条件
* 域名：默认为域名全选状态，支持自定义指定域名查询，当域名超过1000时可选择“全部域名”。
* 时间粒度：包含5分钟、1小时、1天三种方式，默认为1小时。
* 时间范围：默认为最近7天，最大时间范围为3个月。
* 计费区域：默认为全部地区，支持自定义指定计费区域查询。
## 查询结果
* 访问总流量：时间范围内的总流量。
* 日均流量：：时间范围内的日平均流量，不满一天按一天计算。
* 闲时总流量：每日 0:00 - 9:00 时段的总流量。
* 日间总流量：每日 9:00 - 18:00 时段的总流量。
* 可分别查看静态加速和动态加速的流量明细。
## 按域名或地区堆叠
图表支持按域名（不能超过15个）、计量区域堆叠展示；支持数据导出功能。
# 2\. 带宽统计
## 查询条件
* 域名：默认为域名全选状态，支持自定义指定域名查询，当域名超过1000时可选择“全部域名”。
* 时间粒度：包含5分钟、1小时、1天三种方式，默认为1小时。
* 时间范围：默认为最近7天，最大时间范围为3个月。
* 计费区域：默认为全部地区，支持自定义指定计费区域查询。
## 查询结果
* 带宽峰值：选择时间区域内的最大带宽值。
* 可分别查看静态加速和动态加速的带宽统计明细。
## 按域名或地区堆叠
图表支持按域名（不能超过15个）、计量区域堆叠展示；支持数据导出功能。
# 3\. 请求次数统计
## 查询条件
* 域名：默认为域名全选状态，支持自定义指定域名查询。
* 时间粒度：包含5分钟、1小时、1天三种方式，默认为1小时。
* 时间范围：默认为最近7天，最大时间范围为3个月。
由于静态请求次数不收费、动态请求次数全球价格相同，所以请求次数的计量统计暂不提供分区域统计，若需参考用户请求次数的地区分布，可至[日志分析-地区和运营商分布
__](https://portal.qiniu.com/cdn/statistics-v2/log/access)模块查询日志分析结果。
## 查询结果
* 动态访问次数：时间范围内动态请求的总次数。
* 访问总次数：时间范围内的总次数。
* 日均访问次数：：时间范围内的日平均次数，不满一天按一天计算。
* 闲时访问总次数：每日 0:00 - 9:00 时段的访问次数。
* 日间访问总次数：每日 9:00 - 18:00 时段的访问次数。
* 可分别查看静态加速和动态加速的访问次数明细。
## 按域名堆叠
图表支持按域名（不能超过15个）展示；支持数据导出功能。
# 4\. 常见问题
**在域名筛选的条件中，域名“全选”和“全部域名”的差异是什么** ？
域名“全选”和点击“全部域名”按钮在绝大多数场景完全的数据统计结果完全一致，但在以下场景下会产生计量结果差异:
（1）对于域名数量超过 1000 个的场景，“全选”域名的统计结果仅为当前选中的 1000
个域名，“全部域名”的统计结果则为当前账号下的所有域名产生的用量。
（2）点击“全部域名”的统计结果为当前账号下的所有DCDN域名产生的用量结果。
七牛账单上的计量数据以点击“全部域名”的结果为准，即账户下产生的所有使用量。
由于“请求次数”下的静态请求次数不收费，所以“请求次数”下目前暂无“全部域名”选项，若域名超过 1000
可以联系七牛技术售后拉取全部域名的动态请求次数的统计明细。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,199 |
地区运营商分布 | 全站加速 | [全站加速](https://developer.qiniu.com/dcdn) > 使用指南 >
[统计分析](https://developer.qiniu.com/dcdn/development_guidelines/10795/dcdn-
statistical-analysis) > 日志分析 >地区运营商分布
# 地区运营商分布
最近更新时间: 2022-02-16 14:18:19
登录七牛开发者平台后，进入DCDN控制台，您可以登录七牛开发者平台，进入[DCDN-统计分析-地区与运营商分布
__](https://portal.qiniu.com/cdn/statistics-v2/log/access)进行查询。
# 查询条件
### 查询条件
域名：默认为域名全选状态，支持自定义指定域名查询。
时间范围：默认为最近7天，最大时间范围为3个月。
# 地区分布
展示查询条件下访问的地区分布。支持切换分析指标“流量、带宽、请求次数”。
图表默认展示 top 20 的地区分布，若需所有地区分布可查看右侧数据列表或导出 csv。
# 运营商分布
展示查询条件下访问的运营商分布。支持切换分析指标“流量、带宽、请求次数”。
图表和数据表展示所有的运营商分布数据，也可导出 csv 进行数据分析。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[全站加速](https://developer.qiniu.com/dcdn) > 使用指南 >
[统计分析](https://developer.qiniu.com/dcdn/development_guidelines/10795/dcdn-
statistical-analysis) > 日志分析 >地区运营商分布
# 地区运营商分布
最近更新时间: 2022-02-16 14:18:19
登录七牛开发者平台后，进入DCDN控制台，您可以登录七牛开发者平台，进入[DCDN-统计分析-地区与运营商分布
__](https://portal.qiniu.com/cdn/statistics-v2/log/access)进行查询。
# 查询条件
### 查询条件
域名：默认为域名全选状态，支持自定义指定域名查询。
时间范围：默认为最近7天，最大时间范围为3个月。
# 地区分布
展示查询条件下访问的地区分布。支持切换分析指标“流量、带宽、请求次数”。
图表默认展示 top 20 的地区分布，若需所有地区分布可查看右侧数据列表或导出 csv。
# 运营商分布
展示查询条件下访问的运营商分布。支持切换分析指标“流量、带宽、请求次数”。
图表和数据表展示所有的运营商分布数据，也可导出 csv 进行数据分析。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,204 |
状态码 | 全站加速 | [全站加速](https://developer.qiniu.com/dcdn) > 使用指南 >
[统计分析](https://developer.qiniu.com/dcdn/development_guidelines/10795/dcdn-
statistical-analysis) > 日志分析 >状态码
# 状态码
最近更新时间: 2023-05-31 16:59:55
状态码提供了 2XX、3XX、4XX、5XX 状态码统计情况数据展示，您可以登录**七牛开发者平台** 选择**DCDN控制台** ，进行相关查询。
# 操作说明
登录**七牛开发者平台** 后，进入**DCDN控制台** ，选择【统计分析】，点击【状态码】进入查询界面：
### 查询条件
* 域名：默认为全部域名，支持指定标签、协议和域名查询。
* 时间粒度：包含5分钟、1小时、1天三种方式，默认为1小时。
* 时间范围：默认为最近7天，最大时间范围为3个月。
* 区域：指定一个用户所在的区域对数据进行筛选，默认为全部地区。
* 运营商：指定一个用户所使用的网络运营商对数据进行筛选，默认全部运营商。
### 状态码
您可以在此部分查看 2XX、3XX、4XX、5XX 状态码的统计曲线，以及状态码分布比例与详情数据。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[全站加速](https://developer.qiniu.com/dcdn) > 使用指南 >
[统计分析](https://developer.qiniu.com/dcdn/development_guidelines/10795/dcdn-
statistical-analysis) > 日志分析 >状态码
# 状态码
最近更新时间: 2023-05-31 16:59:55
状态码提供了 2XX、3XX、4XX、5XX 状态码统计情况数据展示，您可以登录**七牛开发者平台** 选择**DCDN控制台** ，进行相关查询。
# 操作说明
登录**七牛开发者平台** 后，进入**DCDN控制台** ，选择【统计分析】，点击【状态码】进入查询界面：
### 查询条件
* 域名：默认为全部域名，支持指定标签、协议和域名查询。
* 时间粒度：包含5分钟、1小时、1天三种方式，默认为1小时。
* 时间范围：默认为最近7天，最大时间范围为3个月。
* 区域：指定一个用户所在的区域对数据进行筛选，默认为全部地区。
* 运营商：指定一个用户所使用的网络运营商对数据进行筛选，默认全部运营商。
### 状态码
您可以在此部分查看 2XX、3XX、4XX、5XX 状态码的统计曲线，以及状态码分布比例与详情数据。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,206 |
TOP URL / IP | 全站加速 | [全站加速](https://developer.qiniu.com/dcdn) > 使用指南 >
[统计分析](https://developer.qiniu.com/dcdn/development_guidelines/10795/dcdn-
statistical-analysis) > 日志分析 >TOP URL / IP
# TOP URL / IP
最近更新时间: 2024-02-27 17:13:30
登录七牛开发者平台后，进入DCDN控制台，您可以登录七牛开发者平台，进入[DCDN-统计分析-TOP URL/IP
__](https://portal.qiniu.com/dcdn/statistics/log/top)进行查询。
# 查询条件
* 域名：默认为全部域名，支持自定义指定域名查询。
* 地区：默认为全部地区，支持自定义指定地区查询。
* 时间范围：默认为最近7天，最大时间范围为3个月。
# Top URL
展示用户访问热点资源的 URL 的 top 100 ，支持切换分析指标“流量、带宽”。
# Top IP
展示访问最多的用户 IP 的 top 100 ，支持切换分析指标“流量、带宽”。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[全站加速](https://developer.qiniu.com/dcdn) > 使用指南 >
[统计分析](https://developer.qiniu.com/dcdn/development_guidelines/10795/dcdn-
statistical-analysis) > 日志分析 >TOP URL / IP
# TOP URL / IP
最近更新时间: 2024-02-27 17:13:30
登录七牛开发者平台后，进入DCDN控制台，您可以登录七牛开发者平台，进入[DCDN-统计分析-TOP URL/IP
__](https://portal.qiniu.com/dcdn/statistics/log/top)进行查询。
# 查询条件
* 域名：默认为全部域名，支持自定义指定域名查询。
* 地区：默认为全部地区，支持自定义指定地区查询。
* 时间范围：默认为最近7天，最大时间范围为3个月。
# Top URL
展示用户访问热点资源的 URL 的 top 100 ，支持切换分析指标“流量、带宽”。
# Top IP
展示访问最多的用户 IP 的 top 100 ，支持切换分析指标“流量、带宽”。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,208 |
独立IP | 全站加速 | [全站加速](https://developer.qiniu.com/dcdn) > 使用指南 >
[统计分析](https://developer.qiniu.com/dcdn/development_guidelines/10795/dcdn-
statistical-analysis) > 日志分析 >独立IP
# 独立IP
最近更新时间: 2022-02-16 14:27:40
独立IP提供了域名的UV的统计数据展示，您可以登录**七牛开发者平台** 选择**DCDN控制台** ，进行相关查询。
# 操作说明
登录**七牛开发者平台** 后，进入**DCDN控制台** ，选择【统计分析】，点击【独立IP】进入查询界面：
### 查询条件
* 域名：默认为全部域名，支持自定义指定域名查询。
* 时间粒度：包含5分钟、1小时、1天三种方式，默认为1小时。
* 时间范围：默认为最近7天，最大时间范围为3个月。
### 独立IP
您可以在此部分查看域名的UV统计曲线。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[全站加速](https://developer.qiniu.com/dcdn) > 使用指南 >
[统计分析](https://developer.qiniu.com/dcdn/development_guidelines/10795/dcdn-
statistical-analysis) > 日志分析 >独立IP
# 独立IP
最近更新时间: 2022-02-16 14:27:40
独立IP提供了域名的UV的统计数据展示，您可以登录**七牛开发者平台** 选择**DCDN控制台** ，进行相关查询。
# 操作说明
登录**七牛开发者平台** 后，进入**DCDN控制台** ，选择【统计分析】，点击【独立IP】进入查询界面：
### 查询条件
* 域名：默认为全部域名，支持自定义指定域名查询。
* 时间粒度：包含5分钟、1小时、1天三种方式，默认为1小时。
* 时间范围：默认为最近7天，最大时间范围为3个月。
### 独立IP
您可以在此部分查看域名的UV统计曲线。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,210 |
配置概览 | 全站加速 | [全站加速](https://developer.qiniu.com/dcdn) > 使用指南 > 配置管理 >配置概览
# 配置概览
最近更新时间: 2022-02-18 14:13:24
**七牛云 DCDN** 支持多项自定义配置，您可以根据自身业务需要进行设置。
# [基础信息 __](http://)
配置项 | 描述 | 默认值
---|---|---
覆盖 | 切换加速区域，变更加速区域 | 中国大陆
IP协议 | CDN支持的IP协议 | IPv4/IPv6
# [回源配置 __](https://developer.qiniu.com/fusion/manual/4943/back-to-the-source-
configuration)
配置项 | 描述 | 默认值
---|---|---
源站信息 | 资源的回源域名或IP | 用户配置
回源HOST | 指定请求的服务器的域名，默认为加速域名 | 加速域名
回源协议 | 请求回源的协议，如需修改回源协议请先开启 HTTPS | HTTP
# [缓存配置 __](https://developer.qiniu.com/fusion/manual/4944/cache-
configuration)
配置项 | 描述 | 默认值
---|---|---
静态缓存规则 | 定义指定资源内容的缓存行为及缓存时间规则 | 未开启
忽略URL参数 | 资源缓存时去除 URL「?」后的全部或指定参数进行缓存 | 未开启
# [访问控制配置 __](http://)
配置项 | 描述 | 默认值
---|---|---
[referer防盗链 __](https://developer.qiniu.com/dcdn/development_guidelines/10788/dcdn-referer-hotlinking-prevention)| 配置 Request Header 中 referer 黑白名单，从而限制访问来源 | 未开启
[IP黑白名单 __](https://developer.qiniu.com/dcdn/development_guidelines/10791/dcdn-ip-black-and-white-list)| 允许或者禁止某些 IP 或 IP 段的访问，帮助您解决恶意 IP 盗刷、攻击等问题 | 未开启
# [HTTPS配置 __](https://developer.qiniu.com/fusion/manual/4952/https-
configuration)
配置项 | 描述 | 默认值
---|---|---
开启HTTPS | 开启 HTTPS 安全加速，支持 SSL 证书绑定及 HTTPS 状态管理 | 未开启
更换证书 | 更换即将过期或泄漏的证书 | 无
强制HTTPS | 开启后 HTTP 请求会强制跳转到 HTTPS 进行访问，关闭时默认兼容用户的 HTTP/HTTPS 请求 | 未开启
HTTP/2 访问 | HTTP/2 是最新的 HTTP 协议，用以最小化网络延迟，提升网络速度，如需使用请您先配置 HTTPS 证书 | 未开启
# [HTTP 响应头配置 __](https://developer.qiniu.com/fusion/manual/4953/warning-
traffic-bandwidth)
配置项 | 描述 | 默认值
---|---|---
[HTTP 响应头 __](http://developer.qiniu.com/dcdn/development_guidelines/10793/dcdn-the-http-response-header-configuration)| 支持设置或删除常见的 HTTP 请求响应头配置，用以向客户端提供额外信息 | 未开启
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[全站加速](https://developer.qiniu.com/dcdn) > 使用指南 > 配置管理 >配置概览
# 配置概览
最近更新时间: 2022-02-18 14:13:24
**七牛云 DCDN** 支持多项自定义配置，您可以根据自身业务需要进行设置。
# [基础信息 __](http://)
配置项 | 描述 | 默认值
---|---|---
覆盖 | 切换加速区域，变更加速区域 | 中国大陆
IP协议 | CDN支持的IP协议 | IPv4/IPv6
# [回源配置 __](https://developer.qiniu.com/fusion/manual/4943/back-to-the-source-
configuration)
配置项 | 描述 | 默认值
---|---|---
源站信息 | 资源的回源域名或IP | 用户配置
回源HOST | 指定请求的服务器的域名，默认为加速域名 | 加速域名
回源协议 | 请求回源的协议，如需修改回源协议请先开启 HTTPS | HTTP
# [缓存配置 __](https://developer.qiniu.com/fusion/manual/4944/cache-
configuration)
配置项 | 描述 | 默认值
---|---|---
静态缓存规则 | 定义指定资源内容的缓存行为及缓存时间规则 | 未开启
忽略URL参数 | 资源缓存时去除 URL「?」后的全部或指定参数进行缓存 | 未开启
# [访问控制配置 __](http://)
配置项 | 描述 | 默认值
---|---|---
[referer防盗链 __](https://developer.qiniu.com/dcdn/development_guidelines/10788/dcdn-referer-hotlinking-prevention)| 配置 Request Header 中 referer 黑白名单，从而限制访问来源 | 未开启
[IP黑白名单 __](https://developer.qiniu.com/dcdn/development_guidelines/10791/dcdn-ip-black-and-white-list)| 允许或者禁止某些 IP 或 IP 段的访问，帮助您解决恶意 IP 盗刷、攻击等问题 | 未开启
# [HTTPS配置 __](https://developer.qiniu.com/fusion/manual/4952/https-
configuration)
配置项 | 描述 | 默认值
---|---|---
开启HTTPS | 开启 HTTPS 安全加速，支持 SSL 证书绑定及 HTTPS 状态管理 | 未开启
更换证书 | 更换即将过期或泄漏的证书 | 无
强制HTTPS | 开启后 HTTP 请求会强制跳转到 HTTPS 进行访问，关闭时默认兼容用户的 HTTP/HTTPS 请求 | 未开启
HTTP/2 访问 | HTTP/2 是最新的 HTTP 协议，用以最小化网络延迟，提升网络速度，如需使用请您先配置 HTTPS 证书 | 未开启
# [HTTP 响应头配置 __](https://developer.qiniu.com/fusion/manual/4953/warning-
traffic-bandwidth)
配置项 | 描述 | 默认值
---|---|---
[HTTP 响应头 __](http://developer.qiniu.com/dcdn/development_guidelines/10793/dcdn-the-http-response-header-configuration)| 支持设置或删除常见的 HTTP 请求响应头配置，用以向客户端提供额外信息 | 未开启
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,212 |
回源配置 | 全站加速 | [全站加速](https://developer.qiniu.com/dcdn) > 使用指南 > 配置管理 >回源配置
# 回源配置
最近更新时间: 2024-03-29 17:50:13
您可以登录**七牛开发者平台** 选择**DCDN控制台** ,可以在控制台中查看域名的回源配置信息及进行相关配置修改。
# 操作说明
登录**七牛开发者平台** 后，进入**DCDN控制台** ，选择【域名管理】，点击【配置】：
进入域名配置界面，点击【修改配置】进行回源配置的修改。
### 1\. 基础配置
回源方式支持源站域名、IP地址两种模式：
* 源站域名：设置指定域名作为DCDN回源的源站，源站的域名需要与加速域名不一致。
* IP地址：设置IP作为CDN回源的源站，支持配置多个IP；回源采用轮询方式，首次选择配置的第一个IP进行回源，当发现某一源站IP异常时，将跳过此IP并进入惩罚时间，屏蔽5秒。
### 2\. 回源 HOST
回源 HOST：是指 CDN 节点在回源过程中，在源站访问的站点域名，默认是加速域名。「源站域名」模式下，回源 HOST
支持指定加速域名、源站域名、自定义配置，「IP地址」模式下，回源HOST 支持指定加速域名、自定义配置。
### 3\. 回源协议
回源协议：即请求回源的协议，支持选择回源协议HTTP、遵循请求协议、HTTPS三种模式。
### 4\. 回源验证
回源验证：保证源站的高可用，只有源站测试通过才能继续创建域名。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[全站加速](https://developer.qiniu.com/dcdn) > 使用指南 > 配置管理 >回源配置
# 回源配置
最近更新时间: 2024-03-29 17:50:13
您可以登录**七牛开发者平台** 选择**DCDN控制台** ,可以在控制台中查看域名的回源配置信息及进行相关配置修改。
# 操作说明
登录**七牛开发者平台** 后，进入**DCDN控制台** ，选择【域名管理】，点击【配置】：
进入域名配置界面，点击【修改配置】进行回源配置的修改。
### 1\. 基础配置
回源方式支持源站域名、IP地址两种模式：
* 源站域名：设置指定域名作为DCDN回源的源站，源站的域名需要与加速域名不一致。
* IP地址：设置IP作为CDN回源的源站，支持配置多个IP；回源采用轮询方式，首次选择配置的第一个IP进行回源，当发现某一源站IP异常时，将跳过此IP并进入惩罚时间，屏蔽5秒。
### 2\. 回源 HOST
回源 HOST：是指 CDN 节点在回源过程中，在源站访问的站点域名，默认是加速域名。「源站域名」模式下，回源 HOST
支持指定加速域名、源站域名、自定义配置，「IP地址」模式下，回源HOST 支持指定加速域名、自定义配置。
### 3\. 回源协议
回源协议：即请求回源的协议，支持选择回源协议HTTP、遵循请求协议、HTTPS三种模式。
### 4\. 回源验证
回源验证：保证源站的高可用，只有源站测试通过才能继续创建域名。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,215 |
缓存配置 | 全站加速 | [全站加速](https://developer.qiniu.com/dcdn) > 使用指南 > 配置管理 >缓存配置
# 缓存配置
最近更新时间: 2023-09-07 16:35:16
缓存配置是指动静态混合资源中，静态资源在 DCDN
加速节点上遵循的一套缓存过期规则。全站加速默认全局动态回源不缓存，结合缓存规则可以实现动静态混合加速的效果。您可以登录**七牛开发者平台**
选择**DCDN控制台** ，在控制台中查看域名的缓存配置信息并进行修改。
# 操作说明
登录**七牛开发者平台** 后，进入**DCDN控制台** ，选择【域名管理】，点击【配置】
进入域名配置界面，点击【修改配置】进行缓存配置的修改。
### 1、静态缓存规则
静态缓存规则默认关闭，即没有任何缓存行为。开启后，可配置静态缓存规则针对部分资源进行缓存。
（1）推荐配置：
* .jpg;.jpeg;.png;.bmp;.gif;.webp;.ico 图片类型缓存1天。
* .js;.css;.txt;.xml;.shtml;.html;.htm;.csv;.bat 文本类型缓存1天。
* .m3u8 m3u8类型缓存1小时。
* .avi;.mkv;.mp4;.mov;.flv;.rm;.rmvb;.swf;.mp3;.wav;.wmv;.rmi;.aac 音视频类型缓存7天。
* .exe;.deb;.ipa;.apk;.sis;.psd;.dat 大文件类型缓存7天。
（2）添加后缀
* 后缀：必须以「.」(英文点)开始，多个后缀请用「;」(英文分号)隔开，例如(.png;.jpg;.gif)。
* 缓存规则最多可配置15条。
* 1条缓存规则中，最多10个后缀，「;」(英文分号)隔开。
* 时间单位：分/小时/天，只能输入整数，最大值为 365 天。
* 按从上至下顺序，采取优先匹配原则。
（3）添加目录
* 路径：必须以「/」(英文斜杠)开始，多个路径请用「;」(英文分号)隔开，例如: (/a/b/c;/d/e/f;/h/i/j) ，路 径中不能包含「.」，也不能以「/」结尾。
* 缓存规则最多可配置15条。
* 1条缓存规则中，最多10个路径，「;」(英文分号)隔开。
* 时间单位：分/小时/天，只能输入整数，最大值为 365 天。
* 按从上至下顺序，采取优先匹配原则。
### 2\. 忽略URL参数
（1）保留所有参数：资源缓存时保留 URL「？」后的全部参数进行缓存，请确认请求的 URL 的参数值和文件有关再开启，否则会降低缓存命中率并增加 CDN
回源次数。
（2）忽略所有参数：资源缓存时去除 URL「?」后的全部参数进行缓存，忽略全部参数同时会导致图片处理等 FOP 功能失效。
（3）保留指定参数：资源缓存时会仅仅保留您输入的指定参数然后进行缓存。
（4）忽略指定参数：资源缓存时会去除您输入的指定参数然后进行缓存。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[全站加速](https://developer.qiniu.com/dcdn) > 使用指南 > 配置管理 >缓存配置
# 缓存配置
最近更新时间: 2023-09-07 16:35:16
缓存配置是指动静态混合资源中，静态资源在 DCDN
加速节点上遵循的一套缓存过期规则。全站加速默认全局动态回源不缓存，结合缓存规则可以实现动静态混合加速的效果。您可以登录**七牛开发者平台**
选择**DCDN控制台** ，在控制台中查看域名的缓存配置信息并进行修改。
# 操作说明
登录**七牛开发者平台** 后，进入**DCDN控制台** ，选择【域名管理】，点击【配置】
进入域名配置界面，点击【修改配置】进行缓存配置的修改。
### 1、静态缓存规则
静态缓存规则默认关闭，即没有任何缓存行为。开启后，可配置静态缓存规则针对部分资源进行缓存。
（1）推荐配置：
* .jpg;.jpeg;.png;.bmp;.gif;.webp;.ico 图片类型缓存1天。
* .js;.css;.txt;.xml;.shtml;.html;.htm;.csv;.bat 文本类型缓存1天。
* .m3u8 m3u8类型缓存1小时。
* .avi;.mkv;.mp4;.mov;.flv;.rm;.rmvb;.swf;.mp3;.wav;.wmv;.rmi;.aac 音视频类型缓存7天。
* .exe;.deb;.ipa;.apk;.sis;.psd;.dat 大文件类型缓存7天。
（2）添加后缀
* 后缀：必须以「.」(英文点)开始，多个后缀请用「;」(英文分号)隔开，例如(.png;.jpg;.gif)。
* 缓存规则最多可配置15条。
* 1条缓存规则中，最多10个后缀，「;」(英文分号)隔开。
* 时间单位：分/小时/天，只能输入整数，最大值为 365 天。
* 按从上至下顺序，采取优先匹配原则。
（3）添加目录
* 路径：必须以「/」(英文斜杠)开始，多个路径请用「;」(英文分号)隔开，例如: (/a/b/c;/d/e/f;/h/i/j) ，路 径中不能包含「.」，也不能以「/」结尾。
* 缓存规则最多可配置15条。
* 1条缓存规则中，最多10个路径，「;」(英文分号)隔开。
* 时间单位：分/小时/天，只能输入整数，最大值为 365 天。
* 按从上至下顺序，采取优先匹配原则。
### 2\. 忽略URL参数
（1）保留所有参数：资源缓存时保留 URL「？」后的全部参数进行缓存，请确认请求的 URL 的参数值和文件有关再开启，否则会降低缓存命中率并增加 CDN
回源次数。
（2）忽略所有参数：资源缓存时去除 URL「?」后的全部参数进行缓存，忽略全部参数同时会导致图片处理等 FOP 功能失效。
（3）保留指定参数：资源缓存时会仅仅保留您输入的指定参数然后进行缓存。
（4）忽略指定参数：资源缓存时会去除您输入的指定参数然后进行缓存。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,218 |
IP黑白名单 | 全站加速 | [全站加速](https://developer.qiniu.com/dcdn) > 使用指南 > 配置管理 >访问控制配置 >IP黑白名单
# IP黑白名单
最近更新时间: 2022-02-18 14:20:54
为了解决恶意 IP 盗刷、攻击等问题，七牛云 DCDN 提供了IP黑白名单配置功能，，您可以登录**七牛开发者平台** 选择**DCDN**
控制台，进行IP黑白名单配置。
# 操作说明
登录**七牛开发者平台** 后，进入**DCDN控制台** ，选择【域名管理】，点击【配置】：
进入域名配置界面，**访问控制** 模块下的【IP黑白名单】点击【修改配置】进行IP黑白名单配置。
### IP黑白名单配置
IP黑白名单配置默认为关闭状态，开启后可以根据需要选择配置IP的黑白名单。
* IP白名单：当发起请求的客户端的 IP 匹配列表中的 IP 或 IP 段时，访问能够正常返回所请求的内容，其他请求均直接返回 403。
* IP黑名单：当发起请求的客户端的 IP 匹配列表中的 IP 或 IP 段时，访问直接返回 403，其他访问能够正常返回所请求内容。
**注意事项**
* 支持输入多个IP或网段。
* 网段可以用来描述一个 IP 区间，含义为：例如 127.0.0.1/24，其中 24 表示采用子网掩码中的前 24 位为有效位，即 2 进制的 IP 地址中，前 32 位有效，后 8 位表达了该网段的范围。故 127.0.0.1/24 表示 IP 网段范围是：127.0.0.1~127.0.0.255。目前仅支持 “/8”，"/16"，"/24" 三种。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[全站加速](https://developer.qiniu.com/dcdn) > 使用指南 > 配置管理 >访问控制配置 >IP黑白名单
# IP黑白名单
最近更新时间: 2022-02-18 14:20:54
为了解决恶意 IP 盗刷、攻击等问题，七牛云 DCDN 提供了IP黑白名单配置功能，，您可以登录**七牛开发者平台** 选择**DCDN**
控制台，进行IP黑白名单配置。
# 操作说明
登录**七牛开发者平台** 后，进入**DCDN控制台** ，选择【域名管理】，点击【配置】：
进入域名配置界面，**访问控制** 模块下的【IP黑白名单】点击【修改配置】进行IP黑白名单配置。
### IP黑白名单配置
IP黑白名单配置默认为关闭状态，开启后可以根据需要选择配置IP的黑白名单。
* IP白名单：当发起请求的客户端的 IP 匹配列表中的 IP 或 IP 段时，访问能够正常返回所请求的内容，其他请求均直接返回 403。
* IP黑名单：当发起请求的客户端的 IP 匹配列表中的 IP 或 IP 段时，访问直接返回 403，其他访问能够正常返回所请求内容。
**注意事项**
* 支持输入多个IP或网段。
* 网段可以用来描述一个 IP 区间，含义为：例如 127.0.0.1/24，其中 24 表示采用子网掩码中的前 24 位为有效位，即 2 进制的 IP 地址中，前 32 位有效，后 8 位表达了该网段的范围。故 127.0.0.1/24 表示 IP 网段范围是：127.0.0.1~127.0.0.255。目前仅支持 “/8”，"/16"，"/24" 三种。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,221 |
Referer防盗链 | 全站加速 | [全站加速](https://developer.qiniu.com/dcdn) > 使用指南 > 配置管理 >访问控制配置 >Referer防盗链
# Referer防盗链
最近更新时间: 2022-02-15 16:44:50
referer防盗链是基于获取HTTP请求中的 referer header，根据 referer
跟踪来源，对来源进行识别和判断，您可以登录**七牛开发者平台** 选择**DCDN控制台** ，进行referer
黑白名单的配置，从而限制访问来源，避免恶意用户盗刷。
# 功能说明
referer防盗链默认为关闭状态，开启后可以进行referer黑白名单的配置。
* 白名单：请求的referer字段匹配白名单设置的内容，则 DCDN 节点正常返回请求信息，若不匹配，DCDN 节点拒绝返回该请求信息，返回状态码 403。
* 黑名单：请求的referer不匹配黑名单内设置的内容，则 DCDN 节点正常返回请求信息，若匹配，DCDN 节点拒绝返回该请求信息，返回状态码 403。
* 是否允许空referer：当选择允许空referer时，此时若请求referer字段为空或无referer字段 DCDN 节点正常返回请求信息；若不允许，此时若请求referer字段为空或无referer字段 DCDN 节点拒绝返回该请求信息，会直接返回状态码 403。
# 操作说明
1、登录**七牛开发者平台** 后，进入**DCDN控制台** ，选择【域名管理】，点击【配置】。
2、进入域名配置界面，**访问控制** 模块下的**referer防盗链** 点击【修改配置】进行referer防盗链的配置。
3、开启防盗链配置，选择黑白名单，输入访问的来源域名。
**注意事项**
* 域名之间请回车换行，无需填写 http://，https://；
* 支持域名前使用通配符 ：*.example.com 可用于指代所有 example.com 下的多级子域名，比如 a.example.com 等，但是不包括 example.com，如需要请额外填写一条 example.com；
* 防盗链个数设置不能超过100个；
* 黑白名单生效时间为 1 小时，在此期间不能修改其它配置；
* 不支持 IP，不支持端口号。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[全站加速](https://developer.qiniu.com/dcdn) > 使用指南 > 配置管理 >访问控制配置 >Referer防盗链
# Referer防盗链
最近更新时间: 2022-02-15 16:44:50
referer防盗链是基于获取HTTP请求中的 referer header，根据 referer
跟踪来源，对来源进行识别和判断，您可以登录**七牛开发者平台** 选择**DCDN控制台** ，进行referer
黑白名单的配置，从而限制访问来源，避免恶意用户盗刷。
# 功能说明
referer防盗链默认为关闭状态，开启后可以进行referer黑白名单的配置。
* 白名单：请求的referer字段匹配白名单设置的内容，则 DCDN 节点正常返回请求信息，若不匹配，DCDN 节点拒绝返回该请求信息，返回状态码 403。
* 黑名单：请求的referer不匹配黑名单内设置的内容，则 DCDN 节点正常返回请求信息，若匹配，DCDN 节点拒绝返回该请求信息，返回状态码 403。
* 是否允许空referer：当选择允许空referer时，此时若请求referer字段为空或无referer字段 DCDN 节点正常返回请求信息；若不允许，此时若请求referer字段为空或无referer字段 DCDN 节点拒绝返回该请求信息，会直接返回状态码 403。
# 操作说明
1、登录**七牛开发者平台** 后，进入**DCDN控制台** ，选择【域名管理】，点击【配置】。
2、进入域名配置界面，**访问控制** 模块下的**referer防盗链** 点击【修改配置】进行referer防盗链的配置。
3、开启防盗链配置，选择黑白名单，输入访问的来源域名。
**注意事项**
* 域名之间请回车换行，无需填写 http://，https://；
* 支持域名前使用通配符 ：*.example.com 可用于指代所有 example.com 下的多级子域名，比如 a.example.com 等，但是不包括 example.com，如需要请额外填写一条 example.com；
* 防盗链个数设置不能超过100个；
* 黑白名单生效时间为 1 小时，在此期间不能修改其它配置；
* 不支持 IP，不支持端口号。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,223 |
HTTPS配置 | 全站加速 | [全站加速](https://developer.qiniu.com/dcdn) > 使用指南 > 配置管理 >HTTPS配置
# HTTPS配置
最近更新时间: 2022-02-18 14:23:16
HTTPS 是指超文本传输安全协议（Hypertext Transfer Protocol Secure，缩写：HTTPS，常称为HTTP over
TLS，HTTP over SSL或HTTP
Secure）是一种通过计算机网络进行安全通信的传输协议。HTTPS经由HTTP进行通信，但利用SSL/TLS来加密数据包。HTTPS开发的主要目的，是提供对网站服务器的身份认证，保护交换数据的隐私与完整性。配置
HTTPS 时，需要您提供域名对应的证书，实现全网数据加密传输功能。您可以登录**七牛开发者平台** 选择**DCDN控制台** ，进行HTTPS的配置。
# 操作说明
登录**七牛开发者平台** 后，进入**DCDN控制台** ，选择【域名管理】，点击【配置】。
进入域名配置界面，**HTTPS配置** 模块下点击【修改配置】。
### 1\. 开启 HTTPS
如需启用**HTTPS服务** 时，选择【HTTPS】即可，开启后需要选择对应的证书。
### 2\. 更换证书
如已经完成了证书的上传，选择对应的证书即可
注意：
* 证书筛选框只显示对应域名可用的所有证书，证书剩余有效期必须大于7天。
* 如未上传证书或此域名当前无可用证书，点击**七牛云证书服务** 进入SSL证书服务控制台进行自有证书上传或购买证书操作。
### 3\. 强制HTTPS
如果您的加速域名开启了HTTPS配置，您可以设置【强制HTTPS】，开启后即使用户发起 HTTP 请求，也会强制跳转为 HTTPS
请求进行访问。此项默认为关闭状态，此时同时支持HTTP和HTTPS方式的请求。
### 4\. 开启HTTP/2
如果您的加速域名开启了HTTPS配置，您可以设置【开启HTTP/2】，HTTP/2可以兼容HTTP/1.1的访问，优化网络延迟，提升网络速度，优化用户的网络使用体验。目前，Chrome、
Firefox、Safari 等主流浏览器已经支持 HTTP/2协议。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[全站加速](https://developer.qiniu.com/dcdn) > 使用指南 > 配置管理 >HTTPS配置
# HTTPS配置
最近更新时间: 2022-02-18 14:23:16
HTTPS 是指超文本传输安全协议（Hypertext Transfer Protocol Secure，缩写：HTTPS，常称为HTTP over
TLS，HTTP over SSL或HTTP
Secure）是一种通过计算机网络进行安全通信的传输协议。HTTPS经由HTTP进行通信，但利用SSL/TLS来加密数据包。HTTPS开发的主要目的，是提供对网站服务器的身份认证，保护交换数据的隐私与完整性。配置
HTTPS 时，需要您提供域名对应的证书，实现全网数据加密传输功能。您可以登录**七牛开发者平台** 选择**DCDN控制台** ，进行HTTPS的配置。
# 操作说明
登录**七牛开发者平台** 后，进入**DCDN控制台** ，选择【域名管理】，点击【配置】。
进入域名配置界面，**HTTPS配置** 模块下点击【修改配置】。
### 1\. 开启 HTTPS
如需启用**HTTPS服务** 时，选择【HTTPS】即可，开启后需要选择对应的证书。
### 2\. 更换证书
如已经完成了证书的上传，选择对应的证书即可
注意：
* 证书筛选框只显示对应域名可用的所有证书，证书剩余有效期必须大于7天。
* 如未上传证书或此域名当前无可用证书，点击**七牛云证书服务** 进入SSL证书服务控制台进行自有证书上传或购买证书操作。
### 3\. 强制HTTPS
如果您的加速域名开启了HTTPS配置，您可以设置【强制HTTPS】，开启后即使用户发起 HTTP 请求，也会强制跳转为 HTTPS
请求进行访问。此项默认为关闭状态，此时同时支持HTTP和HTTPS方式的请求。
### 4\. 开启HTTP/2
如果您的加速域名开启了HTTPS配置，您可以设置【开启HTTP/2】，HTTP/2可以兼容HTTP/1.1的访问，优化网络延迟，提升网络速度，优化用户的网络使用体验。目前，Chrome、
Firefox、Safari 等主流浏览器已经支持 HTTP/2协议。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,226 |
HTTP响应头配置 | 全站加速 | [全站加速](https://developer.qiniu.com/dcdn) > 使用指南 > 配置管理 >HTTP响应头配置
# HTTP响应头配置
最近更新时间: 2022-02-18 14:25:12
HTTP 消息头是指，在超文本传输协议（ Hypertext Transfer Protocol，HTTP）的请求和响应消息中，协议头部的组件。在 HTTP
消息头中，按其出现的上下文环境，分为通用头、请求头、响应头等。
其中 HTTP
响应头向客户端提供一些额外信息，比如谁在发送响应、响应者的功能，甚至与响应相关的一些特殊指令。这些头部有助于客户端处理响应，并在将来发起更好的请求。
当您的网站接入 DCDN 后，由于客户端和源站会根据 HTTP 响应头的字段信息进行相关的行为处理，所以会有修改 HTTP 响应头的需求。由于 HTTP
响应头配置是针对域名，因此一旦配置生效，对该域名下任意一个资源的响应消息中均会加入所配置头部。配置 HTTP
响应头仅影响客户端（如浏览器）的响应行为，不会影响到节点的缓存行为。
# 操作说明
您可以登录七牛开发者平台，并进入[**DCDN控制台**
__](https://portal.qiniu.com/dcdn/overview)，选择【域名管理】，点击【配置】。
进入域名配置界面，点击【修改配置】对 HTTP 响应头进行配置。
响应头支持【删除】【设置】操作。
请根据实际情况选择 HTTP 响应头、响应头操作并配置相应的值。
目前七牛云CDN提供11个 HTTP 响应头参数可供您自定义取值，解释如下表所示。 如果您有其他 HTTP 头设置需求，请[提交工单
__](https://support.qiniu.com/tickets/new/form?category=%E9%85%8D%E7%BD%AE%E9%97%AE%E9%A2%98&space=CDN)处理。
HTTP 响应头 | 描述 | 示例
---|---|---
Access-control-allow-origin | 指定允许的跨域请求的来源。 | * （*表示全部域名；也可填写完整域名，例如 http://www.qiniu.com 、http://*.qiniu.com )
Access-Control-Allow-Headers | 指定允许的跨域请求的字段。 | X-Custom-Header
Access-Control-Allow-Methods | 指定允许的跨域请求方法。 | POST,GET,OPTIONS
Content-Type | 指定客户端程序响应对象的内容类型。 | Content-Type
Cache-Control | 指定客户端程序请求和响应遵循的缓存机制。 | no-cache,no-store
Content-Disposition | 指定客户端程序把请求所得的内容存为一个文件时提供的默认的文件名。 | attachment; filename=“filename.jpg”
Content-Language | 指定客户端程序响应对象的语言。 | zh-CN,en-US
Expires | 指定客户端程序响应对象的过期时间。 | Wed, 21 Oct 2015 07:28:00 GMT
Access-Control-Max-Age | 指定跨域请求时，对特定资源的预请求返回结果的缓存时间。 | 600（单位为秒，600表示10分钟）
Access-Control-Expose-Headers | 指定允许访问的自定义头信息。 | Content-Length（可以输入多个头部时，需用 “,” 隔开。）
Access-Control-Allow-Credentials | 指定是否允许跨域请求携带验证信息，验证信息可以是cookies。 | true
注：跨域是指某一个域名，如 www.aaa.com 下的某资源，向另一个域名 www.bbb.com 下的某资源发起请求，此时由于资源所属域名不同，即出现 跨域，不同的协议、不同的端口均会造成跨域访问的出现。此时必须在 Response Header 中增加跨域相关配置，才能让前者成功拿到数据。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[全站加速](https://developer.qiniu.com/dcdn) > 使用指南 > 配置管理 >HTTP响应头配置
# HTTP响应头配置
最近更新时间: 2022-02-18 14:25:12
HTTP 消息头是指，在超文本传输协议（ Hypertext Transfer Protocol，HTTP）的请求和响应消息中，协议头部的组件。在 HTTP
消息头中，按其出现的上下文环境，分为通用头、请求头、响应头等。
其中 HTTP
响应头向客户端提供一些额外信息，比如谁在发送响应、响应者的功能，甚至与响应相关的一些特殊指令。这些头部有助于客户端处理响应，并在将来发起更好的请求。
当您的网站接入 DCDN 后，由于客户端和源站会根据 HTTP 响应头的字段信息进行相关的行为处理，所以会有修改 HTTP 响应头的需求。由于 HTTP
响应头配置是针对域名，因此一旦配置生效，对该域名下任意一个资源的响应消息中均会加入所配置头部。配置 HTTP
响应头仅影响客户端（如浏览器）的响应行为，不会影响到节点的缓存行为。
# 操作说明
您可以登录七牛开发者平台，并进入[**DCDN控制台**
__](https://portal.qiniu.com/dcdn/overview)，选择【域名管理】，点击【配置】。
进入域名配置界面，点击【修改配置】对 HTTP 响应头进行配置。
响应头支持【删除】【设置】操作。
请根据实际情况选择 HTTP 响应头、响应头操作并配置相应的值。
目前七牛云CDN提供11个 HTTP 响应头参数可供您自定义取值，解释如下表所示。 如果您有其他 HTTP 头设置需求，请[提交工单
__](https://support.qiniu.com/tickets/new/form?category=%E9%85%8D%E7%BD%AE%E9%97%AE%E9%A2%98&space=CDN)处理。
HTTP 响应头 | 描述 | 示例
---|---|---
Access-control-allow-origin | 指定允许的跨域请求的来源。 | * （*表示全部域名；也可填写完整域名，例如 http://www.qiniu.com 、http://*.qiniu.com )
Access-Control-Allow-Headers | 指定允许的跨域请求的字段。 | X-Custom-Header
Access-Control-Allow-Methods | 指定允许的跨域请求方法。 | POST,GET,OPTIONS
Content-Type | 指定客户端程序响应对象的内容类型。 | Content-Type
Cache-Control | 指定客户端程序请求和响应遵循的缓存机制。 | no-cache,no-store
Content-Disposition | 指定客户端程序把请求所得的内容存为一个文件时提供的默认的文件名。 | attachment; filename=“filename.jpg”
Content-Language | 指定客户端程序响应对象的语言。 | zh-CN,en-US
Expires | 指定客户端程序响应对象的过期时间。 | Wed, 21 Oct 2015 07:28:00 GMT
Access-Control-Max-Age | 指定跨域请求时，对特定资源的预请求返回结果的缓存时间。 | 600（单位为秒，600表示10分钟）
Access-Control-Expose-Headers | 指定允许访问的自定义头信息。 | Content-Length（可以输入多个头部时，需用 “,” 隔开。）
Access-Control-Allow-Credentials | 指定是否允许跨域请求携带验证信息，验证信息可以是cookies。 | true
注：跨域是指某一个域名，如 www.aaa.com 下的某资源，向另一个域名 www.bbb.com 下的某资源发起请求，此时由于资源所属域名不同，即出现 跨域，不同的协议、不同的端口均会造成跨域访问的出现。此时必须在 Response Header 中增加跨域相关配置，才能让前者成功拿到数据。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,229 |
批量复制 | 全站加速 | [全站加速](https://developer.qiniu.com/dcdn) > 使用指南 > 配置管理 >批量复制
# 批量复制
最近更新时间: 2023-08-11 15:31:35
批量复制可以实现复制已有域名的配置完成批量添加域名，支持调整基础配置批量复制，也支持自定义勾选Referer 防盗链、IP 黑白名单、HTTP
响应头等配置项批量复制。
# 操作说明
### 1.登录**七牛开发者平台** 后，进入**CDN控制台** ，选择【域名管理】，点击目标域名**操作** 项下的**复制** 进入配置界面：
注意：只有**成功** 状态的域名支持批量复制
### 2.添加域名&确认配置
在**加速域名** 输入框中输入需要批量添加的域名，并确认**基本信息、源站配置和缓存配置** ，若非预期配置可以修改。
注意：
a. 添加域名中存在未备案域名，加速范围只能选择海外；
b. 完整域名和泛域名需要分开添加，不能混在一起批量复制；
c. **源站测试** 需要点击并显示测试通过后，才可以点击**下一步** ，否则会报错提示“源站待测试”。
### 3.选择复制配置
**配置项** ：支持自定义勾选的批量复制配置项，包含Referer 防盗链、IP 黑白名单、HTTP 响应头等配置批。
**配置状态** ：配置项的配置状态，包含开启和关闭两种。
**操作** ：点击**详情** 可以查看配置项的配置详情。
注意：
a. 若被复制域名存在后端特殊配置（非控制台配置），该特殊配置无法复制，若需要请联系客服补充配置。
b. 因 HTTPS 证书配置需要重新绑定当前域名，不支持复制此配置，若需要请自助补充配置。
c. 配置状态为关闭的配置项勾选和不勾选，实际配置效果均为关闭。
### 4.确认提交
确认无误，点击**确认** 即可，否则点击**取消** 返回上一步。
### 5.创建完成
注意：
a. 域名的状态若为“创建完成”，仅表示创建域名的任务提交成功，不表示域名配置下发完成；
b. 域名的状态若为“域名所有权待验证”，需要点击**操作** 项下的**所有权验证** 逐个域名进行所有权验证，否则无法成功添加域名。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[全站加速](https://developer.qiniu.com/dcdn) > 使用指南 > 配置管理 >批量复制
# 批量复制
最近更新时间: 2023-08-11 15:31:35
批量复制可以实现复制已有域名的配置完成批量添加域名，支持调整基础配置批量复制，也支持自定义勾选Referer 防盗链、IP 黑白名单、HTTP
响应头等配置项批量复制。
# 操作说明
### 1.登录**七牛开发者平台** 后，进入**CDN控制台** ，选择【域名管理】，点击目标域名**操作** 项下的**复制** 进入配置界面：
注意：只有**成功** 状态的域名支持批量复制
### 2.添加域名&确认配置
在**加速域名** 输入框中输入需要批量添加的域名，并确认**基本信息、源站配置和缓存配置** ，若非预期配置可以修改。
注意：
a. 添加域名中存在未备案域名，加速范围只能选择海外；
b. 完整域名和泛域名需要分开添加，不能混在一起批量复制；
c. **源站测试** 需要点击并显示测试通过后，才可以点击**下一步** ，否则会报错提示“源站待测试”。
### 3.选择复制配置
**配置项** ：支持自定义勾选的批量复制配置项，包含Referer 防盗链、IP 黑白名单、HTTP 响应头等配置批。
**配置状态** ：配置项的配置状态，包含开启和关闭两种。
**操作** ：点击**详情** 可以查看配置项的配置详情。
注意：
a. 若被复制域名存在后端特殊配置（非控制台配置），该特殊配置无法复制，若需要请联系客服补充配置。
b. 因 HTTPS 证书配置需要重新绑定当前域名，不支持复制此配置，若需要请自助补充配置。
c. 配置状态为关闭的配置项勾选和不勾选，实际配置效果均为关闭。
### 4.确认提交
确认无误，点击**确认** 即可，否则点击**取消** 返回上一步。
### 5.创建完成
注意：
a. 域名的状态若为“创建完成”，仅表示创建域名的任务提交成功，不表示域名配置下发完成；
b. 域名的状态若为“域名所有权待验证”，需要点击**操作** 项下的**所有权验证** 逐个域名进行所有权验证，否则无法成功添加域名。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,233 |
接入方式 | 全站加速 | [全站加速](https://developer.qiniu.com/dcdn) > API 文档 > 接入方式
# 接入方式
最近更新时间: 2022-02-09 18:41:48
# 对外域名
Host: `api.qiniu.com`
# 授权
Authorization: `QBox <AccessToken>`
详细描述见[文档
__](http://developer.qiniu.com/docs/v6/api/overview/security.html#accesstoken)。
# API 请求格式
* RESTful api, 具体格式参考每个API定义
* `POST方法，需要带请求头 Content-Type:application/json，请留意`
# API 响应格式
* 响应成功的格式
HTTP/1.1 200 OK
{
// 如果API下面包含有body的响应，会列出body的结构，否则说明响应不包含body
}
* 响应错误的格式
HTTP/1.1 4xx/5xx
{
"code":<Code>, // 错误码在每个API下面都有列出, code为6位数字码，前三位与http code一致
"error":<ErrorMessage>
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[全站加速](https://developer.qiniu.com/dcdn) > API 文档 > 接入方式
# 接入方式
最近更新时间: 2022-02-09 18:41:48
# 对外域名
Host: `api.qiniu.com`
# 授权
Authorization: `QBox <AccessToken>`
详细描述见[文档
__](http://developer.qiniu.com/docs/v6/api/overview/security.html#accesstoken)。
# API 请求格式
* RESTful api, 具体格式参考每个API定义
* `POST方法，需要带请求头 Content-Type:application/json，请留意`
# API 响应格式
* 响应成功的格式
HTTP/1.1 200 OK
{
// 如果API下面包含有body的响应，会列出body的结构，否则说明响应不包含body
}
* 响应错误的格式
HTTP/1.1 4xx/5xx
{
"code":<Code>, // 错误码在每个API下面都有列出, code为6位数字码，前三位与http code一致
"error":<ErrorMessage>
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,236 |
域名归属校验 | 全站加速 | [全站加速](https://developer.qiniu.com/dcdn) > API 文档 > 域名归属校验
# 域名归属校验
最近更新时间: 2022-08-02 17:18:16
# 获取域名验证信息
用户获取域名所有权验证信息接口
## 请求包
GET /domain/<Name>/verify/info?product=<Product>
Authorization: QBox <QBoxToken>
Content-Type: application/x-www-form-urlencoded
### 参数解释
参数 | 类型 | 必填 | 含义
---|---|---|---
Name | string | 是 | 需要验证的域名
Product | string | 是 | 产品类型: `cdn`(静态加速)/`dcdn`(全站加速)
## 返回包
{
domain: <Domain>,
dns: <OwnerVerifyDnsInfo>,
file: <OwnerVerifyFileInfo>,
state: <State>
}
### 参数解释
参数 | 类型 | 含义
---|---|---
Domain | string | 用户需要验证的主域名,比如创建加速域名cdn.qiniu.com,需要验证主域名qiniu.com的所有权
Dns | object | DNS验证信息,用户需要在域名所属的DNS服务商上配置DNS解析完成验证
File | object | 文件验证信息,用户需要在主域名所在服务器的根目录下配置验证文件
State | string | 验证状态: `no_need`(不需要验证)/`doing`(待验证)/`success`(验证通过)
### DNS验证信息
参数 | 类型 | 含义
---|---|---
Host | string | 主机记录
RecordType | string | 记录类型
RecordValue | string | 记录值
### 文件验证信息
参数 | 类型 | 含义
---|---|---
FileName | string | 文件名称
FileValue | string | 文件内容
**错误码**
错误码 | 含义
---|---
400079 | 未知的顶级域名
500005 | 数据查询内部出错
# 验证域名所有权
用户验证域名所有权接口
## 请求包
POST /domain/<Name>/verify/check HTTP/1.1
Content-Type: application/json
Authorization: QBox <QBoxToken>
{
"type": <Type>,
"product": <Product>
}
### 参数解释
参数 | 类型 | 必填 | 含义
---|---|---|---
Name | string | 是 | 域名, 如果是泛域名，必须以点号 . 开头
Product | string | 是 | 产品类型: `cdn`(静态加速)/`dcdn`(全站加速)
Type | string | 是 | 验证类型: `dns`(DNS验证)/`file`(文件验证)
## 返回包
{}
**错误码**
错误码 | 含义
---|---
400000 | 未知的输入参数
400079 | 未知的顶级域名
400937 | 尚未查看域名验证值(未调用获取域名验证信息接口的情况下，直接调用验证域名所有权接口，会返回该错误码)
400932 | 域名所有权验证失败
500004 | 更新数据内部出错
500005 | 数据查询内部出错
## 请求示例
POST /domain/testqiniu.qbox.net/verify/check HTTP/1.1
Authorization: QBox 0tf5awMVxwf8WrEvrjtbiZrdRZRJU-91JgCqTOC8:6oxDOtOXVEfcR8PPuAscmWjVRS8=
Host: api.qiniu.com
{
"type": "dns"
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[全站加速](https://developer.qiniu.com/dcdn) > API 文档 > 域名归属校验
# 域名归属校验
最近更新时间: 2022-08-02 17:18:16
# 获取域名验证信息
用户获取域名所有权验证信息接口
## 请求包
GET /domain/<Name>/verify/info?product=<Product>
Authorization: QBox <QBoxToken>
Content-Type: application/x-www-form-urlencoded
### 参数解释
参数 | 类型 | 必填 | 含义
---|---|---|---
Name | string | 是 | 需要验证的域名
Product | string | 是 | 产品类型: `cdn`(静态加速)/`dcdn`(全站加速)
## 返回包
{
domain: <Domain>,
dns: <OwnerVerifyDnsInfo>,
file: <OwnerVerifyFileInfo>,
state: <State>
}
### 参数解释
参数 | 类型 | 含义
---|---|---
Domain | string | 用户需要验证的主域名,比如创建加速域名cdn.qiniu.com,需要验证主域名qiniu.com的所有权
Dns | object | DNS验证信息,用户需要在域名所属的DNS服务商上配置DNS解析完成验证
File | object | 文件验证信息,用户需要在主域名所在服务器的根目录下配置验证文件
State | string | 验证状态: `no_need`(不需要验证)/`doing`(待验证)/`success`(验证通过)
### DNS验证信息
参数 | 类型 | 含义
---|---|---
Host | string | 主机记录
RecordType | string | 记录类型
RecordValue | string | 记录值
### 文件验证信息
参数 | 类型 | 含义
---|---|---
FileName | string | 文件名称
FileValue | string | 文件内容
**错误码**
错误码 | 含义
---|---
400079 | 未知的顶级域名
500005 | 数据查询内部出错
# 验证域名所有权
用户验证域名所有权接口
## 请求包
POST /domain/<Name>/verify/check HTTP/1.1
Content-Type: application/json
Authorization: QBox <QBoxToken>
{
"type": <Type>,
"product": <Product>
}
### 参数解释
参数 | 类型 | 必填 | 含义
---|---|---|---
Name | string | 是 | 域名, 如果是泛域名，必须以点号 . 开头
Product | string | 是 | 产品类型: `cdn`(静态加速)/`dcdn`(全站加速)
Type | string | 是 | 验证类型: `dns`(DNS验证)/`file`(文件验证)
## 返回包
{}
**错误码**
错误码 | 含义
---|---
400000 | 未知的输入参数
400079 | 未知的顶级域名
400937 | 尚未查看域名验证值(未调用获取域名验证信息接口的情况下，直接调用验证域名所有权接口，会返回该错误码)
400932 | 域名所有权验证失败
500004 | 更新数据内部出错
500005 | 数据查询内部出错
## 请求示例
POST /domain/testqiniu.qbox.net/verify/check HTTP/1.1
Authorization: QBox 0tf5awMVxwf8WrEvrjtbiZrdRZRJU-91JgCqTOC8:6oxDOtOXVEfcR8PPuAscmWjVRS8=
Host: api.qiniu.com
{
"type": "dns"
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,238 |
域名相关 | 全站加速 | [全站加速](https://developer.qiniu.com/dcdn) > API 文档 > 域名相关
# 域名相关
最近更新时间: 2024-07-01 15:33:48
# 创建全站加速域名
用户创建全站加速普通及泛域名接口
## 请求包
POST /domain/<Name> HTTP/1.1
Content-Type: application/json
Authorization: QBox <AccessToken>
{
// 基本配置
"type": <Type>,
"platform": <Platform>,
"geoCover": <GeoCover>,
"protocol": <Protocol>,
"ipTypes": <IpTypes>,
// 回源配置
"source": <Source>,
// 缓存配置
"cache": <Cache>,
// referer 防盗链
"referer": <Referer>,
// ip 黑白名单
"ipACL": <IPACL>,
// htttps 配置
"https": <HTTPS>,
// 备案号
"registerNo": <RegisterNo>
}
### 参数解释
**基本参数**
参数 | 类型 | 必填 | 含义
---|---|---|---
Name | string | 是 | 域名, 如果是泛域名，必须以点号 . 开头
Type | string | 是 | 域名类型: `normal`(普通域名)/`wildcard`(泛域名)
Platform | string | 是 | 平台类型: 固定值 `dynamic`(动态加速)
GeoCover | string | 是 | 地域: `china`/`foreign`/`global`
Protocol | string | 是 | 协议: `http`/`https`
Source | 请参考 [回源配置 __](https://developer.qiniu.com/fusion/api/4249/product-features#2)| 是 | 回源参数
Cache | 请参考 [缓存策略 __](https://developer.qiniu.com/fusion/api/4249/product-features#1)| 备注：平台是动态加速是“否”，其他平台为“是” | 缓存参数
Referer | 请参考 [referer防盗链 __](https://developer.qiniu.com/fusion/api/4249/product-features#3)| 否 | 防盗链参数
IPACL | 请参考 [ip黑白名单 __](https://developer.qiniu.com/fusion/api/4249/product-features#4)| 否 | ip 黑白名单参数
HTTPS | 请参考 [HTTPS __](https://developer.qiniu.com/fusion/api/4249/product-features#7)| 否 | HTTPS参数
RegisterNo | string | 否 | 当创建域名返回`code: 500230` 或者返回的内容提示为`备案查询服务已关闭`，需要API调用者在本参数输入域名的备案号
IpTypes | uint | 否 | IP协议：仅允许ipv4访问，取值为1；同时允许ipv4/ipv6访问，取值为3。不指定IPTypes时，国内/全球域名默认为允许ipv4/ipv6访问，海外域名仅允许ipv4访问。
## 返回包
{}
**错误码**
错误码 | 含义
---|---
400001 | 非法域名
400005 | 未知的协议
400020 | 域名未备案
400040 | 非法的回源域名
400044 | 非法的回源host
400041 | 未知的回源ip
400008 | 无此bucket
400345 | 共享bucket不能绑定域名
400043 | 未知的高级回源参数
400022 | 未知的测试url
400002 | 未知的回源类型
400093 | 非法的域名类型
400060 | 未知的referer防盗链类型
400061 | 未知的referer防盗链参数
400091 | 缓存参数有误
400309 | 缓存规则未设置全局或者为遵循源站
400204 | 时间戳防盗链key值数目不够
400031 | 非法的url
400203 | 已禁用的用户
400541 | 获取用户信息失败
401000 | 未实名认证的用户
400801 | 未知的vendor
400003 | 未知的平台类型
400004 | 未知覆盖
404911 | 非法的路径
404912 | 非法的正则表达式
400520 | 不能同时设置时间戳防盗链和回源鉴权
400200 | 未知的bucket
400521 | 非法的回源鉴权地址
400522 | 非法的回源鉴权http方法
400523 | 非法的回源鉴权http code
400524 | 非法的回源鉴权超时时间
400525 | 非法的回源鉴权url参数
400401 | 无此证书
400324 | https证书解码失败
400325 | https证书解析失败
400321 | https证书还未生效
400329 | https证书过期
400326 | https证书与域名不匹配
400327 | 解析https证书密钥失败
400328 | https证书与密钥不匹配
400323 | 验证https证书链失败
400549 | 只有https域名才能使用强制https跳转
400621 | 泛域名及其子域名不能使用私有bucket
400005 | 未知的协议
400332 | 未知的回源协议
400932 | 域名所有权验证失败
500219 | 查询证书内部错误
500005 | 数据查询内部出错
500230 | 备案查询服务已关闭
500000 | 未知内部错误
## 请求示例
POST /domain/testqiniu.qbox.net HTTP/1.1
Authorization: QBox 0tf5awMVxwf8WrEvrjtbiZrdRZRJU-91JgCqTOC8:6oxDOtOXVEfcR8PPuAscmWjVRS8=
Content-Type: application/json
Host: api.qiniu.com
{
"protocol": "http",
"platform": "web",
"geocover": "china",
"type": "normal",
"ipTypes": 3,
"source": {
"sourceType": "bucket",
"sourceQiniuBucket": "test",
"testURLPath": "qiniu_do_not_delete.gif"
},
"cache": {
"cacheControls": [
{
"time": 0,
"timeunit": 0,
"type": "suffix",
"rule": ".m3u8;.js"
},
{
"time": 1,
"timeunit": 5,
"type": "all",
"rule": "*"
}
],
"ignoreParam": true
},
"referer": {
"refererType": "white",
"refererValues": [
"*.qiniu.com",
"qiniu.com"
],
"nullReferer": true
},
"ipACL": {
"ipACLType": "black",
"ipACLValues": [
"115.223.202.9"
]
}
}
# 调整覆盖
用户修改全站加速普通域名及泛域名区域覆盖接口
## 请求包
PUT /domain/<Name>/geocover
Content-Type: application/json
Authorization: QBox <AccessToken>
{
"geoCover": <GeoCover>
}
### 参数解释
参数 | 类型 | 必填 | 含义
---|---|---|---
Name | string | 是 | 域名
GeoCover | string | 是 | 地域: china/foreign/global（中国大陆/海外/全球）
## 返回包
{ 200 }
**错误码**
错误码 | 含义
---|---
400001 | 非法域名
400004 | 未知覆盖
400108 | 覆盖冲突
400020 | 域名未备案
400030 | 正在处理中
400064 | 无权处理该域名
400066 | 域名状态为失败
400078 | 未备案的海外域名，对七牛资源的使用错误
400093 | 非法的域名类型
400313 | 域名有手动配置的时间戳防盗链
400923 | 域名已冻结
400998 | 域名已下线
404001 | 无此域名
500000 | 未知内部错误
500005 | 数据查询内部出错
500930 | 不能操作已删除的域名
# 修改源站
用户修改普通域名及泛域名源站接口
## 请求包
PUT /domain/<Name>/source
Content-Type: application/json
Authorization: QBox <AccessToken>
{
Source
}
### 参数解释
参数 | 类型 | 必填 | 含义
---|---|---|---
Source | object | 是 | Source结构请参考 [回源配置 __](https://developer.qiniu.com/fusion/api/4249/product-features#2)
## 返回包
{}
**错误码**
错误码 | 含义
---|---
400001 | 非法域名
404001 | 无此域名
400093 | 非法的域名类型
400801 | 未知的vendor
400018 | 非法的cname
400005 | 未知的协议
400046 | 非法的url重写规则
400022 | 非法的测试url
400024 | 验证源站访问性失败
500005 | 数据查询内部出错
500019 | 非标准的回源cname
## 请求示例
PUT /domain/testqiniu.qbox.net/source HTTP/1.1
Authorization: QBox 0tf5awMVxwf8WrEvrjtbiZrdRZRJU-91JgCqTOC8:6oxDOtOXVEfcR8PPuAscmWjVRS8=
Content-Type: application/json
Host: api.qiniu.com
{
"sourceType": "ip",
"sourceIPs": [
"1.1.1.1",
"1.1.1.2"
],
"testURLPath": "test.gif"
}
# 修改Range回源
用户修改普通域名及泛域名Range回源接口
## 请求包
PUT /domain/<Name>/range
Content-Type: application/json
Authorization: QBox <AccessToken>
{
"enable": <Enable>
}
### 参数解释
参数 | 类型 | 必填 | 含义
---|---|---|---
Enable | string | 是 | Range回源开关：on/off
## 返回包
{}
**错误码**
错误码 | 含义
---|---
404001 | 无此域名
400001 | 未知的域名
400064 | 无权处理该域名
400200 | 未知的bucket
400008 | 无此bucket
400013 | 重复操作
400030 | 正在处理中
400066 | 域名状态为失败
400998 | 域名已下线
500923 | 域名已冻结
500930 | 删除中的域名
400957 | 无效的Range配置
## 请求示例
PUT /domain/testqiniu.qbox.net/range HTTP/1.1
Authorization: QBox 0tf5awMVxwf8WrEvrjtbiZrdRZRJU-91JgCqTOC8:6oxDOtOXVEfcR8PPuAscmWjVRS8=
Content-Type: application/json
Host: api.qiniu.com
{
"enable": "on"
}
# 修改缓存规则
用户修改普通域名及泛域名缓存规则接口
## 请求包
PUT /domain/<Name>/cache
Content-Type: application/json
Authorization: QBox <AccessToken>
{
Cache
}
### 参数解释
参数 | 类型 | 必填 | 含义
---|---|---|---
Cache | object | 是 | Cache结构请参考 [缓存策略 __](https://developer.qiniu.com/fusion/api/4249/product-features#1)
## 返回包
{}
**错误码**
错误码 | 含义
---|---
400001 | 未知的域名
404001 | 无此域名
400064 | 无权处理该域名
400093 | 非法的域名类型
400030 | 正在处理中
400066 | 域名状态为失败
400998 | 域名已下线
400091 | 缓存参数有误
400309 | 缓存规则未设置全局或者为遵循源站
500005 | 数据查询内部出错
400923 | 域名已冻结
500930 | 删除中的域名
## 请求示例
PUT /domain/testqiniu.qbox.net/cache HTTP/1.1
Authorization: QBox 0tf5awMVxwf8WrEvrjtbiZrdRZRJU-91JgCqTOC8:6oxDOtOXVEfcR8PPuAscmWjVRS8=
Content-Type: application/json
Host: api.qiniu.com
{
"cacheControls": [
{
"time": 0,
"timeunit": 0,
"type": "suffix",
"rule": ".m3u8;.js"
},
{
"time": 1,
"timeunit": 5,
"type": "all",
"rule": "*"
}
],
"ignoreParam": true
}
# 下线域名
用户下线普通及泛域名接口
## 请求包
POST /domain/<Name>/offline
Content-Type: application/json
Authorization: QBox <AccessToken>
## 返回包
{}
**错误码**
错误码 | 含义
---|---
404001 | 无此域名
400001 | 未知的域名
400064 | 无权处理该域名
400093 | 非法的域名类型
400013 | 重复操作
400030 | 正在处理中
400066 | 域名状态为失败
400018 | 非法的cname
400397 | cname和其他域名冲突
400923 | 域名已冻结
500005 | 数据查询内部出错
# 上线域名
用户上线普通及泛域名接口
## 请求包
POST /domain/<Name>/online
Content-Type: application/json
Authorization: QBox <AccessToken>
## 返回包
{}
**错误码**
错误码 | 含义
---|---
404001 | 无此域名
400001 | 未知的域名
400064 | 无权处理该域名
400093 | 非法的域名类型
400013 | 重复操作
400030 | 正在处理中
400066 | 域名状态为失败
400018 | 非法的cname
400397 | cname和其他域名冲突
500004 | 更新数据内部出错
500923 | 域名已冻结
500005 | 数据查询内部出错
500235 | 该域名未绑定证书
# 删除域名
用户删除普通及泛域名接口
## 请求包
DELETE /domain/<Name>
Content-Type: application/json
Authorization: QBox <AccessToken>
返回包
{}
**错误码**
错误码 | 含义
---|---
404001 | 无此域名
400001 | 未知的域名
400064 | 无权处理该域名
400013 | 重复操作
400030 | 正在处理中
400317 | 非已下线的域名
400066 | 域名状态为失败
400515 | 该泛域名还含有活跃的子域名
500005 | 数据查询内部出错
# 获取域名信息
用户获取域名信息接口，所有域名适用
## 请求包
GET /domain/<Name>
Content-Type: application/x-www-form-urlencoded
Authorization: QBox <AccessToken>
## 返回包
{
"name": <Name>,
"type": <Type>,
"cname": <CName>,
"testURLPath": <TestURLPath>,
"platform": <Platform>,
"geoCover": <GeoCover>,
"protocol": <Protocol>,
"ipTypes": <IpTypes>,
"tagList": <TagList>,
"kvTagList": <KvTagList>
"source": <Source>,
"cache": <Cache>,
"referer": <Referer>,
"ipACL": <IPACL>,
"operationType": <OperationType>,
"operatingState": <OperatingState>,
"operatingStateDesc": <OperatingStateDesc>,
"createAt": <CreateAt>,
"modifyAt": <ModifyAt>,
"pareDomain": <PareDomain>,
"https": <Https>,
}
### 参数解释
基本参数 请参考
参数 | 类型 | 含义
---|---|---
CName | string | 创建域名成功后七牛生成的域名，用户需要把 `Name` cname 到这个域名
Referer | object | Referer结构请参考 [referer防盗链 __](https://developer.qiniu.com/fusion/api/4249/product-features#3)
IPACL | object | IPACL结构请参考 [ip黑白名单 __](https://developer.qiniu.com/fusion/api/4249/product-features#4)
Source | object | Source结构请参考 [回源配置 __](https://developer.qiniu.com/fusion/api/4249/product-features#2)
Cache | object | Cache结构请参考 [缓存策略 __](https://developer.qiniu.com/fusion/api/4249/product-features#1)
OperationType | string | 域名最近一次操作类型: `create_domain`/`offline_domain`/`online_domain`/ `modify_source`/`modify_referer`/`modify_cache`/ `freeze_domain`/`unfreeze_domain`/`modify_timeacl`(修改时间戳防盗链)/ `modify_https_crt`/`sslize`(升级HTTPS)/`modify_bsauth`(修改回源鉴权) /`offline_bsauth`(删除回源鉴权)
OperatingState | string | 域名最近一次的操作状态: `processing`/`success`/`failed`/`frozen`/`offlined`
OperatingStateDesc | string | 域名最近一次的操作状态的描述
CreateAt | string | 域名创建时间，格式:RFC3339
ModifyAt | string | 域名最后一次修改时间，格式:RFC3339
PareDomain | string | 父域名,属于泛子域名字段
Https | Object | Https结构请参考 [HTTPS __](https://developer.qiniu.com/fusion/api/4249/product-features#7)
IpTypes | uint | IP协议：仅允许ipv4访问，取值为1；同时允许ipv4/ipv6访问，取值为3。
TagList | []string | 域名的标签列表（废弃）
kvTagList | []Object | 域名的Key-Value标签列表
**错误码**
错误码 | 含义
---|---
404001 | 无此域名
400001 | 未知的域名
400014 | 无权获取该域名
500005 | 数据查询内部出错
# 获取域名列表
用户获取域名列表接口，所有域名适用
## 请求包
GET /domain?product=<Product>&types=<Types>&certId=<CertId>&sourceTypes=<SourceTypes>&sourceQiniuBucket=<SourceQiniuBucket>&sourceIp=<SourceIp>&marker=<Marker>&limit=<Limit>
Content-Type: application/x-www-form-urlencoded
Authorization: QBox <AccessToken>
### 参数解释
参数 | 类型 | 含义
---|---|---
Product | string | 全站加速固定传参 “dcdn”。
Types | []string | 域名类型，可选normal（普通域名）、wildcard（泛域名）、pan（泛子域名）、test（测试域名）中的一个或多个，不填默认查询全部域名。
CertId | string | 证书ID，不填默认查询全部域名。
SourceTypes | []string | 回源类型，可选domain、ip、qiniuBucket、advanced中的一个或多个，不填默认查询全部域名；如果指定了SourceQiniuBucket参数，SourceTypes只能指定为qiniuBucket一种回源类型，否则SourceQiniuBucket参数将不生效；如果指定了SourceIp参数，SourceTypes只能指定为ip一种回源类型，否则SourceIp参数将不生效；同时获取多种回源类型域名的请求url示例：http://api.qiniu.com/domain?sourceTypes=domain&sourceTypes=ip。
SourceQiniuBucket | string | 七牛存储空间名称，不填默认查询全部域名。请求url示例：http://api.qiniu.com/domain?sourceTypes=qiniuBucket&sourceQiniuBucket=test。
SourceIp | string | 回源IP, 不填默认查询全部域名。请求url示例：http://api.qiniu.com/domain?sourceTypes=ip&sourceIp=1.1.1.1。
Marker | string | 用于标示从哪个位置开始获取域名列表，不填或空表示从头开始。
Limit | int | 返回的最大域名个数。1~1000, 不填默认为 10
## 返回包
{
"marker": <Marker>,
"domains": [
{
"name": <Name>,
"type": <Type>,
"cname": <CName>,
"testURLPath": <TestURLPath>,
"platform": <Platform>,
"geoCover": <GeoCover>,
"protocol": <Protocol>,
"operatingState": <OperatingState>,
"operatingStateDesc": <OperatingStateDesc>,
"createAt": <CreateAt>,
"modifyAt": <ModifyAt>,
},
...
]
}
### 参数解释
基本参数 请参考
参数 | 类型 | 含义
---|---|---
Marker | string | 用于标示下一次从哪个位置开始获取域名列表
CName | string | 创建域名成功后七牛生成的域名，用户需要把 `Name` cname 到这个域名
TestURLPath | string | 域名的测试资源，需要保证这个资源是可访问的
IpTypes | uint | IP协议：仅允许ipv4访问，取值为1；同时允许ipv4/ipv6访问，取值为3。
TagList | []string | 域名的标签列表 （废弃）
KvTagList | []Object | 域名的Key-Value标签列表
OperatingState | string | 域名最近一次的操作状态: `processing`/`success`/`failed`/`frozen`/`offlined`
CreateAt | string | 域名创建时间，格式:RFC3339
ModifyAt | string | 域名最后一次修改时间，格式:RFC3339
**错误码**
错误码 | 含义
---|---
400021 | 非法的参数marker
500005 | 数据查询内部出错
# HTTP升级为HTTPS
HTTP升级为HTTPS
## 请求包
PUT /domain/<Name>/sslize
Content-Type: application/json
Authorization: QBox <AccessToken>
{
"certid":<CertID>,
"forceHttps": <ForceHttps>,
"http2Enable": <Http2Enable>
}
### 参数解释
参数 | 类型 | 含义
---|---|---
CertID | string | 证书id，从上传或者获取证书列表里拿到证书id
ForceHttps | bool | 是否强制https跳转
Http2Enable | bool | http2功能是否启用，false为关闭，true为开启
## 返回包
{}
**错误码**
错误码 | 含义
---|---
400331 | 非法参数
404001 | 无此域名
400001 | 未知的域名
400064 | 无权处理该域名
400008 | 无此bucket
400392 | 非法的域名cname
400013 | 重复操作
400030 | 正在处理中
400066 | 域名状态为失败
400401 | 无此证书
400324 | https证书解码失败
400325 | https证书解析失败
400321 | https证书还未生效
400329 | https证书过期
400326 | https证书与域名不匹配
400327 | 解析https证书密钥失败
400328 | https证书与密钥不匹配
400323 | 验证https证书链失败
400550 | 非法的证书id
500219 | 查询证书内部错误
500005 | 数据查询内部出错
# HTTPS降级为HTTP
HTTPS降级为HTTP
## 请求包
PUT /domain/<Name>/unsslize
Content-Type: application/json
Authorization: QBox <AccessToken>
## 返回包
{}
**错误码**
错误码 | 含义
---|---
400331 | 非法参数
404001 | 无此域名
400001 | 未知的域名
400064 | 无权处理该域名
400093 | 非法的域名类型
400008 | 无此bucket
400392 | 非法的域名cname
400013 | 重复操作
400030 | 正在处理中
400923 | 域名已冻结
400066 | 域名状态为失败
401001 | 域名不允许操作
500004 | 更新数据内部出错
500005 | 数据查询内部出错
# 修改证书
修改证书
## 请求包
PUT /domain/<Name>/httpsconf
Content-Type: application/json
Authorization: QBox <AccessToken>
{
"certId": <CertID>,
"forceHttps": <ForceHttps>,
"http2Enable": <Http2Enable>
}
### 参数解释
参数 | 类型 | 含义
---|---|---
CertID | string | 证书id，从上传或者获取证书列表里拿到证书id
ForceHttps | bool | 是否强制https跳转
Http2Enable | bool | http2功能是否启用，false为关闭，true为开启
## 返回包
{}
**错误码**
错误码 | 含义
---|---
400331 | 非法参数
404001 | 无此域名
400001 | 未知的域名
400064 | 无权处理该域名
400008 | 无此bucket
400392 | 非法的域名cname
400013 | 重复操作
400030 | 正在处理中
400066 | 域名状态为失败
400401 | 无此证书
400324 | https证书解码失败
400325 | https证书解析失败
400321 | https证书还未生效
400329 | https证书过期
400326 | https证书与域名不匹配
400327 | 解析https证书密钥失败
400328 | https证书与密钥不匹配
400323 | 验证https证书链失败
500219 | 查询证书内部错误
500005 | 数据查询内部出错
# 修改referer防盗链
用户修改普通域名及泛域名referer防盗链接口
## 请求包
PUT /domain/<Name>/referer
Content-Type: application/json
Authorization: QBox <AccessToken>
{
Referer
}
### 参数解释
参数 | 类型 | 必填 | 含义
---|---|---|---
Referer | object | 是 | Referer结构请参考 [referer防盗链 __](https://developer.qiniu.com/fusion/api/4249/product-features#3)
## 返回包
{}
**错误码**
错误码 | 含义
---|---
404001 | 无此域名
400001 | 未知的域名
400064 | 无权处理该域名
400008 | 无此bucket
400013 | 重复操作
400030 | 正在处理中
400066 | 域名状态为失败
400998 | 域名已下线
400923 | 域名已冻结
500930 | 删除中的域名
400060 | 未知的referer防盗链类型
400061 | 未知的referer防盗链参数
500005 | 数据查询内部出错
## 请求示例
PUT /domain/testqiniu.qbox.net/referer HTTP/1.1
Authorization: QBox 0tf5awMVxwf8WrEvrjtbiZrdRZRJU-91JgCqTOC8:6oxDOtOXVEfcR8PPuAscmWjVRS8=
Content-Type: application/json
Host: api.qiniu.com
{
"refererType": "white",
"refererValues": [
"*.qiniu.com",
"qiniu.com"
],
"nullReferer": true
}
# 修改ip黑白名单
用户修改普通域名及泛域名ip黑白名单接口
## 请求包
PUT /domain/<Name>/ipacl
Content-Type: application/json
Authorization: QBox <AccessToken>
{
IPACL
}
### 参数解释
参数 | 类型 | 必填 | 含义
---|---|---|---
IPACL | object | 是 | IPACL结构请参考 [ip黑白名单 __](https://developer.qiniu.com/fusion/api/4249/product-features#4)
## 返回包
{}
**错误码**
错误码 | 含义
---|---
404001 | 无此域名
400001 | 未知的域名
400064 | 无权处理该域名
400008 | 无此bucket
400013 | 重复操作
400030 | 正在处理中
400066 | 域名状态为失败
400998 | 域名已下线
400923 | 域名已冻结
500930 | 删除中的域名
400074 | 非法的ip黑白名单类型
400075 | 非法的ip黑白名单参数
500005 | 数据查询内部出错
## 请求示例
PUT /domain/testqiniu.qbox.net/ipacl HTTP/1.1
Authorization: QBox 0tf5awMVxwf8WrEvrjtbiZrdRZRJU-91JgCqTOC8:6oxDOtOXVEfcR8PPuAscmWjVRS8=
Content-Type: application/json
Host: api.qiniu.com
{
"ipACLType": "black",
"ipACLValues": [
"115.223.202.9"
]
}
# 修改响应头
修改CDN返回给用户的响应头
## 请求包
PUT /domain/<Name>/respheader
Content-Type: application/json
Authorization: QBox <AccessToken>
{
responseHeaderControls: [
{
op: <op>
key: <key>
value: <value>
}...
]
}
### 参数解释
参数 | 类型 | 必填 | 含义
---|---|---|---
Name | string | 是 | 域名
op | string | 是 | 对响应头的进行操作的类型，可选"set"、“del”，目前不支持"add"
key | string | 是 | 匹配响应头的key，可选值：Content-Type,Cache-Control,Content-Disposition,Content-Language,Expires,Access-Control-Allow-Origin,Access-Control-Allow-Methods,Access-Control-Allow-Headers,Access-Control-Max-Age,Access-Control-Expose-Headers,Access-Control-Allow-Credentials。
value | string | 是 | 响应头的value，在op为"set"时有效
## 返回包
{ }
**错误码**
错误码 | 含义
---|---
404001 | 无此域名
400001 | 未知的域名
400064 | 无权处理该域名
400008 | 无此bucket
400013 | 重复操作
400030 | 正在处理中
400066 | 域名状态为失败
400998 | 域名已下线
400923 | 域名已冻结
400084 | 无效的响应头key
400085 | 无效的响应头操作请求
400086 | 重复的响应头key
500930 | 删除中的域名
500005 | 数据查询内部出错
# 创建新的域名标签
在账户下添加新的域名标签
## 请求包
POST /domain/tag HTTP/1.1
Content-Type: application/json
Authorization: QBox <AccessToken>
{
tag: <Tag>,
tagKey: <TagKey>,
tagValue: <TagValue>,
product: <Product>
}
### 参数解释
参数 | 类型 | 必填 | 含义
---|---|---|---
Tag | string | 否 | 域名标签（废弃）
TagKey | string | 是 | 域名标签Key
TagValue | string | 是 | 域名标签Value
Product | string | 是 | 产品类型: `cdn`(静态加速)/`dcdn`(全站加速)
## 返回包
{}
**错误码**
错误码 | 含义
---|---
400331 | 非法参数
400925 | 账号域名标签数量达到上限
400927 | 域名标签已存在
500004 | 更新数据内部出错
500005 | 数据查询内部出错
## 请求示例
POST /domain/tag HTTP/1.1
Authorization: QBox 0tf5awMVxwf8WrEvrjtbiZrdRZRJU-91JgCqTOC8:6oxDOtOXVEfcR8PPuAscmWjVRS8=
Content-Type: application/json
Host: api.qiniu.com
{
"tagKey": "图片",
"tagValue": "高清",
"product": "cdn"
}
# 设置域名标签
选取账户下定义好的标签，为域名配置标签列表
## 请求包
PUT /domain/<Domain>/tags HTTP/1.1
Content-Type: application/json
Authorization: QBox <AccessToken>
{
kvTagList: <TagList>
}
### 参数解释
参数 | 类型 | 必填 | 含义
---|---|---|---
kvTagList | []Object | 是 | Key-Value格式标签列表
## 返回包
{}
**错误码**
错误码 | 含义
---|---
400331 | 非法参数
404001 | 无此域名
400064 | 无权处理该域名
400926 | 单个域名标签数量达到上限
500004 | 更新数据内部出错
500005 | 数据查询内部出错
## 请求示例
PUT /domain/<Domain>/tags HTTP/1.1
Authorization: QBox 0tf5awMVxwf8WrEvrjtbiZrdRZRJU-91JgCqTOC8:6oxDOtOXVEfcR8PPuAscmWjVRS8=
Content-Type: application/json
Host: api.qiniu.com
{
"kvTagList": [{"key":"图片","value":"高清"}]
}
# 获取所有域名标签
获取账户下定义的域名标签
## 请求包
GET /domain/all/tags?product=<Product>
Content-Type: application/x-www-form-urlencoded
Authorization: QBox <AccessToken>
### 参数解释
参数 | 类型 | 必填 | 含义
---|---|---|---
Product | string | 是 | 产品类型: `cdn`(静态加速)/`dcdn`(全站加速)
## 返回包
{}
**错误码**
错误码 | 含义
---|---
400331 | 非法参数
500005 | 数据查询内部出错
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[全站加速](https://developer.qiniu.com/dcdn) > API 文档 > 域名相关
# 域名相关
最近更新时间: 2024-07-01 15:33:48
# 创建全站加速域名
用户创建全站加速普通及泛域名接口
## 请求包
POST /domain/<Name> HTTP/1.1
Content-Type: application/json
Authorization: QBox <AccessToken>
{
// 基本配置
"type": <Type>,
"platform": <Platform>,
"geoCover": <GeoCover>,
"protocol": <Protocol>,
"ipTypes": <IpTypes>,
// 回源配置
"source": <Source>,
// 缓存配置
"cache": <Cache>,
// referer 防盗链
"referer": <Referer>,
// ip 黑白名单
"ipACL": <IPACL>,
// htttps 配置
"https": <HTTPS>,
// 备案号
"registerNo": <RegisterNo>
}
### 参数解释
**基本参数**
参数 | 类型 | 必填 | 含义
---|---|---|---
Name | string | 是 | 域名, 如果是泛域名，必须以点号 . 开头
Type | string | 是 | 域名类型: `normal`(普通域名)/`wildcard`(泛域名)
Platform | string | 是 | 平台类型: 固定值 `dynamic`(动态加速)
GeoCover | string | 是 | 地域: `china`/`foreign`/`global`
Protocol | string | 是 | 协议: `http`/`https`
Source | 请参考 [回源配置 __](https://developer.qiniu.com/fusion/api/4249/product-features#2)| 是 | 回源参数
Cache | 请参考 [缓存策略 __](https://developer.qiniu.com/fusion/api/4249/product-features#1)| 备注：平台是动态加速是“否”，其他平台为“是” | 缓存参数
Referer | 请参考 [referer防盗链 __](https://developer.qiniu.com/fusion/api/4249/product-features#3)| 否 | 防盗链参数
IPACL | 请参考 [ip黑白名单 __](https://developer.qiniu.com/fusion/api/4249/product-features#4)| 否 | ip 黑白名单参数
HTTPS | 请参考 [HTTPS __](https://developer.qiniu.com/fusion/api/4249/product-features#7)| 否 | HTTPS参数
RegisterNo | string | 否 | 当创建域名返回`code: 500230` 或者返回的内容提示为`备案查询服务已关闭`，需要API调用者在本参数输入域名的备案号
IpTypes | uint | 否 | IP协议：仅允许ipv4访问，取值为1；同时允许ipv4/ipv6访问，取值为3。不指定IPTypes时，国内/全球域名默认为允许ipv4/ipv6访问，海外域名仅允许ipv4访问。
## 返回包
{}
**错误码**
错误码 | 含义
---|---
400001 | 非法域名
400005 | 未知的协议
400020 | 域名未备案
400040 | 非法的回源域名
400044 | 非法的回源host
400041 | 未知的回源ip
400008 | 无此bucket
400345 | 共享bucket不能绑定域名
400043 | 未知的高级回源参数
400022 | 未知的测试url
400002 | 未知的回源类型
400093 | 非法的域名类型
400060 | 未知的referer防盗链类型
400061 | 未知的referer防盗链参数
400091 | 缓存参数有误
400309 | 缓存规则未设置全局或者为遵循源站
400204 | 时间戳防盗链key值数目不够
400031 | 非法的url
400203 | 已禁用的用户
400541 | 获取用户信息失败
401000 | 未实名认证的用户
400801 | 未知的vendor
400003 | 未知的平台类型
400004 | 未知覆盖
404911 | 非法的路径
404912 | 非法的正则表达式
400520 | 不能同时设置时间戳防盗链和回源鉴权
400200 | 未知的bucket
400521 | 非法的回源鉴权地址
400522 | 非法的回源鉴权http方法
400523 | 非法的回源鉴权http code
400524 | 非法的回源鉴权超时时间
400525 | 非法的回源鉴权url参数
400401 | 无此证书
400324 | https证书解码失败
400325 | https证书解析失败
400321 | https证书还未生效
400329 | https证书过期
400326 | https证书与域名不匹配
400327 | 解析https证书密钥失败
400328 | https证书与密钥不匹配
400323 | 验证https证书链失败
400549 | 只有https域名才能使用强制https跳转
400621 | 泛域名及其子域名不能使用私有bucket
400005 | 未知的协议
400332 | 未知的回源协议
400932 | 域名所有权验证失败
500219 | 查询证书内部错误
500005 | 数据查询内部出错
500230 | 备案查询服务已关闭
500000 | 未知内部错误
## 请求示例
POST /domain/testqiniu.qbox.net HTTP/1.1
Authorization: QBox 0tf5awMVxwf8WrEvrjtbiZrdRZRJU-91JgCqTOC8:6oxDOtOXVEfcR8PPuAscmWjVRS8=
Content-Type: application/json
Host: api.qiniu.com
{
"protocol": "http",
"platform": "web",
"geocover": "china",
"type": "normal",
"ipTypes": 3,
"source": {
"sourceType": "bucket",
"sourceQiniuBucket": "test",
"testURLPath": "qiniu_do_not_delete.gif"
},
"cache": {
"cacheControls": [
{
"time": 0,
"timeunit": 0,
"type": "suffix",
"rule": ".m3u8;.js"
},
{
"time": 1,
"timeunit": 5,
"type": "all",
"rule": "*"
}
],
"ignoreParam": true
},
"referer": {
"refererType": "white",
"refererValues": [
"*.qiniu.com",
"qiniu.com"
],
"nullReferer": true
},
"ipACL": {
"ipACLType": "black",
"ipACLValues": [
"115.223.202.9"
]
}
}
# 调整覆盖
用户修改全站加速普通域名及泛域名区域覆盖接口
## 请求包
PUT /domain/<Name>/geocover
Content-Type: application/json
Authorization: QBox <AccessToken>
{
"geoCover": <GeoCover>
}
### 参数解释
参数 | 类型 | 必填 | 含义
---|---|---|---
Name | string | 是 | 域名
GeoCover | string | 是 | 地域: china/foreign/global（中国大陆/海外/全球）
## 返回包
{ 200 }
**错误码**
错误码 | 含义
---|---
400001 | 非法域名
400004 | 未知覆盖
400108 | 覆盖冲突
400020 | 域名未备案
400030 | 正在处理中
400064 | 无权处理该域名
400066 | 域名状态为失败
400078 | 未备案的海外域名，对七牛资源的使用错误
400093 | 非法的域名类型
400313 | 域名有手动配置的时间戳防盗链
400923 | 域名已冻结
400998 | 域名已下线
404001 | 无此域名
500000 | 未知内部错误
500005 | 数据查询内部出错
500930 | 不能操作已删除的域名
# 修改源站
用户修改普通域名及泛域名源站接口
## 请求包
PUT /domain/<Name>/source
Content-Type: application/json
Authorization: QBox <AccessToken>
{
Source
}
### 参数解释
参数 | 类型 | 必填 | 含义
---|---|---|---
Source | object | 是 | Source结构请参考 [回源配置 __](https://developer.qiniu.com/fusion/api/4249/product-features#2)
## 返回包
{}
**错误码**
错误码 | 含义
---|---
400001 | 非法域名
404001 | 无此域名
400093 | 非法的域名类型
400801 | 未知的vendor
400018 | 非法的cname
400005 | 未知的协议
400046 | 非法的url重写规则
400022 | 非法的测试url
400024 | 验证源站访问性失败
500005 | 数据查询内部出错
500019 | 非标准的回源cname
## 请求示例
PUT /domain/testqiniu.qbox.net/source HTTP/1.1
Authorization: QBox 0tf5awMVxwf8WrEvrjtbiZrdRZRJU-91JgCqTOC8:6oxDOtOXVEfcR8PPuAscmWjVRS8=
Content-Type: application/json
Host: api.qiniu.com
{
"sourceType": "ip",
"sourceIPs": [
"1.1.1.1",
"1.1.1.2"
],
"testURLPath": "test.gif"
}
# 修改Range回源
用户修改普通域名及泛域名Range回源接口
## 请求包
PUT /domain/<Name>/range
Content-Type: application/json
Authorization: QBox <AccessToken>
{
"enable": <Enable>
}
### 参数解释
参数 | 类型 | 必填 | 含义
---|---|---|---
Enable | string | 是 | Range回源开关：on/off
## 返回包
{}
**错误码**
错误码 | 含义
---|---
404001 | 无此域名
400001 | 未知的域名
400064 | 无权处理该域名
400200 | 未知的bucket
400008 | 无此bucket
400013 | 重复操作
400030 | 正在处理中
400066 | 域名状态为失败
400998 | 域名已下线
500923 | 域名已冻结
500930 | 删除中的域名
400957 | 无效的Range配置
## 请求示例
PUT /domain/testqiniu.qbox.net/range HTTP/1.1
Authorization: QBox 0tf5awMVxwf8WrEvrjtbiZrdRZRJU-91JgCqTOC8:6oxDOtOXVEfcR8PPuAscmWjVRS8=
Content-Type: application/json
Host: api.qiniu.com
{
"enable": "on"
}
# 修改缓存规则
用户修改普通域名及泛域名缓存规则接口
## 请求包
PUT /domain/<Name>/cache
Content-Type: application/json
Authorization: QBox <AccessToken>
{
Cache
}
### 参数解释
参数 | 类型 | 必填 | 含义
---|---|---|---
Cache | object | 是 | Cache结构请参考 [缓存策略 __](https://developer.qiniu.com/fusion/api/4249/product-features#1)
## 返回包
{}
**错误码**
错误码 | 含义
---|---
400001 | 未知的域名
404001 | 无此域名
400064 | 无权处理该域名
400093 | 非法的域名类型
400030 | 正在处理中
400066 | 域名状态为失败
400998 | 域名已下线
400091 | 缓存参数有误
400309 | 缓存规则未设置全局或者为遵循源站
500005 | 数据查询内部出错
400923 | 域名已冻结
500930 | 删除中的域名
## 请求示例
PUT /domain/testqiniu.qbox.net/cache HTTP/1.1
Authorization: QBox 0tf5awMVxwf8WrEvrjtbiZrdRZRJU-91JgCqTOC8:6oxDOtOXVEfcR8PPuAscmWjVRS8=
Content-Type: application/json
Host: api.qiniu.com
{
"cacheControls": [
{
"time": 0,
"timeunit": 0,
"type": "suffix",
"rule": ".m3u8;.js"
},
{
"time": 1,
"timeunit": 5,
"type": "all",
"rule": "*"
}
],
"ignoreParam": true
}
# 下线域名
用户下线普通及泛域名接口
## 请求包
POST /domain/<Name>/offline
Content-Type: application/json
Authorization: QBox <AccessToken>
## 返回包
{}
**错误码**
错误码 | 含义
---|---
404001 | 无此域名
400001 | 未知的域名
400064 | 无权处理该域名
400093 | 非法的域名类型
400013 | 重复操作
400030 | 正在处理中
400066 | 域名状态为失败
400018 | 非法的cname
400397 | cname和其他域名冲突
400923 | 域名已冻结
500005 | 数据查询内部出错
# 上线域名
用户上线普通及泛域名接口
## 请求包
POST /domain/<Name>/online
Content-Type: application/json
Authorization: QBox <AccessToken>
## 返回包
{}
**错误码**
错误码 | 含义
---|---
404001 | 无此域名
400001 | 未知的域名
400064 | 无权处理该域名
400093 | 非法的域名类型
400013 | 重复操作
400030 | 正在处理中
400066 | 域名状态为失败
400018 | 非法的cname
400397 | cname和其他域名冲突
500004 | 更新数据内部出错
500923 | 域名已冻结
500005 | 数据查询内部出错
500235 | 该域名未绑定证书
# 删除域名
用户删除普通及泛域名接口
## 请求包
DELETE /domain/<Name>
Content-Type: application/json
Authorization: QBox <AccessToken>
返回包
{}
**错误码**
错误码 | 含义
---|---
404001 | 无此域名
400001 | 未知的域名
400064 | 无权处理该域名
400013 | 重复操作
400030 | 正在处理中
400317 | 非已下线的域名
400066 | 域名状态为失败
400515 | 该泛域名还含有活跃的子域名
500005 | 数据查询内部出错
# 获取域名信息
用户获取域名信息接口，所有域名适用
## 请求包
GET /domain/<Name>
Content-Type: application/x-www-form-urlencoded
Authorization: QBox <AccessToken>
## 返回包
{
"name": <Name>,
"type": <Type>,
"cname": <CName>,
"testURLPath": <TestURLPath>,
"platform": <Platform>,
"geoCover": <GeoCover>,
"protocol": <Protocol>,
"ipTypes": <IpTypes>,
"tagList": <TagList>,
"kvTagList": <KvTagList>
"source": <Source>,
"cache": <Cache>,
"referer": <Referer>,
"ipACL": <IPACL>,
"operationType": <OperationType>,
"operatingState": <OperatingState>,
"operatingStateDesc": <OperatingStateDesc>,
"createAt": <CreateAt>,
"modifyAt": <ModifyAt>,
"pareDomain": <PareDomain>,
"https": <Https>,
}
### 参数解释
基本参数 请参考
参数 | 类型 | 含义
---|---|---
CName | string | 创建域名成功后七牛生成的域名，用户需要把 `Name` cname 到这个域名
Referer | object | Referer结构请参考 [referer防盗链 __](https://developer.qiniu.com/fusion/api/4249/product-features#3)
IPACL | object | IPACL结构请参考 [ip黑白名单 __](https://developer.qiniu.com/fusion/api/4249/product-features#4)
Source | object | Source结构请参考 [回源配置 __](https://developer.qiniu.com/fusion/api/4249/product-features#2)
Cache | object | Cache结构请参考 [缓存策略 __](https://developer.qiniu.com/fusion/api/4249/product-features#1)
OperationType | string | 域名最近一次操作类型: `create_domain`/`offline_domain`/`online_domain`/ `modify_source`/`modify_referer`/`modify_cache`/ `freeze_domain`/`unfreeze_domain`/`modify_timeacl`(修改时间戳防盗链)/ `modify_https_crt`/`sslize`(升级HTTPS)/`modify_bsauth`(修改回源鉴权) /`offline_bsauth`(删除回源鉴权)
OperatingState | string | 域名最近一次的操作状态: `processing`/`success`/`failed`/`frozen`/`offlined`
OperatingStateDesc | string | 域名最近一次的操作状态的描述
CreateAt | string | 域名创建时间，格式:RFC3339
ModifyAt | string | 域名最后一次修改时间，格式:RFC3339
PareDomain | string | 父域名,属于泛子域名字段
Https | Object | Https结构请参考 [HTTPS __](https://developer.qiniu.com/fusion/api/4249/product-features#7)
IpTypes | uint | IP协议：仅允许ipv4访问，取值为1；同时允许ipv4/ipv6访问，取值为3。
TagList | []string | 域名的标签列表（废弃）
kvTagList | []Object | 域名的Key-Value标签列表
**错误码**
错误码 | 含义
---|---
404001 | 无此域名
400001 | 未知的域名
400014 | 无权获取该域名
500005 | 数据查询内部出错
# 获取域名列表
用户获取域名列表接口，所有域名适用
## 请求包
GET /domain?product=<Product>&types=<Types>&certId=<CertId>&sourceTypes=<SourceTypes>&sourceQiniuBucket=<SourceQiniuBucket>&sourceIp=<SourceIp>&marker=<Marker>&limit=<Limit>
Content-Type: application/x-www-form-urlencoded
Authorization: QBox <AccessToken>
### 参数解释
参数 | 类型 | 含义
---|---|---
Product | string | 全站加速固定传参 “dcdn”。
Types | []string | 域名类型，可选normal（普通域名）、wildcard（泛域名）、pan（泛子域名）、test（测试域名）中的一个或多个，不填默认查询全部域名。
CertId | string | 证书ID，不填默认查询全部域名。
SourceTypes | []string | 回源类型，可选domain、ip、qiniuBucket、advanced中的一个或多个，不填默认查询全部域名；如果指定了SourceQiniuBucket参数，SourceTypes只能指定为qiniuBucket一种回源类型，否则SourceQiniuBucket参数将不生效；如果指定了SourceIp参数，SourceTypes只能指定为ip一种回源类型，否则SourceIp参数将不生效；同时获取多种回源类型域名的请求url示例：http://api.qiniu.com/domain?sourceTypes=domain&sourceTypes=ip。
SourceQiniuBucket | string | 七牛存储空间名称，不填默认查询全部域名。请求url示例：http://api.qiniu.com/domain?sourceTypes=qiniuBucket&sourceQiniuBucket=test。
SourceIp | string | 回源IP, 不填默认查询全部域名。请求url示例：http://api.qiniu.com/domain?sourceTypes=ip&sourceIp=1.1.1.1。
Marker | string | 用于标示从哪个位置开始获取域名列表，不填或空表示从头开始。
Limit | int | 返回的最大域名个数。1~1000, 不填默认为 10
## 返回包
{
"marker": <Marker>,
"domains": [
{
"name": <Name>,
"type": <Type>,
"cname": <CName>,
"testURLPath": <TestURLPath>,
"platform": <Platform>,
"geoCover": <GeoCover>,
"protocol": <Protocol>,
"operatingState": <OperatingState>,
"operatingStateDesc": <OperatingStateDesc>,
"createAt": <CreateAt>,
"modifyAt": <ModifyAt>,
},
...
]
}
### 参数解释
基本参数 请参考
参数 | 类型 | 含义
---|---|---
Marker | string | 用于标示下一次从哪个位置开始获取域名列表
CName | string | 创建域名成功后七牛生成的域名，用户需要把 `Name` cname 到这个域名
TestURLPath | string | 域名的测试资源，需要保证这个资源是可访问的
IpTypes | uint | IP协议：仅允许ipv4访问，取值为1；同时允许ipv4/ipv6访问，取值为3。
TagList | []string | 域名的标签列表 （废弃）
KvTagList | []Object | 域名的Key-Value标签列表
OperatingState | string | 域名最近一次的操作状态: `processing`/`success`/`failed`/`frozen`/`offlined`
CreateAt | string | 域名创建时间，格式:RFC3339
ModifyAt | string | 域名最后一次修改时间，格式:RFC3339
**错误码**
错误码 | 含义
---|---
400021 | 非法的参数marker
500005 | 数据查询内部出错
# HTTP升级为HTTPS
HTTP升级为HTTPS
## 请求包
PUT /domain/<Name>/sslize
Content-Type: application/json
Authorization: QBox <AccessToken>
{
"certid":<CertID>,
"forceHttps": <ForceHttps>,
"http2Enable": <Http2Enable>
}
### 参数解释
参数 | 类型 | 含义
---|---|---
CertID | string | 证书id，从上传或者获取证书列表里拿到证书id
ForceHttps | bool | 是否强制https跳转
Http2Enable | bool | http2功能是否启用，false为关闭，true为开启
## 返回包
{}
**错误码**
错误码 | 含义
---|---
400331 | 非法参数
404001 | 无此域名
400001 | 未知的域名
400064 | 无权处理该域名
400008 | 无此bucket
400392 | 非法的域名cname
400013 | 重复操作
400030 | 正在处理中
400066 | 域名状态为失败
400401 | 无此证书
400324 | https证书解码失败
400325 | https证书解析失败
400321 | https证书还未生效
400329 | https证书过期
400326 | https证书与域名不匹配
400327 | 解析https证书密钥失败
400328 | https证书与密钥不匹配
400323 | 验证https证书链失败
400550 | 非法的证书id
500219 | 查询证书内部错误
500005 | 数据查询内部出错
# HTTPS降级为HTTP
HTTPS降级为HTTP
## 请求包
PUT /domain/<Name>/unsslize
Content-Type: application/json
Authorization: QBox <AccessToken>
## 返回包
{}
**错误码**
错误码 | 含义
---|---
400331 | 非法参数
404001 | 无此域名
400001 | 未知的域名
400064 | 无权处理该域名
400093 | 非法的域名类型
400008 | 无此bucket
400392 | 非法的域名cname
400013 | 重复操作
400030 | 正在处理中
400923 | 域名已冻结
400066 | 域名状态为失败
401001 | 域名不允许操作
500004 | 更新数据内部出错
500005 | 数据查询内部出错
# 修改证书
修改证书
## 请求包
PUT /domain/<Name>/httpsconf
Content-Type: application/json
Authorization: QBox <AccessToken>
{
"certId": <CertID>,
"forceHttps": <ForceHttps>,
"http2Enable": <Http2Enable>
}
### 参数解释
参数 | 类型 | 含义
---|---|---
CertID | string | 证书id，从上传或者获取证书列表里拿到证书id
ForceHttps | bool | 是否强制https跳转
Http2Enable | bool | http2功能是否启用，false为关闭，true为开启
## 返回包
{}
**错误码**
错误码 | 含义
---|---
400331 | 非法参数
404001 | 无此域名
400001 | 未知的域名
400064 | 无权处理该域名
400008 | 无此bucket
400392 | 非法的域名cname
400013 | 重复操作
400030 | 正在处理中
400066 | 域名状态为失败
400401 | 无此证书
400324 | https证书解码失败
400325 | https证书解析失败
400321 | https证书还未生效
400329 | https证书过期
400326 | https证书与域名不匹配
400327 | 解析https证书密钥失败
400328 | https证书与密钥不匹配
400323 | 验证https证书链失败
500219 | 查询证书内部错误
500005 | 数据查询内部出错
# 修改referer防盗链
用户修改普通域名及泛域名referer防盗链接口
## 请求包
PUT /domain/<Name>/referer
Content-Type: application/json
Authorization: QBox <AccessToken>
{
Referer
}
### 参数解释
参数 | 类型 | 必填 | 含义
---|---|---|---
Referer | object | 是 | Referer结构请参考 [referer防盗链 __](https://developer.qiniu.com/fusion/api/4249/product-features#3)
## 返回包
{}
**错误码**
错误码 | 含义
---|---
404001 | 无此域名
400001 | 未知的域名
400064 | 无权处理该域名
400008 | 无此bucket
400013 | 重复操作
400030 | 正在处理中
400066 | 域名状态为失败
400998 | 域名已下线
400923 | 域名已冻结
500930 | 删除中的域名
400060 | 未知的referer防盗链类型
400061 | 未知的referer防盗链参数
500005 | 数据查询内部出错
## 请求示例
PUT /domain/testqiniu.qbox.net/referer HTTP/1.1
Authorization: QBox 0tf5awMVxwf8WrEvrjtbiZrdRZRJU-91JgCqTOC8:6oxDOtOXVEfcR8PPuAscmWjVRS8=
Content-Type: application/json
Host: api.qiniu.com
{
"refererType": "white",
"refererValues": [
"*.qiniu.com",
"qiniu.com"
],
"nullReferer": true
}
# 修改ip黑白名单
用户修改普通域名及泛域名ip黑白名单接口
## 请求包
PUT /domain/<Name>/ipacl
Content-Type: application/json
Authorization: QBox <AccessToken>
{
IPACL
}
### 参数解释
参数 | 类型 | 必填 | 含义
---|---|---|---
IPACL | object | 是 | IPACL结构请参考 [ip黑白名单 __](https://developer.qiniu.com/fusion/api/4249/product-features#4)
## 返回包
{}
**错误码**
错误码 | 含义
---|---
404001 | 无此域名
400001 | 未知的域名
400064 | 无权处理该域名
400008 | 无此bucket
400013 | 重复操作
400030 | 正在处理中
400066 | 域名状态为失败
400998 | 域名已下线
400923 | 域名已冻结
500930 | 删除中的域名
400074 | 非法的ip黑白名单类型
400075 | 非法的ip黑白名单参数
500005 | 数据查询内部出错
## 请求示例
PUT /domain/testqiniu.qbox.net/ipacl HTTP/1.1
Authorization: QBox 0tf5awMVxwf8WrEvrjtbiZrdRZRJU-91JgCqTOC8:6oxDOtOXVEfcR8PPuAscmWjVRS8=
Content-Type: application/json
Host: api.qiniu.com
{
"ipACLType": "black",
"ipACLValues": [
"115.223.202.9"
]
}
# 修改响应头
修改CDN返回给用户的响应头
## 请求包
PUT /domain/<Name>/respheader
Content-Type: application/json
Authorization: QBox <AccessToken>
{
responseHeaderControls: [
{
op: <op>
key: <key>
value: <value>
}...
]
}
### 参数解释
参数 | 类型 | 必填 | 含义
---|---|---|---
Name | string | 是 | 域名
op | string | 是 | 对响应头的进行操作的类型，可选"set"、“del”，目前不支持"add"
key | string | 是 | 匹配响应头的key，可选值：Content-Type,Cache-Control,Content-Disposition,Content-Language,Expires,Access-Control-Allow-Origin,Access-Control-Allow-Methods,Access-Control-Allow-Headers,Access-Control-Max-Age,Access-Control-Expose-Headers,Access-Control-Allow-Credentials。
value | string | 是 | 响应头的value，在op为"set"时有效
## 返回包
{ }
**错误码**
错误码 | 含义
---|---
404001 | 无此域名
400001 | 未知的域名
400064 | 无权处理该域名
400008 | 无此bucket
400013 | 重复操作
400030 | 正在处理中
400066 | 域名状态为失败
400998 | 域名已下线
400923 | 域名已冻结
400084 | 无效的响应头key
400085 | 无效的响应头操作请求
400086 | 重复的响应头key
500930 | 删除中的域名
500005 | 数据查询内部出错
# 创建新的域名标签
在账户下添加新的域名标签
## 请求包
POST /domain/tag HTTP/1.1
Content-Type: application/json
Authorization: QBox <AccessToken>
{
tag: <Tag>,
tagKey: <TagKey>,
tagValue: <TagValue>,
product: <Product>
}
### 参数解释
参数 | 类型 | 必填 | 含义
---|---|---|---
Tag | string | 否 | 域名标签（废弃）
TagKey | string | 是 | 域名标签Key
TagValue | string | 是 | 域名标签Value
Product | string | 是 | 产品类型: `cdn`(静态加速)/`dcdn`(全站加速)
## 返回包
{}
**错误码**
错误码 | 含义
---|---
400331 | 非法参数
400925 | 账号域名标签数量达到上限
400927 | 域名标签已存在
500004 | 更新数据内部出错
500005 | 数据查询内部出错
## 请求示例
POST /domain/tag HTTP/1.1
Authorization: QBox 0tf5awMVxwf8WrEvrjtbiZrdRZRJU-91JgCqTOC8:6oxDOtOXVEfcR8PPuAscmWjVRS8=
Content-Type: application/json
Host: api.qiniu.com
{
"tagKey": "图片",
"tagValue": "高清",
"product": "cdn"
}
# 设置域名标签
选取账户下定义好的标签，为域名配置标签列表
## 请求包
PUT /domain/<Domain>/tags HTTP/1.1
Content-Type: application/json
Authorization: QBox <AccessToken>
{
kvTagList: <TagList>
}
### 参数解释
参数 | 类型 | 必填 | 含义
---|---|---|---
kvTagList | []Object | 是 | Key-Value格式标签列表
## 返回包
{}
**错误码**
错误码 | 含义
---|---
400331 | 非法参数
404001 | 无此域名
400064 | 无权处理该域名
400926 | 单个域名标签数量达到上限
500004 | 更新数据内部出错
500005 | 数据查询内部出错
## 请求示例
PUT /domain/<Domain>/tags HTTP/1.1
Authorization: QBox 0tf5awMVxwf8WrEvrjtbiZrdRZRJU-91JgCqTOC8:6oxDOtOXVEfcR8PPuAscmWjVRS8=
Content-Type: application/json
Host: api.qiniu.com
{
"kvTagList": [{"key":"图片","value":"高清"}]
}
# 获取所有域名标签
获取账户下定义的域名标签
## 请求包
GET /domain/all/tags?product=<Product>
Content-Type: application/x-www-form-urlencoded
Authorization: QBox <AccessToken>
### 参数解释
参数 | 类型 | 必填 | 含义
---|---|---|---
Product | string | 是 | 产品类型: `cdn`(静态加速)/`dcdn`(全站加速)
## 返回包
{}
**错误码**
错误码 | 含义
---|---
400331 | 非法参数
500005 | 数据查询内部出错
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,241 |
功能相关 | 全站加速 | [全站加速](https://developer.qiniu.com/dcdn) > API 文档 > 功能相关
# 功能相关
最近更新时间: 2024-03-29 16:34:19
# 缓存策略
## 结构
{
cacheControls: [
{
time: <CCTime>,
timeunit: <CCTimeUnit>,
type: <CCType>,
rule: <CCRule>
}
],
ignoreParam: <IgnoreParam>
}
参数 | 类型 | 必填 | 含义
---|---|---|---
CCTime | int | 是 | 缓存时间，注意不论哪种时间单位，总时间都不能超过1年,type为follow，本字段配为 -1
CCTimeUnit | int | 是 | 缓存时间单位：0(秒)/1(分钟)/2(小时)/3(天)/4(周)/5(月)/6(年)，type为follow，本字段配为0
CCType | string | 是 | 缓存类型：`all`(默认全局规则)/`path`(路径匹配)/`suffix`(后缀匹配)/`follow`(遵循源站)
CCRule | string | 是 | 缓存路径规则：以分号;分割的字符串，每个里面类型一致，比如CCType为path的话，这里每个分号分割的都是以`/`开头，suffix的话，以点号`.`开头，如果是`all`类型，或者`follow`，统一只要填一个星号`*`
IgnoreParam | bool | 是 | 是否开启去问号缓存，默认为false
## 注意
* 缓存配置优先级依从配置数组的前后顺序依次从高到低
* `全局配置要放到最后`，不然自定义规则缓存配置优先级最低
* 如果是遵循源站配置`follow`，只能有一条，即全部遵循源站
## 例子
// .abc, .jpg后缀文件缓存1分钟，/def, /auth 目录下文件不缓存，全局缓存一个月
// url参数不缓存
{
cacheControls: [
{
time: 1,
timeunit: 1,
type: "suffix",
rule: ".abc;.jpg"
},
{
time: 0,
timeunit: 0,
type: "path",
rule: "/def;/auth"
},
{
time: 1,
timeunit: 5,
type: "all",
rule: "*"
},
],
ignoreParam: true
}
// 遵循源站
{
cacheControls: [
{
time: 0,
timeunit: 0,
type: "follow",
rule: "*"
}
],
ignoreParam: false
}
# 回源配置
## 结构
{
sourceType: <SourceType>,
sourceHost: <SourceHost>,
sourceIPs: [<SourceIP>, ...],
sourceDomain: <SourceDomain>,
sourceQiniuBucket: <SourceQiniuBucket>,
sourceURLScheme: <SourceURLScheme>,
advancedSources: [
{
addr: <ASAddr>,
weight: <ASWeight>,
backup: <ASBackup>
}
],
testURLPath: <TestURLPath>
}
参数 | 类型 | 必填 | 含义
---|---|---|---
SourceType | string | 是 | 源站类型: `domain`(域名)/`ip`(ip地址)/`advanced`(高级)
SourceHost | string | 否 | 回源Host, 普通域名默认`SourceHost`为域名本身，泛域名默认`SourceHost`为用户请求时的域名
SourceIP | string | 否 | 回源ip, sourceType为ip时sourceIPs`必填`
SourceDomain | string | 否 | 回源域名, sourceType为domain时此字段`必填`
SourceURLScheme | string | 否 | 回源协议, 可选值: `http`/`https`, 回源七牛bucket时本值无效,默认不填是follow请求协议
ASAddr | string | 否 | 高级回源的回源地址, 可以是IP或者域名；如需指定端口，可直接拼接在地址后面(示例: 1.1.1.1:8080), sourceType为advanced时advancedSources字段`必填`
ASWeight | int | 否 | 高级回源的回源addr权重, 0 ~ 100, 按照权重比例回源，sourceType为advanced时advancedSources字段`必填`
ASBackup | bool | 否 | 高级回源的回源addr是否为备源地址，sourceType为advanced时advancedSources字段`必填`
TestURLPath | string | 是 | 用于测试的URL Path, 检测源站是否可访问, 大小建议`小于1KB`，采用静态资源，并请`不要删除`, 后面域名任何配置更改都会测试该资源, 用以保证域名的访问性
## 注意
* 高级回源模式中如配置了主备回源域名时，只有所有的主源都访问不了，才会访问备源
* 高级回源模式中如设置了源站权重，请求概率=权重/权重总和，eg：有两个主线路A和B，A权重1 和 B权重3，那么四次请求，1次是A，3次是B
# referer 防盗链
## 结构
### 请求结构
{
refererType: <RefererType>,
refererValues: [<RefererValue>,...],
nullReferer: <NullReferer>
}
参数 | 类型 | 必填 | 含义
---|---|---|---
RefererType | string | 是 | Referer防盗链类型： `black`/`white`
RefererValue | string | 是 | Referer防盗链黑白名单
NullReferer | bool | 否 | Referer防盗链, 是否支持空referer，不填为false
### 响应结构
{
refererType: <RefererType>,
refererValues: [<RefererValue>, ...],
nullReferer: <NullReferer>
}
参数 | 类型 | 含义
---|---|---
RefererType | string | Referer防盗链类型： `black`/`white`
RefererValue | string | Referer防盗链黑白名单
NullReferer | bool | Referer防盗链, 是否支持空referer
## 注意
* 请求结构和响应结构不同, 请求结构是指`创建域名`和`修改referer防盗链`的请求采用的结构，响应结构是指, 获取`域名信息`和`获取域名列表`中返回结果中采用的结构
# IP黑白名单
## 结构
### 请求结构
{
ipACLType: <IpACLType>,
ipACLValues: [<IpACLValue>,...],
}
参数 | 类型 | 必填 | 含义
---|---|---|---
IpACLType | string | 是 | ip黑白名单控制控制类型, `black`/`white`/`""`；其中空字符串`""`代表关闭本功能，此时请注意`ipACLValues`需要为空
IpACLValue | string | 是 | ip黑白名单，ip格式为：127.0.0.1/24
### 响应结构
{
ipACLType: <IpACLType>,
ipACLValues: [<IpACLValue>, ...]
}
参数 | 类型 | 含义
---|---|---
ipACLType | string | ip黑白名单控制类型, `black`/`white`
IpACLValues | string | ip黑白名单, ip格式为：127.0.0.1/24
## 注意
* 请求结构和响应结构不同, 请求结构是指`创建域名`和`修改ip黑白名单`的请求采用的结构，响应结构是指, 获取`域名信息`和`获取域名列表`中返回结果中采用的结构
# HTTPS
## 结构
{
certId: <CertID>,
forceHttps: <ForceHttps>,
http2Enable: <Http2Enable>
}
参数 | 类型 | 必填 | 含义
---|---|---|---
CertID | string | 是 | 证书ID, 如果`Protocol`是https, 则需要填写该证书id
ForceHttps | bool | 是 | 是否开启强制https访问，即http访问时30x到https
Http2Enable | bool | 是 | http2功能是否启用，false为关闭，true为开启
## 注意
* 证书id `CertID` 是通过上传证书获取的，也可以通过query自己的证书列表拿取证书id
# 证书配置
## 结构
### 请求结构
{
"name": <CertName>,
"common_name":<CommonName>,
"pri": <Pri>,
"ca": <Ca>,
}
参数 | 类型 | 必填 | 含义
---|---|---|---
CertName | string | 是 | 证书名称
CommonName | string | 否 | 相关域名
Pri | string | 是 | 证书私钥
Ca | string | 是 | 证书内容
### 响应结构
{
"id": <CertID>,
"name": <CertName>,
"common_name":<CommonName>,
"pri": <Pri>,
"ca": <Ca>
}
参数 | 类型 | 含义
---|---|---
CertID | string | 证书id
CertName | string | 证书名称
CommonName | string | 相关域名
Pri | string | 证书私钥
Ca | string | 证书内容
## 注意
* 请求结构和响应结构不同, 请求结构是指`上传证书`的请求采用的结构，响应结构是指, `获取证书`和`获取证书列表`中返回结果中采用的结构
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[全站加速](https://developer.qiniu.com/dcdn) > API 文档 > 功能相关
# 功能相关
最近更新时间: 2024-03-29 16:34:19
# 缓存策略
## 结构
{
cacheControls: [
{
time: <CCTime>,
timeunit: <CCTimeUnit>,
type: <CCType>,
rule: <CCRule>
}
],
ignoreParam: <IgnoreParam>
}
参数 | 类型 | 必填 | 含义
---|---|---|---
CCTime | int | 是 | 缓存时间，注意不论哪种时间单位，总时间都不能超过1年,type为follow，本字段配为 -1
CCTimeUnit | int | 是 | 缓存时间单位：0(秒)/1(分钟)/2(小时)/3(天)/4(周)/5(月)/6(年)，type为follow，本字段配为0
CCType | string | 是 | 缓存类型：`all`(默认全局规则)/`path`(路径匹配)/`suffix`(后缀匹配)/`follow`(遵循源站)
CCRule | string | 是 | 缓存路径规则：以分号;分割的字符串，每个里面类型一致，比如CCType为path的话，这里每个分号分割的都是以`/`开头，suffix的话，以点号`.`开头，如果是`all`类型，或者`follow`，统一只要填一个星号`*`
IgnoreParam | bool | 是 | 是否开启去问号缓存，默认为false
## 注意
* 缓存配置优先级依从配置数组的前后顺序依次从高到低
* `全局配置要放到最后`，不然自定义规则缓存配置优先级最低
* 如果是遵循源站配置`follow`，只能有一条，即全部遵循源站
## 例子
// .abc, .jpg后缀文件缓存1分钟，/def, /auth 目录下文件不缓存，全局缓存一个月
// url参数不缓存
{
cacheControls: [
{
time: 1,
timeunit: 1,
type: "suffix",
rule: ".abc;.jpg"
},
{
time: 0,
timeunit: 0,
type: "path",
rule: "/def;/auth"
},
{
time: 1,
timeunit: 5,
type: "all",
rule: "*"
},
],
ignoreParam: true
}
// 遵循源站
{
cacheControls: [
{
time: 0,
timeunit: 0,
type: "follow",
rule: "*"
}
],
ignoreParam: false
}
# 回源配置
## 结构
{
sourceType: <SourceType>,
sourceHost: <SourceHost>,
sourceIPs: [<SourceIP>, ...],
sourceDomain: <SourceDomain>,
sourceQiniuBucket: <SourceQiniuBucket>,
sourceURLScheme: <SourceURLScheme>,
advancedSources: [
{
addr: <ASAddr>,
weight: <ASWeight>,
backup: <ASBackup>
}
],
testURLPath: <TestURLPath>
}
参数 | 类型 | 必填 | 含义
---|---|---|---
SourceType | string | 是 | 源站类型: `domain`(域名)/`ip`(ip地址)/`advanced`(高级)
SourceHost | string | 否 | 回源Host, 普通域名默认`SourceHost`为域名本身，泛域名默认`SourceHost`为用户请求时的域名
SourceIP | string | 否 | 回源ip, sourceType为ip时sourceIPs`必填`
SourceDomain | string | 否 | 回源域名, sourceType为domain时此字段`必填`
SourceURLScheme | string | 否 | 回源协议, 可选值: `http`/`https`, 回源七牛bucket时本值无效,默认不填是follow请求协议
ASAddr | string | 否 | 高级回源的回源地址, 可以是IP或者域名；如需指定端口，可直接拼接在地址后面(示例: 1.1.1.1:8080), sourceType为advanced时advancedSources字段`必填`
ASWeight | int | 否 | 高级回源的回源addr权重, 0 ~ 100, 按照权重比例回源，sourceType为advanced时advancedSources字段`必填`
ASBackup | bool | 否 | 高级回源的回源addr是否为备源地址，sourceType为advanced时advancedSources字段`必填`
TestURLPath | string | 是 | 用于测试的URL Path, 检测源站是否可访问, 大小建议`小于1KB`，采用静态资源，并请`不要删除`, 后面域名任何配置更改都会测试该资源, 用以保证域名的访问性
## 注意
* 高级回源模式中如配置了主备回源域名时，只有所有的主源都访问不了，才会访问备源
* 高级回源模式中如设置了源站权重，请求概率=权重/权重总和，eg：有两个主线路A和B，A权重1 和 B权重3，那么四次请求，1次是A，3次是B
# referer 防盗链
## 结构
### 请求结构
{
refererType: <RefererType>,
refererValues: [<RefererValue>,...],
nullReferer: <NullReferer>
}
参数 | 类型 | 必填 | 含义
---|---|---|---
RefererType | string | 是 | Referer防盗链类型： `black`/`white`
RefererValue | string | 是 | Referer防盗链黑白名单
NullReferer | bool | 否 | Referer防盗链, 是否支持空referer，不填为false
### 响应结构
{
refererType: <RefererType>,
refererValues: [<RefererValue>, ...],
nullReferer: <NullReferer>
}
参数 | 类型 | 含义
---|---|---
RefererType | string | Referer防盗链类型： `black`/`white`
RefererValue | string | Referer防盗链黑白名单
NullReferer | bool | Referer防盗链, 是否支持空referer
## 注意
* 请求结构和响应结构不同, 请求结构是指`创建域名`和`修改referer防盗链`的请求采用的结构，响应结构是指, 获取`域名信息`和`获取域名列表`中返回结果中采用的结构
# IP黑白名单
## 结构
### 请求结构
{
ipACLType: <IpACLType>,
ipACLValues: [<IpACLValue>,...],
}
参数 | 类型 | 必填 | 含义
---|---|---|---
IpACLType | string | 是 | ip黑白名单控制控制类型, `black`/`white`/`""`；其中空字符串`""`代表关闭本功能，此时请注意`ipACLValues`需要为空
IpACLValue | string | 是 | ip黑白名单，ip格式为：127.0.0.1/24
### 响应结构
{
ipACLType: <IpACLType>,
ipACLValues: [<IpACLValue>, ...]
}
参数 | 类型 | 含义
---|---|---
ipACLType | string | ip黑白名单控制类型, `black`/`white`
IpACLValues | string | ip黑白名单, ip格式为：127.0.0.1/24
## 注意
* 请求结构和响应结构不同, 请求结构是指`创建域名`和`修改ip黑白名单`的请求采用的结构，响应结构是指, 获取`域名信息`和`获取域名列表`中返回结果中采用的结构
# HTTPS
## 结构
{
certId: <CertID>,
forceHttps: <ForceHttps>,
http2Enable: <Http2Enable>
}
参数 | 类型 | 必填 | 含义
---|---|---|---
CertID | string | 是 | 证书ID, 如果`Protocol`是https, 则需要填写该证书id
ForceHttps | bool | 是 | 是否开启强制https访问，即http访问时30x到https
Http2Enable | bool | 是 | http2功能是否启用，false为关闭，true为开启
## 注意
* 证书id `CertID` 是通过上传证书获取的，也可以通过query自己的证书列表拿取证书id
# 证书配置
## 结构
### 请求结构
{
"name": <CertName>,
"common_name":<CommonName>,
"pri": <Pri>,
"ca": <Ca>,
}
参数 | 类型 | 必填 | 含义
---|---|---|---
CertName | string | 是 | 证书名称
CommonName | string | 否 | 相关域名
Pri | string | 是 | 证书私钥
Ca | string | 是 | 证书内容
### 响应结构
{
"id": <CertID>,
"name": <CertName>,
"common_name":<CommonName>,
"pri": <Pri>,
"ca": <Ca>
}
参数 | 类型 | 含义
---|---|---
CertID | string | 证书id
CertName | string | 证书名称
CommonName | string | 相关域名
Pri | string | 证书私钥
Ca | string | 证书内容
## 注意
* 请求结构和响应结构不同, 请求结构是指`上传证书`的请求采用的结构，响应结构是指, `获取证书`和`获取证书列表`中返回结果中采用的结构
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,267 |
证书相关 | 全站加速 | [全站加速](https://developer.qiniu.com/dcdn) > API 文档 > 证书相关
# 证书相关
最近更新时间: 2024-07-01 15:33:42
# 上传证书
用户上传证书的接口, 注意我们不会自动补全证书链，需要用户自己补全
## 请求包
POST /sslcert
Content-Type: application/json
Authorization: QBox <AccessToken>
{
"name": <Name>,
"common_name": <CommonName>,
"pri": <Pri>,
"ca": <Ca>
}
### 参数解释
参数 | 类型 | 含义
---|---|---
Name | string | 证书名称
CommonName | string | 通用名称
Pri | string | 证书私钥
Ca | string | 证书内容
## 返回包
{
"certID": <CertID>
}
### 参数解释
参数 | 类型 | 含义
---|---|---
CertID | string | 证书ID
**错误码**
错误码 | 含义
---|---
400500 | 超过用户绑定证书最大额度
404906 | https证书解码失败
400323 | 验证https证书链失败
400322 | https证书有效期太短
400329 | https证书过期
# 删除证书
用户删除证书的接口
## 请求包
DELETE /sslcert/<CertID>
Content-Type: application/json
Authorization: QBox <AccessToken>
### 参数解释
参数 | 类型 | 含义
---|---|---
CertID | string | 证书ID
## 返回包
{}
**错误码**
错误码 | 含义
---|---
400401 | 无此证书
404908 | 无权操作该证书
400611 | 证书已绑定CDN域名
400911 | 证书已绑定存储域名
# 获取证书
用户获取单个证书的接口
## 请求包
GET /sslcert/<CertID>
Content-Type: application/x-www-form-urlencoded
Authorization: QBox <QBoxToken>
### 参数解释
参数 | 类型 | 含义
---|---|---
CertID | string | 证书ID
## 返回包
{
"name": <Name>,
"common_name": <CommonName>,
"dnsnames": <DNSNames>,
"not_before": <NotBefore>,
"not_after": <NotAfter>,
"pri": <Pri>,
"ca": <Ca>,
"create_time": <CreateTime>
}
### 参数解释
参数 | 类型 | 含义
---|---|---
Name | string | 证书名称
CommonName | string | 通用名称
DNSNames | []string | DNS域名
NotBefore | int | 生效时间
NotAfter | int | 过期时间
Pri | string | 证书私钥
Ca | string | 证书内容
CreateTime | int | 创建时间
**错误码**
错误码 | 含义
---|---
400401 | 无此证书
404908 | 无权操作该证书
# 获取证书列表
用户获取证书列表的接口
## 请求包
GET /sslcert?product=<Product>&marker=<Marker>&limit=<Limit>
Content-Type: application/x-www-form-urlencoded
Authorization: QBox <QBoxToken>
### 参数解释
参数 | 类型 | 含义
---|---|---
Product | string | 全站加速证书列表固定传参"dcdn"
Marker | string | 用于标示从哪个位置开始获取证书列表。不填或空表示从头开始
Limit | int | 返回的最大证书个数。默认 100
## 返回包
{
marker: <Marker>,
"certs":[{
"certid": <CertID>,
"name": <Name>,
"common_name": <CommonName>,
"dnsnames": <DNSNames>,
"not_before": <NotBefore>,
"not_after": <NotAfter>,
"create_time": <CreateTime>
}]
}
### 参数解释
参数 | 类型 | 含义
---|---|---
Marker | string | 用于标示下一次从哪个位置开始获取证书列表
CertID | string | 证书ID
Name | string | 证书名称
CommonName | string | 通用名称
DNSNames | []string | DNS域名
NotBefore | int | 生效时间
NotAfter | int | 过期时间
CreateTime | int | 创建时间
**错误码**
错误码 | 含义
---|---
404908 | 无权操作该证书
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[全站加速](https://developer.qiniu.com/dcdn) > API 文档 > 证书相关
# 证书相关
最近更新时间: 2024-07-01 15:33:42
# 上传证书
用户上传证书的接口, 注意我们不会自动补全证书链，需要用户自己补全
## 请求包
POST /sslcert
Content-Type: application/json
Authorization: QBox <AccessToken>
{
"name": <Name>,
"common_name": <CommonName>,
"pri": <Pri>,
"ca": <Ca>
}
### 参数解释
参数 | 类型 | 含义
---|---|---
Name | string | 证书名称
CommonName | string | 通用名称
Pri | string | 证书私钥
Ca | string | 证书内容
## 返回包
{
"certID": <CertID>
}
### 参数解释
参数 | 类型 | 含义
---|---|---
CertID | string | 证书ID
**错误码**
错误码 | 含义
---|---
400500 | 超过用户绑定证书最大额度
404906 | https证书解码失败
400323 | 验证https证书链失败
400322 | https证书有效期太短
400329 | https证书过期
# 删除证书
用户删除证书的接口
## 请求包
DELETE /sslcert/<CertID>
Content-Type: application/json
Authorization: QBox <AccessToken>
### 参数解释
参数 | 类型 | 含义
---|---|---
CertID | string | 证书ID
## 返回包
{}
**错误码**
错误码 | 含义
---|---
400401 | 无此证书
404908 | 无权操作该证书
400611 | 证书已绑定CDN域名
400911 | 证书已绑定存储域名
# 获取证书
用户获取单个证书的接口
## 请求包
GET /sslcert/<CertID>
Content-Type: application/x-www-form-urlencoded
Authorization: QBox <QBoxToken>
### 参数解释
参数 | 类型 | 含义
---|---|---
CertID | string | 证书ID
## 返回包
{
"name": <Name>,
"common_name": <CommonName>,
"dnsnames": <DNSNames>,
"not_before": <NotBefore>,
"not_after": <NotAfter>,
"pri": <Pri>,
"ca": <Ca>,
"create_time": <CreateTime>
}
### 参数解释
参数 | 类型 | 含义
---|---|---
Name | string | 证书名称
CommonName | string | 通用名称
DNSNames | []string | DNS域名
NotBefore | int | 生效时间
NotAfter | int | 过期时间
Pri | string | 证书私钥
Ca | string | 证书内容
CreateTime | int | 创建时间
**错误码**
错误码 | 含义
---|---
400401 | 无此证书
404908 | 无权操作该证书
# 获取证书列表
用户获取证书列表的接口
## 请求包
GET /sslcert?product=<Product>&marker=<Marker>&limit=<Limit>
Content-Type: application/x-www-form-urlencoded
Authorization: QBox <QBoxToken>
### 参数解释
参数 | 类型 | 含义
---|---|---
Product | string | 全站加速证书列表固定传参"dcdn"
Marker | string | 用于标示从哪个位置开始获取证书列表。不填或空表示从头开始
Limit | int | 返回的最大证书个数。默认 100
## 返回包
{
marker: <Marker>,
"certs":[{
"certid": <CertID>,
"name": <Name>,
"common_name": <CommonName>,
"dnsnames": <DNSNames>,
"not_before": <NotBefore>,
"not_after": <NotAfter>,
"create_time": <CreateTime>
}]
}
### 参数解释
参数 | 类型 | 含义
---|---|---
Marker | string | 用于标示下一次从哪个位置开始获取证书列表
CertID | string | 证书ID
Name | string | 证书名称
CommonName | string | 通用名称
DNSNames | []string | DNS域名
NotBefore | int | 生效时间
NotAfter | int | 过期时间
CreateTime | int | 创建时间
**错误码**
错误码 | 含义
---|---
404908 | 无权操作该证书
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,275 |
流量带宽 | 全站加速 | [全站加速](https://developer.qiniu.com/dcdn) > API 文档 > 流量带宽
# 流量带宽
最近更新时间: 2022-05-06 11:30:35
# 访问域名
Host: fusion.qiniuapi.com
# 认证授权
Authorization: QBox <access_token>
access_token 详细描述请查阅[这里](https://developer.qiniu.com/kodo/manual/access-
token)。
# 批量查询 全站加速 计费带宽
## 接口地址
/v2/dcdn/bandwidth
### 说明
* 返回的数据包含开始日期和结束日期
* 带宽的单位为 bps
* data 只包含有流量的域名
## 请求语法
POST /v2/dcdn/bandwidth
Content-Type: application/json
{
"startDate": <StartDate>,
"endDate": <EndDate>,
"granularity": <Granularity>,
"domains": <Domains>
}
## 请求内容
参数 | 类型 | 必要性 | 说明
---|---|---|---
StartDate | string | 必须 | 开始日期，例如：2016-07-01
EndDate | string | 必须 | 结束日期，例如：2016-07-03
Granularity | string | 必须 | 粒度，取值：5min ／ hour ／day
Domains | string | 必须 | 域名列表，以 ；分割
Type | string | 非必须 | 指定带宽数据类型, `""`或`"bandwidth"`查询全站加速带宽数据，`"dynbandwidth"`查询因动态加速产生的带宽数据, 未启用动态加速功能可忽略该参数
## 响应状态码
HTTP状态码 | 含义 | 说明
---|---|---
200 | success | 成功
400031 | invalid params | 请求参数非法。 e.g. `"Type"`参数指定了除`""`(空)/`"bandwidth"`/`"dynbandwidth"`以外的值
400032 | invalid host | 请求中存在无效的域名，请确保域名格式正确
400080 | invalid start time | 开始时间格式错误
400081 | invalid end time | 截止时间格式错误
400082 | invalid time range | 时间范围错误，请确保开始时间早于结束时间，且时间范围不超过 31 天
500000 | internal error | 服务端内部错误，请联系技术支持
## 响应内容
200 OK HTTP/1.1
{
"code": <Code>,
"error": <Error>,
"time": <Time>,
"data": {
...
<Domain_i>: {
"china": <Domain_i_China>,
"oversea": <Domain_i_Oversea>,
},
...
}
}
参数 | 类型 | 说明
---|---|---
Code | int | HTTP 状态码，整型，见响应状态码
Error | string | 自定义错误码描述，字符串
Time | []string | 时间点数组
data | map | 带宽数据
Domain_i | string | 域名
Domain_i_China | []int | Domain_i 国内带宽数据，与 Time 一一对应
Domain_i_Oversea | []int | Domain_i 海外带宽数据，与 Time 一一对应
## 示例
200 OK HTTP/1.1
{
"code": 200,
"error": "",
"time": ["2016-07-01 00:00:00","2016-07-01 00:05:00", ...],
"data": {
"a.com": {
"china": [8888, 9999, 10000, ...],
"oversea": [3333, 4444, 5000, ...],
},
"b.com": {
"china": [8888, 9999, 10000, ...],
"oversea": [3333, 4444, 5000, ...],
}
}
}
# 批量查询 全站加速 计费流量
## 接口地址
/v2/dcdn/flux
### 说明
* 返回的数据包含开始日期和结束日期
* 流量的单位为 byte
* data 只包含有流量的域名
## 请求语法
POST /v2/dcdn/flux
Content-Type: application/json
{
"startDate": <StartDate>,
"endDate": <EndDate>,
"granularity": <Granularity>,
"domains": <Domains>
}
## 请求内容
参数 | 类型 | 必要性 | 说明
---|---|---|---
StartDate | string | 必须 | 开始日期，例如：2016-07-01
EndDate | string | 必须 | 结束日期，例如：2016-07-03
Granularity | string | 必须 | 粒度，取值：5min ／ hour ／day
Domains | string | 必须 | 域名列表，以 ；分割
Type | string | 非必须 | `""`或`"flux"`查询全站加速流量数据，`"dynflux"`查询因动态加速产生的流量数据, 未启用动态加速功能可忽略该参数
## 响应状态码
HTTP状态码 | 含义 | 说明
---|---|---
200 | success | 成功
400031 | invalid params | 请求参数非法。 e.g. `"Type"`参数指定了除`""`(空)/`"bandwidth"`/`"dynbandwidth"`以外的值
400032 | invalid host | 请求中存在无效的域名，请确保域名格式正确
400080 | invalid start time | 开始时间格式错误
400081 | invalid end time | 截止时间格式错误
400082 | invalid time range | 时间范围错误，请确保开始时间早于结束时间，且时间范围不超过 30 天
500000 | internal error | 服务端内部错误，请联系技术支持
## 响应内容
200 OK HTTP/1.1
{
"code": <Code>,
"error": <Error>,
"time": <Time>,
"data": {
...
<Domain_i>: {
"china": <Domain_i_China>,
"oversea": <Domain_i_Oversea>,
},
...
}
}
参数 | 类型 | 说明
---|---|---
Code | int | HTTP 状态码，整型，见响应状态码
Error | string | 自定义错误码描述，字符串
Time | []string | 时间点数组
data | map | 流量数据
Domain_i | string | 域名
Domain_i_China | []int | Domain_i 国内流量数据，与 Time 一一对应
Domain_i_Oversea | []int | Domain_i 海外流量数据，与 Time 一一对应
## 示例
200 OK HTTP/1.1
{
"code": 200,
"error": "",
"time": ["2016-07-01 00:00:00","2016-07-01 00:05:00", ...],
"data": {
"a.com": {
"china": [8888, 9999, 10000, ...],
"oversea": [3333, 4444, 5000, ...],
},
"b.com": {
"china": [8888, 9999, 10000, ...],
"oversea": [3333, 4444, 5000, ...],
}
}
}
# 批量查询动态加速之动态请求数
## 接口地址
/v2/dcdn/dynreqcount
### 说明
* 返回的数据包含开始日期和结束日期
* 动态请求数单位为 次
* data 只包含有流量的域名(依据动态加速请求日志)
## 请求语法
POST /v2/dcdn/dynreqcount
Content-Type: application/json
{
"startDate": <StartDate>,
"endDate": <EndDate>,
"granularity": <Granularity>,
"domains": <Domains>
}
## 请求内容
参数 | 类型 | 必要性 | 说明
---|---|---|---
StartDate | string | 必须 | 开始日期，例如：2016-07-01
EndDate | string | 必须 | 结束日期，例如：2016-07-03
Granularity | string | 必须 | 粒度，取值：5min ／ hour ／day
Domains | string | 必须 | 域名列表，以 ；分割
Type | string | 非必须 | 数据类型, `""`或`"dynreqcount"`查询因动态加速产生的动态请求数, 其他值视为非法参数
## 响应状态码
HTTP状态码 | 含义 | 说明
---|---|---
200 | success | 成功
400031 | invalid params | 请求内容参数`"Type"`非法. e.g `"Type"`参数指定了除`""`(空)/`"dynreqcount"`之外的值
400032 | invalid host | 请求中存在无效的域名，请确保域名格式正确
400080 | invalid start time | 开始时间格式错误
400081 | invalid end time | 截止时间格式错误
400082 | invalid time range | 时间范围错误，请确保开始时间早于结束时间，且时间范围不超过 30 天
500000 | internal error | 服务端内部错误，请联系技术支持
## 响应内容
200 OK HTTP/1.1
{
"code": <Code>,
"error": <Error>,
"time": <Time>,
"data": {
...
<Domain_i>: {
"china": <Domain_i_China>,
"oversea": <Domain_i_Oversea>,
},
...
}
}
参数 | 类型 | 说明
---|---|---
Code | int | HTTP 状态码，整型，见响应状态码
Error | string | 自定义错误码描述，字符串
Time | []string | 时间点数组
data | map | 流量数据
Domain_i | string | 域名
Domain_i_China | []int | Domain_i 国内流量数据，与 Time 一一对应
Domain_i_Oversea | []int | Domain_i 海外流量数据，与 Time 一一对应
## 示例
200 OK HTTP/1.1
{
"code": 200,
"error": "",
"time": ["2019-01-01 00:00:00","2019-01-01 00:05:00", ...],
"data": {
"a.com": {
"china": [8888, 9999, 10000, ...],
"oversea": [3333, 4444, 5000, ...],
},
"b.com": {
"china": [8888, 9999, 10000, ...],
"oversea": [3333, 4444, 5000, ...],
}
}
}
# 批量查询 全站加速 监控带宽
## 接口地址
/v2/tune/monitoring/bandwidth
### 说明
* 返回的数据包含开始日期和结束日期
* 带宽的单位为 bps
* data 只包含有流量的域名
* 监控接口侧重于全站加速服务实时统计带宽数据的实效性，不保证数据与账单完全一致
* 支持查询3个月之内的带宽数据，/v2/dcdn/bandwidth接口无此限制
## 请求语法
POST /v2/tune/monitoring/bandwidth
Content-Type: application/json
{
"startDate": <StartDate>,
"endDate": <EndDate>,
"granularity": <Granularity>,
"domains": <Domains>
}
## 请求内容
参数 | 类型 | 必要性 | 说明
---|---|---|---
StartDate | string | 必须 | 开始日期，例如：2016-07-01
EndDate | string | 必须 | 结束日期，例如：2016-07-03
Granularity | string | 必须 | 粒度，取值：5min ／ hour ／day
Domains | string | 必须 | 域名列表，以 ；分割
Type | string | 非必须 | 指定带宽数据类型, `""`或`"bandwidth"`查询全站加速带宽数据，`"dynbandwidth"`查询因动态加速产生的带宽数据, 未启用动态加速功能可忽略该参数
## 响应状态码
HTTP状态码 | 含义 | 说明
---|---|---
200 | success | 成功
400031 | invalid params | 请求参数非法。 e.g. `"Type"`参数指定了除`""`(空)/`"bandwidth"`/`"dynbandwidth"`以外的值
400032 | invalid host | 请求中存在无效的域名，请确保域名格式正确
400080 | invalid start time | 开始时间格式错误
400081 | invalid end time | 截止时间格式错误
400082 | invalid time range | 时间范围错误，请确保开始时间早于结束时间，且时间范围不超过 31 天
500000 | internal error | 服务端内部错误，请联系技术支持
## 响应内容
200 OK HTTP/1.1
{
"code": <Code>,
"error": <Error>,
"time": <Time>,
"data": {
...
<Domain_i>: {
"china": <Domain_i_China>,
"oversea": <Domain_i_Oversea>,
},
...
}
}
参数 | 类型 | 说明
---|---|---
Code | int | HTTP 状态码，整型，见响应状态码
Error | string | 自定义错误码描述，字符串
Time | []string | 时间点数组
data | map | 带宽数据
Domain_i | string | 域名
Domain_i_China | []int | Domain_i 国内带宽数据，与 Time 一一对应
Domain_i_Oversea | []int | Domain_i 海外带宽数据，与 Time 一一对应
## 示例
200 OK HTTP/1.1
{
"code": 200,
"error": "",
"time": ["2016-07-01 00:00:00","2016-07-01 00:05:00", ...],
"data": {
"a.com": {
"china": [8888, 9999, 10000, ...],
"oversea": [3333, 4444, 5000, ...],
},
"b.com": {
"china": [8888, 9999, 10000, ...],
"oversea": [3333, 4444, 5000, ...],
}
}
}
# 批量查询 全站加速 监控流量
## 接口地址
/v2/tune/monitoring/flow
### 说明
* 返回的数据包含开始日期和结束日期
* 流量的单位为 byte
* data 只包含有流量的域名
* 监控接口侧重于全站加速服务实时统计流量数据的实效性，不保证数据与账单完全一致
* 支持查询3个月之内的流量数据，/v2/dcdn/flux接口无此限制
## 请求语法
POST /v2/tune/monitoring/flow
Content-Type: application/json
{
"startDate": <StartDate>,
"endDate": <EndDate>,
"granularity": <Granularity>,
"domains": <Domains>
}
## 请求内容
参数 | 类型 | 必要性 | 说明
---|---|---|---
StartDate | string | 必须 | 开始日期，例如：2016-07-01
EndDate | string | 必须 | 结束日期，例如：2016-07-03
Granularity | string | 必须 | 粒度，取值：5min ／ hour ／day
Domains | string | 必须 | 域名列表，以 ；分割
Type | string | 非必须 | `""`或`"flux"`查询全站加速流量数据，`"dynflux"`查询因动态加速产生的流量数据, 未启用动态加速功能可忽略该参数
## 响应状态码
HTTP状态码 | 含义 | 说明
---|---|---
200 | success | 成功
400031 | invalid params | 请求参数非法。 e.g. `"Type"`参数指定了除`""`(空)/`"bandwidth"`/`"dynbandwidth"`以外的值
400032 | invalid host | 请求中存在无效的域名，请确保域名格式正确
400080 | invalid start time | 开始时间格式错误
400081 | invalid end time | 截止时间格式错误
400082 | invalid time range | 时间范围错误，请确保开始时间早于结束时间，且时间范围不超过 30 天
500000 | internal error | 服务端内部错误，请联系技术支持
## 响应内容
200 OK HTTP/1.1
{
"code": <Code>,
"error": <Error>,
"time": <Time>,
"data": {
...
<Domain_i>: {
"china": <Domain_i_China>,
"oversea": <Domain_i_Oversea>,
},
...
}
}
参数 | 类型 | 说明
---|---|---
Code | int | HTTP 状态码，整型，见响应状态码
Error | string | 自定义错误码描述，字符串
Time | []string | 时间点数组
data | map | 流量数据
Domain_i | string | 域名
Domain_i_China | []int | Domain_i 国内流量数据，与 Time 一一对应
Domain_i_Oversea | []int | Domain_i 海外流量数据，与 Time 一一对应
## 示例
200 OK HTTP/1.1
{
"code": 200,
"error": "",
"time": ["2016-07-01 00:00:00","2016-07-01 00:05:00", ...],
"data": {
"a.com": {
"china": [8888, 9999, 10000, ...],
"oversea": [3333, 4444, 5000, ...],
},
"b.com": {
"china": [8888, 9999, 10000, ...],
"oversea": [3333, 4444, 5000, ...],
}
}
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[全站加速](https://developer.qiniu.com/dcdn) > API 文档 > 流量带宽
# 流量带宽
最近更新时间: 2022-05-06 11:30:35
# 访问域名
Host: fusion.qiniuapi.com
# 认证授权
Authorization: QBox <access_token>
access_token 详细描述请查阅[这里](https://developer.qiniu.com/kodo/manual/access-
token)。
# 批量查询 全站加速 计费带宽
## 接口地址
/v2/dcdn/bandwidth
### 说明
* 返回的数据包含开始日期和结束日期
* 带宽的单位为 bps
* data 只包含有流量的域名
## 请求语法
POST /v2/dcdn/bandwidth
Content-Type: application/json
{
"startDate": <StartDate>,
"endDate": <EndDate>,
"granularity": <Granularity>,
"domains": <Domains>
}
## 请求内容
参数 | 类型 | 必要性 | 说明
---|---|---|---
StartDate | string | 必须 | 开始日期，例如：2016-07-01
EndDate | string | 必须 | 结束日期，例如：2016-07-03
Granularity | string | 必须 | 粒度，取值：5min ／ hour ／day
Domains | string | 必须 | 域名列表，以 ；分割
Type | string | 非必须 | 指定带宽数据类型, `""`或`"bandwidth"`查询全站加速带宽数据，`"dynbandwidth"`查询因动态加速产生的带宽数据, 未启用动态加速功能可忽略该参数
## 响应状态码
HTTP状态码 | 含义 | 说明
---|---|---
200 | success | 成功
400031 | invalid params | 请求参数非法。 e.g. `"Type"`参数指定了除`""`(空)/`"bandwidth"`/`"dynbandwidth"`以外的值
400032 | invalid host | 请求中存在无效的域名，请确保域名格式正确
400080 | invalid start time | 开始时间格式错误
400081 | invalid end time | 截止时间格式错误
400082 | invalid time range | 时间范围错误，请确保开始时间早于结束时间，且时间范围不超过 31 天
500000 | internal error | 服务端内部错误，请联系技术支持
## 响应内容
200 OK HTTP/1.1
{
"code": <Code>,
"error": <Error>,
"time": <Time>,
"data": {
...
<Domain_i>: {
"china": <Domain_i_China>,
"oversea": <Domain_i_Oversea>,
},
...
}
}
参数 | 类型 | 说明
---|---|---
Code | int | HTTP 状态码，整型，见响应状态码
Error | string | 自定义错误码描述，字符串
Time | []string | 时间点数组
data | map | 带宽数据
Domain_i | string | 域名
Domain_i_China | []int | Domain_i 国内带宽数据，与 Time 一一对应
Domain_i_Oversea | []int | Domain_i 海外带宽数据，与 Time 一一对应
## 示例
200 OK HTTP/1.1
{
"code": 200,
"error": "",
"time": ["2016-07-01 00:00:00","2016-07-01 00:05:00", ...],
"data": {
"a.com": {
"china": [8888, 9999, 10000, ...],
"oversea": [3333, 4444, 5000, ...],
},
"b.com": {
"china": [8888, 9999, 10000, ...],
"oversea": [3333, 4444, 5000, ...],
}
}
}
# 批量查询 全站加速 计费流量
## 接口地址
/v2/dcdn/flux
### 说明
* 返回的数据包含开始日期和结束日期
* 流量的单位为 byte
* data 只包含有流量的域名
## 请求语法
POST /v2/dcdn/flux
Content-Type: application/json
{
"startDate": <StartDate>,
"endDate": <EndDate>,
"granularity": <Granularity>,
"domains": <Domains>
}
## 请求内容
参数 | 类型 | 必要性 | 说明
---|---|---|---
StartDate | string | 必须 | 开始日期，例如：2016-07-01
EndDate | string | 必须 | 结束日期，例如：2016-07-03
Granularity | string | 必须 | 粒度，取值：5min ／ hour ／day
Domains | string | 必须 | 域名列表，以 ；分割
Type | string | 非必须 | `""`或`"flux"`查询全站加速流量数据，`"dynflux"`查询因动态加速产生的流量数据, 未启用动态加速功能可忽略该参数
## 响应状态码
HTTP状态码 | 含义 | 说明
---|---|---
200 | success | 成功
400031 | invalid params | 请求参数非法。 e.g. `"Type"`参数指定了除`""`(空)/`"bandwidth"`/`"dynbandwidth"`以外的值
400032 | invalid host | 请求中存在无效的域名，请确保域名格式正确
400080 | invalid start time | 开始时间格式错误
400081 | invalid end time | 截止时间格式错误
400082 | invalid time range | 时间范围错误，请确保开始时间早于结束时间，且时间范围不超过 30 天
500000 | internal error | 服务端内部错误，请联系技术支持
## 响应内容
200 OK HTTP/1.1
{
"code": <Code>,
"error": <Error>,
"time": <Time>,
"data": {
...
<Domain_i>: {
"china": <Domain_i_China>,
"oversea": <Domain_i_Oversea>,
},
...
}
}
参数 | 类型 | 说明
---|---|---
Code | int | HTTP 状态码，整型，见响应状态码
Error | string | 自定义错误码描述，字符串
Time | []string | 时间点数组
data | map | 流量数据
Domain_i | string | 域名
Domain_i_China | []int | Domain_i 国内流量数据，与 Time 一一对应
Domain_i_Oversea | []int | Domain_i 海外流量数据，与 Time 一一对应
## 示例
200 OK HTTP/1.1
{
"code": 200,
"error": "",
"time": ["2016-07-01 00:00:00","2016-07-01 00:05:00", ...],
"data": {
"a.com": {
"china": [8888, 9999, 10000, ...],
"oversea": [3333, 4444, 5000, ...],
},
"b.com": {
"china": [8888, 9999, 10000, ...],
"oversea": [3333, 4444, 5000, ...],
}
}
}
# 批量查询动态加速之动态请求数
## 接口地址
/v2/dcdn/dynreqcount
### 说明
* 返回的数据包含开始日期和结束日期
* 动态请求数单位为 次
* data 只包含有流量的域名(依据动态加速请求日志)
## 请求语法
POST /v2/dcdn/dynreqcount
Content-Type: application/json
{
"startDate": <StartDate>,
"endDate": <EndDate>,
"granularity": <Granularity>,
"domains": <Domains>
}
## 请求内容
参数 | 类型 | 必要性 | 说明
---|---|---|---
StartDate | string | 必须 | 开始日期，例如：2016-07-01
EndDate | string | 必须 | 结束日期，例如：2016-07-03
Granularity | string | 必须 | 粒度，取值：5min ／ hour ／day
Domains | string | 必须 | 域名列表，以 ；分割
Type | string | 非必须 | 数据类型, `""`或`"dynreqcount"`查询因动态加速产生的动态请求数, 其他值视为非法参数
## 响应状态码
HTTP状态码 | 含义 | 说明
---|---|---
200 | success | 成功
400031 | invalid params | 请求内容参数`"Type"`非法. e.g `"Type"`参数指定了除`""`(空)/`"dynreqcount"`之外的值
400032 | invalid host | 请求中存在无效的域名，请确保域名格式正确
400080 | invalid start time | 开始时间格式错误
400081 | invalid end time | 截止时间格式错误
400082 | invalid time range | 时间范围错误，请确保开始时间早于结束时间，且时间范围不超过 30 天
500000 | internal error | 服务端内部错误，请联系技术支持
## 响应内容
200 OK HTTP/1.1
{
"code": <Code>,
"error": <Error>,
"time": <Time>,
"data": {
...
<Domain_i>: {
"china": <Domain_i_China>,
"oversea": <Domain_i_Oversea>,
},
...
}
}
参数 | 类型 | 说明
---|---|---
Code | int | HTTP 状态码，整型，见响应状态码
Error | string | 自定义错误码描述，字符串
Time | []string | 时间点数组
data | map | 流量数据
Domain_i | string | 域名
Domain_i_China | []int | Domain_i 国内流量数据，与 Time 一一对应
Domain_i_Oversea | []int | Domain_i 海外流量数据，与 Time 一一对应
## 示例
200 OK HTTP/1.1
{
"code": 200,
"error": "",
"time": ["2019-01-01 00:00:00","2019-01-01 00:05:00", ...],
"data": {
"a.com": {
"china": [8888, 9999, 10000, ...],
"oversea": [3333, 4444, 5000, ...],
},
"b.com": {
"china": [8888, 9999, 10000, ...],
"oversea": [3333, 4444, 5000, ...],
}
}
}
# 批量查询 全站加速 监控带宽
## 接口地址
/v2/tune/monitoring/bandwidth
### 说明
* 返回的数据包含开始日期和结束日期
* 带宽的单位为 bps
* data 只包含有流量的域名
* 监控接口侧重于全站加速服务实时统计带宽数据的实效性，不保证数据与账单完全一致
* 支持查询3个月之内的带宽数据，/v2/dcdn/bandwidth接口无此限制
## 请求语法
POST /v2/tune/monitoring/bandwidth
Content-Type: application/json
{
"startDate": <StartDate>,
"endDate": <EndDate>,
"granularity": <Granularity>,
"domains": <Domains>
}
## 请求内容
参数 | 类型 | 必要性 | 说明
---|---|---|---
StartDate | string | 必须 | 开始日期，例如：2016-07-01
EndDate | string | 必须 | 结束日期，例如：2016-07-03
Granularity | string | 必须 | 粒度，取值：5min ／ hour ／day
Domains | string | 必须 | 域名列表，以 ；分割
Type | string | 非必须 | 指定带宽数据类型, `""`或`"bandwidth"`查询全站加速带宽数据，`"dynbandwidth"`查询因动态加速产生的带宽数据, 未启用动态加速功能可忽略该参数
## 响应状态码
HTTP状态码 | 含义 | 说明
---|---|---
200 | success | 成功
400031 | invalid params | 请求参数非法。 e.g. `"Type"`参数指定了除`""`(空)/`"bandwidth"`/`"dynbandwidth"`以外的值
400032 | invalid host | 请求中存在无效的域名，请确保域名格式正确
400080 | invalid start time | 开始时间格式错误
400081 | invalid end time | 截止时间格式错误
400082 | invalid time range | 时间范围错误，请确保开始时间早于结束时间，且时间范围不超过 31 天
500000 | internal error | 服务端内部错误，请联系技术支持
## 响应内容
200 OK HTTP/1.1
{
"code": <Code>,
"error": <Error>,
"time": <Time>,
"data": {
...
<Domain_i>: {
"china": <Domain_i_China>,
"oversea": <Domain_i_Oversea>,
},
...
}
}
参数 | 类型 | 说明
---|---|---
Code | int | HTTP 状态码，整型，见响应状态码
Error | string | 自定义错误码描述，字符串
Time | []string | 时间点数组
data | map | 带宽数据
Domain_i | string | 域名
Domain_i_China | []int | Domain_i 国内带宽数据，与 Time 一一对应
Domain_i_Oversea | []int | Domain_i 海外带宽数据，与 Time 一一对应
## 示例
200 OK HTTP/1.1
{
"code": 200,
"error": "",
"time": ["2016-07-01 00:00:00","2016-07-01 00:05:00", ...],
"data": {
"a.com": {
"china": [8888, 9999, 10000, ...],
"oversea": [3333, 4444, 5000, ...],
},
"b.com": {
"china": [8888, 9999, 10000, ...],
"oversea": [3333, 4444, 5000, ...],
}
}
}
# 批量查询 全站加速 监控流量
## 接口地址
/v2/tune/monitoring/flow
### 说明
* 返回的数据包含开始日期和结束日期
* 流量的单位为 byte
* data 只包含有流量的域名
* 监控接口侧重于全站加速服务实时统计流量数据的实效性，不保证数据与账单完全一致
* 支持查询3个月之内的流量数据，/v2/dcdn/flux接口无此限制
## 请求语法
POST /v2/tune/monitoring/flow
Content-Type: application/json
{
"startDate": <StartDate>,
"endDate": <EndDate>,
"granularity": <Granularity>,
"domains": <Domains>
}
## 请求内容
参数 | 类型 | 必要性 | 说明
---|---|---|---
StartDate | string | 必须 | 开始日期，例如：2016-07-01
EndDate | string | 必须 | 结束日期，例如：2016-07-03
Granularity | string | 必须 | 粒度，取值：5min ／ hour ／day
Domains | string | 必须 | 域名列表，以 ；分割
Type | string | 非必须 | `""`或`"flux"`查询全站加速流量数据，`"dynflux"`查询因动态加速产生的流量数据, 未启用动态加速功能可忽略该参数
## 响应状态码
HTTP状态码 | 含义 | 说明
---|---|---
200 | success | 成功
400031 | invalid params | 请求参数非法。 e.g. `"Type"`参数指定了除`""`(空)/`"bandwidth"`/`"dynbandwidth"`以外的值
400032 | invalid host | 请求中存在无效的域名，请确保域名格式正确
400080 | invalid start time | 开始时间格式错误
400081 | invalid end time | 截止时间格式错误
400082 | invalid time range | 时间范围错误，请确保开始时间早于结束时间，且时间范围不超过 30 天
500000 | internal error | 服务端内部错误，请联系技术支持
## 响应内容
200 OK HTTP/1.1
{
"code": <Code>,
"error": <Error>,
"time": <Time>,
"data": {
...
<Domain_i>: {
"china": <Domain_i_China>,
"oversea": <Domain_i_Oversea>,
},
...
}
}
参数 | 类型 | 说明
---|---|---
Code | int | HTTP 状态码，整型，见响应状态码
Error | string | 自定义错误码描述，字符串
Time | []string | 时间点数组
data | map | 流量数据
Domain_i | string | 域名
Domain_i_China | []int | Domain_i 国内流量数据，与 Time 一一对应
Domain_i_Oversea | []int | Domain_i 海外流量数据，与 Time 一一对应
## 示例
200 OK HTTP/1.1
{
"code": 200,
"error": "",
"time": ["2016-07-01 00:00:00","2016-07-01 00:05:00", ...],
"data": {
"a.com": {
"china": [8888, 9999, 10000, ...],
"oversea": [3333, 4444, 5000, ...],
},
"b.com": {
"china": [8888, 9999, 10000, ...],
"oversea": [3333, 4444, 5000, ...],
}
}
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,281 |
日志分析 | 全站加速 | [全站加速](https://developer.qiniu.com/dcdn) > API 文档 > 日志分析
# 日志分析
最近更新时间: 2023-06-13 17:42:51
# 访问域名
Host: fusion.qiniuapi.com
# 认证授权
Authorization: QBox <access_token>
access_token 详细描述请查阅[这里
__](https://developer.qiniu.com/kodo/manual/6671/historical-document-
management-certificate)。
# 自定义状态码
HTTP 状态码 | 含义 | 说明
---|---|---
200 | success | 成功
400054 | invalid domain | 域名不合法
400331 | invalid params | 请求参数错误
500000 | internal error | 服务端内部错误
# 区域运营商流量查询
接口地址
/v1/dcdn/loganalyze/traffic
请求语法
POST /v1/dcdn/loganalyze/traffic HTTP/1.1
Authorization:<access_token>
Content-Type: application/json
{
"domains": [<domain1>, <domain2>, <domain3>, ......],
"freq": <freq>,
"regions": [<region1>, <region2>, <region3>, ......],
"isp": <isp>,
"startDate": <startDate>,
"endDate": <endDate>
}
参数 | 类型 | 说明
---|---|---
domainN | string | 域名列表，总数不超过100条
freq | string | 粒度，可选项为 5min、1hour、1day
regionN | string | 区域，选项见 Region 参数列表
isp | string | ISP运营商，比如all(所有 ISP)，telecom(电信)，unicom(联通)，mobile(中国移动)，drpeng(鹏博士)，tietong(铁通)，cernet(教育网)
startDate | string | 开始时间，格式为：2006-01-02。起止最大间隔为31天
endDate | string | 结束时间，格式为：2006-01-02。起止最大间隔为31天
返回包
200 OK
{
"code": <code>,
"error": <error>,
"data": {
"points": [<point1>, <point2>, <point3>, ......],
"value": [<value1>, <value2>, <value3>, ......]
}
}
参数 | 类型 | 说明
---|---|---
code | int | 自定义状态码
error | string | 自定义错误描述
pointN | string | 时间点，形如 2006-01-02-15-04
valueN | long | 在 pointN 时间点的流量
注：如果同时查询中国和上海的数据，结果是两者的累加。
# 区域运营商带宽查询
接口地址
/v1/dcdn/loganalyze/bandwidth
请求语法
POST /v1/dcdn/loganalyze/bandwidth HTTP/1.1
Authorization:<access_token>
Content-Type: application/json
{
"domains": [<domain1>, <domain2>, <domain3>, ......],
"freq": <freq>,
"regions": [<region1>, <region2>, <region3>, ......],
"isp": <isp>,
"startDate": <startDate>,
"endDate": <endDate>
}
参数 | 类型 | 说明
---|---|---
domainN | string | 域名列表，总数不超过100条
freq | string | 粒度，可选项为 5min、1hour、1day
regionN | string | 区域，选项见 Region 参数列表
isp | string | ISP运营商，比如all(所有 ISP)，telecom(电信)，unicom(联通)，mobile(中国移动)，drpeng(鹏博士)，tietong(铁通)，cernet(教育网)
startDate | string | 开始时间，格式为：2006-01-02。起止最大间隔为31天
endDate | string | 结束时间，格式为：2006-01-02。起止最大间隔为31天
返回包
200 OK
{
"code": <code>,
"error": <error>,
"data": {
"points": [<point1>, <point2>, <point3>, ......],
"value": [<value1>, <value2>, <value3>, ......]
},
"stats": {
"peak": {
"time": <peakTime>,
"value": <peakValue>
},
"peak95": {
"time": <peak95Time>,
"value": <peak95Value>
},
"peak95Average": <peak95Average>,
"peakAverage": <peakAverage>
}
}
参数 | 类型 | 说明
---|---|---
code | int | 自定义状态码
error | string | 自定义错误描述
pointN | string | 时间点，形如 2006-01-02-15-04
valueN | long | 在 pointN 时间点的带宽
peakTime | string | 峰值的时间点，形如 2006-01-02-15-04
peakValue | long | 峰值带宽
peak95Time | string | 95峰的时间点，形如 2006-01-02-15-04
peak95Value | long | 95峰带宽
peakAverage | long | 各天峰值的平均值
peak95Average | long | 各天95峰的平均值
注：如果同时查询中国和上海的数据，结果是两者的累加。
# 批量查询状态码
接口地址
/v1/dcdn/loganalyze/statuscode
请求语法
POST /v1/dcdn/loganalyze/statuscode HTTP/1.1
Authorization:<access_token>
Content-Type: application/json
{
"domains": [<domain1>, <domain2>, <domain3>, ......],
"freq": <freq>,
"regions": [<region1>, <region2>, <region3>, ......],
"isp": <isp>,
"startDate": <startDate>,
"endDate": <endDate>
}
请求内容
参数 | 类型 | 说明
---|---|---
domainN | string | 域名列表，总数不超过100条
freq | string | 粒度，可选项为 5min、1hour、1day
regionN | string | 区域，选项见 Region 参数列表
isp | string | ISP运营商，比如all(所有 ISP)，telecom(电信)，unicom(联通)，mobile(中国移动)，drpeng(鹏博士)，tietong(铁通)，cernet(教育网)
startDate | string | 开始时间，格式为：2006-01-02。起止最大间隔为31天
endDate | string | 结束时间，格式为：2006-01-02。起止最大间隔为31天
响应内容
HTTP/1.1 200 OK
Content-Type: application/json
{
"data" : {
"codes" : {
<statusCode> : [<codeCount1>, <codeCount2>, <codeCount3>, ......]
},
"points" : [<point1>, <point2>, <point3>, ......]
},
"error" : <error>,
"code" : <code>
}
参数 | 类型 | 说明
---|---|---
code | int | 自定义状态码
error | string | 自定义错误描述
pointN | string | 时间点，形如 2006-01-02-15-04
statusCode | string | 状态码
codeCountN | long | 状态码在 pointN 时间点的个数
# 批量查询命中率
接口地址
/v1/dcdn/loganalyze/hitmiss
请求语法
POST /v1/dcdn/loganalyze/hitmiss HTTP/1.1
Authorization:<access_token>
Content-Type: application/json
{
"domains": [<domain1>, <domain2>, <domain3>, ......],
"freq": <freq>,
"startDate": <startDate>,
"endDate": <endDate>
}
请求内容
参数 | 类型 | 说明
---|---|---
domainN | string | 域名列表，总数不超过100条
freq | string | 粒度，可选项为 5min、1hour、1day
startDate | string | 开始时间，格式为：2006-01-02。起止最大间隔为31天
endDate | string | 结束时间，格式为：2006-01-02。起止最大间隔为31天
响应内容
HTTP/1.1 200 OK
Content-Type: application/json
{
"data" : {
"points" : [<point1>, <point2>, <point3>, ......],
"hit" : [<hitCount1>, <hitCount2>, <hitCount3>, ......],
"miss" : [<missCount1>, <missCount2>, <missCount3>, ......],
"trafficHit" : [<trafficHitCount1>, <trafficHitCount2>, <trafficHitCount3>, ......],
"trafficMiss" : [<trafficMissCount1>, <trafficMissCount2>, <trafficMissCount3>, ......]
},
"error" : <error>,
"code" : <code>
}
参数 | 类型 | 说明
---|---|---
code | int | 自定义状态码
error | string | 自定义错误描述
pointN | string | 时间点，形如 2006-01-02-15-04
hitCountN | long | pointN 时间点的命中次数
missCountN | long | pointN 时间点的未命中次数
trafficHitCountN | long | pointN 时间点的命中流量，单位 Byte
trafficMissCountN | long | pointN 时间点的未命中流量，单位 Byte
# 批量查询请求次数
接口地址
/v1/dcdn/loganalyze/reqcount
请求语法
POST /v1/dcdn/loganalyze/reqcount HTTP/1.1
Authorization:<access_token>
Content-Type: application/json
{
"domains": [<domain1>, <domain2>, <domain3>, ......],
"freq": <freq>,
"region": <region>,
"startDate": <startDate>,
"endDate": <endDate>
}
请求内容
参数 | 类型 | 说明
---|---|---
domainN | string | 域名列表，总数不超过100条
freq | string | 粒度，可选项为 5min、1hour、1day
region | string | 区域，可选项见 Region 参数列表
startDate | string | 开始时间，格式为：2006-01-02。起止最大间隔为31天
endDate | string | 结束时间，格式为：2006-01-02。起止最大间隔为31天
响应内容
HTTP/1.1 200 OK
Content-Type: application/json
{
"data" : {
"reqCount" : [<reqCount1>, <reqCount2>, <reqCount3>, ......],
"points" : [<point1>, <point2>, <point3>, ......]
},
"error" : "success",
"code" : 0
}
参数 | 类型 | 说明
---|---|---
code | int | 自定义状态码
error | string | 自定义错误描述
pointN | string | 时间点，形如 2006-01-02-15-04
reqCountN | long | pointN 时间点的请求次数
# 批量查询 ISP 请求次数
接口地址
/v1/dcdn/loganalyze/ispreqcount
请求语法
POST /v1/dcdn/loganalyze/ispreqcount HTTP/1.1
Authorization:<access_token>
Content-Type: application/json
{
"domains": [<domain1>, <domain2>, <domain3>, ......],
"freq": <freq>,
"region": <region>,
"startDate": <startDate>,
"endDate": <endDate>
}
请求内容
参数 | 类型 | 说明
---|---|---
domainN | string | 域名列表，总数不超过100条
freq | string | 粒度，可选项为 5min、1hour、1day
region | string | 区域，可选项见 Region 参数列表
startDate | string | 开始时间，格式为：2006-01-02。起止最大间隔为31天
endDate | string | 结束时间，格式为：2006-01-02。起止最大间隔为31天
响应内容
HTTP/1.1 200 OK
Content-Type: application/json
{
"data" : {
"ispReq" : {
<isp>: [<reqCount1>, <reqCount2>, <reqCount3>, ......]
},
"points" : [<point1>, <point2>, <point3>, ......]
},
"error" : "success",
"code" : 0
}
参数 | 类型 | 说明
---|---|---
code | int | 自定义状态码
error | string | 自定义错误描述
pointN | string | 时间点，形如 2006-01-02-15-04
isp | string | ISP 运营商，包括 telecom（电信）、unicom（联通）、 mobile（移动）、drpeng（鹏博士）、tietong（铁通）、cernet（教育网）、others（其他）
reqCountN | long | pointN 时间点的请求次数
# 批量查询 ISP 流量占比
接口地址
/v1/dcdn/loganalyze/isptraffic
请求语法
POST /v1/dcdn/loganalyze/isptraffic HTTP/1.1
Authorization:<access_token>
Content-Type: application/json
{
"domains": [<domain1>, <domain2>, <domain3>, ......],
"regions": [<region1>, <region2>, <region3>, ......],
"startDate": <startDate>,
"endDate": <endDate>
}
参数 | 类型 | 说明
---|---|---
domainN | string | 域名列表，总数不超过100条
regionN | string | 区域，选项见 Region 参数列表
startDate | string | 开始时间，格式为：2006-01-02。起止最大间隔为31天
endDate | string | 结束时间，格式为：2006-01-02。起止最大间隔为31天
返回包
200 OK
{
"code": <code>,
"error": <error>,
"data": {
"isp1": <value1>,
"isp2": <value2>
}
}
参数 | 类型 | 说明
---|---|---
code | int | 自定义状态码
error | string | 自定义错误描述
ispN | string | 运营商
valueN | float | 运营商 ispN 对应的流量占总流量的比例
注：如果同时查询中国和上海的数据，会出现重复计算。
# 批量请求访问次数 Top IP
接口地址
/v1/dcdn/loganalyze/topcountip
请求语法
POST /v1/dcdn/loganalyze/topcountip HTTP/1.1
Authorization:<access_token>
Content-Type: application/json
{
"domains": [<domain1>, <domain2>, <domain3>, ......],
"region": <region>,
"startDate": <startDate>,
"endDate": <endDate>
}
请求内容
参数 | 类型 | 说明
---|---|---
domainN | string | 域名列表，总数不超过100条
region | string | 区域，可选项见 Region 参数列表
startDate | string | 开始时间，格式为：2006-01-02。起止最大间隔为31天
endDate | string | 结束时间，格式为：2006-01-02。起止最大间隔为31天
响应内容
HTTP/1.1 200 OK
Content-Type: application/json
{
"data" : {
"count" : [<count1>, <count2>, <count3>, ......],
"ips": [<ip1>, <ip2>, <ip3>, ......]
},
"error" : "success",
"code" : 0
}
参数 | 类型 | 说明
---|---|---
code | int | 自定义状态码
error | string | 自定义错误描述
ipN | string | IP
countN | long | ipN 在查询时间区间内的访问次数，降序排列
# 批量请求访问流量 Top IP
接口地址
/v1/dcdn/loganalyze/toptrafficip
请求语法
POST /v1/dcdn/loganalyze/toptrafficip HTTP/1.1
Authorization:<access_token>
Content-Type: application/json
{
"domains": [<domain1>, <domain2>, <domain3>, ......],
"region": <region>,
"startDate": <startDate>,
"endDate": <endDate>
}
请求内容
参数 | 类型 | 说明
---|---|---
domainN | string | 域名列表，总数不超过100条
region | string | 区域，可选项见 Region 参数列表
startDate | string | 开始时间，格式为：2006-01-02。起止最大间隔为31天
endDate | string | 结束时间，格式为：2006-01-02。起止最大间隔为31天
响应内容
HTTP/1.1 200 OK
Content-Type: application/json
{
"data" : {
"traffic" : [<traffic1>, <traffic2>, <traffic3>, ......],
"ips": [<ip1>, <ip2>, <ip3>, ......]
},
"error" : "success",
"code" : 0
}
参数 | 类型 | 说明
---|---|---
code | int | 0 表示数据返回成功, 1 表示没有数据，2 表示其他未知错误
error | string | 自定义错误描述
ipN | string | IP
trafficN | long | ipN 在查询时间区间内的访问流量，单位 Byte。降序排列
# 批量请求访问次数 Top URL
接口地址
/v1/dcdn/loganalyze/topcounturl
请求语法
POST /v1/dcdn/loganalyze/topcounturl HTTP/1.1
Authorization:<access_token>
Content-Type: application/json
{
"domains": [<domain1>, <domain2>, <domain3>, ......],
"region": <region>,
"startDate": <startDate>,
"endDate": <endDate>
}
请求内容
参数 | 类型 | 说明
---|---|---
domainN | string | 域名列表，总数不超过100条
region | string | 区域，可选项见 Region 参数列表
startDate | string | 开始时间，格式为：2006-01-02。起止最大间隔为31天
endDate | string | 结束时间，格式为：2006-01-02。起止最大间隔为31天
响应内容
{
"data" : {
"count" : [<count1>, <count2>, <count3>, ......],
"urls": [<url1>, <url2>, <url3>, ......]
},
"error" : "success",
"code" : 0
}
参数 | 类型 | 说明
---|---|---
code | int | 自定义状态码
error | string | 自定义错误描述
urlN | string | URL，去查询参数
countN | long | urlN 在查询时间区间内的访问次数，降序排列
# 批量请求访问流量 Top URL
接口地址
/v1/dcdn/loganalyze/toptrafficurl
请求语法
POST /v1/dcdn/loganalyze/toptrafficurl HTTP/1.1
Authorization:<access_token>
Content-Type: application/json
{
"domains": [<domain1>, <domain2>, <domain3>, ......],
"region": <region>,
"startDate": <startDate>,
"endDate": <endDate>
}
请求内容
参数 | 类型 | 说明
---|---|---
domainN | string | 域名列表，总数不超过100条
region | string | 区域，可选项见 Region 参数列表
startDate | string | 开始时间，格式为：2006-01-02。起止最大间隔为31天
endDate | string | 结束时间，格式为：2006-01-02。起止最大间隔为31天
响应内容
HTTP/1.1 200 OK
Content-Type: application/json
{
"data" : {
"traffic" : [<traffic1>, <traffic2>, <traffic3>, ......],
"urls": [<url1>, <url2>, <url3>, ......]
},
"error" : "success",
"code" : 0
}
参数 | 类型 | 说明
---|---|---
code | int | 自定义状态码
error | string | 自定义错误描述
urlN | string | URL，去查询参数
trafficN | long | urlN 在查询时间区间内的访问流量，单位 Byte。降序排列
# 批量查询 UniqueVisitor
接口地址
/v1/dcdn/loganalyze/uniquevisitor
请求语法
POST /v1/dcdn/loganalyze/uniquevisitor HTTP/1.1
Authorization:<access_token>
Content-Type: application/json
{
"domains": [<domain1>, <domain2>, <domain3>, ......],
"freq": <freq>,
"startDate": <startDate>,
"endDate": <endDate>
}
请求内容
参数 | 类型 | 说明
---|---|---
domainN | string | 域名列表，总数不超过100条
freq | string | 粒度，可选项为 1hour、1day
startDate | string | 开始时间，格式为：2006-01-02。起止最大间隔为31天
endDate | string | 结束时间，格式为：2006-01-02。起止最大间隔为31天
响应内容
HTTP/1.1 200 OK
Content-Type: application/json
{
"data" : {
"uvCount" : [<uvCount1>, <uvCount2>, <uvCount3>, ......],
"points" : [<point1>, <point2>, <point3>, ......]
},
"error" : <error>,
"code" : <code>
}
参数 | 类型 | 说明
---|---|---
code | int | 自定义状态码
error | string | 自定义错误描述
pointN | string | 时间点，形如 2006-01-02-15-04
uvCountN | string | pointN 时间点的 UniqueVisitor 个数
# Region 参数列表
参数 | 说明
---|---
global | 全球
oversea | 海外
china | 中国
shandong | 山东
jiangsu | 江苏
zhejiang | 浙江
anhui | 安徽
shanghai | 上海
fujian | 福建
jiangxi | 江西
guangdong | 广东
guangxi | 广西
hainan | 海南
henan | 河南
hunan | 湖南
hubei | 湖北
beijing | 北京
tianjin | 天津
hebei | 河北
shanxi | 山西
neimenggu | 内蒙古
ningxia | 宁夏
qinghai | 青海
gansu | 甘肃
shaanxi | 陕西
sichuan | 四川
guizhou | 贵州
xinjiang | 新疆
yunnan | 云南
chongqing | 重庆
xizang | 西藏
liaoning | 辽宁
jilin | 吉林
heilongjiang | 黑龙江
hongkong | 香港
macau | 澳门
taiwan | 台湾
unknown | 未知地区
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[全站加速](https://developer.qiniu.com/dcdn) > API 文档 > 日志分析
# 日志分析
最近更新时间: 2023-06-13 17:42:51
# 访问域名
Host: fusion.qiniuapi.com
# 认证授权
Authorization: QBox <access_token>
access_token 详细描述请查阅[这里
__](https://developer.qiniu.com/kodo/manual/6671/historical-document-
management-certificate)。
# 自定义状态码
HTTP 状态码 | 含义 | 说明
---|---|---
200 | success | 成功
400054 | invalid domain | 域名不合法
400331 | invalid params | 请求参数错误
500000 | internal error | 服务端内部错误
# 区域运营商流量查询
接口地址
/v1/dcdn/loganalyze/traffic
请求语法
POST /v1/dcdn/loganalyze/traffic HTTP/1.1
Authorization:<access_token>
Content-Type: application/json
{
"domains": [<domain1>, <domain2>, <domain3>, ......],
"freq": <freq>,
"regions": [<region1>, <region2>, <region3>, ......],
"isp": <isp>,
"startDate": <startDate>,
"endDate": <endDate>
}
参数 | 类型 | 说明
---|---|---
domainN | string | 域名列表，总数不超过100条
freq | string | 粒度，可选项为 5min、1hour、1day
regionN | string | 区域，选项见 Region 参数列表
isp | string | ISP运营商，比如all(所有 ISP)，telecom(电信)，unicom(联通)，mobile(中国移动)，drpeng(鹏博士)，tietong(铁通)，cernet(教育网)
startDate | string | 开始时间，格式为：2006-01-02。起止最大间隔为31天
endDate | string | 结束时间，格式为：2006-01-02。起止最大间隔为31天
返回包
200 OK
{
"code": <code>,
"error": <error>,
"data": {
"points": [<point1>, <point2>, <point3>, ......],
"value": [<value1>, <value2>, <value3>, ......]
}
}
参数 | 类型 | 说明
---|---|---
code | int | 自定义状态码
error | string | 自定义错误描述
pointN | string | 时间点，形如 2006-01-02-15-04
valueN | long | 在 pointN 时间点的流量
注：如果同时查询中国和上海的数据，结果是两者的累加。
# 区域运营商带宽查询
接口地址
/v1/dcdn/loganalyze/bandwidth
请求语法
POST /v1/dcdn/loganalyze/bandwidth HTTP/1.1
Authorization:<access_token>
Content-Type: application/json
{
"domains": [<domain1>, <domain2>, <domain3>, ......],
"freq": <freq>,
"regions": [<region1>, <region2>, <region3>, ......],
"isp": <isp>,
"startDate": <startDate>,
"endDate": <endDate>
}
参数 | 类型 | 说明
---|---|---
domainN | string | 域名列表，总数不超过100条
freq | string | 粒度，可选项为 5min、1hour、1day
regionN | string | 区域，选项见 Region 参数列表
isp | string | ISP运营商，比如all(所有 ISP)，telecom(电信)，unicom(联通)，mobile(中国移动)，drpeng(鹏博士)，tietong(铁通)，cernet(教育网)
startDate | string | 开始时间，格式为：2006-01-02。起止最大间隔为31天
endDate | string | 结束时间，格式为：2006-01-02。起止最大间隔为31天
返回包
200 OK
{
"code": <code>,
"error": <error>,
"data": {
"points": [<point1>, <point2>, <point3>, ......],
"value": [<value1>, <value2>, <value3>, ......]
},
"stats": {
"peak": {
"time": <peakTime>,
"value": <peakValue>
},
"peak95": {
"time": <peak95Time>,
"value": <peak95Value>
},
"peak95Average": <peak95Average>,
"peakAverage": <peakAverage>
}
}
参数 | 类型 | 说明
---|---|---
code | int | 自定义状态码
error | string | 自定义错误描述
pointN | string | 时间点，形如 2006-01-02-15-04
valueN | long | 在 pointN 时间点的带宽
peakTime | string | 峰值的时间点，形如 2006-01-02-15-04
peakValue | long | 峰值带宽
peak95Time | string | 95峰的时间点，形如 2006-01-02-15-04
peak95Value | long | 95峰带宽
peakAverage | long | 各天峰值的平均值
peak95Average | long | 各天95峰的平均值
注：如果同时查询中国和上海的数据，结果是两者的累加。
# 批量查询状态码
接口地址
/v1/dcdn/loganalyze/statuscode
请求语法
POST /v1/dcdn/loganalyze/statuscode HTTP/1.1
Authorization:<access_token>
Content-Type: application/json
{
"domains": [<domain1>, <domain2>, <domain3>, ......],
"freq": <freq>,
"regions": [<region1>, <region2>, <region3>, ......],
"isp": <isp>,
"startDate": <startDate>,
"endDate": <endDate>
}
请求内容
参数 | 类型 | 说明
---|---|---
domainN | string | 域名列表，总数不超过100条
freq | string | 粒度，可选项为 5min、1hour、1day
regionN | string | 区域，选项见 Region 参数列表
isp | string | ISP运营商，比如all(所有 ISP)，telecom(电信)，unicom(联通)，mobile(中国移动)，drpeng(鹏博士)，tietong(铁通)，cernet(教育网)
startDate | string | 开始时间，格式为：2006-01-02。起止最大间隔为31天
endDate | string | 结束时间，格式为：2006-01-02。起止最大间隔为31天
响应内容
HTTP/1.1 200 OK
Content-Type: application/json
{
"data" : {
"codes" : {
<statusCode> : [<codeCount1>, <codeCount2>, <codeCount3>, ......]
},
"points" : [<point1>, <point2>, <point3>, ......]
},
"error" : <error>,
"code" : <code>
}
参数 | 类型 | 说明
---|---|---
code | int | 自定义状态码
error | string | 自定义错误描述
pointN | string | 时间点，形如 2006-01-02-15-04
statusCode | string | 状态码
codeCountN | long | 状态码在 pointN 时间点的个数
# 批量查询命中率
接口地址
/v1/dcdn/loganalyze/hitmiss
请求语法
POST /v1/dcdn/loganalyze/hitmiss HTTP/1.1
Authorization:<access_token>
Content-Type: application/json
{
"domains": [<domain1>, <domain2>, <domain3>, ......],
"freq": <freq>,
"startDate": <startDate>,
"endDate": <endDate>
}
请求内容
参数 | 类型 | 说明
---|---|---
domainN | string | 域名列表，总数不超过100条
freq | string | 粒度，可选项为 5min、1hour、1day
startDate | string | 开始时间，格式为：2006-01-02。起止最大间隔为31天
endDate | string | 结束时间，格式为：2006-01-02。起止最大间隔为31天
响应内容
HTTP/1.1 200 OK
Content-Type: application/json
{
"data" : {
"points" : [<point1>, <point2>, <point3>, ......],
"hit" : [<hitCount1>, <hitCount2>, <hitCount3>, ......],
"miss" : [<missCount1>, <missCount2>, <missCount3>, ......],
"trafficHit" : [<trafficHitCount1>, <trafficHitCount2>, <trafficHitCount3>, ......],
"trafficMiss" : [<trafficMissCount1>, <trafficMissCount2>, <trafficMissCount3>, ......]
},
"error" : <error>,
"code" : <code>
}
参数 | 类型 | 说明
---|---|---
code | int | 自定义状态码
error | string | 自定义错误描述
pointN | string | 时间点，形如 2006-01-02-15-04
hitCountN | long | pointN 时间点的命中次数
missCountN | long | pointN 时间点的未命中次数
trafficHitCountN | long | pointN 时间点的命中流量，单位 Byte
trafficMissCountN | long | pointN 时间点的未命中流量，单位 Byte
# 批量查询请求次数
接口地址
/v1/dcdn/loganalyze/reqcount
请求语法
POST /v1/dcdn/loganalyze/reqcount HTTP/1.1
Authorization:<access_token>
Content-Type: application/json
{
"domains": [<domain1>, <domain2>, <domain3>, ......],
"freq": <freq>,
"region": <region>,
"startDate": <startDate>,
"endDate": <endDate>
}
请求内容
参数 | 类型 | 说明
---|---|---
domainN | string | 域名列表，总数不超过100条
freq | string | 粒度，可选项为 5min、1hour、1day
region | string | 区域，可选项见 Region 参数列表
startDate | string | 开始时间，格式为：2006-01-02。起止最大间隔为31天
endDate | string | 结束时间，格式为：2006-01-02。起止最大间隔为31天
响应内容
HTTP/1.1 200 OK
Content-Type: application/json
{
"data" : {
"reqCount" : [<reqCount1>, <reqCount2>, <reqCount3>, ......],
"points" : [<point1>, <point2>, <point3>, ......]
},
"error" : "success",
"code" : 0
}
参数 | 类型 | 说明
---|---|---
code | int | 自定义状态码
error | string | 自定义错误描述
pointN | string | 时间点，形如 2006-01-02-15-04
reqCountN | long | pointN 时间点的请求次数
# 批量查询 ISP 请求次数
接口地址
/v1/dcdn/loganalyze/ispreqcount
请求语法
POST /v1/dcdn/loganalyze/ispreqcount HTTP/1.1
Authorization:<access_token>
Content-Type: application/json
{
"domains": [<domain1>, <domain2>, <domain3>, ......],
"freq": <freq>,
"region": <region>,
"startDate": <startDate>,
"endDate": <endDate>
}
请求内容
参数 | 类型 | 说明
---|---|---
domainN | string | 域名列表，总数不超过100条
freq | string | 粒度，可选项为 5min、1hour、1day
region | string | 区域，可选项见 Region 参数列表
startDate | string | 开始时间，格式为：2006-01-02。起止最大间隔为31天
endDate | string | 结束时间，格式为：2006-01-02。起止最大间隔为31天
响应内容
HTTP/1.1 200 OK
Content-Type: application/json
{
"data" : {
"ispReq" : {
<isp>: [<reqCount1>, <reqCount2>, <reqCount3>, ......]
},
"points" : [<point1>, <point2>, <point3>, ......]
},
"error" : "success",
"code" : 0
}
参数 | 类型 | 说明
---|---|---
code | int | 自定义状态码
error | string | 自定义错误描述
pointN | string | 时间点，形如 2006-01-02-15-04
isp | string | ISP 运营商，包括 telecom（电信）、unicom（联通）、 mobile（移动）、drpeng（鹏博士）、tietong（铁通）、cernet（教育网）、others（其他）
reqCountN | long | pointN 时间点的请求次数
# 批量查询 ISP 流量占比
接口地址
/v1/dcdn/loganalyze/isptraffic
请求语法
POST /v1/dcdn/loganalyze/isptraffic HTTP/1.1
Authorization:<access_token>
Content-Type: application/json
{
"domains": [<domain1>, <domain2>, <domain3>, ......],
"regions": [<region1>, <region2>, <region3>, ......],
"startDate": <startDate>,
"endDate": <endDate>
}
参数 | 类型 | 说明
---|---|---
domainN | string | 域名列表，总数不超过100条
regionN | string | 区域，选项见 Region 参数列表
startDate | string | 开始时间，格式为：2006-01-02。起止最大间隔为31天
endDate | string | 结束时间，格式为：2006-01-02。起止最大间隔为31天
返回包
200 OK
{
"code": <code>,
"error": <error>,
"data": {
"isp1": <value1>,
"isp2": <value2>
}
}
参数 | 类型 | 说明
---|---|---
code | int | 自定义状态码
error | string | 自定义错误描述
ispN | string | 运营商
valueN | float | 运营商 ispN 对应的流量占总流量的比例
注：如果同时查询中国和上海的数据，会出现重复计算。
# 批量请求访问次数 Top IP
接口地址
/v1/dcdn/loganalyze/topcountip
请求语法
POST /v1/dcdn/loganalyze/topcountip HTTP/1.1
Authorization:<access_token>
Content-Type: application/json
{
"domains": [<domain1>, <domain2>, <domain3>, ......],
"region": <region>,
"startDate": <startDate>,
"endDate": <endDate>
}
请求内容
参数 | 类型 | 说明
---|---|---
domainN | string | 域名列表，总数不超过100条
region | string | 区域，可选项见 Region 参数列表
startDate | string | 开始时间，格式为：2006-01-02。起止最大间隔为31天
endDate | string | 结束时间，格式为：2006-01-02。起止最大间隔为31天
响应内容
HTTP/1.1 200 OK
Content-Type: application/json
{
"data" : {
"count" : [<count1>, <count2>, <count3>, ......],
"ips": [<ip1>, <ip2>, <ip3>, ......]
},
"error" : "success",
"code" : 0
}
参数 | 类型 | 说明
---|---|---
code | int | 自定义状态码
error | string | 自定义错误描述
ipN | string | IP
countN | long | ipN 在查询时间区间内的访问次数，降序排列
# 批量请求访问流量 Top IP
接口地址
/v1/dcdn/loganalyze/toptrafficip
请求语法
POST /v1/dcdn/loganalyze/toptrafficip HTTP/1.1
Authorization:<access_token>
Content-Type: application/json
{
"domains": [<domain1>, <domain2>, <domain3>, ......],
"region": <region>,
"startDate": <startDate>,
"endDate": <endDate>
}
请求内容
参数 | 类型 | 说明
---|---|---
domainN | string | 域名列表，总数不超过100条
region | string | 区域，可选项见 Region 参数列表
startDate | string | 开始时间，格式为：2006-01-02。起止最大间隔为31天
endDate | string | 结束时间，格式为：2006-01-02。起止最大间隔为31天
响应内容
HTTP/1.1 200 OK
Content-Type: application/json
{
"data" : {
"traffic" : [<traffic1>, <traffic2>, <traffic3>, ......],
"ips": [<ip1>, <ip2>, <ip3>, ......]
},
"error" : "success",
"code" : 0
}
参数 | 类型 | 说明
---|---|---
code | int | 0 表示数据返回成功, 1 表示没有数据，2 表示其他未知错误
error | string | 自定义错误描述
ipN | string | IP
trafficN | long | ipN 在查询时间区间内的访问流量，单位 Byte。降序排列
# 批量请求访问次数 Top URL
接口地址
/v1/dcdn/loganalyze/topcounturl
请求语法
POST /v1/dcdn/loganalyze/topcounturl HTTP/1.1
Authorization:<access_token>
Content-Type: application/json
{
"domains": [<domain1>, <domain2>, <domain3>, ......],
"region": <region>,
"startDate": <startDate>,
"endDate": <endDate>
}
请求内容
参数 | 类型 | 说明
---|---|---
domainN | string | 域名列表，总数不超过100条
region | string | 区域，可选项见 Region 参数列表
startDate | string | 开始时间，格式为：2006-01-02。起止最大间隔为31天
endDate | string | 结束时间，格式为：2006-01-02。起止最大间隔为31天
响应内容
{
"data" : {
"count" : [<count1>, <count2>, <count3>, ......],
"urls": [<url1>, <url2>, <url3>, ......]
},
"error" : "success",
"code" : 0
}
参数 | 类型 | 说明
---|---|---
code | int | 自定义状态码
error | string | 自定义错误描述
urlN | string | URL，去查询参数
countN | long | urlN 在查询时间区间内的访问次数，降序排列
# 批量请求访问流量 Top URL
接口地址
/v1/dcdn/loganalyze/toptrafficurl
请求语法
POST /v1/dcdn/loganalyze/toptrafficurl HTTP/1.1
Authorization:<access_token>
Content-Type: application/json
{
"domains": [<domain1>, <domain2>, <domain3>, ......],
"region": <region>,
"startDate": <startDate>,
"endDate": <endDate>
}
请求内容
参数 | 类型 | 说明
---|---|---
domainN | string | 域名列表，总数不超过100条
region | string | 区域，可选项见 Region 参数列表
startDate | string | 开始时间，格式为：2006-01-02。起止最大间隔为31天
endDate | string | 结束时间，格式为：2006-01-02。起止最大间隔为31天
响应内容
HTTP/1.1 200 OK
Content-Type: application/json
{
"data" : {
"traffic" : [<traffic1>, <traffic2>, <traffic3>, ......],
"urls": [<url1>, <url2>, <url3>, ......]
},
"error" : "success",
"code" : 0
}
参数 | 类型 | 说明
---|---|---
code | int | 自定义状态码
error | string | 自定义错误描述
urlN | string | URL，去查询参数
trafficN | long | urlN 在查询时间区间内的访问流量，单位 Byte。降序排列
# 批量查询 UniqueVisitor
接口地址
/v1/dcdn/loganalyze/uniquevisitor
请求语法
POST /v1/dcdn/loganalyze/uniquevisitor HTTP/1.1
Authorization:<access_token>
Content-Type: application/json
{
"domains": [<domain1>, <domain2>, <domain3>, ......],
"freq": <freq>,
"startDate": <startDate>,
"endDate": <endDate>
}
请求内容
参数 | 类型 | 说明
---|---|---
domainN | string | 域名列表，总数不超过100条
freq | string | 粒度，可选项为 1hour、1day
startDate | string | 开始时间，格式为：2006-01-02。起止最大间隔为31天
endDate | string | 结束时间，格式为：2006-01-02。起止最大间隔为31天
响应内容
HTTP/1.1 200 OK
Content-Type: application/json
{
"data" : {
"uvCount" : [<uvCount1>, <uvCount2>, <uvCount3>, ......],
"points" : [<point1>, <point2>, <point3>, ......]
},
"error" : <error>,
"code" : <code>
}
参数 | 类型 | 说明
---|---|---
code | int | 自定义状态码
error | string | 自定义错误描述
pointN | string | 时间点，形如 2006-01-02-15-04
uvCountN | string | pointN 时间点的 UniqueVisitor 个数
# Region 参数列表
参数 | 说明
---|---
global | 全球
oversea | 海外
china | 中国
shandong | 山东
jiangsu | 江苏
zhejiang | 浙江
anhui | 安徽
shanghai | 上海
fujian | 福建
jiangxi | 江西
guangdong | 广东
guangxi | 广西
hainan | 海南
henan | 河南
hunan | 湖南
hubei | 湖北
beijing | 北京
tianjin | 天津
hebei | 河北
shanxi | 山西
neimenggu | 内蒙古
ningxia | 宁夏
qinghai | 青海
gansu | 甘肃
shaanxi | 陕西
sichuan | 四川
guizhou | 贵州
xinjiang | 新疆
yunnan | 云南
chongqing | 重庆
xizang | 西藏
liaoning | 辽宁
jilin | 吉林
heilongjiang | 黑龙江
hongkong | 香港
macau | 澳门
taiwan | 台湾
unknown | 未知地区
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,298 |
日志下载 | 全站加速 | [全站加速](https://developer.qiniu.com/dcdn) > API 文档 > 日志下载
# 日志下载
最近更新时间: 2022-02-09 18:44:59
日志下载接口可以查询域名日志列表，获取日志的下载外链，只提供 30 个自然日内的日志下载，例如当前日期为 2016-08-31，则只提供
2016-08-01 ~ 2016-08-30 的日志。
日志文件默认按小时下载，如果单小时内日志过大会进行切分(分片大小128MB)，日志文件采用gzip压缩。
日志大概延迟6小时，举例：1月18日0点-1点的日志，会在1月18日8点-10点左右可下载。
# 访问域名
Host: fusion.qiniuapi.com
# 接口地址
/v2/tune/log/list
# 认证授权
Authorization: <access_token>
access_token 详细描述请查阅[这里](https://developer.qiniu.com/kodo/manual/access-
token)。
# 请求报文
## 请求语法
POST /v2/tune/log/list
Content-Type: application/json
{
"day":<Day>,
"domains": <Domains>
}
## 请求内容
参数 | 类型 | 必须 | 描述
---|---|---|---
`<Day>` | string | 是 | 日期，例如 2016-07-01
`<Domains>` | string | 是 | 域名列表，以英文分号 ; 分割
# 响应报文
## 响应状态码
HTTP状态码 | 含义 | 说明
---|---|---
200 | success | 成功
400 | invalid params | 请求参数格式错误
401 | bad token | 认证授权失败（包括密钥信息不正确；数字签名错误；授权已超时）
400032 | invalid host | 请求中存在无效的域名，请确保域名格式正确
500000 | internal error | 服务器内部错误
## 响应内容
HTTP/1.1 200 OK
Content-Type: application/json
{
"code":<Code>,
"error": <Error>,
"data": {
...
<Domain_i>:[
...
{
"name":<Name>,
"size":<Size>,
"mtime":<Mtime>,
"url":<Url>,
},
...
],
...
}
}
参数 | 类型 | 说明
---|---|---
Code | int | HTTP 状态码，整型，见响应状态码
Error | string | 自定义错误码描述，字符串
data | map | 日志数据
Domain_i | string | 域名，字符串
Domain_i_Name | string | 文件名，字符串
Domain_i_Size | int64 | 文件大小，单位为 Byte
Domain_i_Mtime | int64 | 文件修改时间，Unix 时间戳
Domain_i_Url | string | 下载链接，字符串
# 示例
## 请求示例
POST https://fusion.qiniuapi.com/v2/tune/log/list
Content-Type: application/json
{
"day":"2016-07-01",
"domains": "log-test1.qiniu.com;log-test2.qiniu.com"
}
## 响应示例
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"log-test1.qiniu.com": [
{
"name":"log-test1.qiniu.com_2016-07-01-00_00.gz",
"size": 88490306,
"mtime": 1466274440,
"url": "https://fusionlog.qiniu.com/log-test1.qiniu.com_2016-07-01-00_00.gz?e=1561008052&token=557TpseUM8ovpfUhaw8gfa2DQ0104ZScM-BTIcBx:8AUwyRCO6nwb8vTH_LNKg4016Ec"
}
],
"log-test2.qiniu.com": [
{
"name":"log-test2.qiniu.com_2016-07-01-00_00.gz",
"size": 73280873,
"mtime": 1466273259,
"url": "https://fusionlog.qiniu.com/log-test2.qiniu.com_2016-07-01-00_00.gz?e=1561008052&token=336DepseUM8ovpfUhaw8gfa2DQ0104ZScM-BTIcBx:8AUwyRCO6nwb8vTH_LNKg3879Wd"
}
]
}
}
# 日志格式
IP 命中率 响应时间 请求时间 请求方法 请求URL 请求协议 状态码 响应大小 referer 用户代理
ClientIP Hit/Miss ResponseTime [Time Zone] Method URL Protocol StatusCode TrafficSize Referer UserAgent
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[全站加速](https://developer.qiniu.com/dcdn) > API 文档 > 日志下载
# 日志下载
最近更新时间: 2022-02-09 18:44:59
日志下载接口可以查询域名日志列表，获取日志的下载外链，只提供 30 个自然日内的日志下载，例如当前日期为 2016-08-31，则只提供
2016-08-01 ~ 2016-08-30 的日志。
日志文件默认按小时下载，如果单小时内日志过大会进行切分(分片大小128MB)，日志文件采用gzip压缩。
日志大概延迟6小时，举例：1月18日0点-1点的日志，会在1月18日8点-10点左右可下载。
# 访问域名
Host: fusion.qiniuapi.com
# 接口地址
/v2/tune/log/list
# 认证授权
Authorization: <access_token>
access_token 详细描述请查阅[这里](https://developer.qiniu.com/kodo/manual/access-
token)。
# 请求报文
## 请求语法
POST /v2/tune/log/list
Content-Type: application/json
{
"day":<Day>,
"domains": <Domains>
}
## 请求内容
参数 | 类型 | 必须 | 描述
---|---|---|---
`<Day>` | string | 是 | 日期，例如 2016-07-01
`<Domains>` | string | 是 | 域名列表，以英文分号 ; 分割
# 响应报文
## 响应状态码
HTTP状态码 | 含义 | 说明
---|---|---
200 | success | 成功
400 | invalid params | 请求参数格式错误
401 | bad token | 认证授权失败（包括密钥信息不正确；数字签名错误；授权已超时）
400032 | invalid host | 请求中存在无效的域名，请确保域名格式正确
500000 | internal error | 服务器内部错误
## 响应内容
HTTP/1.1 200 OK
Content-Type: application/json
{
"code":<Code>,
"error": <Error>,
"data": {
...
<Domain_i>:[
...
{
"name":<Name>,
"size":<Size>,
"mtime":<Mtime>,
"url":<Url>,
},
...
],
...
}
}
参数 | 类型 | 说明
---|---|---
Code | int | HTTP 状态码，整型，见响应状态码
Error | string | 自定义错误码描述，字符串
data | map | 日志数据
Domain_i | string | 域名，字符串
Domain_i_Name | string | 文件名，字符串
Domain_i_Size | int64 | 文件大小，单位为 Byte
Domain_i_Mtime | int64 | 文件修改时间，Unix 时间戳
Domain_i_Url | string | 下载链接，字符串
# 示例
## 请求示例
POST https://fusion.qiniuapi.com/v2/tune/log/list
Content-Type: application/json
{
"day":"2016-07-01",
"domains": "log-test1.qiniu.com;log-test2.qiniu.com"
}
## 响应示例
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"log-test1.qiniu.com": [
{
"name":"log-test1.qiniu.com_2016-07-01-00_00.gz",
"size": 88490306,
"mtime": 1466274440,
"url": "https://fusionlog.qiniu.com/log-test1.qiniu.com_2016-07-01-00_00.gz?e=1561008052&token=557TpseUM8ovpfUhaw8gfa2DQ0104ZScM-BTIcBx:8AUwyRCO6nwb8vTH_LNKg4016Ec"
}
],
"log-test2.qiniu.com": [
{
"name":"log-test2.qiniu.com_2016-07-01-00_00.gz",
"size": 73280873,
"mtime": 1466273259,
"url": "https://fusionlog.qiniu.com/log-test2.qiniu.com_2016-07-01-00_00.gz?e=1561008052&token=336DepseUM8ovpfUhaw8gfa2DQ0104ZScM-BTIcBx:8AUwyRCO6nwb8vTH_LNKg3879Wd"
}
]
}
}
# 日志格式
IP 命中率 响应时间 请求时间 请求方法 请求URL 请求协议 状态码 响应大小 referer 用户代理
ClientIP Hit/Miss ResponseTime [Time Zone] Method URL Protocol StatusCode TrafficSize Referer UserAgent
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,323 |
缓存刷新与查询 | 全站加速 | [全站加速](https://developer.qiniu.com/dcdn) > API 文档 > 缓存刷新与查询
# 缓存刷新与查询
最近更新时间: 2022-04-28 23:56:37
缓存刷新，是指将缓存过的客户资源在 CDN 节点内设置为过期状态；当用户再次发起访问时，节点回源站拉取所需资源，并重新缓存在节点上。具体做法是客户提交资源
url 到 CDN，由 CDN 来操作刷新。
# 访问域名
Host: fusion.qiniuapi.com
# 认证授权
Authorization: <access_token>
access_token 详细描述请查阅[这里](https://developer.qiniu.com/kodo/manual/access-
token)。
## 接口地址
/v2/tune/refresh
# 刷新
## 请求语法
POST /v2/tune/refresh HTTP/1.1
Authorization:<access_token>
Content-Type: application/json
{
"urls":[<url1>, <url2>, <url3>, ...],
"dirs":[<dir1>, <dir2>, <dir3>, ...],
"product":"dcdn",
}
## 请求内容
参数 | 类型 | 必要性 | 说明
---|---|---|---
urlN | array | 可选 | 要刷新的单个url列表，总数不超过60条；单个url，即一个具体的url，例如：`http://bar.foo.com/index.html`
dirN | array | 可选 | 要刷新的目录url列表，总数不超过10条；目录dir，即表示一个目录级的url，例如：`http://bar.foo.com/dir/`，也支持在尾部使用通配符，例如：`http://bar.foo.com/dir/*`
product | string | 必选 | 此处填写固定值 dcdn
### 注意事项
* 请输入资源 url 完整的绝对路径，由 http:// 或 https:// 开始。
* 资源 url 不支持通配符，例如：不支持 `http://www.test.com/abc/\*.\*`。
* 进行目录刷新时，资源 url 需要以 / 结尾，例如：`http://www.test.com/abc/`。
* 带参数的 url 刷新，根据其域名缓存配置是否忽略参数缓存决定刷新结果。如果配置了时间戳防盗链的资源 url 提交时刷新需要去掉 sign 和 t 参数。
* 请求数量限制，以下限制达到任意一个即触发限制：
* 每秒钟刷新请求和[预取请求 __](https://developer.qiniu.com/fusion/api/1227/file-prefetching)中的url、dir的总量限制为 240。
* 每个请求中 url 的条数限制为 60 条。
* 每个请求中 dir 的条数限制为 10 条。
## 响应状态码
HTTP状态码 | 含义 | 说明
---|---|---
200 | success | 成功
400031 | invalid url | 请求中存在无效的 url，请确保 url 格式正确
400032 | invalid host | 请求中存在无效的域名，请确保域名格式正确
400034 | refresh url limit error | 请求次数超出当日刷新限额
400036 | invalid request id | 无效的请求 id
400037 | url has existed | url 正在刷新中
400038 | refresh dir authority error | 没有刷新目录的权限， 如果需要请联系[技术支持 __](https://support.qiniu.com/tickets/category)
403024 | single user QPS Rate limited | 请求达到单用户QPS限制，请重试或联系我们
403022 | server QPS Rate limited | 请求达到全局QPS限制，请联系我们
500000 | internal error | 服务端内部错误，请联系[技术支持 __](https://support.qiniu.com/tickets/category)
## 响应内容
HTTP/1.1 200 OK
Content-Type: application/json
{
"code": <custom code>,
"error": <error string>,
"requestId": <request id>,
"taskIds": <task id map>,
"invalidUrls": [<url1>, <url2>, <url3>, ...],
"invalidDirs": [<dir1>, <dir2>, <dir3>, ...],
"urlQuotaDay": <url quota one day >,
"urlSurplusDay": <url surplus one day >,
"dirQuotaDay": <dir quota one day >,
"dirSurplusDay": <dir surplus one day >,
}
参数 | 类型 | 说明
---|---|---
code | int | 自定义错误码，整型，见自定义状态码
error | string | 自定义错误码描述，字符串
requestId | string | 刷新请求id，只有在任务被接受时才有值
taskIds | map[string]string | URL/DIR 对应的任务 ID，map[url/dir]taskId
invalidUrls | string array | 无效的url列表
invalidDirs | string array | 无效的dir列表
urlQuotaDay | int | 每日的刷新url限额
urlSurplusDay | int | 每日的当前剩余的刷新url限额
dirQuotaDay | int | 每日的刷新dir限额
dirSurplusDay | int | 每日的当前剩余的刷新dir限额
### 注意事项
* 在请求成功时 code 为 200，requestId、urlQuotaDay、urlSurplusDay、dirQuotaDay、dirSurplusDay才会有有效值，否则为空。
* 在请求失败时 code 为非 200，error 中包含描述信息。
## 刷新示例
下面是命令行示例：
请求命令示例：
第一步生成token：
echo "/v2/tune/refresh" |openssl dgst -binary -hmac "用户SK" -sha1 |base64 | tr + - | tr / _ 回车
生成的token
第二步发起请求：
curl -X POST -H "Authorization: QBox <用户AK>:<生成的token>" http://fusion.qiniuapi.com/v2/tune/refresh -d '{"urls":["<用户url>"],"product":"dcdn"}' -H 'Content-Type: application/json'
响应内容示例：
{"code":200,"error":"success","requestId":"575d1930f9537d3f2600003d","invalidUrls":null,"invalidDirs":null,"urlQuotaDay":100,"urlSurplusDay":99,"dirQuotaDay":10,"dirSurplusDay":10}
# 刷新查询
## 接口地址
/v2/tune/refresh／list
## 请求语法
POST http://<Host>/v2/tune/refresh/list
Authorization:<access_token>
{
"requestId": <request id>,
"taskId": <task id>,
"isDir": <dir flag>,
"urls":[<url1>, <url2>, <url3>, ...],
"state": <state>,
"pageNo": <page no>,
"pageSize": <page size>,
"startTime": <startTime>,
"endTime": <endTime>,
"product":"dcdn",
}
## 请求内容
参数 | 类型 | 必要性 | 说明
---|---|---|---
requestId | string | 可选 | 指定要查询记录所在的刷新请求id
taskId | string | 可选 | 指定查询的单个任务 id
isDir | string | 可选 | 指定是否查询目录，取值为 yes/no，默认不填则为两种类型记录都查询
urls | string | 可选 | 要查询的url列表，每个url可以是文件url，也可以是目录url
state | string | 可选 | 指定要查询记录的状态，取值processing／success／failure
pageNo | int | 可选 | 要求返回的页号，默认为0
pageSize | int | 可选 | 要求返回的页长度，默认为100
startTime | string | 可选 | 指定查询的开始日期，格式2006-01-01
endTime | string | 可选 | 指定查询的结束日期，格式2006-01-01
product | string | 必选 | 此处填写固定值 dcdn
### 注意事项
* 输入参数可选部分全部为空时，服务端返回无效参数错误。
* 查询的时间范围：当天至当天的前6天（共7天）。
* startTime和endTime任一缺失的情况下，查询默认返回近3天的操作记录。
## 响应状态码
HTTP状态码 | 含义 | 说明
---|---|---
200 | success | 成功
400000 | invalid input | 无效的输入参数
500000 | internal error | 服务端内部错误
500005 | query data error | 服务端查询数据错误
## 响应内容
HTTP/1.1 200 OK
Content-Type: application/json
{
"code": <custom code>,
"error": <error string>,
"total": <total count>,
"pageNo": <page no>,
"pageSize": <page size>,
"currentSize": <current size>,
"items": [{
"uid": <user uid>,
"requestId": <request id>,
"url": <url>,
"state": <state>,
"stateDetail": <stateDetail>,
"createAt": <create time>,
"beginAt": <begin time>,
"endAt": <end time>,
}, ...],
}
参数 | 类型 | 说明
---|---|---
code | int | 自定义错误码，整型，见自定义状态码
error | string | 自定义错误码描述，字符串
total | int | 当前条件下查询的记录总数
pageNo | int | 要查询的页号
pageSize | int | 要返回的页长度
currentSize | int | 当前实际返回的页长度
uid | string | 用户id
requestId | string | 记录所在的刷新请求id
url | string | url
state | string | 刷新状态，取值为success／processing／failure
stateDetail | string | 刷新状态描述信息
createAt | string | 当前记录创建时间，格式为xxxx-xx-xx xx:xx:xx，例如2015-11-01 16:05:05
beginAt | string | 当前记录开始时间，格式为xxxx-xx-xx xx:xx:xx，例如2015-11-01 16:05:25。
endAt | string | 当前记录结束时间，格式为xxxx-xx-xx xx:xx:xx，例如2015-11-01 16:09:05
## 刷新查询示例
下面是命令行示例：
请求命令示例：
第一步生成token：
echo "/v2/tune/refresh/list" |openssl dgst -binary -hmac "用户SK" -sha1 |base64 | tr + - | tr / _ 回车
生成的token
第二步发起请求：
curl -X POST -H "Authorization: QBox <用户AK>:<生成的token>" http://fusion.qiniuapi.com/v2/tune/refresh/list -d '{"urls":["<用户url>"，"pageNo":<page no>,"pageSize":<page size>],"product":"dcdn"}' -H 'Content-Type: application/json'
响应内容示例：
{"code":200,"error":"success","total":1,"pageNo":0,"pageSize":10,"currentSize":1,"items":[{"uid":1100000009,"requestId":"57edce1a23232391821e303b","url":"http://www.test.com/test01","state":"success","stateDetail":"","createAt":"2015-09-30 10:29:46","beginAt":"2015-09-30 10:29:48","endAt":"2015-09-30 10:30:08"}]}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[全站加速](https://developer.qiniu.com/dcdn) > API 文档 > 缓存刷新与查询
# 缓存刷新与查询
最近更新时间: 2022-04-28 23:56:37
缓存刷新，是指将缓存过的客户资源在 CDN 节点内设置为过期状态；当用户再次发起访问时，节点回源站拉取所需资源，并重新缓存在节点上。具体做法是客户提交资源
url 到 CDN，由 CDN 来操作刷新。
# 访问域名
Host: fusion.qiniuapi.com
# 认证授权
Authorization: <access_token>
access_token 详细描述请查阅[这里](https://developer.qiniu.com/kodo/manual/access-
token)。
## 接口地址
/v2/tune/refresh
# 刷新
## 请求语法
POST /v2/tune/refresh HTTP/1.1
Authorization:<access_token>
Content-Type: application/json
{
"urls":[<url1>, <url2>, <url3>, ...],
"dirs":[<dir1>, <dir2>, <dir3>, ...],
"product":"dcdn",
}
## 请求内容
参数 | 类型 | 必要性 | 说明
---|---|---|---
urlN | array | 可选 | 要刷新的单个url列表，总数不超过60条；单个url，即一个具体的url，例如：`http://bar.foo.com/index.html`
dirN | array | 可选 | 要刷新的目录url列表，总数不超过10条；目录dir，即表示一个目录级的url，例如：`http://bar.foo.com/dir/`，也支持在尾部使用通配符，例如：`http://bar.foo.com/dir/*`
product | string | 必选 | 此处填写固定值 dcdn
### 注意事项
* 请输入资源 url 完整的绝对路径，由 http:// 或 https:// 开始。
* 资源 url 不支持通配符，例如：不支持 `http://www.test.com/abc/\*.\*`。
* 进行目录刷新时，资源 url 需要以 / 结尾，例如：`http://www.test.com/abc/`。
* 带参数的 url 刷新，根据其域名缓存配置是否忽略参数缓存决定刷新结果。如果配置了时间戳防盗链的资源 url 提交时刷新需要去掉 sign 和 t 参数。
* 请求数量限制，以下限制达到任意一个即触发限制：
* 每秒钟刷新请求和[预取请求 __](https://developer.qiniu.com/fusion/api/1227/file-prefetching)中的url、dir的总量限制为 240。
* 每个请求中 url 的条数限制为 60 条。
* 每个请求中 dir 的条数限制为 10 条。
## 响应状态码
HTTP状态码 | 含义 | 说明
---|---|---
200 | success | 成功
400031 | invalid url | 请求中存在无效的 url，请确保 url 格式正确
400032 | invalid host | 请求中存在无效的域名，请确保域名格式正确
400034 | refresh url limit error | 请求次数超出当日刷新限额
400036 | invalid request id | 无效的请求 id
400037 | url has existed | url 正在刷新中
400038 | refresh dir authority error | 没有刷新目录的权限， 如果需要请联系[技术支持 __](https://support.qiniu.com/tickets/category)
403024 | single user QPS Rate limited | 请求达到单用户QPS限制，请重试或联系我们
403022 | server QPS Rate limited | 请求达到全局QPS限制，请联系我们
500000 | internal error | 服务端内部错误，请联系[技术支持 __](https://support.qiniu.com/tickets/category)
## 响应内容
HTTP/1.1 200 OK
Content-Type: application/json
{
"code": <custom code>,
"error": <error string>,
"requestId": <request id>,
"taskIds": <task id map>,
"invalidUrls": [<url1>, <url2>, <url3>, ...],
"invalidDirs": [<dir1>, <dir2>, <dir3>, ...],
"urlQuotaDay": <url quota one day >,
"urlSurplusDay": <url surplus one day >,
"dirQuotaDay": <dir quota one day >,
"dirSurplusDay": <dir surplus one day >,
}
参数 | 类型 | 说明
---|---|---
code | int | 自定义错误码，整型，见自定义状态码
error | string | 自定义错误码描述，字符串
requestId | string | 刷新请求id，只有在任务被接受时才有值
taskIds | map[string]string | URL/DIR 对应的任务 ID，map[url/dir]taskId
invalidUrls | string array | 无效的url列表
invalidDirs | string array | 无效的dir列表
urlQuotaDay | int | 每日的刷新url限额
urlSurplusDay | int | 每日的当前剩余的刷新url限额
dirQuotaDay | int | 每日的刷新dir限额
dirSurplusDay | int | 每日的当前剩余的刷新dir限额
### 注意事项
* 在请求成功时 code 为 200，requestId、urlQuotaDay、urlSurplusDay、dirQuotaDay、dirSurplusDay才会有有效值，否则为空。
* 在请求失败时 code 为非 200，error 中包含描述信息。
## 刷新示例
下面是命令行示例：
请求命令示例：
第一步生成token：
echo "/v2/tune/refresh" |openssl dgst -binary -hmac "用户SK" -sha1 |base64 | tr + - | tr / _ 回车
生成的token
第二步发起请求：
curl -X POST -H "Authorization: QBox <用户AK>:<生成的token>" http://fusion.qiniuapi.com/v2/tune/refresh -d '{"urls":["<用户url>"],"product":"dcdn"}' -H 'Content-Type: application/json'
响应内容示例：
{"code":200,"error":"success","requestId":"575d1930f9537d3f2600003d","invalidUrls":null,"invalidDirs":null,"urlQuotaDay":100,"urlSurplusDay":99,"dirQuotaDay":10,"dirSurplusDay":10}
# 刷新查询
## 接口地址
/v2/tune/refresh／list
## 请求语法
POST http://<Host>/v2/tune/refresh/list
Authorization:<access_token>
{
"requestId": <request id>,
"taskId": <task id>,
"isDir": <dir flag>,
"urls":[<url1>, <url2>, <url3>, ...],
"state": <state>,
"pageNo": <page no>,
"pageSize": <page size>,
"startTime": <startTime>,
"endTime": <endTime>,
"product":"dcdn",
}
## 请求内容
参数 | 类型 | 必要性 | 说明
---|---|---|---
requestId | string | 可选 | 指定要查询记录所在的刷新请求id
taskId | string | 可选 | 指定查询的单个任务 id
isDir | string | 可选 | 指定是否查询目录，取值为 yes/no，默认不填则为两种类型记录都查询
urls | string | 可选 | 要查询的url列表，每个url可以是文件url，也可以是目录url
state | string | 可选 | 指定要查询记录的状态，取值processing／success／failure
pageNo | int | 可选 | 要求返回的页号，默认为0
pageSize | int | 可选 | 要求返回的页长度，默认为100
startTime | string | 可选 | 指定查询的开始日期，格式2006-01-01
endTime | string | 可选 | 指定查询的结束日期，格式2006-01-01
product | string | 必选 | 此处填写固定值 dcdn
### 注意事项
* 输入参数可选部分全部为空时，服务端返回无效参数错误。
* 查询的时间范围：当天至当天的前6天（共7天）。
* startTime和endTime任一缺失的情况下，查询默认返回近3天的操作记录。
## 响应状态码
HTTP状态码 | 含义 | 说明
---|---|---
200 | success | 成功
400000 | invalid input | 无效的输入参数
500000 | internal error | 服务端内部错误
500005 | query data error | 服务端查询数据错误
## 响应内容
HTTP/1.1 200 OK
Content-Type: application/json
{
"code": <custom code>,
"error": <error string>,
"total": <total count>,
"pageNo": <page no>,
"pageSize": <page size>,
"currentSize": <current size>,
"items": [{
"uid": <user uid>,
"requestId": <request id>,
"url": <url>,
"state": <state>,
"stateDetail": <stateDetail>,
"createAt": <create time>,
"beginAt": <begin time>,
"endAt": <end time>,
}, ...],
}
参数 | 类型 | 说明
---|---|---
code | int | 自定义错误码，整型，见自定义状态码
error | string | 自定义错误码描述，字符串
total | int | 当前条件下查询的记录总数
pageNo | int | 要查询的页号
pageSize | int | 要返回的页长度
currentSize | int | 当前实际返回的页长度
uid | string | 用户id
requestId | string | 记录所在的刷新请求id
url | string | url
state | string | 刷新状态，取值为success／processing／failure
stateDetail | string | 刷新状态描述信息
createAt | string | 当前记录创建时间，格式为xxxx-xx-xx xx:xx:xx，例如2015-11-01 16:05:05
beginAt | string | 当前记录开始时间，格式为xxxx-xx-xx xx:xx:xx，例如2015-11-01 16:05:25。
endAt | string | 当前记录结束时间，格式为xxxx-xx-xx xx:xx:xx，例如2015-11-01 16:09:05
## 刷新查询示例
下面是命令行示例：
请求命令示例：
第一步生成token：
echo "/v2/tune/refresh/list" |openssl dgst -binary -hmac "用户SK" -sha1 |base64 | tr + - | tr / _ 回车
生成的token
第二步发起请求：
curl -X POST -H "Authorization: QBox <用户AK>:<生成的token>" http://fusion.qiniuapi.com/v2/tune/refresh/list -d '{"urls":["<用户url>"，"pageNo":<page no>,"pageSize":<page size>],"product":"dcdn"}' -H 'Content-Type: application/json'
响应内容示例：
{"code":200,"error":"success","total":1,"pageNo":0,"pageSize":10,"currentSize":1,"items":[{"uid":1100000009,"requestId":"57edce1a23232391821e303b","url":"http://www.test.com/test01","state":"success","stateDetail":"","createAt":"2015-09-30 10:29:46","beginAt":"2015-09-30 10:29:48","endAt":"2015-09-30 10:30:08"}]}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,328 |
文件预取与查询 | 全站加速 | [全站加速](https://developer.qiniu.com/dcdn) > API 文档 > 文件预取与查询
# 文件预取与查询
最近更新时间: 2022-02-09 19:22:22
文件预取，也可称为预加热或预缓存，是指客户新资源提前由 CDN 拉取到 CDN 缓存节点。具体做法是客户提交资源 url 到 CDN，由 CDN
来操作预取。
# 访问域名
Host: fusion.qiniuapi.com
# 认证授权
Authorization: <access_token>
access_token 详细描述请查阅[这里](https://developer.qiniu.com/kodo/manual/access-
token)。
# 预取
## 接口地址
/v2/tune/prefetch
## 请求语法
POST /v2/tune/prefetch HTTP/1.1
Authorization:<access_token>
Content-Type: application/json
{
"urls": [<url1>, <url2>, <url3>, ......],
"product": "dcdn"
}
## 请求内容
参数 | 类型 | 必要性 | 说明
---|---|---|---
urlN | array | 必选 | 要预取的单个url列表，总数不超过60条；单个url，即一个具体的url，例如：`http://bar.foo.com/test.zip`
product | string | 必选 | 此处填写固定值 dcdn
### 注意事项
* 请输入资源 url 完整的绝对路径，由 http:// 或 https:// 开始。
* 资源 url 不支持通配符，例如：不支持 `http://www.test.com/abc/\*.\*`。
* 请求数量限制，以下限制达到任意一个即触发限制：
* 每秒钟预取请求和[刷新请求 __](https://developer.qiniu.com/fusion/api/1229/cache-refresh)中的 url、dir 的总量限制为 240。
* 每个请求中 url 的条数限制为 60 。
## 响应状态码
HTTP状态码 | 含义 | 说明
---|---|---
400031 | invalid url | 请求中存在无效的 url，请确保提交的 url 格式正确
400032 | invalid host | 请求中存在无效的域名，请确保域名格式正确
400033 | prefetch url limit error | 请求次数超出当日预取限额
400036 | invalid request id | 无效的请求 id
400037 | url has existed | url 正在预取中
403024 | single user QPS Rate limited | 请求达到单用户QPS限制，请重试或联系我们
403022 | server QPS Rate limited | 请求达到全局QPS限制，请联系我们
500000 | internal error | 服务端内部错误，请联系技术支持
## 响应内容
HTTP/1.1 200 OK
Content-Type: application/json
{
"code": <custom code>,
"error": <error string>,
"requestId": <request id>,
"invalidUrls": [<url1>, <url2>, <url3>, ...],
"quotaDay": <quota one day >,
"surplusDay": <surplus one day >,
}
参数 | 类型 | 说明 |
---|---|---|---
code | int | HTTP 状态码，整型，见响应状态码 |
error | string | HTTP 状态码说明，字符串 |
requestId | string | 预取请求 id，只有在任务被接受时才有值 |
invalidUrls | string array | 无效的 url 列表 |
quotaDay | int | 每日的预取 url 限额 |
surplusDay | int | 每日的当前剩余的预取 url 限额 |
### 注意事项
* 在请求成功时 code 为 200，requestId、quotaDay、surplusDay 才会有有效值，否则为空。
* 在请求失败时 code 为非 200，error 中包含描述信息。
## 预取示例
下面是命令行示例：
请求命令示例：
第一步生成token：
echo "/v2/tune/prefetch" |openssl dgst -binary -hmac "用户SK" -sha1 |base64 | tr + - | tr / _ 回车
生成的token
第二步请求数据：
curl -X POST -H "Authorization: QBox <用户AK>:<生成的token>" http://fusion.qiniuapi.com/v2/tune/prefetch -d '{"urls":["<用户url>"], "product":"dcdn"}' -H 'Content-Type: application/json'
响应内容示例：
{"code":200,"error":"success","requestId":"577471ace3ab3a030c058972","invalidUrls":null,"quotaDay":100,"surplusDay":99}
# 预取查询
## 接口地址
/v2/tune/prefetch/list
## 请求语法
POST http://<Host>/v2/tune/prefetch/list
Authorization:<access_token>
{
"requestId": <request id>,
"urls":[<url1>, <url2>, <url3>, ...],
"state": <state>,
"pageNo": <page no>,
"pageSize": <page size>,
"startTime": <startTime>,
"endTime": <endTime>,
"product": "dcdn",
}
## 请求内容
参数 | 类型 | 必要性 | 说明
---|---|---|---
requestId | string | 可选 | 指定要查询记录所在的预取请求id。
urls | string | 可选 | 要查询的url列表
state | string | 可选 | 指定要查询记录的状态，取值processing／success／failure。
pageNo | int | 可选 | 要求返回的页号，默认为0。
pageSize | int | 可选 | 要求返回的页长度，默认为100。
startTime | string | 可选 | 指定查询的开始日期，格式2006-01-01
endTime | string | 可选 | 指定查询的结束日期，格式2006-01-01
product | string | 必选 | 此处填写固定值 dcdn
### 注意事项
* 输入参数可选部分全部为空时，服务端返回无效参数错误。
* 查询的时间范围：当天至当天的前6天（共7天)。
* startTime和endTime任一缺失的情况下，查询默认返回近3天的操作记录。
## 响应状态码
HTTP状态码 | 含义 | 说明
---|---|---
200 | success | 成功
400000 | invalid input | 无效的输入参数
500000 | internal error | 服务端内部错误
500005 | query data error | 服务端查询数据错误
## 响应内容
HTTP/1.1 200 OK
Content-Type: application/json
{
"code": <custom code>,
"error": <error string>,
"total": <total count>,
"pageNo": <page no>,
"pageSize": <page size>,
"currentSize": <current size>,
"items": [{
"uid": <user uid>,
"requestId": <request id>,
"url": <url>,
"state": <state>,
"stateDetail": <stateDetail>,
"createAt": <create time>,
"beginAt": <begin time>,
"endAt": <end time>,
}, ...],
}
参数 | 类型 | 说明
---|---|---
code | int | 自定义错误码，整型，见自定义状态码
error | string | 自定义错误码描述，字符串
total | int | 当前条件下查询的记录总数
pageNo | int | 要查询的页号
pageSize | int | 要返回的页长度
currentSize | int | 当前实际返回的页长度
uid | int | 用户id
requestId | string | 记录所在的预取请求id
url | string | url
state | string | 预取状态，取值为success/processing／failure
stateDetail | string | 预取状态描述信息
createAt | string | 当前记录创建时间，格式为xxxx-xx-xx xx:xx:xx，例如2015-11-01 16:05:05
beginAt | string | 当前记录开始时间，格式为xxxx-xx-xx xx:xx:xx，例如2015-11-01 16:05:25。
endAt | string | 当前记录结束时间，格式为xxxx-xx-xx xx:xx:xx，例如2015-11-01 16:09:05。
## 预取查询示例
下面是命令行示例：
请求命令示例：
第一步生成token：
echo "/v2/tune/prefetch/list" |openssl dgst -binary -hmac "用户SK" -sha1 |base64 | tr + - | tr / _ 回车
生成的token
第二步请求数据：
curl -X POST -H "Authorization: QBox <用户AK>:<生成的token>" http://fusion.qiniuapi.com/v2/tune/prefetch/list -d '{"urls":["<用户url>","pageNo":<page no>,"pageSize":<page size>],"product":"dcdn"}' -H 'Content-Type: application/json'
响应内容示例：
{"code":200,"error":"success","total":1,"pageNo":0,"pageSize":10,"currentSize":1,"items":[{"uid":1100000009,"requestId":"57edcafafawwqtqt211e303b","url":"http://www.test.com/test01","state":"success","stateDetail":"","createAt":"2015-09-11 10:29:46","beginAt":"2015-11-30 10:29:48","endAt":"2015-11-30 10:30:08"}]}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[全站加速](https://developer.qiniu.com/dcdn) > API 文档 > 文件预取与查询
# 文件预取与查询
最近更新时间: 2022-02-09 19:22:22
文件预取，也可称为预加热或预缓存，是指客户新资源提前由 CDN 拉取到 CDN 缓存节点。具体做法是客户提交资源 url 到 CDN，由 CDN
来操作预取。
# 访问域名
Host: fusion.qiniuapi.com
# 认证授权
Authorization: <access_token>
access_token 详细描述请查阅[这里](https://developer.qiniu.com/kodo/manual/access-
token)。
# 预取
## 接口地址
/v2/tune/prefetch
## 请求语法
POST /v2/tune/prefetch HTTP/1.1
Authorization:<access_token>
Content-Type: application/json
{
"urls": [<url1>, <url2>, <url3>, ......],
"product": "dcdn"
}
## 请求内容
参数 | 类型 | 必要性 | 说明
---|---|---|---
urlN | array | 必选 | 要预取的单个url列表，总数不超过60条；单个url，即一个具体的url，例如：`http://bar.foo.com/test.zip`
product | string | 必选 | 此处填写固定值 dcdn
### 注意事项
* 请输入资源 url 完整的绝对路径，由 http:// 或 https:// 开始。
* 资源 url 不支持通配符，例如：不支持 `http://www.test.com/abc/\*.\*`。
* 请求数量限制，以下限制达到任意一个即触发限制：
* 每秒钟预取请求和[刷新请求 __](https://developer.qiniu.com/fusion/api/1229/cache-refresh)中的 url、dir 的总量限制为 240。
* 每个请求中 url 的条数限制为 60 。
## 响应状态码
HTTP状态码 | 含义 | 说明
---|---|---
400031 | invalid url | 请求中存在无效的 url，请确保提交的 url 格式正确
400032 | invalid host | 请求中存在无效的域名，请确保域名格式正确
400033 | prefetch url limit error | 请求次数超出当日预取限额
400036 | invalid request id | 无效的请求 id
400037 | url has existed | url 正在预取中
403024 | single user QPS Rate limited | 请求达到单用户QPS限制，请重试或联系我们
403022 | server QPS Rate limited | 请求达到全局QPS限制，请联系我们
500000 | internal error | 服务端内部错误，请联系技术支持
## 响应内容
HTTP/1.1 200 OK
Content-Type: application/json
{
"code": <custom code>,
"error": <error string>,
"requestId": <request id>,
"invalidUrls": [<url1>, <url2>, <url3>, ...],
"quotaDay": <quota one day >,
"surplusDay": <surplus one day >,
}
参数 | 类型 | 说明 |
---|---|---|---
code | int | HTTP 状态码，整型，见响应状态码 |
error | string | HTTP 状态码说明，字符串 |
requestId | string | 预取请求 id，只有在任务被接受时才有值 |
invalidUrls | string array | 无效的 url 列表 |
quotaDay | int | 每日的预取 url 限额 |
surplusDay | int | 每日的当前剩余的预取 url 限额 |
### 注意事项
* 在请求成功时 code 为 200，requestId、quotaDay、surplusDay 才会有有效值，否则为空。
* 在请求失败时 code 为非 200，error 中包含描述信息。
## 预取示例
下面是命令行示例：
请求命令示例：
第一步生成token：
echo "/v2/tune/prefetch" |openssl dgst -binary -hmac "用户SK" -sha1 |base64 | tr + - | tr / _ 回车
生成的token
第二步请求数据：
curl -X POST -H "Authorization: QBox <用户AK>:<生成的token>" http://fusion.qiniuapi.com/v2/tune/prefetch -d '{"urls":["<用户url>"], "product":"dcdn"}' -H 'Content-Type: application/json'
响应内容示例：
{"code":200,"error":"success","requestId":"577471ace3ab3a030c058972","invalidUrls":null,"quotaDay":100,"surplusDay":99}
# 预取查询
## 接口地址
/v2/tune/prefetch/list
## 请求语法
POST http://<Host>/v2/tune/prefetch/list
Authorization:<access_token>
{
"requestId": <request id>,
"urls":[<url1>, <url2>, <url3>, ...],
"state": <state>,
"pageNo": <page no>,
"pageSize": <page size>,
"startTime": <startTime>,
"endTime": <endTime>,
"product": "dcdn",
}
## 请求内容
参数 | 类型 | 必要性 | 说明
---|---|---|---
requestId | string | 可选 | 指定要查询记录所在的预取请求id。
urls | string | 可选 | 要查询的url列表
state | string | 可选 | 指定要查询记录的状态，取值processing／success／failure。
pageNo | int | 可选 | 要求返回的页号，默认为0。
pageSize | int | 可选 | 要求返回的页长度，默认为100。
startTime | string | 可选 | 指定查询的开始日期，格式2006-01-01
endTime | string | 可选 | 指定查询的结束日期，格式2006-01-01
product | string | 必选 | 此处填写固定值 dcdn
### 注意事项
* 输入参数可选部分全部为空时，服务端返回无效参数错误。
* 查询的时间范围：当天至当天的前6天（共7天)。
* startTime和endTime任一缺失的情况下，查询默认返回近3天的操作记录。
## 响应状态码
HTTP状态码 | 含义 | 说明
---|---|---
200 | success | 成功
400000 | invalid input | 无效的输入参数
500000 | internal error | 服务端内部错误
500005 | query data error | 服务端查询数据错误
## 响应内容
HTTP/1.1 200 OK
Content-Type: application/json
{
"code": <custom code>,
"error": <error string>,
"total": <total count>,
"pageNo": <page no>,
"pageSize": <page size>,
"currentSize": <current size>,
"items": [{
"uid": <user uid>,
"requestId": <request id>,
"url": <url>,
"state": <state>,
"stateDetail": <stateDetail>,
"createAt": <create time>,
"beginAt": <begin time>,
"endAt": <end time>,
}, ...],
}
参数 | 类型 | 说明
---|---|---
code | int | 自定义错误码，整型，见自定义状态码
error | string | 自定义错误码描述，字符串
total | int | 当前条件下查询的记录总数
pageNo | int | 要查询的页号
pageSize | int | 要返回的页长度
currentSize | int | 当前实际返回的页长度
uid | int | 用户id
requestId | string | 记录所在的预取请求id
url | string | url
state | string | 预取状态，取值为success/processing／failure
stateDetail | string | 预取状态描述信息
createAt | string | 当前记录创建时间，格式为xxxx-xx-xx xx:xx:xx，例如2015-11-01 16:05:05
beginAt | string | 当前记录开始时间，格式为xxxx-xx-xx xx:xx:xx，例如2015-11-01 16:05:25。
endAt | string | 当前记录结束时间，格式为xxxx-xx-xx xx:xx:xx，例如2015-11-01 16:09:05。
## 预取查询示例
下面是命令行示例：
请求命令示例：
第一步生成token：
echo "/v2/tune/prefetch/list" |openssl dgst -binary -hmac "用户SK" -sha1 |base64 | tr + - | tr / _ 回车
生成的token
第二步请求数据：
curl -X POST -H "Authorization: QBox <用户AK>:<生成的token>" http://fusion.qiniuapi.com/v2/tune/prefetch/list -d '{"urls":["<用户url>","pageNo":<page no>,"pageSize":<page size>],"product":"dcdn"}' -H 'Content-Type: application/json'
响应内容示例：
{"code":200,"error":"success","total":1,"pageNo":0,"pageSize":10,"currentSize":1,"items":[{"uid":1100000009,"requestId":"57edcafafawwqtqt211e303b","url":"http://www.test.com/test01","state":"success","stateDetail":"","createAt":"2015-09-11 10:29:46","beginAt":"2015-11-30 10:29:48","endAt":"2015-11-30 10:30:08"}]}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,340 |
服务保障协议(SLA) | 全站加速 | [全站加速](https://developer.qiniu.com/dcdn) > 服务协议 > 服务保障协议(SLA)
# 服务保障协议(SLA)
最近更新时间: 2022-02-09 12:24:13
# 1\. 服务内容
七牛云全站加速服务 （Dynamic Route for Content Delivery Network，简称"DCDN"） 在 CDN
基础上融合动态加速的能力，静态资源自动分发缓存至七牛云服务节点，动态资源选择最优路径回源，从而缩短用户查看对象的延迟，提高用户访问网站的响应速度与网站的可用性，解决网络带宽小、用户访问量大、网点分布不均等问题。
# 2\. 定义
* 服务：指七牛云 CDN 根据本协议向开发者提供的付费服务（未付费情况，不适用本协议）。
* 动态资源：指用户使用七牛云 DCDN 服务的域名下所有文件后缀为.asp、.jsp、.php、.cgi 、.perl 、API 接口等动态文件。
* 静态资源：指网页/图片/下载内容/点播流媒体内容等文件。
* 服务周期：以一个自然月做为一个服务周期，如果不满一个月则按一个月计算。
* 服务区域：中国大陆地区。
* 服务周期总分钟数：按照每月每周 7（七）天每天 24（二十四）小时计算。
* 失败请求：因 DCDN 系统原因导致的域名返回的 5XX 请求和因为 DCDN 服务故障导致用户正常请求未能到达 DCDN 服务器端的请求视为失败请求。因 DCDN 服务故障导致的用户正常请求未能到达 DCDN 服务器端的失败请求，将通过故障前 7 天内用户域名的平均请求数计算。
* 有效请求：客户在七牛云服务账号下所有 DCDN 的域名加速服务，在 DCDN 服务器收到的请求视为有效请求。
* 每 5 分钟错误率：每 5 分钟错误率=（每 5 分钟失败请求数/每 5 分钟有效请求总数）* 100 %
* 不可用时间：DCDN 在连续的 10 分钟或更长时间出现每 5 分钟错误率大于 0.05 % 的情况，方计为不可用时间。
* 月度服务费用：客户在一个自然月中在七牛云账号下 DCDN 产品服务费用总额。
# 3\. 指标项
## 3.1 服务可用性
* 七牛云 DCDN 保证用户购买的服务的“服务可用性”达到 99.9 %，即每月服务不可用时间累计小于 44 分钟。
服务可用性计算公式：域名服务周期内正常服务时间 / 域名服务周期内可服务总时间。
* 服务可用性按服务周期统计，一个服务周期为一个自然月，如不满一个月不计算为一个服务周期。
* 统计对象为某一七牛云账户下的所有开启 DCDN 服务的域名（月请求量小于 100 万的域名除外）。
* 七牛云 DCDN 服务的不可用时间不包括日常系统维护时间、由用户原因、第三方原因或不可抗力导致的不可用时间。
## 3.2 私密性
用户在七牛云 DCDN 服务创建的加速域名等资源，在未经用户合法授权的情况下，其他用户无法对其配置进行更改。七牛云为用户分配最多 2 对 Access
Key ID/Secret Access Key 密钥对，从七牛云服务访问接口上进行权限控制和隔离，保障用户数据的私密性。
## 3.3 可审查性
依据现行法律法规或根据政府监管部门监管、安全合规、审计或取证调查等原因的需要，在符合流程和手续完备的情况下，七牛云可以提供用户所使用的服务的相关信息。
## 3.4 服务资源调配能力
七牛云 DCDN 为用户提供内容分发、加速服务，并支持引入安全防护功能，保障用户源站安全。用户申请使用 DCDN
服务时，不设置带宽、存储限制，根据需要，容量将实时动态扩展。随着访问量的增长， DCDN
后台的带宽、存储处理能力会自动扩展，无需用户干预，但大规模流量突增（业务突发增长大于上月计费带宽的30%或总带宽增加50Gbps以上），需至少提前3个工作日告知七牛云服务团队，否则将可能影响可用性，即若因此影响服务可用性的，七牛云不承担责任。
在未提前告知的情况下，七牛云DCDN服务可提供额外30%以内（包含）上月计费带宽供客户使用，确保接入的域名可用性不会明显降低。
## 3.5 故障恢复能力及客服保证
七牛云 DCDN
为用户提供全天候的运行维护，并以在线自助工单系统、客服电话报障等方式提供技术支持。七牛云具备完善的故障监控、自动告警、快速定位、快速恢复等一系列故障应急响应机制。
客服咨询电话：400-808-9176；服务时间：7*24 小时。
## 3.6 网络接入性能
七牛云 DCDN 对用户不限制公网出口带宽，七牛云在全国部署数百个缓存节点，保障用户的网络接入质量。
## 3.7 服务计量准确性
七牛云 DCDN 服务具备准确、透明的计量计费系统。七牛云 DCDN 根据用户的实际使用量据实结算，价格及计费模式见七牛云官网。
# 4\. 服务赔偿条款
## 4.1 赔偿范围
因七牛云设备故障、设计缺陷或操作不当导致用户所购买的 DCDN 服务无法正常使用，七牛云将对不可用时间进行赔偿，但不包括以下原因所导致的服务不可用时间：
* 七牛云预先通知用户后进行系统维护所引起的，包括割接、维修、升级和模拟故障演练；
* 任何七牛云所属设备以外的网络、设备故障或配置调整引起的；
* 用户的应用程序或数据信息受到黑客攻击而引起的；
* 用户维护不当或保密不当致使数据、口令、密码等丢失或泄漏所引起的；
* 用户自行升级操作系统所引起的；
* 用户的应用程序或安装活动所引起的；
* 用户的疏忽或由用户授权的操作所引起的；
* 不可抗力以及意外事件引起的；
* 其他非七牛云原因所造成的不可用。
## 4.2 赔偿方案
七牛云对用户存在故障的每个域名按不可用时间进行 10 倍赔偿，赔付金额 = 发生故障的域名故障前 24 小时平均每分钟费用 × 故障不可用时间 × 10
倍。
* 赔偿只针对使用 DCDN 服务已产生费用的用户，以代金券的形式赔偿，不折算现金返还。
* 故障不可用时间 = 故障解决时间 - 故障开始时间，不可用时间按分钟计算。
* 如果用户没有使用到 24 小时，按实际使用时长计算平均每分钟费用。
* 赔付金额不超过客户对该故障域名所消费的费用平均值（故障当月前12个月费用折算平均值）或故障当月客户消费的月度服务费用的25%（服务不满12个月，不包含本月）。
## 4.3 赔偿申请时限
客户可在每月第五个工作日之后对上个自然月没有达到可用性的情况提出赔偿申请。赔偿申请必须限于在DCDN服务没有达到可用性的相关月份结束后两个月内提出；超出申请时限的赔偿申请将不被受理。
# 5\. 免责声明
详见[《七牛云服务用户协议》 __](https://www.qiniu.com/user-agreement)中的"免责声明"相关条款内容。
# 6\. 其他
* 本协议一经公布立即生效，七牛云有权随时对协议内容进行修改。如用户不同意七牛云对本协议相关内容所做的修改，用户有权停止使用七牛云 DCDN 服务。若用户继续使用七牛云 DCDN 服务，则视为用户接受七牛云对本协议相关内容所做的修改。
* 本协议项下七牛云 DCDN 服务对于用户所有的通知均可通过网页公告、站内信、电子邮件、手机短信或其他形式等方式进行；该通知于发送之日视为已送达收件人。
* 本协议的订立、执行和解释及争议的解决均应适用中国法律并受中国法院管辖。如双方就本协议内容或其执行发生任何争议，双方应尽量友好协商解决；协商不成时，任何一方均可向上海市浦东新区人民法院提起诉讼。
* 本协议构成双方对本协议之约定事项及其他有关事宜的完整协议，除本协议规定的之外，未赋予本协议各方其他权利。
* 如本协议中的任何协议无论因何种原因完全或部分无效或不具有执行力，本协议的其余协议仍应有效并且有约束力。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[全站加速](https://developer.qiniu.com/dcdn) > 服务协议 > 服务保障协议(SLA)
# 服务保障协议(SLA)
最近更新时间: 2022-02-09 12:24:13
# 1\. 服务内容
七牛云全站加速服务 （Dynamic Route for Content Delivery Network，简称"DCDN"） 在 CDN
基础上融合动态加速的能力，静态资源自动分发缓存至七牛云服务节点，动态资源选择最优路径回源，从而缩短用户查看对象的延迟，提高用户访问网站的响应速度与网站的可用性，解决网络带宽小、用户访问量大、网点分布不均等问题。
# 2\. 定义
* 服务：指七牛云 CDN 根据本协议向开发者提供的付费服务（未付费情况，不适用本协议）。
* 动态资源：指用户使用七牛云 DCDN 服务的域名下所有文件后缀为.asp、.jsp、.php、.cgi 、.perl 、API 接口等动态文件。
* 静态资源：指网页/图片/下载内容/点播流媒体内容等文件。
* 服务周期：以一个自然月做为一个服务周期，如果不满一个月则按一个月计算。
* 服务区域：中国大陆地区。
* 服务周期总分钟数：按照每月每周 7（七）天每天 24（二十四）小时计算。
* 失败请求：因 DCDN 系统原因导致的域名返回的 5XX 请求和因为 DCDN 服务故障导致用户正常请求未能到达 DCDN 服务器端的请求视为失败请求。因 DCDN 服务故障导致的用户正常请求未能到达 DCDN 服务器端的失败请求，将通过故障前 7 天内用户域名的平均请求数计算。
* 有效请求：客户在七牛云服务账号下所有 DCDN 的域名加速服务，在 DCDN 服务器收到的请求视为有效请求。
* 每 5 分钟错误率：每 5 分钟错误率=（每 5 分钟失败请求数/每 5 分钟有效请求总数）* 100 %
* 不可用时间：DCDN 在连续的 10 分钟或更长时间出现每 5 分钟错误率大于 0.05 % 的情况，方计为不可用时间。
* 月度服务费用：客户在一个自然月中在七牛云账号下 DCDN 产品服务费用总额。
# 3\. 指标项
## 3.1 服务可用性
* 七牛云 DCDN 保证用户购买的服务的“服务可用性”达到 99.9 %，即每月服务不可用时间累计小于 44 分钟。
服务可用性计算公式：域名服务周期内正常服务时间 / 域名服务周期内可服务总时间。
* 服务可用性按服务周期统计，一个服务周期为一个自然月，如不满一个月不计算为一个服务周期。
* 统计对象为某一七牛云账户下的所有开启 DCDN 服务的域名（月请求量小于 100 万的域名除外）。
* 七牛云 DCDN 服务的不可用时间不包括日常系统维护时间、由用户原因、第三方原因或不可抗力导致的不可用时间。
## 3.2 私密性
用户在七牛云 DCDN 服务创建的加速域名等资源，在未经用户合法授权的情况下，其他用户无法对其配置进行更改。七牛云为用户分配最多 2 对 Access
Key ID/Secret Access Key 密钥对，从七牛云服务访问接口上进行权限控制和隔离，保障用户数据的私密性。
## 3.3 可审查性
依据现行法律法规或根据政府监管部门监管、安全合规、审计或取证调查等原因的需要，在符合流程和手续完备的情况下，七牛云可以提供用户所使用的服务的相关信息。
## 3.4 服务资源调配能力
七牛云 DCDN 为用户提供内容分发、加速服务，并支持引入安全防护功能，保障用户源站安全。用户申请使用 DCDN
服务时，不设置带宽、存储限制，根据需要，容量将实时动态扩展。随着访问量的增长， DCDN
后台的带宽、存储处理能力会自动扩展，无需用户干预，但大规模流量突增（业务突发增长大于上月计费带宽的30%或总带宽增加50Gbps以上），需至少提前3个工作日告知七牛云服务团队，否则将可能影响可用性，即若因此影响服务可用性的，七牛云不承担责任。
在未提前告知的情况下，七牛云DCDN服务可提供额外30%以内（包含）上月计费带宽供客户使用，确保接入的域名可用性不会明显降低。
## 3.5 故障恢复能力及客服保证
七牛云 DCDN
为用户提供全天候的运行维护，并以在线自助工单系统、客服电话报障等方式提供技术支持。七牛云具备完善的故障监控、自动告警、快速定位、快速恢复等一系列故障应急响应机制。
客服咨询电话：400-808-9176；服务时间：7*24 小时。
## 3.6 网络接入性能
七牛云 DCDN 对用户不限制公网出口带宽，七牛云在全国部署数百个缓存节点，保障用户的网络接入质量。
## 3.7 服务计量准确性
七牛云 DCDN 服务具备准确、透明的计量计费系统。七牛云 DCDN 根据用户的实际使用量据实结算，价格及计费模式见七牛云官网。
# 4\. 服务赔偿条款
## 4.1 赔偿范围
因七牛云设备故障、设计缺陷或操作不当导致用户所购买的 DCDN 服务无法正常使用，七牛云将对不可用时间进行赔偿，但不包括以下原因所导致的服务不可用时间：
* 七牛云预先通知用户后进行系统维护所引起的，包括割接、维修、升级和模拟故障演练；
* 任何七牛云所属设备以外的网络、设备故障或配置调整引起的；
* 用户的应用程序或数据信息受到黑客攻击而引起的；
* 用户维护不当或保密不当致使数据、口令、密码等丢失或泄漏所引起的；
* 用户自行升级操作系统所引起的；
* 用户的应用程序或安装活动所引起的；
* 用户的疏忽或由用户授权的操作所引起的；
* 不可抗力以及意外事件引起的；
* 其他非七牛云原因所造成的不可用。
## 4.2 赔偿方案
七牛云对用户存在故障的每个域名按不可用时间进行 10 倍赔偿，赔付金额 = 发生故障的域名故障前 24 小时平均每分钟费用 × 故障不可用时间 × 10
倍。
* 赔偿只针对使用 DCDN 服务已产生费用的用户，以代金券的形式赔偿，不折算现金返还。
* 故障不可用时间 = 故障解决时间 - 故障开始时间，不可用时间按分钟计算。
* 如果用户没有使用到 24 小时，按实际使用时长计算平均每分钟费用。
* 赔付金额不超过客户对该故障域名所消费的费用平均值（故障当月前12个月费用折算平均值）或故障当月客户消费的月度服务费用的25%（服务不满12个月，不包含本月）。
## 4.3 赔偿申请时限
客户可在每月第五个工作日之后对上个自然月没有达到可用性的情况提出赔偿申请。赔偿申请必须限于在DCDN服务没有达到可用性的相关月份结束后两个月内提出；超出申请时限的赔偿申请将不被受理。
# 5\. 免责声明
详见[《七牛云服务用户协议》 __](https://www.qiniu.com/user-agreement)中的"免责声明"相关条款内容。
# 6\. 其他
* 本协议一经公布立即生效，七牛云有权随时对协议内容进行修改。如用户不同意七牛云对本协议相关内容所做的修改，用户有权停止使用七牛云 DCDN 服务。若用户继续使用七牛云 DCDN 服务，则视为用户接受七牛云对本协议相关内容所做的修改。
* 本协议项下七牛云 DCDN 服务对于用户所有的通知均可通过网页公告、站内信、电子邮件、手机短信或其他形式等方式进行；该通知于发送之日视为已送达收件人。
* 本协议的订立、执行和解释及争议的解决均应适用中国法律并受中国法院管辖。如双方就本协议内容或其执行发生任何争议，双方应尽量友好协商解决；协商不成时，任何一方均可向上海市浦东新区人民法院提起诉讼。
* 本协议构成双方对本协议之约定事项及其他有关事宜的完整协议，除本协议规定的之外，未赋予本协议各方其他权利。
* 如本协议中的任何协议无论因何种原因完全或部分无效或不具有执行力，本协议的其余协议仍应有效并且有约束力。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,350 |
互动直播 | 低代码 | [低代码](https://developer.qiniu.com/lowcode) > 使用文档 > 互动直播
# 互动直播
最近更新时间: 2022-07-11 10:22:12
介绍低代码互动直播使用。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[低代码](https://developer.qiniu.com/lowcode) > 使用文档 > 互动直播
# 互动直播
最近更新时间: 2022-07-11 10:22:12
介绍低代码互动直播使用。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,356 |
互动直播服务端接入指南 | 低代码 | [低代码](https://developer.qiniu.com/lowcode) > 使用文档 >
[互动直播](https://developer.qiniu.com/lowcode/manual/12004/qlive) > 互动直播服务端接入指南
# 互动直播服务端接入指南
最近更新时间: 2023-03-28 17:23:02
# 1\. 项目编译运行
## 1.1 项目编译
* 本项目使用go 1.16 编译
1. clone 项目
git clone https://github.com/pili-engineering/QNLiveKit_Server
2. 编译
cd QNLiveKit_Server/app/live
go build
* 在当前目录下，生成可执行文件 live
## 1.2 项目运行
* 项目的运行，需要提供一个配置文件 config.yaml。配置文件的说明，见后面。
./live -f config.yaml 2>&1 > live.log &
# 2\. 配置文件
* 互动直播使用 yaml 格式的配置文件，文件内容如下所示：
node_id: {{ nodeId }}
service:
host: {{ host }}
port: {{ port }}
jwt_key: {{ jwt_key }}
callback: https://niucube-api.qiniu.com/v1/live/callback
censor_callback: https://{{xxx}}
censor_bucket: {{ censor_bucket }}
censor_addr:https://{{xxx}}
gift_addr: https://{{xxx}}
cache_config:
type: {{type}}
addr: {{host:ip}}
mysqls:
- host: 127.0.0.1
port: 3306
username: {{ user }}
password: {{ password }}
max_idle_conns: 10
max_open_conns: 100
database: live
conn_max_life_time: 5
default: live
- host: 127.0.0.1
port: 3306
username: {{ user }}
password: {{ password }}
max_idle_conns: 10
max_open_conns: 100
database: live
conn_max_life_time: 5
default: live
read_only: true
mac_config:
enable: true
access_key: ak
secret_key: sk
im_config:
app_id: {{ im_app_id }}
endpoint: {{ im_endpoint }}
token: {{ im_admin_token }}
rtc_config:
app_id: {{ app_id }}
access_key: {{ ak }}
secret_key: {{ sk }}
room_token_expire_s: 3600
hub: {{ 直播hub }}
security_type: none
publish_key: {{ publish_key }}
publish_expire_s: 3600
playback_url: https://{{xxx}}-playback.com
stream_pattern: qn_live_kit-%s
publish_url: rtmp://{{xxx}}-publish.com
publish_domain: {{xxx}}-publish.com
rtmp_play_url: rtmp://{{xxx}}-rtmp.com
flv_play_url: https://{{xxx}}-hdl.com
hls_play_url: https://{{xxx}}-hls.com
prome_config:
client_mode: pusher
exporter_config:
listen_addr: ":9200"
pusher_config:
url: "https://{{xxx}}"
job: live
instance: live_{{.node}}
interval_s: 10
cron_config:
single_task_node: 1
## **2.1 基本配置**
### node配置
node_id: {{ nodeId }}
字段名 | 类型 | 示例 | 说明
---|---|---|---
node_id | int | 1 | 互动直播支持分布式部署，每个节点指定一个nodeId。所有节点的nodeId 不能重复。
nodeId 会用于内部的ID 生成。
### service
service:
host: {{ host }}
port: {{ port }}
* 互动直播服务提供HTTP RESTful API 接口。service 配置服务的监听地址。
字段名 | 类型 | 示例 | 说明
---|---|---|---
host | string | 127.0.0.1（本地） | 监听的IP，部署在服务器上可为空或填0.0.0.0
port | int | 8080 | 监听的端口
### jwt_key
jwt_key: {{ jwt_key }}
* 字符串
* 用于客户端鉴权token 的加解密
### callback
callback: {{ callback_addrs }}
字段名 | 类型 | 示例 | 说明
---|---|---|---
callback | string | https://niucube-api.qiniu.com/v1/live/callback | 配置低代码服务的回调地址,该地址由业务服务来实现.
低代码服务会将状态信息，通过回调的方式，通知给业务服务
## **2.2 Redis 配置**
cache_config:
type: node
addr: {{ip:port}}
# password: {{password}}
或者
cache_config:
type: cluster
addrs:
- {{ip:port}}
- {{ip:port}}
# password: {{password}}
字段名 | 类型 | 示例 | 说明
---|---|---|---
type | string | node/cluster | 低代码服务，使用redis 作为缓存。支持redis 单节点模式，与集群模式。
node：单节点模式
cluster：集群模式
addr | string | addr: 127.0.0.1:6379 | 配置type为node时，必须配置单节点redis 的地址。
addrs | | 如上所示 | 配置type为cluster时，必须配置的redis集群地址列表。
password | string | | redis如果设置密码，取消注释，填入密码；没设置密码，不需要password字端
## **2.3 数据库配置**
mysqls:
- host: 127.0.0.1
port: 3306
username: {{ user }}
password: {{ password }}
max_idle_conns: 10
max_open_conns: 100
database: live
conn_max_life_time: 5
default: live
- host: 127.0.0.1
port: 3306
username: {{ user }}
password: {{ password }}
max_idle_conns: 10
max_open_conns: 100
database: live
conn_max_life_time: 5
default: live
read_only: true
* 使用读写分离模式，必须其一包含配置项read_only: true
* 互动直播服务使用mysql 进行业务数据存储。
* 支持配置多个数据库。
## **2.4 面向服务的鉴权配置**
mac_config:
enable: true
access_key: {{ ak }}
secret_key: {{ sk }}
字段名 | 类型 | 示例 | 说明
---|---|---|---
enable | bool | true | enable：true，开启鉴权；false，关闭鉴权。如果互动直播服务，与需要调用互动直播服务接口的其他服务，在同一个安全局域网内，可以关闭服务端接口的鉴权。
access_key | string | ak | 互动直播服务，提供面向服务端的接口，与面向客户端的接口。面向服务端的接口，使用 ak/sk 的鉴权方式。这里的access_key自行定义
secret_key | string | sk | secret key 自行定义
## **2.5 im_config**
im_config:
app_id: {{ im_app_id }}
endpoint: {{ im_endpoint }}
token: {{ im_admin_token }}
字段名 | 类型 | 示例 | 说明 |
---|---|---|---|---
app_id | string | | 互动直播服务，使用七牛IM 作为即时通信消息服务。
app_id：创建IM App时，为App生成的唯一标识 |
endpoint | string | | endpoint：App所在API服务的地址 ，参考 [IM服务接入指南 __](https://developer.qiniu.com/IM/8332/startim)与[IM服务端接入指南 __](https://developer.qiniu.com/IM/8102/im-service-integration-guide)|
token | string | | token：IM中获取的管理员token，参考 [IM服务接入指南 __](https://developer.qiniu.com/IM/8332/startim)与[IM服务端接入指南 __](https://developer.qiniu.com/IM/8102/im-service-integration-guide)|
## **2.6 rtc_config**
rtc_config:
app_id: {{ app_id }}
access_key: {{ ak }}
secret_key: {{ ak }}
room_token_expire_s: 3600
hub: {{ 直播hub }}
security_type: none
publish_key: {{ publish_key }}
publish_expire_s: 3600
stream_pattern: qn_live_kit-%s
playback_url: https://{{xxx}}-playback.com
publish_url: rtmp://{{xxx}}-publish.com
publish_domain: {{xxx}}-publish.com
rtmp_play_url: rtmp://{{xxx}}-rtmp.com
flv_play_url: https://{{xxx}}-hdl.com
hls_play_url: https://{{xxx}}-hls.com
字段名 | 类型 | 示例 | 说明
---|---|---|---
app_id | string | | 互动直播服务，使用七牛的RTC 服务，作为连麦服务。
RTC 应用的配置，参考：[管理实时音视频 __](https://developer.qiniu.com/rtc/9858/applist)
access_key | string | | 七牛对API请求鉴权，用户需要使用密钥（AccessKey/SecretKey）进行身份验证。此处填入AccessKey
secret_key | string | | 此处填入SecretKey，第一次使用七牛API之前，您需要在七牛开发者平台的 [密钥管理 __](https://portal.qiniu.com/user/key)中取得密钥
room_token_expire_s | int | 3600 |
hub | string | live | 直播空间信息，参考：[直播云 __](https://developer.qiniu.com/pili)
security_type | string | none/expiry/expiry_sk | 推流鉴权方式,详情见下表
publish_key | string | | 详情见下表
publish_expire_s | int | 3600 |
stream_pattern | string | qn_live_kit-%s |
playback_url | string | | 域名管理-加速域名-点播域名
publish_url | string | rtmp:// 前缀 | 域名管理-直播域名-推流域名
publish_domain | string | | 域名管理-直播域名-推流域名
rtmp_play_url | string | rtmp:// 前缀 | 域名管理-直播域名-RTMP播放域名
flv_play_url | string | | 域名管理-直播域名- HDL播放域名
hls_play_url | string | | 域名管理-直播域名-HLS播放域名
* 直播推流鉴权说明：目前直播推流鉴权，支持三种方式：无鉴权，限时鉴权，限时鉴权SK，不同鉴权模式的配置方式如下
鉴权模式 | security_type | publish_key | publish_expire_s
---|---|---|---
无鉴权 | none | 无需指定，留空 | 过期时间秒。如：3600 表示 一小时后过期，推流URL 过期
限时鉴权 | expiry | 使用配置的key 鉴权。从【直播空间设置】获取key | 同上
限时鉴权SK | expiry_sk | 使用RTC 用户的SK 鉴权。无需配置，留空。 | 同上
## **2.7 Prometheus系统监控配置**
prome_config:
client_mode: exporter
exporter_config:
listen_addr: ":9200"
或
prome_config:
client_mode: pusher
pusher_config:
url: "https://{{xxx}}"
job: live
instance: live_{{.node}}
interval_s: 10
低代码服务运行过程中，生成prometheus 监控数据指标。
字段名 | 类型 | 示例 | 说明
---|---|---|---
client_mode | string | exporter/pusher | client_mode：指标导出模式配置，支持的模式如下
exporter：exporter 模式，开启http 监听，由prometheus 服务来拉取。
pusher：pusher模式，主动向prometheus-gateway 推送指标。
exporter_config
listen_addr | string | “:9200” | 在client_mode 为 exporter 时，需要配置。
listen_addr： 监听的端口
pusher_config
url
job
instance
interval_s | string | | 在client_mode 为 pusher_config 时，需要配置。url：prometheus-gateway 的指标收集地址。
job：任务名称
instance：live 服务的实例ID。
interval_s：推送间隔。单位：秒。
## **2.8 cron_config**
live 服务，有一些后台任务运行。
cron_config:
single_task_node: 1
* single_task_node：单任务运行节点的ID。有些任务，需要全局单线程执行，只有节点ID 等于 single_task_node 的节点，才会运行单线程的任务。
## **2.9 三鉴模块配置**
live 服务，使用七牛的AI 审核功能，对直播内容进行内容审核。
censor_callback: https://{{host}}
censor_bucket: {{ censor_bucket }}
censor_addr: https://{{xxx}}
* 如果不需要鉴黄鉴暴恐鉴敏感人物模块，可删去这三行配置文件，但是需要调用关闭三鉴模块的接口：其中enable设为false。https://developer.qiniu.com/lowcode/12364/qlive-admin-api-censor
* censor_callback：AI审核结果回调地址，配置为项目的域名。
* censor_bucket: AI审核疑似违规照片的存储bucket。
* censor_addr: bucket内存储文件的外链域名。
* 存储的bucket，与外链域名配置，参考 [对象存储使用 __](https://developer.qiniu.com/kodo/8452/kodo-console-guide)
## **2.10 礼物模块配置**
live 服务，支持直播间礼物发送功能。
gift_addr: https://{{xxx}}
字段名 | 类型 | 示例 | 说明
---|---|---|---
gift_addr | string | http://127.0.0.1:8099/manager/gift/test | 礼物支付的回调接口。礼物发送之前，需要业务服务提供礼物支付功能。
live 服务在发送礼物之前，回调该接口，完成实际支付。
只有支付成功的礼物，才会被发送。
暂时通过 http://127.0.0.1:8099/manager/gift/test 接口返回模拟的支付成功
### **礼物支付的回调接口要求**
Body 参数
使用JSON 格式数据
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
LiveId | string | 是 | 直播间ID | 1582200377771377896
UserId | string | 是 | 用户ID | test_user
BizId | string | 是 | 交易ID | 1574597777432780800
AnchorId | string | 是 | 当前直播间主播ID | test_anchor
GiftId | int | 是 | 礼物ID | 3
Amount | int | 是 | 礼物数量 | 99
举例如下
{
"biz_id": "1574597777432780800",
"user_id":"test_user_001",
"live_id":"1772215041443373056",
"anchor_id": "test_user_002" ,
"gift_id":1 ,
"amount": 99
}
返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：成功时为0；其他错误码表示失败
"message": "success" //code 非0 时，错误原因描述
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[低代码](https://developer.qiniu.com/lowcode) > 使用文档 >
[互动直播](https://developer.qiniu.com/lowcode/manual/12004/qlive) > 互动直播服务端接入指南
# 互动直播服务端接入指南
最近更新时间: 2023-03-28 17:23:02
# 1\. 项目编译运行
## 1.1 项目编译
* 本项目使用go 1.16 编译
1. clone 项目
git clone https://github.com/pili-engineering/QNLiveKit_Server
2. 编译
cd QNLiveKit_Server/app/live
go build
* 在当前目录下，生成可执行文件 live
## 1.2 项目运行
* 项目的运行，需要提供一个配置文件 config.yaml。配置文件的说明，见后面。
./live -f config.yaml 2>&1 > live.log &
# 2\. 配置文件
* 互动直播使用 yaml 格式的配置文件，文件内容如下所示：
node_id: {{ nodeId }}
service:
host: {{ host }}
port: {{ port }}
jwt_key: {{ jwt_key }}
callback: https://niucube-api.qiniu.com/v1/live/callback
censor_callback: https://{{xxx}}
censor_bucket: {{ censor_bucket }}
censor_addr:https://{{xxx}}
gift_addr: https://{{xxx}}
cache_config:
type: {{type}}
addr: {{host:ip}}
mysqls:
- host: 127.0.0.1
port: 3306
username: {{ user }}
password: {{ password }}
max_idle_conns: 10
max_open_conns: 100
database: live
conn_max_life_time: 5
default: live
- host: 127.0.0.1
port: 3306
username: {{ user }}
password: {{ password }}
max_idle_conns: 10
max_open_conns: 100
database: live
conn_max_life_time: 5
default: live
read_only: true
mac_config:
enable: true
access_key: ak
secret_key: sk
im_config:
app_id: {{ im_app_id }}
endpoint: {{ im_endpoint }}
token: {{ im_admin_token }}
rtc_config:
app_id: {{ app_id }}
access_key: {{ ak }}
secret_key: {{ sk }}
room_token_expire_s: 3600
hub: {{ 直播hub }}
security_type: none
publish_key: {{ publish_key }}
publish_expire_s: 3600
playback_url: https://{{xxx}}-playback.com
stream_pattern: qn_live_kit-%s
publish_url: rtmp://{{xxx}}-publish.com
publish_domain: {{xxx}}-publish.com
rtmp_play_url: rtmp://{{xxx}}-rtmp.com
flv_play_url: https://{{xxx}}-hdl.com
hls_play_url: https://{{xxx}}-hls.com
prome_config:
client_mode: pusher
exporter_config:
listen_addr: ":9200"
pusher_config:
url: "https://{{xxx}}"
job: live
instance: live_{{.node}}
interval_s: 10
cron_config:
single_task_node: 1
## **2.1 基本配置**
### node配置
node_id: {{ nodeId }}
字段名 | 类型 | 示例 | 说明
---|---|---|---
node_id | int | 1 | 互动直播支持分布式部署，每个节点指定一个nodeId。所有节点的nodeId 不能重复。
nodeId 会用于内部的ID 生成。
### service
service:
host: {{ host }}
port: {{ port }}
* 互动直播服务提供HTTP RESTful API 接口。service 配置服务的监听地址。
字段名 | 类型 | 示例 | 说明
---|---|---|---
host | string | 127.0.0.1（本地） | 监听的IP，部署在服务器上可为空或填0.0.0.0
port | int | 8080 | 监听的端口
### jwt_key
jwt_key: {{ jwt_key }}
* 字符串
* 用于客户端鉴权token 的加解密
### callback
callback: {{ callback_addrs }}
字段名 | 类型 | 示例 | 说明
---|---|---|---
callback | string | https://niucube-api.qiniu.com/v1/live/callback | 配置低代码服务的回调地址,该地址由业务服务来实现.
低代码服务会将状态信息，通过回调的方式，通知给业务服务
## **2.2 Redis 配置**
cache_config:
type: node
addr: {{ip:port}}
# password: {{password}}
或者
cache_config:
type: cluster
addrs:
- {{ip:port}}
- {{ip:port}}
# password: {{password}}
字段名 | 类型 | 示例 | 说明
---|---|---|---
type | string | node/cluster | 低代码服务，使用redis 作为缓存。支持redis 单节点模式，与集群模式。
node：单节点模式
cluster：集群模式
addr | string | addr: 127.0.0.1:6379 | 配置type为node时，必须配置单节点redis 的地址。
addrs | | 如上所示 | 配置type为cluster时，必须配置的redis集群地址列表。
password | string | | redis如果设置密码，取消注释，填入密码；没设置密码，不需要password字端
## **2.3 数据库配置**
mysqls:
- host: 127.0.0.1
port: 3306
username: {{ user }}
password: {{ password }}
max_idle_conns: 10
max_open_conns: 100
database: live
conn_max_life_time: 5
default: live
- host: 127.0.0.1
port: 3306
username: {{ user }}
password: {{ password }}
max_idle_conns: 10
max_open_conns: 100
database: live
conn_max_life_time: 5
default: live
read_only: true
* 使用读写分离模式，必须其一包含配置项read_only: true
* 互动直播服务使用mysql 进行业务数据存储。
* 支持配置多个数据库。
## **2.4 面向服务的鉴权配置**
mac_config:
enable: true
access_key: {{ ak }}
secret_key: {{ sk }}
字段名 | 类型 | 示例 | 说明
---|---|---|---
enable | bool | true | enable：true，开启鉴权；false，关闭鉴权。如果互动直播服务，与需要调用互动直播服务接口的其他服务，在同一个安全局域网内，可以关闭服务端接口的鉴权。
access_key | string | ak | 互动直播服务，提供面向服务端的接口，与面向客户端的接口。面向服务端的接口，使用 ak/sk 的鉴权方式。这里的access_key自行定义
secret_key | string | sk | secret key 自行定义
## **2.5 im_config**
im_config:
app_id: {{ im_app_id }}
endpoint: {{ im_endpoint }}
token: {{ im_admin_token }}
字段名 | 类型 | 示例 | 说明 |
---|---|---|---|---
app_id | string | | 互动直播服务，使用七牛IM 作为即时通信消息服务。
app_id：创建IM App时，为App生成的唯一标识 |
endpoint | string | | endpoint：App所在API服务的地址 ，参考 [IM服务接入指南 __](https://developer.qiniu.com/IM/8332/startim)与[IM服务端接入指南 __](https://developer.qiniu.com/IM/8102/im-service-integration-guide)|
token | string | | token：IM中获取的管理员token，参考 [IM服务接入指南 __](https://developer.qiniu.com/IM/8332/startim)与[IM服务端接入指南 __](https://developer.qiniu.com/IM/8102/im-service-integration-guide)|
## **2.6 rtc_config**
rtc_config:
app_id: {{ app_id }}
access_key: {{ ak }}
secret_key: {{ ak }}
room_token_expire_s: 3600
hub: {{ 直播hub }}
security_type: none
publish_key: {{ publish_key }}
publish_expire_s: 3600
stream_pattern: qn_live_kit-%s
playback_url: https://{{xxx}}-playback.com
publish_url: rtmp://{{xxx}}-publish.com
publish_domain: {{xxx}}-publish.com
rtmp_play_url: rtmp://{{xxx}}-rtmp.com
flv_play_url: https://{{xxx}}-hdl.com
hls_play_url: https://{{xxx}}-hls.com
字段名 | 类型 | 示例 | 说明
---|---|---|---
app_id | string | | 互动直播服务，使用七牛的RTC 服务，作为连麦服务。
RTC 应用的配置，参考：[管理实时音视频 __](https://developer.qiniu.com/rtc/9858/applist)
access_key | string | | 七牛对API请求鉴权，用户需要使用密钥（AccessKey/SecretKey）进行身份验证。此处填入AccessKey
secret_key | string | | 此处填入SecretKey，第一次使用七牛API之前，您需要在七牛开发者平台的 [密钥管理 __](https://portal.qiniu.com/user/key)中取得密钥
room_token_expire_s | int | 3600 |
hub | string | live | 直播空间信息，参考：[直播云 __](https://developer.qiniu.com/pili)
security_type | string | none/expiry/expiry_sk | 推流鉴权方式,详情见下表
publish_key | string | | 详情见下表
publish_expire_s | int | 3600 |
stream_pattern | string | qn_live_kit-%s |
playback_url | string | | 域名管理-加速域名-点播域名
publish_url | string | rtmp:// 前缀 | 域名管理-直播域名-推流域名
publish_domain | string | | 域名管理-直播域名-推流域名
rtmp_play_url | string | rtmp:// 前缀 | 域名管理-直播域名-RTMP播放域名
flv_play_url | string | | 域名管理-直播域名- HDL播放域名
hls_play_url | string | | 域名管理-直播域名-HLS播放域名
* 直播推流鉴权说明：目前直播推流鉴权，支持三种方式：无鉴权，限时鉴权，限时鉴权SK，不同鉴权模式的配置方式如下
鉴权模式 | security_type | publish_key | publish_expire_s
---|---|---|---
无鉴权 | none | 无需指定，留空 | 过期时间秒。如：3600 表示 一小时后过期，推流URL 过期
限时鉴权 | expiry | 使用配置的key 鉴权。从【直播空间设置】获取key | 同上
限时鉴权SK | expiry_sk | 使用RTC 用户的SK 鉴权。无需配置，留空。 | 同上
## **2.7 Prometheus系统监控配置**
prome_config:
client_mode: exporter
exporter_config:
listen_addr: ":9200"
或
prome_config:
client_mode: pusher
pusher_config:
url: "https://{{xxx}}"
job: live
instance: live_{{.node}}
interval_s: 10
低代码服务运行过程中，生成prometheus 监控数据指标。
字段名 | 类型 | 示例 | 说明
---|---|---|---
client_mode | string | exporter/pusher | client_mode：指标导出模式配置，支持的模式如下
exporter：exporter 模式，开启http 监听，由prometheus 服务来拉取。
pusher：pusher模式，主动向prometheus-gateway 推送指标。
exporter_config
listen_addr | string | “:9200” | 在client_mode 为 exporter 时，需要配置。
listen_addr： 监听的端口
pusher_config
url
job
instance
interval_s | string | | 在client_mode 为 pusher_config 时，需要配置。url：prometheus-gateway 的指标收集地址。
job：任务名称
instance：live 服务的实例ID。
interval_s：推送间隔。单位：秒。
## **2.8 cron_config**
live 服务，有一些后台任务运行。
cron_config:
single_task_node: 1
* single_task_node：单任务运行节点的ID。有些任务，需要全局单线程执行，只有节点ID 等于 single_task_node 的节点，才会运行单线程的任务。
## **2.9 三鉴模块配置**
live 服务，使用七牛的AI 审核功能，对直播内容进行内容审核。
censor_callback: https://{{host}}
censor_bucket: {{ censor_bucket }}
censor_addr: https://{{xxx}}
* 如果不需要鉴黄鉴暴恐鉴敏感人物模块，可删去这三行配置文件，但是需要调用关闭三鉴模块的接口：其中enable设为false。https://developer.qiniu.com/lowcode/12364/qlive-admin-api-censor
* censor_callback：AI审核结果回调地址，配置为项目的域名。
* censor_bucket: AI审核疑似违规照片的存储bucket。
* censor_addr: bucket内存储文件的外链域名。
* 存储的bucket，与外链域名配置，参考 [对象存储使用 __](https://developer.qiniu.com/kodo/8452/kodo-console-guide)
## **2.10 礼物模块配置**
live 服务，支持直播间礼物发送功能。
gift_addr: https://{{xxx}}
字段名 | 类型 | 示例 | 说明
---|---|---|---
gift_addr | string | http://127.0.0.1:8099/manager/gift/test | 礼物支付的回调接口。礼物发送之前，需要业务服务提供礼物支付功能。
live 服务在发送礼物之前，回调该接口，完成实际支付。
只有支付成功的礼物，才会被发送。
暂时通过 http://127.0.0.1:8099/manager/gift/test 接口返回模拟的支付成功
### **礼物支付的回调接口要求**
Body 参数
使用JSON 格式数据
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
LiveId | string | 是 | 直播间ID | 1582200377771377896
UserId | string | 是 | 用户ID | test_user
BizId | string | 是 | 交易ID | 1574597777432780800
AnchorId | string | 是 | 当前直播间主播ID | test_anchor
GiftId | int | 是 | 礼物ID | 3
Amount | int | 是 | 礼物数量 | 99
举例如下
{
"biz_id": "1574597777432780800",
"user_id":"test_user_001",
"live_id":"1772215041443373056",
"anchor_id": "test_user_002" ,
"gift_id":1 ,
"amount": 99
}
返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：成功时为0；其他错误码表示失败
"message": "success" //code 非0 时，错误原因描述
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,357 |
服务端接入指南（develop分支 支持docker部署） | 低代码 | [低代码](https://developer.qiniu.com/lowcode) > 使用文档 >
[互动直播](https://developer.qiniu.com/lowcode/manual/12004/qlive) >
[互动直播服务端接入指南](https://developer.qiniu.com/lowcode/manual/12005/qlive-server-
guide) > 服务端接入指南（develop分支 支持docker部署）
# 服务端接入指南（develop分支 支持docker部署）
最近更新时间: 2023-03-28 17:23:08
# 1\. 项目编译运行
## 1.1 项目编译
* 本项目使用go 1.16 编译
1. clone 项目
git clone https://github.com/pili-engineering/QNLiveKit_Server
2. 编译
cd QNLiveKit_Server/app/live
go build
* 在当前目录下，生成可执行文件 live
## 1.2 项目运行
* 项目的运行，需要提供一个配置文件 config.yaml。配置文件的说明，见后面。
./live -f config.yaml 2>&1 > live.log &
## 1.3 使用docker-compose部署
* 安装 docker、docker-compose
* 新建 .env 文件 ，内容示例如下
PORT_LIVE=8099
PORT_PROMETHEUS=29090
PORT_GRAFANA=23000
QINIU_ACCESS_KEY = {{ ak }}
QINIU_SECRET_KEY = {{ sk }}
IM_ADMIN_TOKEN = {{ im_admin_token }}
PILI_PUB_KEY = {{ publish_key }}
字段名 | 说明 |
---|---|---
PORT_LIVE | qnlivekit_server-qnliv中， “${PORT_LIVE}:8099” 将容器的8099端口映射到宿主机PORT_LIVE端口 |
PORT_PROMETHEUS | prometheus “${PORT_PROMETHEUS}:9090” 将容器的9090端口映射到宿主机PORT_PROMETHEUS端口 |
PORT_GRAFANA | grafana “${PORT_GRAFANA}:3000” 将容器的3000端口映射到宿主机PORT_GRAFANA端口 |
QINIU_ACCESS_KEY | ak/sk鉴权 {{ .qiniu_key_pair_access_key }} |
QINIU_SECRET_KEY | ak/sk鉴权 {{ .qiniu_key_pair_secret_key }} |
IM_ADMIN_TOKEN | IM服务 获取管理员token ，详情参考[IM服务接入指南 __](https://developer.qiniu.com/IM/8332/startim)与[IM服务端接入指南 __](https://developer.qiniu.com/IM/8102/im-service-integration-guide)|
PILI_PUB_KEY | Pili服务直播推流鉴权，当采用限时鉴权，security_type为expiry时， 从【直播空间设置】获取publish_key ；当security_type为无鉴权（none）和 限时鉴权SK（expiry_sk），该位置留空 |
* 执行 `docker-compose --env-file live.env up`
自动完成包括构建镜像，（重新）创建服务，启动服务，并关联服务相关容器的一系列操作。
* 修改后可执行 ` docker-compose --env-file live.env up --build`。
如果不希望容器被停止并重新创建，可以使用 `docker-compose up --no-
recreate`。这样将只会启动处于停止状态的容器，而忽略已经运行的服务。
* `docker-compose down`停止和删除容器、网络、卷、镜像。
#2. 配置文件
* 互动直播使用 yaml 格式的配置文件，文件内容如下所示：
node:
node_id: {{.node_id}}
account:
access_key: {{ .qiniu_key_pair_access_key }}
secret_key: {{ .qiniu_key_pair_secret_key }}
httpq:
addr: ":8099"
auth:
jwt_key: jwtkey
server:
enable: true
access_key: ak
secret_key: sk
cache:
type: {{type}}
addr: {{host:ip}}
mysql:
databases:
- host: 127.0.0.1
port: 3306
username: {{ user }}
password: {{ password }}
max_idle_conns: 10
max_open_conns: 100
database: live
conn_max_life_time: 5
default: live
- host: 127.0.0.1
port: 3306
username: {{ user }}
password: {{ password }}
max_idle_conns: 10
max_open_conns: 100
database: live
conn_max_life_time: 5
default: live
read_only: true
im:
app_id: {{ im_app_id }}
endpoint: {{ im_endpoint }}
token: {{ im_admin_token }}
rtc:
app_id: {{ app_id }}
pili:
hub: {{ 直播hub }}
room_token_expire_s: 3600
playback_url: https://{{xxx}}-playback.com
security_type: { { security_type } }
publish_key: {{ publish_key }}
publish_expire_s: 3600
stream_pattern: qn_live_kit-%s
publish_url: rtmp://{{xxx}}-publish.com
publish_domain: {{xxx}}-publish.com
rtmp_play_url: rtmp://{{xxx}}-rtmp.com
flv_play_url: https://{{xxx}}-hdl.com
hls_play_url: https://{{xxx}}-hls.com
media_url: https://{{xxx}}
cron:
single_task_node: 1
prome:
client_mode: pusher
exporter_config:
listen_addr: ":9200"
pusher_config:
url: "https://{{xxx}}"
job: live
instance: live_{{.node}}
interval_s: 10
callback:
addr: https://niucube-api.qiniu.com/v1/live/callback
censor:
callback: https://{{xxx}}
bucket: {{ censor_bucket }}
addr: https://{{xxx}}
gift:
gift_addr: http://127.0.0.1:8099/manager/gift/test
## 配置文件详细介绍
### node配置
node_id: {{ nodeId }}
字段名 | 类型 | 示例 | 说明
---|---|---|---
node_id | int | 1 | 互动直播支持分布式部署，每个节点指定一个nodeId。所有节点的nodeId 不能重复。
nodeId 会用于内部的ID 生成。
### 面向服务的鉴权配置 account：
account:
access_key: {{ .qiniu_key_pair_access_key }}
secret_key: {{ .qiniu_key_pair_secret_key }}
字段名 | 示例 | 说明
---|---|---
access_key | {{ .qiniu_key_pair_access_key }} | 七牛对API请求鉴权，用户需要使用密钥（AccessKey/SecretKey）进行身份验证。此处填入AccessKey
secret_key | {{ .qiniu_key_pair_secret_key }} | 此处填入SecretKey，第一次使用七牛API之前，您需要在七牛开发者平台的 [密钥管理 __](https://portal.qiniu.com/user/key)中取得密钥
### 监听地址
httpq:
addr: ":8099"
字段名 | 类型 | 示例 | 说明
---|---|---|---
addr | string | 1 | 互动直播服务提供HTTP RESTful API 接口。service 配置服务的监听地址`{host:ip}`
host：监听的IP
port: 监听的端口
### 互动直播服务端鉴权
auth:
jwt_key: jwtkey
server:
enable: true
access_key: ak
secret_key: sk
字段名 | 类型 | 示例 | 说明
---|---|---|---
jwt_key | string | jwt-key | 用于客户端鉴权token 的加解密
server:
enable | bool | true | enable：true，开启鉴权；false，关闭鉴权。如果互动直播服务，与需要调用互动直播服务接口的其他服务，在同一个安全局域网内，可以关闭服务端接口的鉴权。
server:
access_key | string | ak | 互动直播服务，提供面向服务端的接口，与面向客户端的接口。面向服务端的接口，使用 ak/sk 的鉴权方式。这里为ak
server:
secret_key | string | sk | secret key
### Redis配置
cache_config:
type: node
addr: {{ip:port}}
或者
cache_config:
type: cluster
addrs:
- {{ip:port}}
- {{ip:port}}
字段名 | 类型 | 示例 | 说明
---|---|---|---
type | string | node/cluster | 低代码服务，使用redis 作为缓存。支持redis 单节点模式，与集群模式。
node：单节点模式
cluster：集群模式
addr | string | addr: 127.0.0.1:6379 | 配置type为node时，必须配置单节点redis 的地址。
addrs | | 如上所示 | 配置type为cluster时，必须配置的redis集群地址列表。
### Mysql配置
mysql:
databases:
- host: 127.0.0.1
port: 3306
username: {{ user }}
password: {{ password }}
max_idle_conns: 10
max_open_conns: 100
database: live
conn_max_life_time: 5
default: live
- host: 127.0.0.1
port: 3306
username: {{ user }}
password: {{ password }}
max_idle_conns: 10
max_open_conns: 100
database: live
conn_max_life_time: 5
default: live
read_only: true
* 互动直播服务使用mysql 进行业务数据存储。
* 支持配置多个数据库，使用读写分离模式。
字段名 | 说明
---|---
host/port | MySQL 实例的 IP 地址/主机名和可选端口。
username | 数据库用户的登录名/用户名
password | 数据库用户密码
max_idle_conns | 空闲连接池中的最大连接数，默认2（Grafana v5.4+）
max_open_conns | 数据库的最大打开连接数，默认unlimited（Grafana v5.4+）
database | MySQL 数据库的名称。
conn_max_life_time | 可以重用连接的最长时间（以秒为单位），默认为14400/4 小时。这应该始终低于 MySQL (Grafana v5.4+) 中配置的wait_timeout。
default | 默认数据源意味着它将被预先选用
### IM配置
im:
app_id: {{ im_app_id }}
endpoint: {{ im_endpoint }}
token: {{ im_admin_token }}
字段名 | 类型 | 示例 | 说明 |
---|---|---|---|---
app_id | string | | 互动直播服务，使用七牛IM 作为即时通信消息服务。
app_id：创建IM App时，为App生成的唯一标识 |
endpoint | string | | endpoint：App所在API服务的地址 ，参考 [IM服务接入指南 __](https://developer.qiniu.com/IM/8332/startim)与[IM服务端接入指南 __](https://developer.qiniu.com/IM/8102/im-service-integration-guide)|
token | string | | token：IM中获取的管理员token，参考 [IM服务接入指南 __](https://developer.qiniu.com/IM/8332/startim)与[IM服务端接入指南 __](https://developer.qiniu.com/IM/8102/im-service-integration-guide)|
### RTC PILI配置
RTC
rtc:
app_id: {{ app_id }}
字段名 | 类型 | 示例 | 说明
---|---|---|---
app_id | string | c9n9509o5e70 | 互动直播服务，使用七牛的RTC 服务，作为连麦服务。
RTC 应用的配置，参考：[管理实时音视频 __](https://developer.qiniu.com/rtc/9858/applist)
Pili
pili:
hub: {{ 直播hub }}
room_token_expire_s: 3600
playback_url: https://{{xxx}}-playback.com
security_type: { { security_type } }
publish_key: {{ publish_key }}
publish_expire_s: 3600
stream_pattern: qn_live_kit-%s
publish_url: rtmp://{{xxx}}-publish.com
publish_domain: {{xxx}}-publish.com
rtmp_play_url: rtmp://{{xxx}}-rtmp.com
flv_play_url: https://{{xxx}}-hdl.com
hls_play_url: https://{{xxx}}-hls.com
media_url: https://{{xxx}}
字段名 | 类型 | 示例 | 说明
---|---|---|---
hub | string | live | 直播空间信息，参考：[直播云 __](https://developer.qiniu.com/pili)
room_token_expire_s | int | 3600 |
playback_url | string | | 点播域名
security_type | string | none/expiry/expiry_sk | 推流鉴权方式,详情见下表
publish_key | string | | 详情见下表
publish_expire_s | int | 3600 |
stream_pattern | string | qn_live_kit-%s |
publish_url | string | | 推流域名
publish_domain | string | | 推流域名
rtmp_play_url | string | | RTMP播放域名
flv_play_url | string | | FLV播放域名
hls_play_url | string | | HLS播放域名
media_url | string | |
* 直播推流鉴权说明：目前直播推流鉴权，支持三种方式：无鉴权，限时鉴权，限时鉴权SK，不同鉴权模式的配置方式如下
鉴权模式 | security_type | publish_key | publish_expire_s
---|---|---|---
无鉴权 | none | 无需指定，留空 | 过期时间秒。如：3600 表示 一小时后过期，推流URL 过期
限时鉴权 | expiry | 使用配置的key 鉴权。从【直播空间设置】获取key | 同上
限时鉴权SK | expiry_sk | 使用RTC 用户的SK 鉴权。无需配置，留空。 | 同上
### cron配置
cron:
single_task_node: 1
字段名 | 类型 | 示例 | 说明
---|---|---|---
single_task_node | int | 1 | 单任务运行节点的ID。有些任务，需要全局单线程执行，只有节点ID 等于 single_task_node 的节点，才会运行单线程的任务。
### Prometheus系统监控配置
prome_config:
client_mode: exporter
exporter_config:
listen_addr: ":9200"
或
prome_config:
client_mode: pusher
pusher_config:
url: "https://{{xxx}}"
job: live
instance: live_{{.node}}
interval_s: 10
字段名 | 类型 | 示例 | 说明
---|---|---|---
client_mode | string | exporter/pusher | client_mode：指标导出模式配置，支持的模式如下
exporter：exporter 模式，开启http 监听，由prometheus 服务来拉取。
pusher：pusher模式，主动向prometheus-gateway 推送指标。
exporter_config
listen_addr | string | “:9200” | 在client_mode 为 exporter 时，需要配置。
listen_addr： 监听的端口
pusher_config
url
job
instance
interval_s | string | | 在client_mode 为 pusher_config 时，需要配置。url：prometheus-gateway 的指标收集地址。
job：任务名称
instance：live 服务的实例ID。
interval_s：推送间隔。单位：秒。
| | |
### callback
callback:
addr: https://niucube-api.qiniu.com/v1/live/callback
字段名 | 类型 | 示例 | 说明
---|---|---|---
addr | string | https://niucube-api.qiniu.com/v1/live/callback | 配置低代码服务的回调地址,该地址由业务服务来实现.
低代码服务会将状态信息，通过回调的方式，通知给业务服务
### kodo配置（三鉴模块）- censor
censor:
callback: https://{{xxx}}
bucket: {{ censor_bucket }}
addr: https://{{xxx}}
字段名 | 类型 | 示例 | 说明
---|---|---|---
callback | string | | AI审核结果回调地址，配置为项目的域名。
bucket | string | | AI审核疑似违规照片的存储bucket。
addr | string | | bucket内存储文件的外链域名。
存储的bucket，与外链域名配置，参考 [对象存储使用 __](https://developer.qiniu.com/kodo/8452/kodo-
console-guide)
### 礼物模块配置 - gift
gift:
gift_addr: http://127.0.0.1:8099/manager/gift/test
字段名 | 类型 | 示例 | 说明
---|---|---|---
gift_addr | string | http://127.0.0.1:8099/manager/gift/test | 礼物支付的回调接口。礼物发送之前，需要业务服务提供礼物支付功能。
live 服务在发送礼物之前，回调该接口，完成实际支付。
只有支付成功的礼物，才会被发送。
暂时通过 http://127.0.0.1:8099/manager/gift/test 接口返回模拟的支付成功
#### 礼物支付的回调接口要求
Body 参数
使用JSON 格式数据
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
LiveId | string | 是 | 直播间ID | 1582200377771377896
UserId | string | 是 | 用户ID | test_user
BizId | string | 是 | 交易ID | 1574597777432780800
AnchorId | string | 是 | 当前直播间主播ID | test_anchor
GiftId | int | 是 | 礼物ID | 3
Amount | int | 是 | 礼物数量 | 99
举例如下
{
"biz_id": "1574597777432780800",
"user_id":"test_user_001",
"live_id":"1772215041443373056",
"anchor_id": "test_user_002" ,
"gift_id":1 ,
"amount": 99
}
返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：成功时为0；其他为失败
"message": "success" //code 非0 时，错误原因描述
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[低代码](https://developer.qiniu.com/lowcode) > 使用文档 >
[互动直播](https://developer.qiniu.com/lowcode/manual/12004/qlive) >
[互动直播服务端接入指南](https://developer.qiniu.com/lowcode/manual/12005/qlive-server-
guide) > 服务端接入指南（develop分支 支持docker部署）
# 服务端接入指南（develop分支 支持docker部署）
最近更新时间: 2023-03-28 17:23:08
# 1\. 项目编译运行
## 1.1 项目编译
* 本项目使用go 1.16 编译
1. clone 项目
git clone https://github.com/pili-engineering/QNLiveKit_Server
2. 编译
cd QNLiveKit_Server/app/live
go build
* 在当前目录下，生成可执行文件 live
## 1.2 项目运行
* 项目的运行，需要提供一个配置文件 config.yaml。配置文件的说明，见后面。
./live -f config.yaml 2>&1 > live.log &
## 1.3 使用docker-compose部署
* 安装 docker、docker-compose
* 新建 .env 文件 ，内容示例如下
PORT_LIVE=8099
PORT_PROMETHEUS=29090
PORT_GRAFANA=23000
QINIU_ACCESS_KEY = {{ ak }}
QINIU_SECRET_KEY = {{ sk }}
IM_ADMIN_TOKEN = {{ im_admin_token }}
PILI_PUB_KEY = {{ publish_key }}
字段名 | 说明 |
---|---|---
PORT_LIVE | qnlivekit_server-qnliv中， “${PORT_LIVE}:8099” 将容器的8099端口映射到宿主机PORT_LIVE端口 |
PORT_PROMETHEUS | prometheus “${PORT_PROMETHEUS}:9090” 将容器的9090端口映射到宿主机PORT_PROMETHEUS端口 |
PORT_GRAFANA | grafana “${PORT_GRAFANA}:3000” 将容器的3000端口映射到宿主机PORT_GRAFANA端口 |
QINIU_ACCESS_KEY | ak/sk鉴权 {{ .qiniu_key_pair_access_key }} |
QINIU_SECRET_KEY | ak/sk鉴权 {{ .qiniu_key_pair_secret_key }} |
IM_ADMIN_TOKEN | IM服务 获取管理员token ，详情参考[IM服务接入指南 __](https://developer.qiniu.com/IM/8332/startim)与[IM服务端接入指南 __](https://developer.qiniu.com/IM/8102/im-service-integration-guide)|
PILI_PUB_KEY | Pili服务直播推流鉴权，当采用限时鉴权，security_type为expiry时， 从【直播空间设置】获取publish_key ；当security_type为无鉴权（none）和 限时鉴权SK（expiry_sk），该位置留空 |
* 执行 `docker-compose --env-file live.env up`
自动完成包括构建镜像，（重新）创建服务，启动服务，并关联服务相关容器的一系列操作。
* 修改后可执行 ` docker-compose --env-file live.env up --build`。
如果不希望容器被停止并重新创建，可以使用 `docker-compose up --no-
recreate`。这样将只会启动处于停止状态的容器，而忽略已经运行的服务。
* `docker-compose down`停止和删除容器、网络、卷、镜像。
#2. 配置文件
* 互动直播使用 yaml 格式的配置文件，文件内容如下所示：
node:
node_id: {{.node_id}}
account:
access_key: {{ .qiniu_key_pair_access_key }}
secret_key: {{ .qiniu_key_pair_secret_key }}
httpq:
addr: ":8099"
auth:
jwt_key: jwtkey
server:
enable: true
access_key: ak
secret_key: sk
cache:
type: {{type}}
addr: {{host:ip}}
mysql:
databases:
- host: 127.0.0.1
port: 3306
username: {{ user }}
password: {{ password }}
max_idle_conns: 10
max_open_conns: 100
database: live
conn_max_life_time: 5
default: live
- host: 127.0.0.1
port: 3306
username: {{ user }}
password: {{ password }}
max_idle_conns: 10
max_open_conns: 100
database: live
conn_max_life_time: 5
default: live
read_only: true
im:
app_id: {{ im_app_id }}
endpoint: {{ im_endpoint }}
token: {{ im_admin_token }}
rtc:
app_id: {{ app_id }}
pili:
hub: {{ 直播hub }}
room_token_expire_s: 3600
playback_url: https://{{xxx}}-playback.com
security_type: { { security_type } }
publish_key: {{ publish_key }}
publish_expire_s: 3600
stream_pattern: qn_live_kit-%s
publish_url: rtmp://{{xxx}}-publish.com
publish_domain: {{xxx}}-publish.com
rtmp_play_url: rtmp://{{xxx}}-rtmp.com
flv_play_url: https://{{xxx}}-hdl.com
hls_play_url: https://{{xxx}}-hls.com
media_url: https://{{xxx}}
cron:
single_task_node: 1
prome:
client_mode: pusher
exporter_config:
listen_addr: ":9200"
pusher_config:
url: "https://{{xxx}}"
job: live
instance: live_{{.node}}
interval_s: 10
callback:
addr: https://niucube-api.qiniu.com/v1/live/callback
censor:
callback: https://{{xxx}}
bucket: {{ censor_bucket }}
addr: https://{{xxx}}
gift:
gift_addr: http://127.0.0.1:8099/manager/gift/test
## 配置文件详细介绍
### node配置
node_id: {{ nodeId }}
字段名 | 类型 | 示例 | 说明
---|---|---|---
node_id | int | 1 | 互动直播支持分布式部署，每个节点指定一个nodeId。所有节点的nodeId 不能重复。
nodeId 会用于内部的ID 生成。
### 面向服务的鉴权配置 account：
account:
access_key: {{ .qiniu_key_pair_access_key }}
secret_key: {{ .qiniu_key_pair_secret_key }}
字段名 | 示例 | 说明
---|---|---
access_key | {{ .qiniu_key_pair_access_key }} | 七牛对API请求鉴权，用户需要使用密钥（AccessKey/SecretKey）进行身份验证。此处填入AccessKey
secret_key | {{ .qiniu_key_pair_secret_key }} | 此处填入SecretKey，第一次使用七牛API之前，您需要在七牛开发者平台的 [密钥管理 __](https://portal.qiniu.com/user/key)中取得密钥
### 监听地址
httpq:
addr: ":8099"
字段名 | 类型 | 示例 | 说明
---|---|---|---
addr | string | 1 | 互动直播服务提供HTTP RESTful API 接口。service 配置服务的监听地址`{host:ip}`
host：监听的IP
port: 监听的端口
### 互动直播服务端鉴权
auth:
jwt_key: jwtkey
server:
enable: true
access_key: ak
secret_key: sk
字段名 | 类型 | 示例 | 说明
---|---|---|---
jwt_key | string | jwt-key | 用于客户端鉴权token 的加解密
server:
enable | bool | true | enable：true，开启鉴权；false，关闭鉴权。如果互动直播服务，与需要调用互动直播服务接口的其他服务，在同一个安全局域网内，可以关闭服务端接口的鉴权。
server:
access_key | string | ak | 互动直播服务，提供面向服务端的接口，与面向客户端的接口。面向服务端的接口，使用 ak/sk 的鉴权方式。这里为ak
server:
secret_key | string | sk | secret key
### Redis配置
cache_config:
type: node
addr: {{ip:port}}
或者
cache_config:
type: cluster
addrs:
- {{ip:port}}
- {{ip:port}}
字段名 | 类型 | 示例 | 说明
---|---|---|---
type | string | node/cluster | 低代码服务，使用redis 作为缓存。支持redis 单节点模式，与集群模式。
node：单节点模式
cluster：集群模式
addr | string | addr: 127.0.0.1:6379 | 配置type为node时，必须配置单节点redis 的地址。
addrs | | 如上所示 | 配置type为cluster时，必须配置的redis集群地址列表。
### Mysql配置
mysql:
databases:
- host: 127.0.0.1
port: 3306
username: {{ user }}
password: {{ password }}
max_idle_conns: 10
max_open_conns: 100
database: live
conn_max_life_time: 5
default: live
- host: 127.0.0.1
port: 3306
username: {{ user }}
password: {{ password }}
max_idle_conns: 10
max_open_conns: 100
database: live
conn_max_life_time: 5
default: live
read_only: true
* 互动直播服务使用mysql 进行业务数据存储。
* 支持配置多个数据库，使用读写分离模式。
字段名 | 说明
---|---
host/port | MySQL 实例的 IP 地址/主机名和可选端口。
username | 数据库用户的登录名/用户名
password | 数据库用户密码
max_idle_conns | 空闲连接池中的最大连接数，默认2（Grafana v5.4+）
max_open_conns | 数据库的最大打开连接数，默认unlimited（Grafana v5.4+）
database | MySQL 数据库的名称。
conn_max_life_time | 可以重用连接的最长时间（以秒为单位），默认为14400/4 小时。这应该始终低于 MySQL (Grafana v5.4+) 中配置的wait_timeout。
default | 默认数据源意味着它将被预先选用
### IM配置
im:
app_id: {{ im_app_id }}
endpoint: {{ im_endpoint }}
token: {{ im_admin_token }}
字段名 | 类型 | 示例 | 说明 |
---|---|---|---|---
app_id | string | | 互动直播服务，使用七牛IM 作为即时通信消息服务。
app_id：创建IM App时，为App生成的唯一标识 |
endpoint | string | | endpoint：App所在API服务的地址 ，参考 [IM服务接入指南 __](https://developer.qiniu.com/IM/8332/startim)与[IM服务端接入指南 __](https://developer.qiniu.com/IM/8102/im-service-integration-guide)|
token | string | | token：IM中获取的管理员token，参考 [IM服务接入指南 __](https://developer.qiniu.com/IM/8332/startim)与[IM服务端接入指南 __](https://developer.qiniu.com/IM/8102/im-service-integration-guide)|
### RTC PILI配置
RTC
rtc:
app_id: {{ app_id }}
字段名 | 类型 | 示例 | 说明
---|---|---|---
app_id | string | c9n9509o5e70 | 互动直播服务，使用七牛的RTC 服务，作为连麦服务。
RTC 应用的配置，参考：[管理实时音视频 __](https://developer.qiniu.com/rtc/9858/applist)
Pili
pili:
hub: {{ 直播hub }}
room_token_expire_s: 3600
playback_url: https://{{xxx}}-playback.com
security_type: { { security_type } }
publish_key: {{ publish_key }}
publish_expire_s: 3600
stream_pattern: qn_live_kit-%s
publish_url: rtmp://{{xxx}}-publish.com
publish_domain: {{xxx}}-publish.com
rtmp_play_url: rtmp://{{xxx}}-rtmp.com
flv_play_url: https://{{xxx}}-hdl.com
hls_play_url: https://{{xxx}}-hls.com
media_url: https://{{xxx}}
字段名 | 类型 | 示例 | 说明
---|---|---|---
hub | string | live | 直播空间信息，参考：[直播云 __](https://developer.qiniu.com/pili)
room_token_expire_s | int | 3600 |
playback_url | string | | 点播域名
security_type | string | none/expiry/expiry_sk | 推流鉴权方式,详情见下表
publish_key | string | | 详情见下表
publish_expire_s | int | 3600 |
stream_pattern | string | qn_live_kit-%s |
publish_url | string | | 推流域名
publish_domain | string | | 推流域名
rtmp_play_url | string | | RTMP播放域名
flv_play_url | string | | FLV播放域名
hls_play_url | string | | HLS播放域名
media_url | string | |
* 直播推流鉴权说明：目前直播推流鉴权，支持三种方式：无鉴权，限时鉴权，限时鉴权SK，不同鉴权模式的配置方式如下
鉴权模式 | security_type | publish_key | publish_expire_s
---|---|---|---
无鉴权 | none | 无需指定，留空 | 过期时间秒。如：3600 表示 一小时后过期，推流URL 过期
限时鉴权 | expiry | 使用配置的key 鉴权。从【直播空间设置】获取key | 同上
限时鉴权SK | expiry_sk | 使用RTC 用户的SK 鉴权。无需配置，留空。 | 同上
### cron配置
cron:
single_task_node: 1
字段名 | 类型 | 示例 | 说明
---|---|---|---
single_task_node | int | 1 | 单任务运行节点的ID。有些任务，需要全局单线程执行，只有节点ID 等于 single_task_node 的节点，才会运行单线程的任务。
### Prometheus系统监控配置
prome_config:
client_mode: exporter
exporter_config:
listen_addr: ":9200"
或
prome_config:
client_mode: pusher
pusher_config:
url: "https://{{xxx}}"
job: live
instance: live_{{.node}}
interval_s: 10
字段名 | 类型 | 示例 | 说明
---|---|---|---
client_mode | string | exporter/pusher | client_mode：指标导出模式配置，支持的模式如下
exporter：exporter 模式，开启http 监听，由prometheus 服务来拉取。
pusher：pusher模式，主动向prometheus-gateway 推送指标。
exporter_config
listen_addr | string | “:9200” | 在client_mode 为 exporter 时，需要配置。
listen_addr： 监听的端口
pusher_config
url
job
instance
interval_s | string | | 在client_mode 为 pusher_config 时，需要配置。url：prometheus-gateway 的指标收集地址。
job：任务名称
instance：live 服务的实例ID。
interval_s：推送间隔。单位：秒。
| | |
### callback
callback:
addr: https://niucube-api.qiniu.com/v1/live/callback
字段名 | 类型 | 示例 | 说明
---|---|---|---
addr | string | https://niucube-api.qiniu.com/v1/live/callback | 配置低代码服务的回调地址,该地址由业务服务来实现.
低代码服务会将状态信息，通过回调的方式，通知给业务服务
### kodo配置（三鉴模块）- censor
censor:
callback: https://{{xxx}}
bucket: {{ censor_bucket }}
addr: https://{{xxx}}
字段名 | 类型 | 示例 | 说明
---|---|---|---
callback | string | | AI审核结果回调地址，配置为项目的域名。
bucket | string | | AI审核疑似违规照片的存储bucket。
addr | string | | bucket内存储文件的外链域名。
存储的bucket，与外链域名配置，参考 [对象存储使用 __](https://developer.qiniu.com/kodo/8452/kodo-
console-guide)
### 礼物模块配置 - gift
gift:
gift_addr: http://127.0.0.1:8099/manager/gift/test
字段名 | 类型 | 示例 | 说明
---|---|---|---
gift_addr | string | http://127.0.0.1:8099/manager/gift/test | 礼物支付的回调接口。礼物发送之前，需要业务服务提供礼物支付功能。
live 服务在发送礼物之前，回调该接口，完成实际支付。
只有支付成功的礼物，才会被发送。
暂时通过 http://127.0.0.1:8099/manager/gift/test 接口返回模拟的支付成功
#### 礼物支付的回调接口要求
Body 参数
使用JSON 格式数据
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
LiveId | string | 是 | 直播间ID | 1582200377771377896
UserId | string | 是 | 用户ID | test_user
BizId | string | 是 | 交易ID | 1574597777432780800
AnchorId | string | 是 | 当前直播间主播ID | test_anchor
GiftId | int | 是 | 礼物ID | 3
Amount | int | 是 | 礼物数量 | 99
举例如下
{
"biz_id": "1574597777432780800",
"user_id":"test_user_001",
"live_id":"1772215041443373056",
"anchor_id": "test_user_002" ,
"gift_id":1 ,
"amount": 99
}
返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：成功时为0；其他为失败
"message": "success" //code 非0 时，错误原因描述
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,374 |
安卓端接入指南 | 低代码 | [低代码](https://developer.qiniu.com/lowcode) > 使用文档 >
[互动直播](https://developer.qiniu.com/lowcode/manual/12004/qlive) > 安卓端接入指南
# 安卓端接入指南
最近更新时间: 2022-12-26 13:57:39
+---------------+ +---> RoomListPage //房间列表UI实现页面
| | |
+---+ QLiveUIKIT +--- -+
| | | |
| +---------------+ +---> RoomPage //直播间页面UI实现
| uikit sdk
|
|
|
| +---> createRoom //创建房间接口
| +---------------+ |
+----------------------+ | | | +---> listRoom //房间列表接口
| | +---+ QRooms +-----+
| QLive | | | | +---> deleteRoom //删除房间接口
| | | +---------------+ |
+----------------------+ | 房间管理接口 +---> getRoomInfo //获取房间信息接口
|
|
|
| +---> QChatRoomService //聊天室服务
| +----------------+ |
| | | +---> QLinkMicService //连麦业务服务
+---+ QLiveClient +---+
| | +---> QPKService //pk业务服务
+----------------+ |
推拉流房间客户端 +---> QPublicChatService //房间里公屏消息服务
无UI版本sdk |
+---> QRoomService //房间频道业务
|
+---> QDanmakuService //弹幕服务
|
+---> QShoppingService //电商购物服务
|
+---> QGiftService //礼物服务
|
+---> QLikeService //点赞服务
## sdk接入
1 下载sdk [下载地址](https://github.com/qiniu/QNLiveKit_Android/tree/main/app-sdk)
2 参考dome工程的build.gradle文件 配置aar
//七牛imsdk 必选
implementation project(':app-sdk:depends_sdk_qnim')
//七牛rtc 主播推流必选 观众要连麦必选
implementation project(':app-sdk:depends_sdk_qrtc')
//七牛播放器 观众拉流端必选
implementation project(':app-sdk:depends_sdk_piliplayer')
//低代码无ui sdk 必选
implementation project(':app-sdk:qlive-sdk')
//okhttp 3版本以上
implementation 'com.squareup.okhttp3:okhttp:4.2.2'
//json
implementation 'com.google.code.gson:gson:2.8.9'
//UIkit包 不使用UI则不需要依赖
implementation project(':app-sdk:qlive-sdk-uikit')
//谷歌官方UI组件
implementation 'androidx.lifecycle:lifecycle-runtime-ktx:2.3.0'
implementation 'androidx.recyclerview:recyclerview:1.1.0'
implementation 'androidx.cardview:cardview:1.0.0'
//图片加载
implementation 'com.github.bumptech.glide:glide:4.11.0'
//如果没有开启 viewbinding 选项 务必依赖这个库
implementation "androidx.databinding:viewbinding:7.1.2"
> UIkit也可以直接使用源码模块-可直接修改代码
>
> #### implementation project(':qlive-uikit')
3 混淆配置 如果你的项目需要混淆
[qlivesdk混淆配置参考](https://github.com/qiniu/QNLiveKit_Android/blob/main/app/proguard-
rules.pro)
## UIKIT使用说明
### 初始化
//初始化
QLive.init(this, QLiveConfig()) { callback ->
//业务方如何获取token 在token过期和登陆时候会回调该方法
getLoginToken(callback)
}
//登陆
QLive.auth(object : QLiveCallBack<Void> {
override fun onError(code: Int, msg: String?) {}
override fun onSuccess(data: Void) {}
})
//可选 绑定用户资料 第一次绑定后没有跟新个人资料可不用每次都绑定
//也可以在服务端绑定用户 服务端也可以调用
val ext = HashMap<String, String>()
// 可选参数，接入用户希望在直播间的在线用户列表/资料卡等UI中显示自定义字段如vip等级等等接入方的业务字段
ext.put("vip", "1")
ext.put("xxx", "xxx")
//跟新/绑定 业务端的用户信息
QLive.setUser(QUserInfo("your avatar", "your nick", ext), object : QLiveCallBack<Void> {
override fun onError(code: Int, msg: String?) {}
override fun onSuccess(data: Void?) {}
})
val liveUIKit = QLive.getLiveUIKit()
//跳转到直播列表页面
liveUIKit.launch(context)
> 登陆成功后才能使用sdk
### 主动跳转到直播间
//主动跳转观众直播间
QLive.getLiveUIKit().getPage(RoomPage::class.java).startPlayerRoomActivity(...)
//主播主动跳转已经存在主播直播间
QLive.getLiveUIKit().getPage(RoomPage::class.java).startAnchorRoomActivity(...)
//自定义开播跳转预览创建直播间页面
QLive.getLiveUIKit().getPage(RoomPage::class.java).startAnchorRoomWithPreview(...)
### 定制UI
#### 修改现有的UI组件
**直接修改开源代码** uikit使用源码依赖，直接修改源码
> 优点：快捷 缺点：官方更新UI逻辑代码后不方便同步
**无侵入式自定义UI** uikit使用sdk依赖
拷贝布局文件--只需拷贝需要修改的页面，拷贝至接入的工程并且重新命名
* kit_activity_room_player.xml //[观众直播间布局 ](https://github.com/qiniu/QNLiveKit_Android/blob/main/liveroom-uikit/src/main/res/layout/kit_activity_room_player.xml)
* kit_activity_room_pusher.xm //[主播直播间布局](https://github.com/qiniu/QNLiveKit_Android/blob/main/liveroom-uikit/src/main/res/layout/kit_activity_room_pusher.xml)
* kit_activity_room_list.xml //[房间列表页布局](https://github.com/qiniu/QNLiveKit_Android/blob/main/liveroom-uikit/src/main/res/layout/kit_activity_room_list.xml)
clear重新编译编译-->androidStudio预览看到如上效果图
* 1修改拷贝文件的布局任意属性，比如边距，文本颜色，样式等等
* 2调用替换布局文件
val roomPage = QLive.getLiveUIKit().getPage(RoomPage::class.java)
//自定义房间页面观众房间的布局
roomPage.playerCustomLayoutID = R.layout.customXXXlayout
//自定义房间页面主播房间的布局
roomPage.anchorCustomLayoutID = R.layout.customXXlayout
val roomListPage = QLive.getLiveUIKit().getPage(RoomListPage::class.java)
//自定义房间列表页面布局
roomListPage.customLayoutID = R.layout.customXlayout
修改拷贝的布局文件或者源布局文件
案列：
<!-- 找到房间背景图-->
<com.qlive.uikitcore.QKitImageView
android:layout_width="match_parent"
android:layout_height="match_parent"
android:src="@drawable/kit_dafault_room_bg" />
<!--替换-->
<com.qlive.uikitcore.QKitImageView
android:layout_width="match_parent"
android:layout_height="match_parent"
android:src="@drawable/my_room_bg" />
> tip: 所有的安卓自带基础UI都可以修改属性 如边距,父容器排列，文本颜色等等
如果要替换UI里面的逻辑代码 创建自定义UI组件 继承QLiveComponent 案列：
//自定义一个公告UI组件--参考原来的公告实现
class CustomNoticeView :FrameLayout, com.qlive.uikit.QLiveComponent {
constructor(context: Context) : this(context, null)
constructor(context: Context, attrs: AttributeSet?) : this(context, attrs, 0)
constructor(context: Context, attrs: AttributeSet?, defStyleAttr: Int) : super(
context,
attrs,
defStyleAttr
){
//自己的公告布局
LayoutInflater.from(context).inflate(R.layout.customnoticeview,this,true)
}
//绑定UI组件上下文 context中包涵UI实现安卓平台功能的字段如activity fragmentManager
override fun attachKitContext(context: com.qlive.uikit.QLiveUIKitContext) {}
//绑定房间客户端 通过client可以获取业务实现
override fun attachLiveClient(client: QLiveClient) {}
//进入回调 在这个阶段可以提前根据liveId提前初始化一些UI
override fun onEntering(liveID: String, user: QLiveUser) { }
//加入回调 房间加入成功阶段 已经拿到了QLiveRoomInfo
override fun onJoined(roomInfo: QLiveRoomInfo, isResumeFromFloating: Boolean) {
//设置房间公告文本 公告文本roomInfo中字段取出
tvNotice.setText("房间公告："+roomInfo.notice)
}
//离开回调
override fun onLeft() {
//房间切换/离开 清空UI
tvNotice.setText("")
}
// 销毁
override fun onDestroyed() { }
//安卓activity生命周期 安卓页面 onresume onpause等等
override fun onStateChanged(source: LifecycleOwner, event: Lifecycle.Event) {}
}
//自定义UI可以参考原来的实现修改成自定义实现
//提示：所有的UI组件不需要在activity绑定操作 只需要继承QLiveComponent就能完成所有工作
然后在拷贝布局文件里或者源码布局里替换原来内置的UI组件
<!-- 原来的UI组件-->
<com.qlive.uikitpublicchat.RoomNoticeView
android:layout_width="238dp"
android:layout_height="wrap_content"
android:layout_marginStart="8dp"
android:layout_marginBottom="2dp"
android:background="@drawable/kit_shape_40000000_6"
android:orientation="vertical"
android:paddingStart="8dp"
android:paddingTop="16dp"
android:paddingEnd="8dp"
android:paddingBottom="16dp"
android:textColor="#ffffff"
android:textSize="13sp"
tools:text="官方公告" />
<!-- 改成你自己的-->
<CustomNoticeView
android:layout_width="238dp"
android:layout_height="wrap_content"/>
> 提示不需要修改activity
#### 删除内置UI组件
直接在拷贝的布局文件或者源码布局里里删除
案列：去掉pk功能 在xml里直接删除开始pk按钮
<!-- 去掉开始pk按钮-->
<com.qlive.uikitpk.StartPKView
android:layout_width="wrap_content"
android:layout_height="wrap_content" />
<!-- 去掉pk预览-->
<com.qlive.uikitpk.PKAnchorPreview
android:layout_width="match_parent"
android:layout_height="match_parent" />
> UI插件的增删改不需要修改activity
#### 添加UI组件
class CustomView :FrameLayout, com.qlive.uikit.QLiveComponent {
// 实现自己额外的多个UI布局
}
//在拷贝的布局文件里或者源码布局里你想要的位置添加即可
#### 自定义房间列表页面
如果需要将房间列表页面添加到你想要的页面比如app首页的viewpager切换，否则直接替换修改内在roomList布局就可以了
方式1 使用RoomListView
在想要添加的布局xml里面添加RoomListView
<!-- empty_placeholder_tips 没有数据的占位提示-->
<!-- empty_placeholder_no_net_icon 没有网络的占位图片-->
<!-- empty_placeholder_icon 没有数据的占位图片-->
<com.qlive.uikit.component.RoomListView
android:layout_width="match_parent"
android:layout_height="match_parent"
app:empty_placeholder_icon="@drawable/kit_pic_empty"
app:empty_placeholder_no_net_icon="@drawable/kit_pic_empty_network"
app:empty_placeholder_tips="空空如也" />
在你的activivity代码里配置样式
//可选 替换列表item适配
roomListView.setRoomAdapter(CustomAdapter())
//必选 启动
roomListView.attachKitContext(QUIKitContext(this,supportFragmentManager,this,this))
方式2 使用 qlive数据api
//使用 qlive数据api 获取房间等数据自定义UI
QLive.getRooms().listRoom(..）
QLive.getRooms().createRoom(..）
方式3 修改UIkit源码
### UI插件通信事件
如选择不修改源码的形式接入uikit，如何在不同模块间UI插件实现通信
//定义一个UI事件 继承UIEvent
public class TestUIEvent extends UIEvent{
//自定义多个字段
public int testInt = 2;
}
在某个UI组件里注册事件
//注册TestUIEvent
registerEventAction(TestUIEvent::class.java) {
//事件数据
event:TestUIEvent ->
//收到测试事件1的回调
Log.d("UIEvent",event.getAction()+" "+event.testInt)
}
//注册其他更多UIEvent
registerEventAction(xxxUIEvent::class.java) {event:xxxUIEvent ->
//收到测试事件xxx的回调
Log.d("UIEvent",event.getAction())
}
在另外一个UI组件里发送事件
sendUIEvent(TestUIEvent().apply {testInt = 1000;})
### 使用美颜插件（可选）
拷贝源码模块uikit-beauty并且添加依赖
implementation project(":qlive-uicomponnets:uikit-beauty")
* (必选) 联系七牛商务获取美颜认证lic文件 重命名SenseME.lic放在assets文件下->运行sdk已经带了美颜滤镜贴纸功能
* (可选 -自定义调节UI面板) 修改美颜调节面板UI及拷贝购买的额外的素材文件/或删除原有用不着的素材至uikit-beauty/assets
* (可选 -自定义显示美颜弹窗按钮)uikit中调用 kitContext?.getLiveFuncComponent(FuncCPTBeautyDialogShower::class.java)?.showBeautyEffectDialog() 即可显示美颜特效弹窗
* (可选 -自定义显示贴纸弹窗按钮)uikit中调用 kitContext?.getLiveFuncComponent(FuncCPTBeautyDialogShower::class.java) ?.showBeautyStickDialog() 即可显示美颜贴纸弹窗
#### 外接其他美颜
client.setVideoFrameListener(object:QVideoFrameListener{
//拿到帧回调即可以使用其他美颜sdk处理
})
### 小窗播放
配置权限
<!-- 系统悬浮窗权限 -->
<uses-permission android:name="android.permission.SYSTEM_ALERT_WINDOW" />
<!-- 从桌面返回 -->
<uses-permission android:name="android.permission.REORDER_TASKS" />
在UIkit中 启动小窗播放
//FloatingModel.GO_DESKTOP (开始悬浮并返回桌面)
//FloatingModel.BACK_LAST_PAGE (开始悬浮返回上一个页面 -- 当前activity会销毁-可再次进入或进入新的直播间)
//FloatingModel.GO_NEXT_PAGE (开始悬浮去下一页面)
kitContext.getLiveFuncComponent(FuncCPTPlayerFloatingHandler::class.java)?.create(FloatingModel) { succeed: Boolean, msg: String ->
//小窗后要跳转的页面
}
小窗组件功能概览 如需自定义参考配置
//内置悬浮窗播放功能组件
class FuncCPTPlayerFloatingHandler{
//静态配置
companion object {
//当前正在展示的悬浮窗
fun currentFloatingPlayerView(): FloatingPlayerView?
/**
* 自定义权限申请提示
默认权限申请时候提示用户开始权限，，自定义可以替换
* Permission request tip call
* @param afterTipCall 自定义权限申请提示
* afterTipCall.invoke(true) == 已经提示完成可以去申请
* afterTipCall.invoke(false) == 不去申请，取消操作
*/
var permissionRequestTipCall: (kitConText: com.qlive.uikit.QLiveUIKitContext, afterTipCall: (Boolean) -> Unit) -> Unit ={}
}
/**
* 开始悬浮播放
* @param floatingModel 悬浮窗模式
* @param view 自定义小窗UI 默认DefaultFloatingPlayerView
* @param config 小窗的位置等配置参数
* @param createCall 成功失败回调
*/
fun create(
floatingModel: FloatingModel,
view: FloatingPlayerView = DefaultFloatingPlayerView(),
config: FloatConfig = createDefaultFloatConfig(kitContext!!.androidContext),
createCall: (Boolean, String) -> Unit
){}
}
### 跳转直播间携带本地参数
如果需要跳转直播携带一些本地的参数。 调用带StartRoomActivityExtSetter参数的启动直播间方法
QLive.getLiveUIKit()
.getPage(RoomPage::class.java)
.startXXXXRoomActivity(this,
"id",
//自定义本地参数
object : StartRoomActivityExtSetter {
override fun setExtParams(startIntent: Intent) {
//安卓平台Intent的存放参数
startIntent.putExtra("xxx", "xxx")
}
}, null
)
在直播间任意UI插件中通过上下文获取
val xxx = kitContext.currentActivity.intent.getStringExtra("xxx")
### 定制内置UI组件点击事件和样式
每个内置的UI组件都有静态的样式配置和事件回调 如设置直播间在线用户的样式
//设置点击事件
OnlineUserView.onItemUserClickListener={
kitContext, //上下文
client, //客户端
view, //点击的UI
user //点击的用户
->
// todo 跳转用户主页等操作
}
//设置item样式
OnlineUserView.adapterProvider={
kitContext, //上下文
client, //客户端
->
CustomOnlineUserViewAdapter() //返回自定义列表适配
}
## 无UI-标准集成
//初始化
QLive.init(this, QLiveConfig()) {
callback ->
//业务方如何获取token 在token过期和登陆时候会回调该方法
getLoginToken(callback)
}
//登陆
QLive.auth(object : QLiveCallBack<Void> {
override fun onError(code: Int, msg: String?) {}
override fun onSuccess(data: Void) {}
})
//可选 绑定用户资料 第一次绑定后没有跟新个人资料可不用每次都绑定
//也可以在服务端绑定用户 服务端也可以调用
val ext = HashMap<String, String>()
// 可选参数，接入用户希望在直播间的在线用户列表/资料卡等UI中显示自定义字段如vip等级等等接入方的业务字段
ext.put("vip", "1")
ext.put("xxx", "xxx")
//跟新/绑定 业务端的用户信息
QLive.setUser(QUserInfo("your avatar", "your nick", ext), object : QLiveCallBack<Void> {
override fun onError(code: Int, msg: String?) {}
override fun onSuccess(data: Void?) {}
})
//创建房间
val param = QCreateRoomParam()
param.setTitle("xxxtitle");
QLive.getRooms().createRoom(param, object : QLiveCallBack<QLiveRoomInfo> {
override fun onError(code: Int, msg: String) {
}
override fun onSuccess(data: QLiveRoomInfo) {
}
})
// 主播推流
//创建推流client
val client = QLive.createPusherClient()
val microphoneParams = QMicrophoneParam()
microphoneParam.setSampleRate(48000)
//启动麦克风模块
client.enableMicrophone(microphoneParam)
val cameraParam = QCameraParam()
cameraParam.setFPS(15)
//启动摄像头模块
client.enableCamera(cameraParam,findViewById(R.id.renderView))
//注册房间端监听
client.setLiveStatusListener(object : QLiveStatusListener{})
//加入房间
client.joinRoom(roomId, object : QLiveCallBack<QLiveRoomInfo> {
override fun onError(code: Int, msg: String?) {
}
override fun onSuccess(data: QLiveRoomInfo) {
}
})
//关闭
client.closeRoom(object : QLiveCallBack<Void> {
override fun onError(code: Int, msg: String?) {
}
override fun onSuccess(data: Void?) {
}
})
//销毁
client.destroy()
//用户拉流房间
val client = QLive.createPlayerClient()
//注册房间端监听
client.setLiveStatusListener(object : QLiveStatusListener{})
//加入房间
client.joinRoom(roomId, object :
QLiveCallBack<QLiveRoomInfo> {
override fun onError(code: Int, msg: String?) {
}
override fun onSuccess(data: QLiveRoomInfo) {
}
})
//播放
client.play(findViewById(R.id.renderView));
//离开
client.leaveRoom(object : QLiveCallBack<Void> {
override fun onError(code: Int, msg: String?) {
}
override fun onSuccess(data: Void?) {
}
})
//销毁
client.destroy()
### 使用插件服务
client.getService(QxxxService::class.java) //获取某个业务插件服务
//案列
client.getService(QPKService::class.java)?.start(20 * 1000, receiverRoomID, receiver.userId, null,object : QLiveCallBack<QPKSession> {})
### 无UISDK实现连麦
[多人连麦demo](https://github.com/qiniu/QNLiveKit_Android/blob/main/qlive-
uicomponnets/uikit-
linkmic/src/main/java/com/qlive/uikitlinkmic/MicLinkersView.kt)
[分屏连麦demo](https://github.com/qiniu/QNLiveKit_Android/blob/main/qlive-
uicomponnets/uikit-
linkmic/src/main/java/com/qlive/uikitlinkmic/MicLinkerSplitScreenPreview.java)
package com.qlive.qnlivekit
//邀请监听
private val mInvitationListener = object : QInvitationHandlerListener {
//收到邀请
override fun onReceivedApply(qInvitation: QInvitation) {
//todo 显示申请弹窗 qInvitation.getInitiator()获取到申请方资料 显示UI
// 点击按钮 拒绝操作
client!!.getService(QLinkMicService::class.java).invitationHandler.reject(qInvitation.invitationID, null, callBack)
//点击按钮 接受操作
client!!.getService(QLinkMicService::class.java).invitationHandler.accept(qInvitation.invitationID, null, callBack)
}
//收到对方取消
override fun onApplyCanceled(qInvitation: QInvitation) {}
//发起超时对方没响应
override fun onApplyTimeOut(qInvitation: QInvitation) {}
//对方接受
override fun onAccept(qInvitation: QInvitation) {
//对方接受后调用开始上麦 传摄像头麦克参数 自动开启相应的媒体流
client?.getService(QLinkMicService::class.java)?.audienceMicHandler?.startLink(null, QCameraParam(), QMicrophoneParam(), callback)
}
//对方拒绝
override fun onReject(qInvitation: QInvitation) {}
}
//麦位麦位监听
private val mQLinkMicServiceListener = object : QLinkMicServiceListener {
//有人上麦了
override fun onLinkerJoin(micLinker: QMicLinker) {
//麦上用户和主播设置这个用户预览 直播拉流用户无需设置
val preview = QPushTextureView(context)
//添加到你要添加到的容器
containerView.addView(preview)
//设置该用户的预览
linkService.setUserPreview(micLinker.user.userId, preview)
//跟新连麦UI 如果要显示头像 micLinker里取到上麦者资料
}
//有人下麦了
override fun onLinkerLeft(micLinker: QMicLinker) {
//移除已经设置的预览窗口
container.removeUserPreView(xxxx)
//跟新连麦UI 比如去掉麦上头像
}
override fun onLinkerMicrophoneStatusChange(micLinker: QMicLinker) {
//跟新连麦UI
}
override fun onLinkerCameraStatusChange(micLinker: QMicLinker) {
//跟新连麦UI
}
//某个用户被踢麦
override fun onLinkerKicked(micLinker: QMicLinker, msg: String) {}
override fun onLinkerExtensionUpdate(micLinker: QMicLinker, extension: QExtension) {}
}
//混流适配 房主负责混流
private val mQMixStreamAdapter =
object : QLinkMicMixStreamAdapter {
/**
* 连麦开始如果要自定义混流画布和背景
* 返回空则主播推流分辨率有多大就多大默认实现
* @return
*/
override fun onMixStreamStart(): QMixStreamParams? {
return null
}
/**
* 混流布局适配
*/
override fun onResetMixParam(
micLinkers: MutableList<QMicLinker>, //所有麦位置
target: QMicLinker, //目标麦位
isJoin: Boolean //是否是加入 否则离开
): MutableList<QMergeOption> {
//将变化后的麦位换算成连麦混流参数
//比如 案例(x,y) ->1号麦位（0，200 ）2号麦位（0，200+180+15）3号麦位（0，200+2*180+15）...
val ops = ArrayList<QMergeOption>()
val lastY = 200
micLinkers.forEachIndex { index, linker ->
ops.add(QMergeOption().apply {
// 该连麦者的用户ID
uid = linker.user.userId
//该用户的摄像头参数
cameraMergeOption = CameraMergeOption().apply {
isNeed = true
x = 0 //麦位x
y = lastY + 180 + 15 //每个麦位 依次往下排 180 + 15 个分辨率间距
z = 0
width = 180
height = 180
}
//该用户的麦克风参数
microphoneMergeOption = MicrophoneMergeOption().apply {
isNeed = true
}
})
lastY = lastY + 180 + 15
}
}
}
//观众端连麦器监听
private val mQAudienceMicHandler = object : QAudienceMicHandler.LinkMicHandlerListener {
override fun onRoleChange(isLinker: Boolean) {
if (isLinker) {
//我切换到了连麦模式 -> 使用连麦和麦上用户和主播互动 延迟更低
client?.getService(QLinkMicService::class.java)?.allLinker?.forEach { micLinker ->
//对原来麦上的人设置预览
val preview = QPushTextureView(context)
//添加到你要添加到的容器
containerView.addView(preview)
//设置该用户的预览
linkService.setUserPreview(micLinker.user.userId, preview)
}
} else {
//我切换拉流模式
client?.getService(QLinkMicService::class.java)?.allLinker?.forEach {
//移除对原来设置麦位移除设置预览view
removePreview(it.user.userId)
}
}
}
}
//主播设置混流适配
client!!.getService(QLinkMicService::class.java).anchorHostMicHandler.setMixStreamAdapter( mQMixStreamAdapter )
//观众设置观众连麦处理监听
client!!.getService(QLinkMicService::class.java).audienceMicHandler.addLinkMicListener( mQAudienceMicHandler )
//主播和观众都关心麦位监听
client!!.getService(QLinkMicService::class.java).addMicLinkerListener(mQLinkMicServiceListener)
//注册邀请监听
client.getService(QLinkMicService::class.java).invitationHandler.addInvitationHandlerListener( mInvitationListener )
//点击某个按钮 发起对某个主播申请 或者主播邀请用户
client!!.getService(QLinkMicService::class.java).invitationHandler.apply(10 * 1000, room.liveID, room.anchor.userId, null,callback )
如果不使用内置的邀请系统 比如外接匹配系统或者直接上麦不需要邀请
//todo
// 别的邀请或者匹配
//直接调用上麦方法
client?.getService(QLinkMicService::class.java)?.audienceMicHandler?.startLink( null, QCameraParam() , QMicrophoneParam(),callback )
### 无UISDK 实现PK
//邀请监听
private val mPKInvitationListener = object : QInvitationHandlerListener {
//收到邀请
override fun onReceivedApply(pkInvitation: QInvitation) {
//拒绝操作
client!!.getService(QPKService::class.java).invitationHandler.reject(pkInvitation.invitationID, null, callBack)
//接受
client!!.getService(QPKService::class.java).invitationHandler.accept(pkInvitation.invitationID, null, callBack)
}
//收到对方取消
override fun onApplyCanceled(pkInvitation: QInvitation) {}
//发起超时对方没响应
override fun onApplyTimeOut(pkInvitation: QInvitation) {}
//对方接受
override fun onAccept(pkInvitation: QInvitation) {
//对方接受后调用开始pk
client?.getService(QPKService::class.java)?.start(20 * 1000, invitation.receiverRoomID, invitation.receiver.userId, null, callBack)
}
//对方拒绝
override fun onReject(pkInvitation: QInvitation) {}
}
//pk监听
private val mQPKServiceListener = object : QPKServiceListener {
override fun onStart(pkSession: QPKSession) {
//主播设置对方主播预览
client.getService(QPKService::class.java).setPeerAnchorPreView(findviewbyid(...))
//主播和观众都显示pk覆盖UI
}
override fun onStop(pkSession: QPKSession, code: Int, msg: String) {
//主播移除预览对方的UI 主播和观众都隐藏pk覆盖UI
}
override fun onStartTimeOut(pkSession: QPKSession) {}
override fun onPKExtensionUpdate(pkSession: QPKSession, extension: QExtension) {
}
}
//混流适配
private val mQPKMixStreamAdapter = object : QPKMixStreamAdapter {
//pk对方进入了 返回混流参数（同连麦）
override fun onPKLinkerJoin(pkSession: QPKSession): MutableList<QMergeOption> {
return LinkerUIHelper.getPKMixOp(pkSession, user!!)
}
//pk开始了 如果修改整个直播混流面板（同连麦）
override fun onPKMixStreamStart(pkSession: QPKSession): QMixStreamParams {
return QMixStreamParams()
}
}
//添加pk监听
client!!.getService(QPKService::
class.java).addServiceListener(mQPKServiceListener)
//主播注册混流适配
client!!.getService(QPKService::
class.java).setPKMixStreamAdapter(mQPKMixStreamAdapter)
//注册邀请监听
client.getService(QPKService::
class.java).invitationHandler.addInvitationHandlerListener( mPKInvitationListener )
//点击某个按钮 发起对某个主播邀请
client!!.getService(QPKService::
class.java).invitationHandler.apply(10 * 1000, room.liveID, room.anchor.userId, null,callback )
如果不使用内置的邀请系统 比如外接匹配pk系统
//todo 别的邀请或者匹配
//直接调用开始PK方法
client?.getService(QPKService::class.java)?.start(20 * 1000, invitation.receiverRoomID, invitation.receiver.userId, null,callBack)
### 自定义IM,播放器，rtc sdk参数配置
#### 自定义im初始化
QNIMConfig.imSDKConfigGetter = { appId: String, context: Context ->
//返回你的自定义配置参数，比如加上推送配置，使用参考七牛im文档。
BMXSDKConfig()
}
#### 自定义播放器参数
QMediaPlayerConfig.mAVOptionsGetter = {
//返回你的自定义AVOptions，使用参考七牛播放器文档
AVOptions（）
}
#### 自定义rtc配置
QRtcLiveRoomConfig.mRTCSettingGetter = {
//返回你的rtc配置，使用参考七牛rtc文档
QNRTCSetting()
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[低代码](https://developer.qiniu.com/lowcode) > 使用文档 >
[互动直播](https://developer.qiniu.com/lowcode/manual/12004/qlive) > 安卓端接入指南
# 安卓端接入指南
最近更新时间: 2022-12-26 13:57:39
+---------------+ +---> RoomListPage //房间列表UI实现页面
| | |
+---+ QLiveUIKIT +--- -+
| | | |
| +---------------+ +---> RoomPage //直播间页面UI实现
| uikit sdk
|
|
|
| +---> createRoom //创建房间接口
| +---------------+ |
+----------------------+ | | | +---> listRoom //房间列表接口
| | +---+ QRooms +-----+
| QLive | | | | +---> deleteRoom //删除房间接口
| | | +---------------+ |
+----------------------+ | 房间管理接口 +---> getRoomInfo //获取房间信息接口
|
|
|
| +---> QChatRoomService //聊天室服务
| +----------------+ |
| | | +---> QLinkMicService //连麦业务服务
+---+ QLiveClient +---+
| | +---> QPKService //pk业务服务
+----------------+ |
推拉流房间客户端 +---> QPublicChatService //房间里公屏消息服务
无UI版本sdk |
+---> QRoomService //房间频道业务
|
+---> QDanmakuService //弹幕服务
|
+---> QShoppingService //电商购物服务
|
+---> QGiftService //礼物服务
|
+---> QLikeService //点赞服务
## sdk接入
1 下载sdk [下载地址](https://github.com/qiniu/QNLiveKit_Android/tree/main/app-sdk)
2 参考dome工程的build.gradle文件 配置aar
//七牛imsdk 必选
implementation project(':app-sdk:depends_sdk_qnim')
//七牛rtc 主播推流必选 观众要连麦必选
implementation project(':app-sdk:depends_sdk_qrtc')
//七牛播放器 观众拉流端必选
implementation project(':app-sdk:depends_sdk_piliplayer')
//低代码无ui sdk 必选
implementation project(':app-sdk:qlive-sdk')
//okhttp 3版本以上
implementation 'com.squareup.okhttp3:okhttp:4.2.2'
//json
implementation 'com.google.code.gson:gson:2.8.9'
//UIkit包 不使用UI则不需要依赖
implementation project(':app-sdk:qlive-sdk-uikit')
//谷歌官方UI组件
implementation 'androidx.lifecycle:lifecycle-runtime-ktx:2.3.0'
implementation 'androidx.recyclerview:recyclerview:1.1.0'
implementation 'androidx.cardview:cardview:1.0.0'
//图片加载
implementation 'com.github.bumptech.glide:glide:4.11.0'
//如果没有开启 viewbinding 选项 务必依赖这个库
implementation "androidx.databinding:viewbinding:7.1.2"
> UIkit也可以直接使用源码模块-可直接修改代码
>
> #### implementation project(':qlive-uikit')
3 混淆配置 如果你的项目需要混淆
[qlivesdk混淆配置参考](https://github.com/qiniu/QNLiveKit_Android/blob/main/app/proguard-
rules.pro)
## UIKIT使用说明
### 初始化
//初始化
QLive.init(this, QLiveConfig()) { callback ->
//业务方如何获取token 在token过期和登陆时候会回调该方法
getLoginToken(callback)
}
//登陆
QLive.auth(object : QLiveCallBack<Void> {
override fun onError(code: Int, msg: String?) {}
override fun onSuccess(data: Void) {}
})
//可选 绑定用户资料 第一次绑定后没有跟新个人资料可不用每次都绑定
//也可以在服务端绑定用户 服务端也可以调用
val ext = HashMap<String, String>()
// 可选参数，接入用户希望在直播间的在线用户列表/资料卡等UI中显示自定义字段如vip等级等等接入方的业务字段
ext.put("vip", "1")
ext.put("xxx", "xxx")
//跟新/绑定 业务端的用户信息
QLive.setUser(QUserInfo("your avatar", "your nick", ext), object : QLiveCallBack<Void> {
override fun onError(code: Int, msg: String?) {}
override fun onSuccess(data: Void?) {}
})
val liveUIKit = QLive.getLiveUIKit()
//跳转到直播列表页面
liveUIKit.launch(context)
> 登陆成功后才能使用sdk
### 主动跳转到直播间
//主动跳转观众直播间
QLive.getLiveUIKit().getPage(RoomPage::class.java).startPlayerRoomActivity(...)
//主播主动跳转已经存在主播直播间
QLive.getLiveUIKit().getPage(RoomPage::class.java).startAnchorRoomActivity(...)
//自定义开播跳转预览创建直播间页面
QLive.getLiveUIKit().getPage(RoomPage::class.java).startAnchorRoomWithPreview(...)
### 定制UI
#### 修改现有的UI组件
**直接修改开源代码** uikit使用源码依赖，直接修改源码
> 优点：快捷 缺点：官方更新UI逻辑代码后不方便同步
**无侵入式自定义UI** uikit使用sdk依赖
拷贝布局文件--只需拷贝需要修改的页面，拷贝至接入的工程并且重新命名
* kit_activity_room_player.xml //[观众直播间布局 ](https://github.com/qiniu/QNLiveKit_Android/blob/main/liveroom-uikit/src/main/res/layout/kit_activity_room_player.xml)
* kit_activity_room_pusher.xm //[主播直播间布局](https://github.com/qiniu/QNLiveKit_Android/blob/main/liveroom-uikit/src/main/res/layout/kit_activity_room_pusher.xml)
* kit_activity_room_list.xml //[房间列表页布局](https://github.com/qiniu/QNLiveKit_Android/blob/main/liveroom-uikit/src/main/res/layout/kit_activity_room_list.xml)
clear重新编译编译-->androidStudio预览看到如上效果图
* 1修改拷贝文件的布局任意属性，比如边距，文本颜色，样式等等
* 2调用替换布局文件
val roomPage = QLive.getLiveUIKit().getPage(RoomPage::class.java)
//自定义房间页面观众房间的布局
roomPage.playerCustomLayoutID = R.layout.customXXXlayout
//自定义房间页面主播房间的布局
roomPage.anchorCustomLayoutID = R.layout.customXXlayout
val roomListPage = QLive.getLiveUIKit().getPage(RoomListPage::class.java)
//自定义房间列表页面布局
roomListPage.customLayoutID = R.layout.customXlayout
修改拷贝的布局文件或者源布局文件
案列：
<!-- 找到房间背景图-->
<com.qlive.uikitcore.QKitImageView
android:layout_width="match_parent"
android:layout_height="match_parent"
android:src="@drawable/kit_dafault_room_bg" />
<!--替换-->
<com.qlive.uikitcore.QKitImageView
android:layout_width="match_parent"
android:layout_height="match_parent"
android:src="@drawable/my_room_bg" />
> tip: 所有的安卓自带基础UI都可以修改属性 如边距,父容器排列，文本颜色等等
如果要替换UI里面的逻辑代码 创建自定义UI组件 继承QLiveComponent 案列：
//自定义一个公告UI组件--参考原来的公告实现
class CustomNoticeView :FrameLayout, com.qlive.uikit.QLiveComponent {
constructor(context: Context) : this(context, null)
constructor(context: Context, attrs: AttributeSet?) : this(context, attrs, 0)
constructor(context: Context, attrs: AttributeSet?, defStyleAttr: Int) : super(
context,
attrs,
defStyleAttr
){
//自己的公告布局
LayoutInflater.from(context).inflate(R.layout.customnoticeview,this,true)
}
//绑定UI组件上下文 context中包涵UI实现安卓平台功能的字段如activity fragmentManager
override fun attachKitContext(context: com.qlive.uikit.QLiveUIKitContext) {}
//绑定房间客户端 通过client可以获取业务实现
override fun attachLiveClient(client: QLiveClient) {}
//进入回调 在这个阶段可以提前根据liveId提前初始化一些UI
override fun onEntering(liveID: String, user: QLiveUser) { }
//加入回调 房间加入成功阶段 已经拿到了QLiveRoomInfo
override fun onJoined(roomInfo: QLiveRoomInfo, isResumeFromFloating: Boolean) {
//设置房间公告文本 公告文本roomInfo中字段取出
tvNotice.setText("房间公告："+roomInfo.notice)
}
//离开回调
override fun onLeft() {
//房间切换/离开 清空UI
tvNotice.setText("")
}
// 销毁
override fun onDestroyed() { }
//安卓activity生命周期 安卓页面 onresume onpause等等
override fun onStateChanged(source: LifecycleOwner, event: Lifecycle.Event) {}
}
//自定义UI可以参考原来的实现修改成自定义实现
//提示：所有的UI组件不需要在activity绑定操作 只需要继承QLiveComponent就能完成所有工作
然后在拷贝布局文件里或者源码布局里替换原来内置的UI组件
<!-- 原来的UI组件-->
<com.qlive.uikitpublicchat.RoomNoticeView
android:layout_width="238dp"
android:layout_height="wrap_content"
android:layout_marginStart="8dp"
android:layout_marginBottom="2dp"
android:background="@drawable/kit_shape_40000000_6"
android:orientation="vertical"
android:paddingStart="8dp"
android:paddingTop="16dp"
android:paddingEnd="8dp"
android:paddingBottom="16dp"
android:textColor="#ffffff"
android:textSize="13sp"
tools:text="官方公告" />
<!-- 改成你自己的-->
<CustomNoticeView
android:layout_width="238dp"
android:layout_height="wrap_content"/>
> 提示不需要修改activity
#### 删除内置UI组件
直接在拷贝的布局文件或者源码布局里里删除
案列：去掉pk功能 在xml里直接删除开始pk按钮
<!-- 去掉开始pk按钮-->
<com.qlive.uikitpk.StartPKView
android:layout_width="wrap_content"
android:layout_height="wrap_content" />
<!-- 去掉pk预览-->
<com.qlive.uikitpk.PKAnchorPreview
android:layout_width="match_parent"
android:layout_height="match_parent" />
> UI插件的增删改不需要修改activity
#### 添加UI组件
class CustomView :FrameLayout, com.qlive.uikit.QLiveComponent {
// 实现自己额外的多个UI布局
}
//在拷贝的布局文件里或者源码布局里你想要的位置添加即可
#### 自定义房间列表页面
如果需要将房间列表页面添加到你想要的页面比如app首页的viewpager切换，否则直接替换修改内在roomList布局就可以了
方式1 使用RoomListView
在想要添加的布局xml里面添加RoomListView
<!-- empty_placeholder_tips 没有数据的占位提示-->
<!-- empty_placeholder_no_net_icon 没有网络的占位图片-->
<!-- empty_placeholder_icon 没有数据的占位图片-->
<com.qlive.uikit.component.RoomListView
android:layout_width="match_parent"
android:layout_height="match_parent"
app:empty_placeholder_icon="@drawable/kit_pic_empty"
app:empty_placeholder_no_net_icon="@drawable/kit_pic_empty_network"
app:empty_placeholder_tips="空空如也" />
在你的activivity代码里配置样式
//可选 替换列表item适配
roomListView.setRoomAdapter(CustomAdapter())
//必选 启动
roomListView.attachKitContext(QUIKitContext(this,supportFragmentManager,this,this))
方式2 使用 qlive数据api
//使用 qlive数据api 获取房间等数据自定义UI
QLive.getRooms().listRoom(..）
QLive.getRooms().createRoom(..）
方式3 修改UIkit源码
### UI插件通信事件
如选择不修改源码的形式接入uikit，如何在不同模块间UI插件实现通信
//定义一个UI事件 继承UIEvent
public class TestUIEvent extends UIEvent{
//自定义多个字段
public int testInt = 2;
}
在某个UI组件里注册事件
//注册TestUIEvent
registerEventAction(TestUIEvent::class.java) {
//事件数据
event:TestUIEvent ->
//收到测试事件1的回调
Log.d("UIEvent",event.getAction()+" "+event.testInt)
}
//注册其他更多UIEvent
registerEventAction(xxxUIEvent::class.java) {event:xxxUIEvent ->
//收到测试事件xxx的回调
Log.d("UIEvent",event.getAction())
}
在另外一个UI组件里发送事件
sendUIEvent(TestUIEvent().apply {testInt = 1000;})
### 使用美颜插件（可选）
拷贝源码模块uikit-beauty并且添加依赖
implementation project(":qlive-uicomponnets:uikit-beauty")
* (必选) 联系七牛商务获取美颜认证lic文件 重命名SenseME.lic放在assets文件下->运行sdk已经带了美颜滤镜贴纸功能
* (可选 -自定义调节UI面板) 修改美颜调节面板UI及拷贝购买的额外的素材文件/或删除原有用不着的素材至uikit-beauty/assets
* (可选 -自定义显示美颜弹窗按钮)uikit中调用 kitContext?.getLiveFuncComponent(FuncCPTBeautyDialogShower::class.java)?.showBeautyEffectDialog() 即可显示美颜特效弹窗
* (可选 -自定义显示贴纸弹窗按钮)uikit中调用 kitContext?.getLiveFuncComponent(FuncCPTBeautyDialogShower::class.java) ?.showBeautyStickDialog() 即可显示美颜贴纸弹窗
#### 外接其他美颜
client.setVideoFrameListener(object:QVideoFrameListener{
//拿到帧回调即可以使用其他美颜sdk处理
})
### 小窗播放
配置权限
<!-- 系统悬浮窗权限 -->
<uses-permission android:name="android.permission.SYSTEM_ALERT_WINDOW" />
<!-- 从桌面返回 -->
<uses-permission android:name="android.permission.REORDER_TASKS" />
在UIkit中 启动小窗播放
//FloatingModel.GO_DESKTOP (开始悬浮并返回桌面)
//FloatingModel.BACK_LAST_PAGE (开始悬浮返回上一个页面 -- 当前activity会销毁-可再次进入或进入新的直播间)
//FloatingModel.GO_NEXT_PAGE (开始悬浮去下一页面)
kitContext.getLiveFuncComponent(FuncCPTPlayerFloatingHandler::class.java)?.create(FloatingModel) { succeed: Boolean, msg: String ->
//小窗后要跳转的页面
}
小窗组件功能概览 如需自定义参考配置
//内置悬浮窗播放功能组件
class FuncCPTPlayerFloatingHandler{
//静态配置
companion object {
//当前正在展示的悬浮窗
fun currentFloatingPlayerView(): FloatingPlayerView?
/**
* 自定义权限申请提示
默认权限申请时候提示用户开始权限，，自定义可以替换
* Permission request tip call
* @param afterTipCall 自定义权限申请提示
* afterTipCall.invoke(true) == 已经提示完成可以去申请
* afterTipCall.invoke(false) == 不去申请，取消操作
*/
var permissionRequestTipCall: (kitConText: com.qlive.uikit.QLiveUIKitContext, afterTipCall: (Boolean) -> Unit) -> Unit ={}
}
/**
* 开始悬浮播放
* @param floatingModel 悬浮窗模式
* @param view 自定义小窗UI 默认DefaultFloatingPlayerView
* @param config 小窗的位置等配置参数
* @param createCall 成功失败回调
*/
fun create(
floatingModel: FloatingModel,
view: FloatingPlayerView = DefaultFloatingPlayerView(),
config: FloatConfig = createDefaultFloatConfig(kitContext!!.androidContext),
createCall: (Boolean, String) -> Unit
){}
}
### 跳转直播间携带本地参数
如果需要跳转直播携带一些本地的参数。 调用带StartRoomActivityExtSetter参数的启动直播间方法
QLive.getLiveUIKit()
.getPage(RoomPage::class.java)
.startXXXXRoomActivity(this,
"id",
//自定义本地参数
object : StartRoomActivityExtSetter {
override fun setExtParams(startIntent: Intent) {
//安卓平台Intent的存放参数
startIntent.putExtra("xxx", "xxx")
}
}, null
)
在直播间任意UI插件中通过上下文获取
val xxx = kitContext.currentActivity.intent.getStringExtra("xxx")
### 定制内置UI组件点击事件和样式
每个内置的UI组件都有静态的样式配置和事件回调 如设置直播间在线用户的样式
//设置点击事件
OnlineUserView.onItemUserClickListener={
kitContext, //上下文
client, //客户端
view, //点击的UI
user //点击的用户
->
// todo 跳转用户主页等操作
}
//设置item样式
OnlineUserView.adapterProvider={
kitContext, //上下文
client, //客户端
->
CustomOnlineUserViewAdapter() //返回自定义列表适配
}
## 无UI-标准集成
//初始化
QLive.init(this, QLiveConfig()) {
callback ->
//业务方如何获取token 在token过期和登陆时候会回调该方法
getLoginToken(callback)
}
//登陆
QLive.auth(object : QLiveCallBack<Void> {
override fun onError(code: Int, msg: String?) {}
override fun onSuccess(data: Void) {}
})
//可选 绑定用户资料 第一次绑定后没有跟新个人资料可不用每次都绑定
//也可以在服务端绑定用户 服务端也可以调用
val ext = HashMap<String, String>()
// 可选参数，接入用户希望在直播间的在线用户列表/资料卡等UI中显示自定义字段如vip等级等等接入方的业务字段
ext.put("vip", "1")
ext.put("xxx", "xxx")
//跟新/绑定 业务端的用户信息
QLive.setUser(QUserInfo("your avatar", "your nick", ext), object : QLiveCallBack<Void> {
override fun onError(code: Int, msg: String?) {}
override fun onSuccess(data: Void?) {}
})
//创建房间
val param = QCreateRoomParam()
param.setTitle("xxxtitle");
QLive.getRooms().createRoom(param, object : QLiveCallBack<QLiveRoomInfo> {
override fun onError(code: Int, msg: String) {
}
override fun onSuccess(data: QLiveRoomInfo) {
}
})
// 主播推流
//创建推流client
val client = QLive.createPusherClient()
val microphoneParams = QMicrophoneParam()
microphoneParam.setSampleRate(48000)
//启动麦克风模块
client.enableMicrophone(microphoneParam)
val cameraParam = QCameraParam()
cameraParam.setFPS(15)
//启动摄像头模块
client.enableCamera(cameraParam,findViewById(R.id.renderView))
//注册房间端监听
client.setLiveStatusListener(object : QLiveStatusListener{})
//加入房间
client.joinRoom(roomId, object : QLiveCallBack<QLiveRoomInfo> {
override fun onError(code: Int, msg: String?) {
}
override fun onSuccess(data: QLiveRoomInfo) {
}
})
//关闭
client.closeRoom(object : QLiveCallBack<Void> {
override fun onError(code: Int, msg: String?) {
}
override fun onSuccess(data: Void?) {
}
})
//销毁
client.destroy()
//用户拉流房间
val client = QLive.createPlayerClient()
//注册房间端监听
client.setLiveStatusListener(object : QLiveStatusListener{})
//加入房间
client.joinRoom(roomId, object :
QLiveCallBack<QLiveRoomInfo> {
override fun onError(code: Int, msg: String?) {
}
override fun onSuccess(data: QLiveRoomInfo) {
}
})
//播放
client.play(findViewById(R.id.renderView));
//离开
client.leaveRoom(object : QLiveCallBack<Void> {
override fun onError(code: Int, msg: String?) {
}
override fun onSuccess(data: Void?) {
}
})
//销毁
client.destroy()
### 使用插件服务
client.getService(QxxxService::class.java) //获取某个业务插件服务
//案列
client.getService(QPKService::class.java)?.start(20 * 1000, receiverRoomID, receiver.userId, null,object : QLiveCallBack<QPKSession> {})
### 无UISDK实现连麦
[多人连麦demo](https://github.com/qiniu/QNLiveKit_Android/blob/main/qlive-
uicomponnets/uikit-
linkmic/src/main/java/com/qlive/uikitlinkmic/MicLinkersView.kt)
[分屏连麦demo](https://github.com/qiniu/QNLiveKit_Android/blob/main/qlive-
uicomponnets/uikit-
linkmic/src/main/java/com/qlive/uikitlinkmic/MicLinkerSplitScreenPreview.java)
package com.qlive.qnlivekit
//邀请监听
private val mInvitationListener = object : QInvitationHandlerListener {
//收到邀请
override fun onReceivedApply(qInvitation: QInvitation) {
//todo 显示申请弹窗 qInvitation.getInitiator()获取到申请方资料 显示UI
// 点击按钮 拒绝操作
client!!.getService(QLinkMicService::class.java).invitationHandler.reject(qInvitation.invitationID, null, callBack)
//点击按钮 接受操作
client!!.getService(QLinkMicService::class.java).invitationHandler.accept(qInvitation.invitationID, null, callBack)
}
//收到对方取消
override fun onApplyCanceled(qInvitation: QInvitation) {}
//发起超时对方没响应
override fun onApplyTimeOut(qInvitation: QInvitation) {}
//对方接受
override fun onAccept(qInvitation: QInvitation) {
//对方接受后调用开始上麦 传摄像头麦克参数 自动开启相应的媒体流
client?.getService(QLinkMicService::class.java)?.audienceMicHandler?.startLink(null, QCameraParam(), QMicrophoneParam(), callback)
}
//对方拒绝
override fun onReject(qInvitation: QInvitation) {}
}
//麦位麦位监听
private val mQLinkMicServiceListener = object : QLinkMicServiceListener {
//有人上麦了
override fun onLinkerJoin(micLinker: QMicLinker) {
//麦上用户和主播设置这个用户预览 直播拉流用户无需设置
val preview = QPushTextureView(context)
//添加到你要添加到的容器
containerView.addView(preview)
//设置该用户的预览
linkService.setUserPreview(micLinker.user.userId, preview)
//跟新连麦UI 如果要显示头像 micLinker里取到上麦者资料
}
//有人下麦了
override fun onLinkerLeft(micLinker: QMicLinker) {
//移除已经设置的预览窗口
container.removeUserPreView(xxxx)
//跟新连麦UI 比如去掉麦上头像
}
override fun onLinkerMicrophoneStatusChange(micLinker: QMicLinker) {
//跟新连麦UI
}
override fun onLinkerCameraStatusChange(micLinker: QMicLinker) {
//跟新连麦UI
}
//某个用户被踢麦
override fun onLinkerKicked(micLinker: QMicLinker, msg: String) {}
override fun onLinkerExtensionUpdate(micLinker: QMicLinker, extension: QExtension) {}
}
//混流适配 房主负责混流
private val mQMixStreamAdapter =
object : QLinkMicMixStreamAdapter {
/**
* 连麦开始如果要自定义混流画布和背景
* 返回空则主播推流分辨率有多大就多大默认实现
* @return
*/
override fun onMixStreamStart(): QMixStreamParams? {
return null
}
/**
* 混流布局适配
*/
override fun onResetMixParam(
micLinkers: MutableList<QMicLinker>, //所有麦位置
target: QMicLinker, //目标麦位
isJoin: Boolean //是否是加入 否则离开
): MutableList<QMergeOption> {
//将变化后的麦位换算成连麦混流参数
//比如 案例(x,y) ->1号麦位（0，200 ）2号麦位（0，200+180+15）3号麦位（0，200+2*180+15）...
val ops = ArrayList<QMergeOption>()
val lastY = 200
micLinkers.forEachIndex { index, linker ->
ops.add(QMergeOption().apply {
// 该连麦者的用户ID
uid = linker.user.userId
//该用户的摄像头参数
cameraMergeOption = CameraMergeOption().apply {
isNeed = true
x = 0 //麦位x
y = lastY + 180 + 15 //每个麦位 依次往下排 180 + 15 个分辨率间距
z = 0
width = 180
height = 180
}
//该用户的麦克风参数
microphoneMergeOption = MicrophoneMergeOption().apply {
isNeed = true
}
})
lastY = lastY + 180 + 15
}
}
}
//观众端连麦器监听
private val mQAudienceMicHandler = object : QAudienceMicHandler.LinkMicHandlerListener {
override fun onRoleChange(isLinker: Boolean) {
if (isLinker) {
//我切换到了连麦模式 -> 使用连麦和麦上用户和主播互动 延迟更低
client?.getService(QLinkMicService::class.java)?.allLinker?.forEach { micLinker ->
//对原来麦上的人设置预览
val preview = QPushTextureView(context)
//添加到你要添加到的容器
containerView.addView(preview)
//设置该用户的预览
linkService.setUserPreview(micLinker.user.userId, preview)
}
} else {
//我切换拉流模式
client?.getService(QLinkMicService::class.java)?.allLinker?.forEach {
//移除对原来设置麦位移除设置预览view
removePreview(it.user.userId)
}
}
}
}
//主播设置混流适配
client!!.getService(QLinkMicService::class.java).anchorHostMicHandler.setMixStreamAdapter( mQMixStreamAdapter )
//观众设置观众连麦处理监听
client!!.getService(QLinkMicService::class.java).audienceMicHandler.addLinkMicListener( mQAudienceMicHandler )
//主播和观众都关心麦位监听
client!!.getService(QLinkMicService::class.java).addMicLinkerListener(mQLinkMicServiceListener)
//注册邀请监听
client.getService(QLinkMicService::class.java).invitationHandler.addInvitationHandlerListener( mInvitationListener )
//点击某个按钮 发起对某个主播申请 或者主播邀请用户
client!!.getService(QLinkMicService::class.java).invitationHandler.apply(10 * 1000, room.liveID, room.anchor.userId, null,callback )
如果不使用内置的邀请系统 比如外接匹配系统或者直接上麦不需要邀请
//todo
// 别的邀请或者匹配
//直接调用上麦方法
client?.getService(QLinkMicService::class.java)?.audienceMicHandler?.startLink( null, QCameraParam() , QMicrophoneParam(),callback )
### 无UISDK 实现PK
//邀请监听
private val mPKInvitationListener = object : QInvitationHandlerListener {
//收到邀请
override fun onReceivedApply(pkInvitation: QInvitation) {
//拒绝操作
client!!.getService(QPKService::class.java).invitationHandler.reject(pkInvitation.invitationID, null, callBack)
//接受
client!!.getService(QPKService::class.java).invitationHandler.accept(pkInvitation.invitationID, null, callBack)
}
//收到对方取消
override fun onApplyCanceled(pkInvitation: QInvitation) {}
//发起超时对方没响应
override fun onApplyTimeOut(pkInvitation: QInvitation) {}
//对方接受
override fun onAccept(pkInvitation: QInvitation) {
//对方接受后调用开始pk
client?.getService(QPKService::class.java)?.start(20 * 1000, invitation.receiverRoomID, invitation.receiver.userId, null, callBack)
}
//对方拒绝
override fun onReject(pkInvitation: QInvitation) {}
}
//pk监听
private val mQPKServiceListener = object : QPKServiceListener {
override fun onStart(pkSession: QPKSession) {
//主播设置对方主播预览
client.getService(QPKService::class.java).setPeerAnchorPreView(findviewbyid(...))
//主播和观众都显示pk覆盖UI
}
override fun onStop(pkSession: QPKSession, code: Int, msg: String) {
//主播移除预览对方的UI 主播和观众都隐藏pk覆盖UI
}
override fun onStartTimeOut(pkSession: QPKSession) {}
override fun onPKExtensionUpdate(pkSession: QPKSession, extension: QExtension) {
}
}
//混流适配
private val mQPKMixStreamAdapter = object : QPKMixStreamAdapter {
//pk对方进入了 返回混流参数（同连麦）
override fun onPKLinkerJoin(pkSession: QPKSession): MutableList<QMergeOption> {
return LinkerUIHelper.getPKMixOp(pkSession, user!!)
}
//pk开始了 如果修改整个直播混流面板（同连麦）
override fun onPKMixStreamStart(pkSession: QPKSession): QMixStreamParams {
return QMixStreamParams()
}
}
//添加pk监听
client!!.getService(QPKService::
class.java).addServiceListener(mQPKServiceListener)
//主播注册混流适配
client!!.getService(QPKService::
class.java).setPKMixStreamAdapter(mQPKMixStreamAdapter)
//注册邀请监听
client.getService(QPKService::
class.java).invitationHandler.addInvitationHandlerListener( mPKInvitationListener )
//点击某个按钮 发起对某个主播邀请
client!!.getService(QPKService::
class.java).invitationHandler.apply(10 * 1000, room.liveID, room.anchor.userId, null,callback )
如果不使用内置的邀请系统 比如外接匹配pk系统
//todo 别的邀请或者匹配
//直接调用开始PK方法
client?.getService(QPKService::class.java)?.start(20 * 1000, invitation.receiverRoomID, invitation.receiver.userId, null,callBack)
### 自定义IM,播放器，rtc sdk参数配置
#### 自定义im初始化
QNIMConfig.imSDKConfigGetter = { appId: String, context: Context ->
//返回你的自定义配置参数，比如加上推送配置，使用参考七牛im文档。
BMXSDKConfig()
}
#### 自定义播放器参数
QMediaPlayerConfig.mAVOptionsGetter = {
//返回你的自定义AVOptions，使用参考七牛播放器文档
AVOptions（）
}
#### 自定义rtc配置
QRtcLiveRoomConfig.mRTCSettingGetter = {
//返回你的rtc配置，使用参考七牛rtc文档
QNRTCSetting()
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,393 |
互动直播iOS接入指南 | 低代码 | [低代码](https://developer.qiniu.com/lowcode) > 使用文档 >
[互动直播](https://developer.qiniu.com/lowcode/manual/12004/qlive) > 互动直播iOS接入指南
# 互动直播iOS接入指南
最近更新时间: 2022-08-02 16:28:10
## 互动直播低代码iOS
## SDK接入
下载路径：https://github.com/pili-engineering/QNLiveKit_iOS/tree/main/DownloadResource/
### 配置依赖
// podfile文件中加入以下依赖项，如果项目中已经依赖可以忽略
pod 'QNRTCKit-iOS','5.1.1'
pod 'PLPlayerKit', '3.4.7'
pod 'MJExtension'
pod 'Masonry'
pod 'SDWebImage'
pod 'AFNetworking'
信令依赖：将QNIMSDK拖入项目中，并在General的中选择 Embed & sign。
图片资源：将livekitResource文件拖入项目的Assets中。
美颜依赖：1、将BeautyResource拖入项目中，
2、在Targets->Build Settings->Framework Search Paths中添加BeautyResource路径
3、Targets->Build Settings->Header Search Paths中添加BeautyResource/PLSTArEffects.framework/Headers路径
4、请求美颜证书SENSEME.lic并放入项目（不使用美颜功能可不放）
### 快速接入
//初始化SDK errorBack错误回调，可在此处更新过期的token
[QLive initWithToken:token serverURL:@"liveKit域名" errorBack:nil];
//绑定自己服务器的头像和昵称 extension为扩展字段，可以自定义同步的内容
[QLive setUser:user.avatar nick:user.nickname extension:nil];
如果需要使用内置UI，直接跳转至特定的ViewController即可
Tips:如果需要使用内置美颜，在初始化后调用[QLive setBeauty:YES];
//直播列表页：
QLiveListController *listVc = [QLiveListController new];
[self.navigationController pushViewController:listVc animated:YES];
//观众观看页面：
QNAudienceController *vc = [QNAudienceController new];
vc.roomInfo = roomInfo;
vc.modalPresentationStyle = UIModalPresentationFullScreen;
[self presentViewController:vc animated:YES completion:nil];
### 详细接入
#### 初始化类
/// 房间业务管理
@interface QLive : NSObject
// 初始化
+ (void)initWithToken:(NSString *)token serverURL:(NSString *)serverURL errorBack:(nullable void (^)(NSError *error))errorBack;
//绑定用户信息
+ (void)setUser:(NSString *)avatar nick:(NSString *)nick extension:(nullable NSDictionary *)extension;
//创建主播端
+ (QNLivePushClient *)createPusherClient;
//创建观众端
+ (QNLivePullClient *)createPlayerClient;
//获得直播场景
+ (QRooms *)getRooms;
//获取自己的信息
+ (void)getSelfUser:(void (^)(QNLiveUser *user))callBack;
@end
#### 主播操作
@interface QNLivePushClient : QNLiveRoomClient
//直播操作
/// 开始直播
- (void)startLive:(NSString *)roomID callBack:(nullable void (^)(QNLiveRoomInfo *_Nullable roomInfo))callBack;
/// 停止直播
- (void)closeRoom;
//推流操作
/// 启动视频采集
- (void)enableCamera:(nullable QNCameraParams *)cameraParams renderView:(nullable QRenderView *)renderView;
/// 切换摄像头
- (void)switchCamera;
/// 是否禁止本地摄像头推流
- (void)muteCamera:(BOOL)muted;
/// 是否禁止本地麦克风推流
- (void)muteMicrophone:(BOOL)muted;
/// 设置本地音频帧回调
- (void)setAudioFrameListener:(id<QNLocalAudioTrackDelegate>)listener;
/// 设置本地视频帧回调
- (void)setVideoFrameListener:(id<QNLocalVideoTrackDelegate>)listener;
//获取混流器
- (QMixStreamManager *)getMixStreamManager;
#### 观众操作
@interface QNLivePullClient : QNLiveRoomClient
/// 观众加入直播
- (void)joinRoom:(NSString *)roomID callBack:(nullable void (^)(QNLiveRoomInfo *_Nullable roomInfo))callBack;
/// 离开直播
- (void)leaveRoom;
#### 房间操作
@interface QRooms : NSObject
/// 创建房间
/// @param param 创建房间参数
/// @param callBack 回调房间信息
- (void)createRoom:(QNCreateRoomParam *)param callBack:(nullable void (^)(QNLiveRoomInfo *roomInfo))callBack;
/// 删除房间
/// @param callBack 回调
- (void)deleteRoom:(NSString *)liveId callBack:(void (^)(void))callBack;
/// 房间列表
/// @param pageNumber 页数
/// @param pageSize 页面大小
/// @param callBack 回调房间列表
- (void)listRoom:(NSInteger)pageNumber pageSize:(NSInteger)pageSize callBack:(nullable void (^)(NSArray<QNLiveRoomInfo *> * list))callBack;
/// 查询房间信息
/// @param callBack 回调房间信息
- (void)getRoomInfo:(NSString *)roomID callBack:(nullable void (^)(QNLiveRoomInfo *roomInfo))callBack;
@end
#### 房间状态
/// 房间生命周期
@protocol QNRoomLifeCycleListener <NSObject>
@optional
/// 进入房间回调
/// @param user 用户
- (void)onRoomEnter:(QNLiveUser *)user;
/// 加入房间回调
/// @param roomInfo 房间信息
- (void)onRoomJoined:(QNLiveRoomInfo *)roomInfo;
//直播间某个属性变化
- (BOOL)onRoomExtensions:(NSString *)extension;
/// 离开回调
- (void)onRoomLeave:(QNLiveUser *)user;
/// 销毁回调
- (void)onRoomClose;
@end
@interface QNLiveRoomClient : NSObject
@property (nonatomic, weak) id <QNRoomLifeCycleListener> roomLifeCycleListener;
/// 获取房间所有用户
/// @param roomId 房间id
/// @param pageNumber 页数
/// @param pageSize 页面大小
/// @param callBack 回调用户列表
- (void)getUserList:(NSString *)roomId pageNumber:(NSInteger)pageNumber pageSize:(NSInteger)pageSize callBack:(void (^)(NSArray<QNLiveUser *> * _Nonnull))callBack;
//房间心跳
- (void)roomHeartBeart:(NSString *)roomId;
//更新直播扩展信息
- (void)updateRoom:(NSString *)roomId extension:(NSString *)extension callBack:(void (^)(void))callBack;
//某个房间在线用户
- (void)getOnlineUser:(NSString *)roomId callBack:(void (^)(NSArray <QNLiveUser *> *list))callBack;
//使用用户ID搜索房间用户
- (void)searchUserByUserId:(NSString *)uid callBack:(void (^)(QNLiveUser *user))callBack;
//使用用户im uid 搜索用户
- (void)searchUserByIMUid:(NSString *)imUid callBack:(void (^)(QNLiveUser *user))callBack;
#### 连麦服务
//连麦服务
@interface QNLinkMicService : QNLiveService
@property (nonatomic, weak)id<MicLinkerListener> micLinkerListener;
//获取当前房间所有连麦用户
- (void)getAllLinker:(void (^)(NSArray <QNMicLinker *> *list))callBack;
//上麦
- (void)onMic:(BOOL)mic camera:(BOOL)camera extends:(nullable NSDictionary *)extends;
//下麦
- (void)downMic;
//踢人
- (void)kickOutUser:(NSString *)uid msg:(nullable NSString *)msg callBack:(nullable void (^)(QNMicLinker * _Nullable))callBack ;
//开关麦 type:mic/camera flag:on/off
- (void)updateMicStatusType:(NSString *)type flag:(BOOL)flag;
//申请连麦
- (void)ApplyLink:(QNLiveUser *)receiveUser;
//接受连麦
- (void)AcceptLink:(QInvitationModel *)invitationModel;
//拒绝连麦
- (void)RejectLink:(QInvitationModel *)invitationModel;
@end
#### 连麦回调
/// 有人上麦
- (void)onUserJoinLink:(QNMicLinker *)micLinker;
/// 有人下麦
- (void)onUserLeave:(QNMicLinker *)micLinker;
/// 有人麦克风变化
- (void)onUserMicrophoneStatusChange:(NSString *)uid mute:(BOOL)mute;
/// 有人摄像头状态变化
- (void)onUserCameraStatusChange:(NSString *)uid mute:(BOOL)mute;
/// 有人被踢
- (void)onUserBeKick:(LinkOptionModel *)micLinker;
//收到连麦邀请
- (void)onReceiveLinkInvitation:(QInvitationModel *)model;
//连麦邀请被接受
- (void)onReceiveLinkInvitationAccept:(QInvitationModel *)model;
//连麦邀请被拒绝
- (void)onReceiveLinkInvitationReject:(QInvitationModel *)model;
#### PK服务
@interface QNPKService : QNLiveService
@property (nonatomic, weak)id<PKServiceListener> delegate;
//申请pk
- (void)applyPK:(NSString *)receiveRoomId receiveUser:(QNLiveUser *)receiveUser;
//接受PK申请
- (void)AcceptPK:(QInvitationModel *)invitationModel;
//拒绝PK申请
- (void)sendPKReject:(QInvitationModel *)invitationModel;
//结束pk
- (void)stopPK:(nullable void (^)(void))callBack;
@end
#### pk回调
//收到PK邀请
- (void)onReceivePKInvitation:(QInvitationModel *)model;
//PK邀请被接受
- (void)onReceivePKInvitationAccept:(QNPKSession *)model;
//PK邀请被拒绝
- (void)onReceivePKInvitationReject:(QInvitationModel *)model;
//PK开始
- (void)onReceiveStartPKSession:(QNPKSession *)pkSession;
//pk结束
- (void)onReceiveStopPKSession:(QNPKSession *)pkSession;
#### 聊天/信令发送
@interface QNChatRoomService : QNLiveService
//添加聊天监听
- (void)addChatServiceListener:(id<QNChatRoomServiceListener>)listener;
//移除聊天监听
- (void)removeChatServiceListener;
//发公聊消息
- (void)sendPubChatMsg:(NSString *)msg callBack:(void (^)(QNIMMessageObject *msg))callBack;
//发进房消息
- (void)sendWelComeMsg:(void (^)(QNIMMessageObject *msg))callBack;
//发离开消息
- (void)sendLeaveMsg;
@end
#### 聊天/信令获取
@protocol QNChatRoomServiceListener <NSObject>
@optional
//有人加入聊天室
- (void)onUserJoin:(QNLiveUser *)user message:(QNIMMessageObject *)message;
//有人离开聊天室
- (void)onUserLeave:(QNLiveUser *)user message:(QNIMMessageObject *)message;
//收到公聊消息
- (void)onReceivedPuChatMsg:(PubChatModel *)msg message:(QNIMMessageObject *)message;
//收到点赞消息
- (void)onReceivedLikeMsgFrom:(QNLiveUser *)sendUser;
//收到弹幕消息
- (void)onReceivedDamaku:(PubChatModel *)msg;
@end
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[低代码](https://developer.qiniu.com/lowcode) > 使用文档 >
[互动直播](https://developer.qiniu.com/lowcode/manual/12004/qlive) > 互动直播iOS接入指南
# 互动直播iOS接入指南
最近更新时间: 2022-08-02 16:28:10
## 互动直播低代码iOS
## SDK接入
下载路径：https://github.com/pili-engineering/QNLiveKit_iOS/tree/main/DownloadResource/
### 配置依赖
// podfile文件中加入以下依赖项，如果项目中已经依赖可以忽略
pod 'QNRTCKit-iOS','5.1.1'
pod 'PLPlayerKit', '3.4.7'
pod 'MJExtension'
pod 'Masonry'
pod 'SDWebImage'
pod 'AFNetworking'
信令依赖：将QNIMSDK拖入项目中，并在General的中选择 Embed & sign。
图片资源：将livekitResource文件拖入项目的Assets中。
美颜依赖：1、将BeautyResource拖入项目中，
2、在Targets->Build Settings->Framework Search Paths中添加BeautyResource路径
3、Targets->Build Settings->Header Search Paths中添加BeautyResource/PLSTArEffects.framework/Headers路径
4、请求美颜证书SENSEME.lic并放入项目（不使用美颜功能可不放）
### 快速接入
//初始化SDK errorBack错误回调，可在此处更新过期的token
[QLive initWithToken:token serverURL:@"liveKit域名" errorBack:nil];
//绑定自己服务器的头像和昵称 extension为扩展字段，可以自定义同步的内容
[QLive setUser:user.avatar nick:user.nickname extension:nil];
如果需要使用内置UI，直接跳转至特定的ViewController即可
Tips:如果需要使用内置美颜，在初始化后调用[QLive setBeauty:YES];
//直播列表页：
QLiveListController *listVc = [QLiveListController new];
[self.navigationController pushViewController:listVc animated:YES];
//观众观看页面：
QNAudienceController *vc = [QNAudienceController new];
vc.roomInfo = roomInfo;
vc.modalPresentationStyle = UIModalPresentationFullScreen;
[self presentViewController:vc animated:YES completion:nil];
### 详细接入
#### 初始化类
/// 房间业务管理
@interface QLive : NSObject
// 初始化
+ (void)initWithToken:(NSString *)token serverURL:(NSString *)serverURL errorBack:(nullable void (^)(NSError *error))errorBack;
//绑定用户信息
+ (void)setUser:(NSString *)avatar nick:(NSString *)nick extension:(nullable NSDictionary *)extension;
//创建主播端
+ (QNLivePushClient *)createPusherClient;
//创建观众端
+ (QNLivePullClient *)createPlayerClient;
//获得直播场景
+ (QRooms *)getRooms;
//获取自己的信息
+ (void)getSelfUser:(void (^)(QNLiveUser *user))callBack;
@end
#### 主播操作
@interface QNLivePushClient : QNLiveRoomClient
//直播操作
/// 开始直播
- (void)startLive:(NSString *)roomID callBack:(nullable void (^)(QNLiveRoomInfo *_Nullable roomInfo))callBack;
/// 停止直播
- (void)closeRoom;
//推流操作
/// 启动视频采集
- (void)enableCamera:(nullable QNCameraParams *)cameraParams renderView:(nullable QRenderView *)renderView;
/// 切换摄像头
- (void)switchCamera;
/// 是否禁止本地摄像头推流
- (void)muteCamera:(BOOL)muted;
/// 是否禁止本地麦克风推流
- (void)muteMicrophone:(BOOL)muted;
/// 设置本地音频帧回调
- (void)setAudioFrameListener:(id<QNLocalAudioTrackDelegate>)listener;
/// 设置本地视频帧回调
- (void)setVideoFrameListener:(id<QNLocalVideoTrackDelegate>)listener;
//获取混流器
- (QMixStreamManager *)getMixStreamManager;
#### 观众操作
@interface QNLivePullClient : QNLiveRoomClient
/// 观众加入直播
- (void)joinRoom:(NSString *)roomID callBack:(nullable void (^)(QNLiveRoomInfo *_Nullable roomInfo))callBack;
/// 离开直播
- (void)leaveRoom;
#### 房间操作
@interface QRooms : NSObject
/// 创建房间
/// @param param 创建房间参数
/// @param callBack 回调房间信息
- (void)createRoom:(QNCreateRoomParam *)param callBack:(nullable void (^)(QNLiveRoomInfo *roomInfo))callBack;
/// 删除房间
/// @param callBack 回调
- (void)deleteRoom:(NSString *)liveId callBack:(void (^)(void))callBack;
/// 房间列表
/// @param pageNumber 页数
/// @param pageSize 页面大小
/// @param callBack 回调房间列表
- (void)listRoom:(NSInteger)pageNumber pageSize:(NSInteger)pageSize callBack:(nullable void (^)(NSArray<QNLiveRoomInfo *> * list))callBack;
/// 查询房间信息
/// @param callBack 回调房间信息
- (void)getRoomInfo:(NSString *)roomID callBack:(nullable void (^)(QNLiveRoomInfo *roomInfo))callBack;
@end
#### 房间状态
/// 房间生命周期
@protocol QNRoomLifeCycleListener <NSObject>
@optional
/// 进入房间回调
/// @param user 用户
- (void)onRoomEnter:(QNLiveUser *)user;
/// 加入房间回调
/// @param roomInfo 房间信息
- (void)onRoomJoined:(QNLiveRoomInfo *)roomInfo;
//直播间某个属性变化
- (BOOL)onRoomExtensions:(NSString *)extension;
/// 离开回调
- (void)onRoomLeave:(QNLiveUser *)user;
/// 销毁回调
- (void)onRoomClose;
@end
@interface QNLiveRoomClient : NSObject
@property (nonatomic, weak) id <QNRoomLifeCycleListener> roomLifeCycleListener;
/// 获取房间所有用户
/// @param roomId 房间id
/// @param pageNumber 页数
/// @param pageSize 页面大小
/// @param callBack 回调用户列表
- (void)getUserList:(NSString *)roomId pageNumber:(NSInteger)pageNumber pageSize:(NSInteger)pageSize callBack:(void (^)(NSArray<QNLiveUser *> * _Nonnull))callBack;
//房间心跳
- (void)roomHeartBeart:(NSString *)roomId;
//更新直播扩展信息
- (void)updateRoom:(NSString *)roomId extension:(NSString *)extension callBack:(void (^)(void))callBack;
//某个房间在线用户
- (void)getOnlineUser:(NSString *)roomId callBack:(void (^)(NSArray <QNLiveUser *> *list))callBack;
//使用用户ID搜索房间用户
- (void)searchUserByUserId:(NSString *)uid callBack:(void (^)(QNLiveUser *user))callBack;
//使用用户im uid 搜索用户
- (void)searchUserByIMUid:(NSString *)imUid callBack:(void (^)(QNLiveUser *user))callBack;
#### 连麦服务
//连麦服务
@interface QNLinkMicService : QNLiveService
@property (nonatomic, weak)id<MicLinkerListener> micLinkerListener;
//获取当前房间所有连麦用户
- (void)getAllLinker:(void (^)(NSArray <QNMicLinker *> *list))callBack;
//上麦
- (void)onMic:(BOOL)mic camera:(BOOL)camera extends:(nullable NSDictionary *)extends;
//下麦
- (void)downMic;
//踢人
- (void)kickOutUser:(NSString *)uid msg:(nullable NSString *)msg callBack:(nullable void (^)(QNMicLinker * _Nullable))callBack ;
//开关麦 type:mic/camera flag:on/off
- (void)updateMicStatusType:(NSString *)type flag:(BOOL)flag;
//申请连麦
- (void)ApplyLink:(QNLiveUser *)receiveUser;
//接受连麦
- (void)AcceptLink:(QInvitationModel *)invitationModel;
//拒绝连麦
- (void)RejectLink:(QInvitationModel *)invitationModel;
@end
#### 连麦回调
/// 有人上麦
- (void)onUserJoinLink:(QNMicLinker *)micLinker;
/// 有人下麦
- (void)onUserLeave:(QNMicLinker *)micLinker;
/// 有人麦克风变化
- (void)onUserMicrophoneStatusChange:(NSString *)uid mute:(BOOL)mute;
/// 有人摄像头状态变化
- (void)onUserCameraStatusChange:(NSString *)uid mute:(BOOL)mute;
/// 有人被踢
- (void)onUserBeKick:(LinkOptionModel *)micLinker;
//收到连麦邀请
- (void)onReceiveLinkInvitation:(QInvitationModel *)model;
//连麦邀请被接受
- (void)onReceiveLinkInvitationAccept:(QInvitationModel *)model;
//连麦邀请被拒绝
- (void)onReceiveLinkInvitationReject:(QInvitationModel *)model;
#### PK服务
@interface QNPKService : QNLiveService
@property (nonatomic, weak)id<PKServiceListener> delegate;
//申请pk
- (void)applyPK:(NSString *)receiveRoomId receiveUser:(QNLiveUser *)receiveUser;
//接受PK申请
- (void)AcceptPK:(QInvitationModel *)invitationModel;
//拒绝PK申请
- (void)sendPKReject:(QInvitationModel *)invitationModel;
//结束pk
- (void)stopPK:(nullable void (^)(void))callBack;
@end
#### pk回调
//收到PK邀请
- (void)onReceivePKInvitation:(QInvitationModel *)model;
//PK邀请被接受
- (void)onReceivePKInvitationAccept:(QNPKSession *)model;
//PK邀请被拒绝
- (void)onReceivePKInvitationReject:(QInvitationModel *)model;
//PK开始
- (void)onReceiveStartPKSession:(QNPKSession *)pkSession;
//pk结束
- (void)onReceiveStopPKSession:(QNPKSession *)pkSession;
#### 聊天/信令发送
@interface QNChatRoomService : QNLiveService
//添加聊天监听
- (void)addChatServiceListener:(id<QNChatRoomServiceListener>)listener;
//移除聊天监听
- (void)removeChatServiceListener;
//发公聊消息
- (void)sendPubChatMsg:(NSString *)msg callBack:(void (^)(QNIMMessageObject *msg))callBack;
//发进房消息
- (void)sendWelComeMsg:(void (^)(QNIMMessageObject *msg))callBack;
//发离开消息
- (void)sendLeaveMsg;
@end
#### 聊天/信令获取
@protocol QNChatRoomServiceListener <NSObject>
@optional
//有人加入聊天室
- (void)onUserJoin:(QNLiveUser *)user message:(QNIMMessageObject *)message;
//有人离开聊天室
- (void)onUserLeave:(QNLiveUser *)user message:(QNIMMessageObject *)message;
//收到公聊消息
- (void)onReceivedPuChatMsg:(PubChatModel *)msg message:(QNIMMessageObject *)message;
//收到点赞消息
- (void)onReceivedLikeMsgFrom:(QNLiveUser *)sendUser;
//收到弹幕消息
- (void)onReceivedDamaku:(PubChatModel *)msg;
@end
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,430 |
产品简介 | 低代码 | [低代码](https://developer.qiniu.com/lowcode) > 产品简介 > 产品简介
# 产品简介
最近更新时间: 2022-09-09 09:21:24
# 基本描述
基于七牛云的音视频、直播，IM，AI 智能算法和网络等先进技术，通过低代码方式接入，帮助企业快速完成在自有
APP、小程序、网站等平台的私域电商直播间的搭建。具有接入方便，扩展性强等特性，既可以满足企业定制需求，又可以降低时间成本，快速验证直播卖货商业模式。
# 产品架构
# 交付方式
# 产品优势
## 低成本接入
降低音视频开发门槛，助力企业以更低成本、更高效率搭建更高质量的专属音视频应用。
支持低代码集成，最快3步对接，10行代码上线自有品牌的互动直播间。
## 拓展性强
开源所有UI组件，客户可以按自己的需求快速个性化改造。
低代码SDK对音视频、实时消息、直播管理、PK连麦、弹幕等模块和近百个 API 接口进行封装，开发者可按需选择模块和接口轻松进行功能组装，灵活强大
## 全场景支持
覆盖泛娱乐互动直播，电商直播带货，语聊房，互动课堂，在线监考，连麦 PK，视频交友，FM 电台，在线 KTV，一起看视频等多应用场景
## 保障业务数据安全
低代码服务端代码完全开源，客户可自主决定业务数据的存储地方，如：本地IDC机房、任意指定云服务器等。
# 解决的核心痛点
企业自建电商直播业务板块通常会有2种选择，但都会遇到一些问题：
## 对接SaaS平台直播或者使用第三方直播平台
* 直播平台无法与既有业务系统深度融合。如原有商品、用户系统与直播系统无法对接，导致重要数据缺失或者难以形成后续的有效跟踪。
* 功能依赖第三方或SaaS平台能力升级，难以满足业务需求。
## 搭建团队自建平台
* 音视频能力开发难度大，研发时间长达1-2个月，传统企业音视频开发人力储备不足，无法快速上线自有电商直播产品。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[低代码](https://developer.qiniu.com/lowcode) > 产品简介 > 产品简介
# 产品简介
最近更新时间: 2022-09-09 09:21:24
# 基本描述
基于七牛云的音视频、直播，IM，AI 智能算法和网络等先进技术，通过低代码方式接入，帮助企业快速完成在自有
APP、小程序、网站等平台的私域电商直播间的搭建。具有接入方便，扩展性强等特性，既可以满足企业定制需求，又可以降低时间成本，快速验证直播卖货商业模式。
# 产品架构
# 交付方式
# 产品优势
## 低成本接入
降低音视频开发门槛，助力企业以更低成本、更高效率搭建更高质量的专属音视频应用。
支持低代码集成，最快3步对接，10行代码上线自有品牌的互动直播间。
## 拓展性强
开源所有UI组件，客户可以按自己的需求快速个性化改造。
低代码SDK对音视频、实时消息、直播管理、PK连麦、弹幕等模块和近百个 API 接口进行封装，开发者可按需选择模块和接口轻松进行功能组装，灵活强大
## 全场景支持
覆盖泛娱乐互动直播，电商直播带货，语聊房，互动课堂，在线监考，连麦 PK，视频交友，FM 电台，在线 KTV，一起看视频等多应用场景
## 保障业务数据安全
低代码服务端代码完全开源，客户可自主决定业务数据的存储地方，如：本地IDC机房、任意指定云服务器等。
# 解决的核心痛点
企业自建电商直播业务板块通常会有2种选择，但都会遇到一些问题：
## 对接SaaS平台直播或者使用第三方直播平台
* 直播平台无法与既有业务系统深度融合。如原有商品、用户系统与直播系统无法对接，导致重要数据缺失或者难以形成后续的有效跟踪。
* 功能依赖第三方或SaaS平台能力升级，难以满足业务需求。
## 搭建团队自建平台
* 音视频能力开发难度大，研发时间长达1-2个月，传统企业音视频开发人力储备不足，无法快速上线自有电商直播产品。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,442 |
产品接入 | 低代码 | [低代码](https://developer.qiniu.com/lowcode) > 产品简介 > 产品接入
# 产品接入
最近更新时间: 2022-09-09 09:20:09
# 系统对接流程
* 第一步：应用创建
* 第二步：应用配置
* 第三步：低代码接入，快速上线
# 低代码接入举例
import com.qlive.sdk.QLive
val config = QLiveConfig("serverURL")
QLive.init(appContext, config, tokenGetter)
QLive.auth(callback)
QLive.setUser(QUserInfo("your avatar", "your nick", extraInfo), callback)
QLive.getLiveUIKit().launch(context)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[低代码](https://developer.qiniu.com/lowcode) > 产品简介 > 产品接入
# 产品接入
最近更新时间: 2022-09-09 09:20:09
# 系统对接流程
* 第一步：应用创建
* 第二步：应用配置
* 第三步：低代码接入，快速上线
# 低代码接入举例
import com.qlive.sdk.QLive
val config = QLiveConfig("serverURL")
QLive.init(appContext, config, tokenGetter)
QLive.auth(callback)
QLive.setUser(QUserInfo("your avatar", "your nick", extraInfo), callback)
QLive.getLiveUIKit().launch(context)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,444 |
方案推荐 | 低代码 | [低代码](https://developer.qiniu.com/lowcode) > 产品简介 > 方案推荐
# 方案推荐
最近更新时间: 2022-09-09 09:20:02
# 互动直播方案
七牛低代码互动直播方案是基于七牛云音视频、AI智能算法和网络等先进技术，提供易接入、强扩展、高效部署和覆盖多场景的音视频服务，助力企业快速搭建高品质的互动直播，娱乐直播业务平台。
## 落地效果
# 电商直播方案
七牛低代码电商直播方案是基于七牛云音视频、AI智能算法和网络等先进技术，提供易接入、强扩展、高效部署和覆盖多场景的音视频服务，助力企业快速搭建高品质的专属电商直播业务平台。
适用于以下行业的直播带货场景。
* 平台类电商
* 品牌类电商
* 社区类电商
## 落地效果
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[低代码](https://developer.qiniu.com/lowcode) > 产品简介 > 方案推荐
# 方案推荐
最近更新时间: 2022-09-09 09:20:02
# 互动直播方案
七牛低代码互动直播方案是基于七牛云音视频、AI智能算法和网络等先进技术，提供易接入、强扩展、高效部署和覆盖多场景的音视频服务，助力企业快速搭建高品质的互动直播，娱乐直播业务平台。
## 落地效果
# 电商直播方案
七牛低代码电商直播方案是基于七牛云音视频、AI智能算法和网络等先进技术，提供易接入、强扩展、高效部署和覆盖多场景的音视频服务，助力企业快速搭建高品质的专属电商直播业务平台。
适用于以下行业的直播带货场景。
* 平台类电商
* 品牌类电商
* 社区类电商
## 落地效果
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,446 |
互动直播 | 低代码 | [低代码](https://developer.qiniu.com/lowcode) > API 文档 > 互动直播
# 互动直播
最近更新时间: 2022-07-11 10:15:29
互动直播低代码API 参考。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[低代码](https://developer.qiniu.com/lowcode) > API 文档 > 互动直播
# 互动直播
最近更新时间: 2022-07-11 10:15:29
互动直播低代码API 参考。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,447 |
服务端API参考 | 低代码 | [低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) > 服务端API参考
# 服务端API参考
最近更新时间: 2022-07-21 16:07:43
介绍互动直播低代码服务端API 参考。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) > 服务端API参考
# 服务端API参考
最近更新时间: 2022-07-21 16:07:43
介绍互动直播低代码服务端API 参考。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,448 |
服务端鉴权 | 低代码 | [低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) >
[服务端API参考](https://developer.qiniu.com/lowcode/api/12008/qlive-server-api-
reference) > 服务端鉴权
# 服务端鉴权
最近更新时间: 2022-07-21 16:07:50
服务端接口，使用AK/SK 方式进行鉴权。
# 请求认证
## API 域名
https://live-api.qiniu.com
* 私有部署时，使用自己的域名。
* 私有部署时，可以选择不鉴权，具体配置方式参考 [项目说明文档 __](https://github.com/pili-engineering/QNLiveKit_Server)
每一个请求均需在 HTTP 请求头部增加一个 Authorization 字段，其值为符合管理凭证的字符串，形式如下：
Authorization: <QiniuToken>
## 生成管理凭证
`<QiniuToken>`: 管理凭证，用于鉴权。以golang 为例，生成方式如下：
// golang
// 构造待签名的 Data
// 1. 添加 Path
data = "<Method> <Path>"
// 2. 添加 Query，前提: Query 存在且不为空
if "<RawQuery>" != "" {
data += "?<RawQuery>"
}
// 3. 添加 Host
data += "\nHost: <Host>"
// 4. 添加 Content-Type，前提: Content-Type 存在且不为空
if "<Content-Type>" != "" {
data += "\nContent-Type: <Content-Type>"
}
// 5. 添加回车
data += "\n\n"
// 6. 添加 Body，前提: Content-Length 存在且 Body 不为空，同时 Content-Type 存在且不为空或 "application/octet-stream"
bodyOK := "<Content-Length>" != "" && "<Body>" != ""
contentTypeOK := "<Content-Type>" != "" && "<Content-Type>" != "application/octet-stream"
if bodyOK && contentTypeOK {
data += "<Body>"
}
// 计算 HMAC-SHA1 签名，并对签名结果做 URL 安全的 Base64 编码
sign = hmac_sha1(data, "Your_Secret_Key")
encodedSign = urlsafe_base64_encode(sign)
// 将 Qiniu 标识与 AccessKey、encodedSign 拼接得到管理凭证
<QiniuToken> = "Qiniu " + "Your_Access_Key" + ":" + encodedSign
## 请求示例
GET /server/auth/token HTTP/1.1
Host: live-api.qiniu.com
Authorization: Qiniu 7O7hf7Ld1RrC_fpZdFvU8aCgOPuhw2K4eapYOdII:PGTUV-oRxWAIl6mdneJPSJieyyQ=
Content-Type: application/json
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) >
[服务端API参考](https://developer.qiniu.com/lowcode/api/12008/qlive-server-api-
reference) > 服务端鉴权
# 服务端鉴权
最近更新时间: 2022-07-21 16:07:50
服务端接口，使用AK/SK 方式进行鉴权。
# 请求认证
## API 域名
https://live-api.qiniu.com
* 私有部署时，使用自己的域名。
* 私有部署时，可以选择不鉴权，具体配置方式参考 [项目说明文档 __](https://github.com/pili-engineering/QNLiveKit_Server)
每一个请求均需在 HTTP 请求头部增加一个 Authorization 字段，其值为符合管理凭证的字符串，形式如下：
Authorization: <QiniuToken>
## 生成管理凭证
`<QiniuToken>`: 管理凭证，用于鉴权。以golang 为例，生成方式如下：
// golang
// 构造待签名的 Data
// 1. 添加 Path
data = "<Method> <Path>"
// 2. 添加 Query，前提: Query 存在且不为空
if "<RawQuery>" != "" {
data += "?<RawQuery>"
}
// 3. 添加 Host
data += "\nHost: <Host>"
// 4. 添加 Content-Type，前提: Content-Type 存在且不为空
if "<Content-Type>" != "" {
data += "\nContent-Type: <Content-Type>"
}
// 5. 添加回车
data += "\n\n"
// 6. 添加 Body，前提: Content-Length 存在且 Body 不为空，同时 Content-Type 存在且不为空或 "application/octet-stream"
bodyOK := "<Content-Length>" != "" && "<Body>" != ""
contentTypeOK := "<Content-Type>" != "" && "<Content-Type>" != "application/octet-stream"
if bodyOK && contentTypeOK {
data += "<Body>"
}
// 计算 HMAC-SHA1 签名，并对签名结果做 URL 安全的 Base64 编码
sign = hmac_sha1(data, "Your_Secret_Key")
encodedSign = urlsafe_base64_encode(sign)
// 将 Qiniu 标识与 AccessKey、encodedSign 拼接得到管理凭证
<QiniuToken> = "Qiniu " + "Your_Access_Key" + ":" + encodedSign
## 请求示例
GET /server/auth/token HTTP/1.1
Host: live-api.qiniu.com
Authorization: Qiniu 7O7hf7Ld1RrC_fpZdFvU8aCgOPuhw2K4eapYOdII:PGTUV-oRxWAIl6mdneJPSJieyyQ=
Content-Type: application/json
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,449 |
客户端用户Token | 低代码 | [低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) >
[服务端API参考](https://developer.qiniu.com/lowcode/api/12008/qlive-server-api-
reference) > 客户端用户Token
# 客户端用户Token
最近更新时间: 2022-07-25 10:14:47
# 获取用户访问token
互动直播客户端，需要访问互动直播服务时，需要使用jwt 鉴权token。
该接口用于颁发访问token。
## 路径
GET /server/auth/token
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | AK/SK 鉴权token | Qiniu AK:sign
## Query 参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
app_id | string | 是 | 互动直播的应用ID | live_app_1
user_id | string | 是 | 客户端用户ID，唯一标识一个用户 | user_1
device_id | string | 否 | 客户端设备ID | device_1
expires_at | int64 | 否 | token 过期时间，秒级时间戳。默认7 天过期 | 1655882609
## 返回
该接口正确处理请求时返回如下 JSON 数据
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success", //code 非0 时，错误原因描述
"data": {
"access_token":"xxx", //客户端访问token
"expires_at":1655882609 //过期时间，秒级时间戳
}
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) >
[服务端API参考](https://developer.qiniu.com/lowcode/api/12008/qlive-server-api-
reference) > 客户端用户Token
# 客户端用户Token
最近更新时间: 2022-07-25 10:14:47
# 获取用户访问token
互动直播客户端，需要访问互动直播服务时，需要使用jwt 鉴权token。
该接口用于颁发访问token。
## 路径
GET /server/auth/token
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | AK/SK 鉴权token | Qiniu AK:sign
## Query 参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
app_id | string | 是 | 互动直播的应用ID | live_app_1
user_id | string | 是 | 客户端用户ID，唯一标识一个用户 | user_1
device_id | string | 否 | 客户端设备ID | device_1
expires_at | int64 | 否 | token 过期时间，秒级时间戳。默认7 天过期 | 1655882609
## 返回
该接口正确处理请求时返回如下 JSON 数据
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success", //code 非0 时，错误原因描述
"data": {
"access_token":"xxx", //客户端访问token
"expires_at":1655882609 //过期时间，秒级时间戳
}
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,453 |
用户模块接口 | 低代码 | [低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) >
[服务端API参考](https://developer.qiniu.com/lowcode/api/12008/qlive-server-api-
reference) > 用户模块接口
# 用户模块接口
最近更新时间: 2022-07-21 16:07:58
用户相关接口。
# 1.用户注册
注册一个用户。
## 路径
POST /server/user/register
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | AK/SK 鉴权token | Qiniu AK:sign
## Body 参数
使用JSON 格式数据
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
user_id | string | 是 | 客户端用户ID，唯一标识一个用户 | user_1
nick | string | 否 | 用户昵称 | 风清扬
avatar | string | 否 | 用户头像，URL 地址 | https://xxx.com/avator.png
extends | map[string]string | 否 | 扩展信息，key value 结构 |
举例如下
{
"user_id": "user-1",
"nick":"用户",
"avatar":"http;//xxx.png",
"extends": {
"age":"18"
}
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 2\. 批量用户注册
批量注册用户。
## 路径
POST /server/user/register/batch
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | AK/SK 鉴权token | Qiniu AK:sign
## Body参数
使用Json 格式数据。
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
user_id | string | 是 | 客户端用户ID，唯一标识一个用户 | user_1
nick | string | 否 | 用户昵称 | 风清扬
avatar | string | 否 | 用户头像，URL 地址 | https://xxx.com/avator.png
extends | map[string]string | 否 | 扩展信息，key value 结构 |
举例如下
[
{
"user_id": "user-1",
"nick":"用户",
"avatar":"http;//xxx.png",
"extends": {
"age":"18"
}
}
]
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 3\. 更新用户信息
更新用户信息。
## 路径
PUT /server/user/{user_id}
路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
user_id | string | 是 | 客户端用户ID，唯一标识一个用户 | user_1
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | AK/SK 鉴权token | Qiniu AK:sign
## Body 参数
使用JSON 格式数据
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
nick | string | 否 | 用户昵称 | 风清扬
avatar | string | 否 | 用户头像，URL 地址 | https://xxx.com/avator.png
extends | map[string]string | 否 | 扩展信息，key value 结构 |
举例如下
{
"nick":"用户",
"avatar":"http;//xxx.png",
"extends": {
"age":"18"
}
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 4\. 查询用户信息
查询用户信息。
## 路径
GET /server/user/info/{user_id}
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
user_id | string | 是 | 客户端用户ID，唯一标识一个用户 | user_1
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | AK/SK 鉴权token | Qiniu AK:sign
## 请求body
无
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data": {
"user_id": "user-1",
"nick":"用户",
"avatar":"http;//xxx.png",
"im_userid": "im 系统用户ID",
"extends": {
"age":"18"
}
}
}
# 5\. 批量查询用户信息
批量查询用户信息。
## 路径
GET /server/user/infos
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | AK/SK 鉴权token | Qiniu AK:sign
## query参数
user_ids 数组参数，传递多个用户ID。
curl "https://live-api.qiniu.com?user_ids=user_1&user_ids=user2"
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data": [
{
"user_id": "user-1",
"nick":"用户",
"avatar":"http;//xxx.png",
"im_userid": "im 系统用户ID",
"extends": {
"age":"18"
}
}
]
}
# 6\. 查询用户详细信息
查询用户详细信息。
## 路径
GET /server/user/profile/{user_id}
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
user_id | string | 是 | 客户端用户ID，唯一标识一个用户 | user_1
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | AK/SK 鉴权token | Qiniu AK:sign
## 请求body
无
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data": {
"user_id": "user-1",
"nick":"用户",
"avatar":"http;//xxx.png",
"im_userid": "im 系统用户ID",
"im_username":"用于登录IM 的用户名",
"im_password":"用于登录IM 用户密码",
"extends": {
"age":"18"
}
}
}
# 7\. 批量用户详细信息
批量查询用户详细信息。
## 路径
GET /server/user/profiles
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | AK/SK 鉴权token | Qiniu AK:sign
## 请求body
Json 格式的数组，传递用户ID 列表。
[
"user_1",
"user_2"
]
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data": [
{
"user_id": "user-1",
"nick":"用户",
"avatar":"http;//xxx.png",
"im_userid": "im 系统用户ID",
"im_username":"用于登录IM 的用户名",
"im_password":"用于登录IM 用户密码",
"extends": {
"age":"18"
}
}
]
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) >
[服务端API参考](https://developer.qiniu.com/lowcode/api/12008/qlive-server-api-
reference) > 用户模块接口
# 用户模块接口
最近更新时间: 2022-07-21 16:07:58
用户相关接口。
# 1.用户注册
注册一个用户。
## 路径
POST /server/user/register
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | AK/SK 鉴权token | Qiniu AK:sign
## Body 参数
使用JSON 格式数据
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
user_id | string | 是 | 客户端用户ID，唯一标识一个用户 | user_1
nick | string | 否 | 用户昵称 | 风清扬
avatar | string | 否 | 用户头像，URL 地址 | https://xxx.com/avator.png
extends | map[string]string | 否 | 扩展信息，key value 结构 |
举例如下
{
"user_id": "user-1",
"nick":"用户",
"avatar":"http;//xxx.png",
"extends": {
"age":"18"
}
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 2\. 批量用户注册
批量注册用户。
## 路径
POST /server/user/register/batch
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | AK/SK 鉴权token | Qiniu AK:sign
## Body参数
使用Json 格式数据。
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
user_id | string | 是 | 客户端用户ID，唯一标识一个用户 | user_1
nick | string | 否 | 用户昵称 | 风清扬
avatar | string | 否 | 用户头像，URL 地址 | https://xxx.com/avator.png
extends | map[string]string | 否 | 扩展信息，key value 结构 |
举例如下
[
{
"user_id": "user-1",
"nick":"用户",
"avatar":"http;//xxx.png",
"extends": {
"age":"18"
}
}
]
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 3\. 更新用户信息
更新用户信息。
## 路径
PUT /server/user/{user_id}
路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
user_id | string | 是 | 客户端用户ID，唯一标识一个用户 | user_1
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | AK/SK 鉴权token | Qiniu AK:sign
## Body 参数
使用JSON 格式数据
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
nick | string | 否 | 用户昵称 | 风清扬
avatar | string | 否 | 用户头像，URL 地址 | https://xxx.com/avator.png
extends | map[string]string | 否 | 扩展信息，key value 结构 |
举例如下
{
"nick":"用户",
"avatar":"http;//xxx.png",
"extends": {
"age":"18"
}
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 4\. 查询用户信息
查询用户信息。
## 路径
GET /server/user/info/{user_id}
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
user_id | string | 是 | 客户端用户ID，唯一标识一个用户 | user_1
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | AK/SK 鉴权token | Qiniu AK:sign
## 请求body
无
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data": {
"user_id": "user-1",
"nick":"用户",
"avatar":"http;//xxx.png",
"im_userid": "im 系统用户ID",
"extends": {
"age":"18"
}
}
}
# 5\. 批量查询用户信息
批量查询用户信息。
## 路径
GET /server/user/infos
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | AK/SK 鉴权token | Qiniu AK:sign
## query参数
user_ids 数组参数，传递多个用户ID。
curl "https://live-api.qiniu.com?user_ids=user_1&user_ids=user2"
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data": [
{
"user_id": "user-1",
"nick":"用户",
"avatar":"http;//xxx.png",
"im_userid": "im 系统用户ID",
"extends": {
"age":"18"
}
}
]
}
# 6\. 查询用户详细信息
查询用户详细信息。
## 路径
GET /server/user/profile/{user_id}
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
user_id | string | 是 | 客户端用户ID，唯一标识一个用户 | user_1
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | AK/SK 鉴权token | Qiniu AK:sign
## 请求body
无
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data": {
"user_id": "user-1",
"nick":"用户",
"avatar":"http;//xxx.png",
"im_userid": "im 系统用户ID",
"im_username":"用于登录IM 的用户名",
"im_password":"用于登录IM 用户密码",
"extends": {
"age":"18"
}
}
}
# 7\. 批量用户详细信息
批量查询用户详细信息。
## 路径
GET /server/user/profiles
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | AK/SK 鉴权token | Qiniu AK:sign
## 请求body
Json 格式的数组，传递用户ID 列表。
[
"user_1",
"user_2"
]
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data": [
{
"user_id": "user-1",
"nick":"用户",
"avatar":"http;//xxx.png",
"im_userid": "im 系统用户ID",
"im_username":"用于登录IM 的用户名",
"im_password":"用于登录IM 用户密码",
"extends": {
"age":"18"
}
}
]
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,456 |
直播模块接口 | 低代码 | [低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) >
[服务端API参考](https://developer.qiniu.com/lowcode/api/12008/qlive-server-api-
reference) > 直播模块接口
# 直播模块接口
最近更新时间: 2023-01-09 10:57:15
直播间相关接口。
# 1\. 创建直播间
创建一个直播间。
## 路径
POST /server/live
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | AK/SK 鉴权token | Qiniu AK:sign
## Body 参数
使用JSON 格式数据
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
anchor_id | string | 是 | 主播的用户ID | user_1
title | string | 是 | 直播标题 | XXX直播
notice | string | 否 | 直播公告 | 直播公告
cover_url | string | 否 | 用户头像，URL 地址 | https://xxx.com/avator.png
extends | map[string]string | 否 | 扩展信息，key value 结构 |
start_at | string | 否 | 直播开始时间 | “2021-12-02 11:11:11”
end_at | string | 否 | 直播结束时间 | “2021-12-02 11:11:11”
publish_expire_at | string | 否 | 自定义推流地址Token过期时间 | “2021-12-02 11:11:11”
举例如下
{
"title": "XXX直播",
"notice":"直播预告",
"cover_url":"http;//xxx.png",
"extends": {
"age":"18"
},
"start_at": "2021-12-02 11:11:11",
"end_at":"2021-12-02 11:11:11",
"publish_expire_at":"2021-12-02 11:11:11"
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data": {
"live_id":"live_1", //直播间ID
"title":"XXX直播", //直播间标题
"notice":"直播间公告", //直播间公告
"cover_url":"https://xxx.png", //
"extends": {
"age":"18"
},
"anchor_info": {
"user_id":"user_1", //主播用户ID
"im_userid":9000990, //主播的IM 用户ID
"nick":"主播1", //主播昵称
"avatar":"", //主播用户头像
"extends": { //主播用户扩展信息
"age":"18"
},
},
"anchor_status":1, //主播状态：0, 离线；1，在线
"pk_id":"", //跨房会话ID，跨房PK 时有效
"online_count": 3, //在线用户数
"start_time": 1656315406, //开始直播时间，秒级时间戳
"end_time": 1656315406, //结束直播时间，秒级时间戳
"chat_id": 19903902, //聊天室ID
"push_url": "", //推流地址
"hls_url":"", //hls 拉流URL
"rtmp_url":"", //rtmp 拉流URL
"flv_url":"", //flv 拉流URL
"pv": 1003, //PV
"uv": 934, //UV
"live_status":1 //直播间状态，0，已创建；1，直播中；2，已结束
}
}
# 2\. 查询直播间
查询直播间信息。
## 路径
GET /server/live/{live_id}
路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间ID | user_123
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | AK/SK 鉴权token | Qiniu AK:sign
## Body 参数
无
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data": {
"live_id":"live_1", //直播间ID
"title":"XXX直播", //直播间标题
"notice":"直播间公告", //直播间公告
"cover_url":"https://xxx.png", //
"extends": {
"age":"18"
},
"anchor_info": {
"user_id":"user_1", //主播用户ID
"im_userid":9000990, //主播的IM 用户ID
"nick":"主播1", //主播昵称
"avatar":"", //主播用户头像
"extends": { //主播用户扩展信息
"age":"18"
},
},
"anchor_status":1, //主播状态：0, 离线；1，在线
"pk_id":"", //跨房会话ID，跨房PK 时有效
"online_count": 3, //在线用户数
"start_time": 1656315406, //开始直播时间，秒级时间戳
"end_time": 1656315406, //结束直播时间，秒级时间戳
"chat_id": 19903902, //聊天室ID
"push_url": "", //推流地址
"hls_url":"", //hls 拉流URL
"rtmp_url":"", //rtmp 拉流URL
"flv_url":"", //flv 拉流URL
"pv": 1003, //PV
"uv": 934, //UV
"live_status":1 //直播间状态，0，已创建；1，直播中；2，已结束
}
}
# 3\. 关闭直播间
关闭直播间。
## 路径
POST /server/live/{live_id}/stop
路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间ID | user_123
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | AK/SK 鉴权token | Qiniu AK:sign
## Body 参数
无
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 4\. 删除直播间
删除直播间。
## 路径
DELETE /server/live/{live_id}
路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间ID | user_123
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | AK/SK 鉴权token | Qiniu AK:sign
## Body 参数
无
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) >
[服务端API参考](https://developer.qiniu.com/lowcode/api/12008/qlive-server-api-
reference) > 直播模块接口
# 直播模块接口
最近更新时间: 2023-01-09 10:57:15
直播间相关接口。
# 1\. 创建直播间
创建一个直播间。
## 路径
POST /server/live
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | AK/SK 鉴权token | Qiniu AK:sign
## Body 参数
使用JSON 格式数据
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
anchor_id | string | 是 | 主播的用户ID | user_1
title | string | 是 | 直播标题 | XXX直播
notice | string | 否 | 直播公告 | 直播公告
cover_url | string | 否 | 用户头像，URL 地址 | https://xxx.com/avator.png
extends | map[string]string | 否 | 扩展信息，key value 结构 |
start_at | string | 否 | 直播开始时间 | “2021-12-02 11:11:11”
end_at | string | 否 | 直播结束时间 | “2021-12-02 11:11:11”
publish_expire_at | string | 否 | 自定义推流地址Token过期时间 | “2021-12-02 11:11:11”
举例如下
{
"title": "XXX直播",
"notice":"直播预告",
"cover_url":"http;//xxx.png",
"extends": {
"age":"18"
},
"start_at": "2021-12-02 11:11:11",
"end_at":"2021-12-02 11:11:11",
"publish_expire_at":"2021-12-02 11:11:11"
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data": {
"live_id":"live_1", //直播间ID
"title":"XXX直播", //直播间标题
"notice":"直播间公告", //直播间公告
"cover_url":"https://xxx.png", //
"extends": {
"age":"18"
},
"anchor_info": {
"user_id":"user_1", //主播用户ID
"im_userid":9000990, //主播的IM 用户ID
"nick":"主播1", //主播昵称
"avatar":"", //主播用户头像
"extends": { //主播用户扩展信息
"age":"18"
},
},
"anchor_status":1, //主播状态：0, 离线；1，在线
"pk_id":"", //跨房会话ID，跨房PK 时有效
"online_count": 3, //在线用户数
"start_time": 1656315406, //开始直播时间，秒级时间戳
"end_time": 1656315406, //结束直播时间，秒级时间戳
"chat_id": 19903902, //聊天室ID
"push_url": "", //推流地址
"hls_url":"", //hls 拉流URL
"rtmp_url":"", //rtmp 拉流URL
"flv_url":"", //flv 拉流URL
"pv": 1003, //PV
"uv": 934, //UV
"live_status":1 //直播间状态，0，已创建；1，直播中；2，已结束
}
}
# 2\. 查询直播间
查询直播间信息。
## 路径
GET /server/live/{live_id}
路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间ID | user_123
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | AK/SK 鉴权token | Qiniu AK:sign
## Body 参数
无
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data": {
"live_id":"live_1", //直播间ID
"title":"XXX直播", //直播间标题
"notice":"直播间公告", //直播间公告
"cover_url":"https://xxx.png", //
"extends": {
"age":"18"
},
"anchor_info": {
"user_id":"user_1", //主播用户ID
"im_userid":9000990, //主播的IM 用户ID
"nick":"主播1", //主播昵称
"avatar":"", //主播用户头像
"extends": { //主播用户扩展信息
"age":"18"
},
},
"anchor_status":1, //主播状态：0, 离线；1，在线
"pk_id":"", //跨房会话ID，跨房PK 时有效
"online_count": 3, //在线用户数
"start_time": 1656315406, //开始直播时间，秒级时间戳
"end_time": 1656315406, //结束直播时间，秒级时间戳
"chat_id": 19903902, //聊天室ID
"push_url": "", //推流地址
"hls_url":"", //hls 拉流URL
"rtmp_url":"", //rtmp 拉流URL
"flv_url":"", //flv 拉流URL
"pv": 1003, //PV
"uv": 934, //UV
"live_status":1 //直播间状态，0，已创建；1，直播中；2，已结束
}
}
# 3\. 关闭直播间
关闭直播间。
## 路径
POST /server/live/{live_id}/stop
路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间ID | user_123
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | AK/SK 鉴权token | Qiniu AK:sign
## Body 参数
无
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 4\. 删除直播间
删除直播间。
## 路径
DELETE /server/live/{live_id}
路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间ID | user_123
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | AK/SK 鉴权token | Qiniu AK:sign
## Body 参数
无
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,464 |
客户端交互接口 | 低代码 | [低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) >
[服务端API参考](https://developer.qiniu.com/lowcode/api/12008/qlive-server-api-
reference) > 客户端交互接口
# 客户端交互接口
最近更新时间: 2022-09-07 17:15:21
提供给互动直播客户端的接口。
互动直播SDK 使用这部分接口与互动直播服务进行通信。
业务APP可以使用这部分接口，进行客户端业务扩展。
# 认证方式
客户端接口，使用在请求头部，携带鉴权token的方式，来进行认证。
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## 鉴权token 获取
鉴权token，由业务服务根据用户身份来生成。
业务服务生成鉴权token，参考 [获取用户访问token
__](https://developer.qiniu.com/lowcode/12010/qlive-server-api-user-token)
# 返回结果
API 的返回结果，格式如下。
{
"request_id":"", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "", //错误原因，当 code 非 0 时，错误原因必须携带。
"data":{ //返回结果，具体参考每个API 定义
}
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) >
[服务端API参考](https://developer.qiniu.com/lowcode/api/12008/qlive-server-api-
reference) > 客户端交互接口
# 客户端交互接口
最近更新时间: 2022-09-07 17:15:21
提供给互动直播客户端的接口。
互动直播SDK 使用这部分接口与互动直播服务进行通信。
业务APP可以使用这部分接口，进行客户端业务扩展。
# 认证方式
客户端接口，使用在请求头部，携带鉴权token的方式，来进行认证。
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## 鉴权token 获取
鉴权token，由业务服务根据用户身份来生成。
业务服务生成鉴权token，参考 [获取用户访问token
__](https://developer.qiniu.com/lowcode/12010/qlive-server-api-user-token)
# 返回结果
API 的返回结果，格式如下。
{
"request_id":"", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "", //错误原因，当 code 非 0 时，错误原因必须携带。
"data":{ //返回结果，具体参考每个API 定义
}
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,473 |
礼物模块接口 | 低代码 | [低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) >
[服务端API参考](https://developer.qiniu.com/lowcode/api/12008/qlive-server-api-
reference) > [客户端交互接口](https://developer.qiniu.com/lowcode/api/12188/client-
apis) > 礼物模块接口
# 礼物模块接口
最近更新时间: 2022-12-15 17:33:40
# 查看礼物配置
查看所有的礼物配置。
## 路径
GET /client/gift/config/{type}
路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
type | int | 是 | 类型 ID，type==-1时表示全部类型 |
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Body 参数
无。
## 返回
该接口正确处理请求时返回如下 JSON 数据
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data": [
{
"type": 1, //礼物类型
"gift_id":3, //礼物id
"name": "红包", //礼物名称
"amount": 5, //礼物金额，0 表示自定义金额,
"img": "", //礼物图片,
"animation_type":0, //动态效果类型,
"animation_img":"", //动态效果图片,
"order": 0, //排序，从小到大排序，相同order 根据创建时间排序',
"created_at":"2022-09-15 13:00:00", //创建时间
"updated_at":"2022-09-20 15:00:00" //更新时间
}
]
}
# 查看直播间礼物列表
查看直播间的礼物记录。只有主播才能查看。
## 路径
GET /client/gift/list/live/{live_id}
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
liveId | string | 是 | 直播间 ID |
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Query 参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
page_num | integer | 否 | 页码 |
page_size | integer | 否 | 分页大小 |
## 返回
该接口正确处理请求时返回如下 JSON 数据
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data":{
"total_count":100, //总数
"page_total": 5, //总页数
"end_page": false, //当前是否最后一页
"list":[
{
"biz_id":"", //交易ID，唯一标识一次礼物发送，业务方生成
"user_id":"", //发送礼物的用户ID
"live_id":""// 直播间ID
"type":1, //礼物类型，用户在礼物配置接口配置
"gift_id":1, //礼物id，用户在礼物配置接口配置
"amount":99, //礼物金额
"created_at":"2022-09-01 00:00:00", //发送时间
}
]
}
}
# 查看主播礼物列表
查看直播间的礼物记录。只有主播才能查看。
## 路径
GET /client/gift/list/anchor
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Query 参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
page_num | integer | 否 | 页码 |
page_size | integer | 否 | 分页大小 |
## 返回
该接口正确处理请求时返回如下 JSON 数据
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data":{
"total_count":100, //总数
"page_total": 5, //总页数
"end_page": false, //当前是否最后一页
"list":[
{
"biz_id":"", //交易ID，唯一标识一次礼物发送，业务方生成
"user_id":"", //发送礼物的用户ID
"live_id":""// 直播间ID
"type":1, //礼物类型，用户在礼物配置接口配置
"gift_id":1, //礼物id，用户在礼物配置接口配置
"amount":99, //礼物金额
"created_at":"2022-09-01 00:00:00", //发送时间
}
]
}
}
# 查看用户打赏礼物列表
查看直播间的礼物记录。
## 路径
GET /client/gift/list/user
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Query 参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
page_num | integer | 否 | 页码 |
page_size | integer | 否 | 分页大小 |
## 返回
该接口正确处理请求时返回如下 JSON 数据
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data":{
"total_count":100, //总数
"page_total": 5, //总页数
"end_page": false, //当前是否最后一页
"list":[
{
"biz_id":"", //交易ID，唯一标识一次礼物发送，业务方生成
"user_id":"", //发送礼物的用户ID
"live_id":""// 直播间ID
"type":1, //礼物类型，用户在礼物配置接口配置
"gift_id":1, //礼物id，用户在礼物配置接口配置
"amount":99, //礼物金额
"created_at":"2022-09-01 00:00:00", //发送时间
}
]
}
}
# 发送礼物
直播间内用户，在直播间发送礼物。
## 路径
POST /client/gift/send
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
liveId | string | 是 | 直播间 ID |
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Body 参数
{
"live_id":"", //直播间ID
"user_id":"", //发送礼物的用户ID
"amount":99, //礼物金额
}
## 返回
该接口正确处理请求时返回如下 JSON 数据
{
"request_id": "XXX",
"code": 0,
"message": "success",
"data": {
"biz_id": "XXXX",
"user_id": "test_XXX",
"live_id": "XXXXX",
"anchor_id": "XXXX",
"gift_id": 3,
"amount": 99,
"status": 1
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) >
[服务端API参考](https://developer.qiniu.com/lowcode/api/12008/qlive-server-api-
reference) > [客户端交互接口](https://developer.qiniu.com/lowcode/api/12188/client-
apis) > 礼物模块接口
# 礼物模块接口
最近更新时间: 2022-12-15 17:33:40
# 查看礼物配置
查看所有的礼物配置。
## 路径
GET /client/gift/config/{type}
路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
type | int | 是 | 类型 ID，type==-1时表示全部类型 |
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Body 参数
无。
## 返回
该接口正确处理请求时返回如下 JSON 数据
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data": [
{
"type": 1, //礼物类型
"gift_id":3, //礼物id
"name": "红包", //礼物名称
"amount": 5, //礼物金额，0 表示自定义金额,
"img": "", //礼物图片,
"animation_type":0, //动态效果类型,
"animation_img":"", //动态效果图片,
"order": 0, //排序，从小到大排序，相同order 根据创建时间排序',
"created_at":"2022-09-15 13:00:00", //创建时间
"updated_at":"2022-09-20 15:00:00" //更新时间
}
]
}
# 查看直播间礼物列表
查看直播间的礼物记录。只有主播才能查看。
## 路径
GET /client/gift/list/live/{live_id}
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
liveId | string | 是 | 直播间 ID |
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Query 参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
page_num | integer | 否 | 页码 |
page_size | integer | 否 | 分页大小 |
## 返回
该接口正确处理请求时返回如下 JSON 数据
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data":{
"total_count":100, //总数
"page_total": 5, //总页数
"end_page": false, //当前是否最后一页
"list":[
{
"biz_id":"", //交易ID，唯一标识一次礼物发送，业务方生成
"user_id":"", //发送礼物的用户ID
"live_id":""// 直播间ID
"type":1, //礼物类型，用户在礼物配置接口配置
"gift_id":1, //礼物id，用户在礼物配置接口配置
"amount":99, //礼物金额
"created_at":"2022-09-01 00:00:00", //发送时间
}
]
}
}
# 查看主播礼物列表
查看直播间的礼物记录。只有主播才能查看。
## 路径
GET /client/gift/list/anchor
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Query 参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
page_num | integer | 否 | 页码 |
page_size | integer | 否 | 分页大小 |
## 返回
该接口正确处理请求时返回如下 JSON 数据
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data":{
"total_count":100, //总数
"page_total": 5, //总页数
"end_page": false, //当前是否最后一页
"list":[
{
"biz_id":"", //交易ID，唯一标识一次礼物发送，业务方生成
"user_id":"", //发送礼物的用户ID
"live_id":""// 直播间ID
"type":1, //礼物类型，用户在礼物配置接口配置
"gift_id":1, //礼物id，用户在礼物配置接口配置
"amount":99, //礼物金额
"created_at":"2022-09-01 00:00:00", //发送时间
}
]
}
}
# 查看用户打赏礼物列表
查看直播间的礼物记录。
## 路径
GET /client/gift/list/user
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Query 参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
page_num | integer | 否 | 页码 |
page_size | integer | 否 | 分页大小 |
## 返回
该接口正确处理请求时返回如下 JSON 数据
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data":{
"total_count":100, //总数
"page_total": 5, //总页数
"end_page": false, //当前是否最后一页
"list":[
{
"biz_id":"", //交易ID，唯一标识一次礼物发送，业务方生成
"user_id":"", //发送礼物的用户ID
"live_id":""// 直播间ID
"type":1, //礼物类型，用户在礼物配置接口配置
"gift_id":1, //礼物id，用户在礼物配置接口配置
"amount":99, //礼物金额
"created_at":"2022-09-01 00:00:00", //发送时间
}
]
}
}
# 发送礼物
直播间内用户，在直播间发送礼物。
## 路径
POST /client/gift/send
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
liveId | string | 是 | 直播间 ID |
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Body 参数
{
"live_id":"", //直播间ID
"user_id":"", //发送礼物的用户ID
"amount":99, //礼物金额
}
## 返回
该接口正确处理请求时返回如下 JSON 数据
{
"request_id": "XXX",
"code": 0,
"message": "success",
"data": {
"biz_id": "XXXX",
"user_id": "test_XXX",
"live_id": "XXXXX",
"anchor_id": "XXXX",
"gift_id": 3,
"amount": 99,
"status": 1
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,475 |
应用全局模块 | 低代码 | [低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) >
[服务端API参考](https://developer.qiniu.com/lowcode/api/12008/qlive-server-api-
reference) > [客户端交互接口](https://developer.qiniu.com/lowcode/api/12188/client-
apis) > 应用全局模块
# 应用全局模块
最近更新时间: 2022-09-07 17:15:36
描述应用相关的接口。
# 获取应用配置信息
客户端请求互动直播服务相关的应用信息。
## 路径
GET /client/app/config
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data": {
"im_app_id": "<im app id>" //对应的IM 应用ID
}
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) >
[服务端API参考](https://developer.qiniu.com/lowcode/api/12008/qlive-server-api-
reference) > [客户端交互接口](https://developer.qiniu.com/lowcode/api/12188/client-
apis) > 应用全局模块
# 应用全局模块
最近更新时间: 2022-09-07 17:15:36
描述应用相关的接口。
# 获取应用配置信息
客户端请求互动直播服务相关的应用信息。
## 路径
GET /client/app/config
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data": {
"im_app_id": "<im app id>" //对应的IM 应用ID
}
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,485 |
客户端用户模块接口 | 低代码 | [低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) >
[服务端API参考](https://developer.qiniu.com/lowcode/api/12008/qlive-server-api-
reference) > [客户端交互接口](https://developer.qiniu.com/lowcode/api/12188/client-
apis) > 客户端用户模块接口
# 客户端用户模块接口
最近更新时间: 2022-09-07 17:15:43
# 获取自己的详细信息接口
用户获取自己的详细信息。包括自己私有信息，如：IM用户名，密码。
## 路径
GET /client/user/profile
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data": {
"user_id": "user_123", //用户ID
"nick": "", //昵称
"avatar": "", //头像
"extends": { //扩展信息
"ext-key":"ext-value"
},
"im_userid": 12345, //IM用户ID
"im_username": "im_user_123", //IM用户名
"im_password": "*****" //IM用户密码
}
}
# 获取其他用户信息
查询其他用户的信息。不包含私有信息。
## 路径
GET /client/user/user/{user_id}
路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
user_id | string | 是 | 用户ID | user_123
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## 请求body
无
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data": {
"user_id": "user-1",
"nick":"用户",
"avatar":"http://xxx.png",
"im_userid": "im 系统用户ID",
"extends": {
"age":"18"
}
}
}
# 批量获取用户信息
批量获取其他用户的公开信息。
## 路径
GET /client/user/users
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## query参数
user_ids 数组参数，传递多个用户ID。
curl "https://live-api.qiniu.com/client/user/users?user_ids=user_1&user_ids=user_2"
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data": [
{
"user_id": "user-1",
"nick":"用户",
"avatar":"http;//xxx.png",
"im_userid": "im 系统用户ID",
"extends": {
"age":"18"
}
}
]
}
# 更新用户信息
更新自己的用户信息。
## 路径
PUT /client/user/user
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Body 参数
{
"nick": "feng",
"avatar":"beauty",
"extends": {
"score":"15",
"lost":"hehe"
}
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 根据IM用户id 查找用户信息
根据IM 用户ID，查找用户信息。
## 路径
GET /client/user/imusers
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## query参数
im_user_ids 数组参数，传递多个IM用户ID。
curl "https://live-api.qiniu.com/client/user/musers?im_user_ids=123&im_user_ids=456"
## 返回结果
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data": [
{
"user_id": "user-1",
"nick":"用户",
"avatar":"http;//xxx.png",
"im_userid": "im 系统用户ID",
"extends": {
"age":"18"
}
}
]
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) >
[服务端API参考](https://developer.qiniu.com/lowcode/api/12008/qlive-server-api-
reference) > [客户端交互接口](https://developer.qiniu.com/lowcode/api/12188/client-
apis) > 客户端用户模块接口
# 客户端用户模块接口
最近更新时间: 2022-09-07 17:15:43
# 获取自己的详细信息接口
用户获取自己的详细信息。包括自己私有信息，如：IM用户名，密码。
## 路径
GET /client/user/profile
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data": {
"user_id": "user_123", //用户ID
"nick": "", //昵称
"avatar": "", //头像
"extends": { //扩展信息
"ext-key":"ext-value"
},
"im_userid": 12345, //IM用户ID
"im_username": "im_user_123", //IM用户名
"im_password": "*****" //IM用户密码
}
}
# 获取其他用户信息
查询其他用户的信息。不包含私有信息。
## 路径
GET /client/user/user/{user_id}
路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
user_id | string | 是 | 用户ID | user_123
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## 请求body
无
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data": {
"user_id": "user-1",
"nick":"用户",
"avatar":"http://xxx.png",
"im_userid": "im 系统用户ID",
"extends": {
"age":"18"
}
}
}
# 批量获取用户信息
批量获取其他用户的公开信息。
## 路径
GET /client/user/users
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## query参数
user_ids 数组参数，传递多个用户ID。
curl "https://live-api.qiniu.com/client/user/users?user_ids=user_1&user_ids=user_2"
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data": [
{
"user_id": "user-1",
"nick":"用户",
"avatar":"http;//xxx.png",
"im_userid": "im 系统用户ID",
"extends": {
"age":"18"
}
}
]
}
# 更新用户信息
更新自己的用户信息。
## 路径
PUT /client/user/user
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Body 参数
{
"nick": "feng",
"avatar":"beauty",
"extends": {
"score":"15",
"lost":"hehe"
}
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 根据IM用户id 查找用户信息
根据IM 用户ID，查找用户信息。
## 路径
GET /client/user/imusers
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## query参数
im_user_ids 数组参数，传递多个IM用户ID。
curl "https://live-api.qiniu.com/client/user/musers?im_user_ids=123&im_user_ids=456"
## 返回结果
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data": [
{
"user_id": "user-1",
"nick":"用户",
"avatar":"http;//xxx.png",
"im_userid": "im 系统用户ID",
"extends": {
"age":"18"
}
}
]
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,487 |
直播间管理接口 | 低代码 | [低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) >
[服务端API参考](https://developer.qiniu.com/lowcode/api/12008/qlive-server-api-
reference) > [客户端交互接口](https://developer.qiniu.com/lowcode/api/12188/client-
apis) > 直播间管理接口
# 直播间管理接口
最近更新时间: 2022-09-07 17:15:51
直播间相关接口。
# 创建直播间
创建一个直播间。创建直播间的用户，作为直播间的主播。
## 路径
POST /client/live/room/instance
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Body 参数
使用JSON 格式数据
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
title | string | 是 | 直播标题 | XXX直播
notice | string | 否 | 直播公告 | 直播公告
cover_url | string | 否 | 用户头像，URL 地址 | https://xxx.com/avator.png
extends | map[string]string | 否 | 扩展信息，key value 结构 |
start_at | string | 否 | 直播开始时间 | “2021-12-02 11:11:11”
end_at | string | 否 | 直播结束时间 | “2021-12-02 11:11:11”
publish_expire_at | string | 否 | 自定义推流地址Token过期时间 | “2021-12-02 11:11:11”
举例如下
{
"title": "XXX直播",
"notice":"直播预告",
"cover_url":"http;//xxx.png",
"extends": {
"age":"18"
},
"start_at": "2021-12-02 11:11:11" ,
"end_at":"2021-12-02 11:11:11" ,
"publish_expire_at":"2021-12-02 11:11:11"
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data": {
"live_id":"live_1", //直播间ID
"title":"XXX直播", //直播间标题
"notice":"直播间公告", //直播间公告
"cover_url":"https://xxx.png", //
"extends": {
"age":"18"
},
"anchor_info": {
"user_id":"user_1", //主播用户ID
"im_userid":9000990, //主播的IM 用户ID
"nick":"主播1", //主播昵称
"avatar":"", //主播用户头像
"extends": { //主播用户扩展信息
"age":"18"
},
},
"anchor_status":1, //主播状态：0, 离线；1，在线
"pk_id":"", //跨房会话ID，跨房PK 时有效
"online_count": 3, //在线用户数
"start_time": 1656315406, //开始直播时间，秒级时间戳
"end_time": 1656315406, //结束直播时间，秒级时间戳
"chat_id": 19903902, //聊天室ID
"push_url": "", //推流地址
"hls_url":"", //hls 拉流URL
"rtmp_url":"", //rtmp 拉流URL
"flv_url":"", //flv 拉流URL
"pv": 1003, //PV
"uv": 934, //UV
"live_status":1 //直播间状态，0，已创建；1，直播中；2，已结束
}
}
# 查询直播间
查询直播间信息。
## 路径
GET /client/live/room/info/{live_id}
路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间ID | live_123
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Body 参数
无
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data": {
"live_id":"live_1", //直播间ID
"title":"XXX直播", //直播间标题
"notice":"直播间公告", //直播间公告
"cover_url":"https://xxx.png", //
"extends": {
"age":"18"
},
"anchor_info": {
"user_id":"user_1", //主播用户ID
"im_userid":9000990, //主播的IM 用户ID
"nick":"主播1", //主播昵称
"avatar":"", //主播用户头像
"extends": { //主播用户扩展信息
"age":"18"
},
},
"anchor_status":1, //主播状态：0, 离线；1，在线
"pk_id":"", //跨房会话ID，跨房PK 时有效
"online_count": 3, //在线用户数
"start_time": 1656315406, //开始直播时间，秒级时间戳
"end_time": 1656315406, //结束直播时间，秒级时间戳
"chat_id": 19903902, //聊天室ID
"push_url": "", //推流地址
"hls_url":"", //hls 拉流URL
"rtmp_url":"", //rtmp 拉流URL
"flv_url":"", //flv 拉流URL
"pv": 1003, //PV
"uv": 934, //UV
"live_status":1 //直播间状态，0，已创建；1，直播中；2，已结束
}
}
# 开始直播
开始直播间的直播。开始直播后，其他用户可以看到该直播间。
只有直播间的主播，才能开始直播。
直播间关闭之后，不能调用该接口开始直播。
## 路径
PUT /client/live/room/{live_id}
路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间ID | live_123
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Body 参数
无
## 返回
如果开启成功，返回直播间详情信息。
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success", //code 非0 时，错误原因描述
"data": {
"live_id":"live_1", //直播间ID
"title":"XXX直播", //直播间标题
"notice":"直播间公告", //直播间公告
"cover_url":"https://xxx.png", //
"extends": {
"age":"18"
},
"anchor_info": {
"user_id":"user_1", //主播用户ID
"im_userid":9000990, //主播的IM 用户ID
"nick":"主播1", //主播昵称
"avatar":"", //主播用户头像
"extends": { //主播用户扩展信息
"age":"18"
},
},
"anchor_status":1, //主播状态：0, 离线；1，在线
"pk_id":"", //跨房会话ID，跨房PK 时有效
"online_count": 3, //在线用户数
"start_time": 1656315406, //开始直播时间，秒级时间戳
"end_time": 1656315406, //结束直播时间，秒级时间戳
"chat_id": 19903902, //聊天室ID
"push_url": "", //推流地址
"hls_url":"", //hls 拉流URL
"rtmp_url":"", //rtmp 拉流URL
"flv_url":"", //flv 拉流URL
"pv": 1003, //PV
"uv": 934, //UV
"live_status":1 //直播间状态，0，已创建；1，直播中；2，已结束
}
}
# 停止直播
停止直播。
只有直播间的主播才能停止直播。
只有直播间在直播状态，才能停止直播。
## 路径
POST /client/live/room/{live_id}
路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间ID | live_123
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Body 参数
无
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 删除直播间
删除直播间。
只有直播间的主播才能删除直播间。
## 路径
DELETE /client/live/room/instance/{live_id}
路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间ID | live_123
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Body 参数
无
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 搜索直播
直播间搜索。
## 路径
GET /client/live/room
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Query 参数
{
"page_num": 1, //页码
"page_size": 20, //分页数量
"keyword":"" //搜索关键字
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success", //code 非0 时，错误原因描述
"data": {
"total_count":100, //总数
"page_total": 5, //总页数
"end_page": false, //当前是否最后一页
"list": [
{
"live_id":"live_1", //直播间ID
"title":"XXX直播", //直播间标题
"notice":"直播间公告", //直播间公告
"cover_url":"https://xxx.png", //
"extends": {
"age":"18"
},
"anchor_info": {
"user_id":"user_1", //主播用户ID
"im_userid":9000990, //主播的IM 用户ID
"nick":"主播1", //主播昵称
"avatar":"", //主播用户头像
"extends": { //主播用户扩展信息
"age":"18"
},
},
"anchor_status":1, //主播状态：0, 离线；1，在线
"pk_id":"", //跨房会话ID，跨房PK 时有效
"online_count": 3, //在线用户数
"start_time": 1656315406, //开始直播时间，秒级时间戳
"end_time": 1656315406, //结束直播时间，秒级时间戳
"chat_id": 19903902, //聊天室ID
"push_url": "", //推流地址
"hls_url":"", //hls 拉流URL
"rtmp_url":"", //rtmp 拉流URL
"flv_url":"", //flv 拉流URL
"pv": 1003, //PV
"uv": 934, //UV
"live_status":1 //直播间状态，0，已创建；1，直播中；2，已结束
}
]
}
}
# 直播列表
分页查看直播间列表。
只会看到正在直播的直播间。
## 路径
GET /client/live/room/list
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Query 参数
{
"page_num": 1, //页码
"page_size": 20 //分页数量
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success", //code 非0 时，错误原因描述
"data": {
"total_count":100, //总数
"page_total": 5, //总页数
"end_page": false, //当前是否最后一页
"list": [
{
"live_id":"live_1", //直播间ID
"title":"XXX直播", //直播间标题
"notice":"直播间公告", //直播间公告
"cover_url":"https://xxx.png", //
"extends": {
"age":"18"
},
"anchor_info": {
"user_id":"user_1", //主播用户ID
"im_userid":9000990, //主播的IM 用户ID
"nick":"主播1", //主播昵称
"avatar":"", //主播用户头像
"extends": { //主播用户扩展信息
"age":"18"
},
},
"anchor_status":1, //主播状态：0, 离线；1，在线
"pk_id":"", //跨房会话ID，跨房PK 时有效
"online_count": 3, //在线用户数
"start_time": 1656315406, //开始直播时间，秒级时间戳
"end_time": 1656315406, //结束直播时间，秒级时间戳
"chat_id": 19903902, //聊天室ID
"push_url": "", //推流地址
"hls_url":"", //hls 拉流URL
"rtmp_url":"", //rtmp 拉流URL
"flv_url":"", //flv 拉流URL
"pv": 1003, //PV
"uv": 934, //UV
"live_status":1 //直播间状态，0，已创建；1，直播中；2，已结束
}
]
}
}
# 加入直播
用户加入一个直播间。
一个用户在同一个时间，只能加入一个直播间。
加入第二个直播间，会主动从第一个直播间退出。
## 路径
POST /client/live/room/user/{live_id}
路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间ID | live_123
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success", //code 非0 时，错误原因描述
"data": {
"live_id":"live_1", //直播间ID
"title":"XXX直播", //直播间标题
"notice":"直播间公告", //直播间公告
"cover_url":"https://xxx.png", //
"extends": {
"age":"18"
},
"anchor_info": {
"user_id":"user_1", //主播用户ID
"im_userid":9000990, //主播的IM 用户ID
"nick":"主播1", //主播昵称
"avatar":"", //主播用户头像
"extends": { //主播用户扩展信息
"age":"18"
},
},
"anchor_status":1, //主播状态：0, 离线；1，在线
"pk_id":"", //跨房会话ID，跨房PK 时有效
"online_count": 3, //在线用户数
"start_time": 1656315406, //开始直播时间，秒级时间戳
"end_time": 1656315406, //结束直播时间，秒级时间戳
"chat_id": 19903902, //聊天室ID
"push_url": "", //推流地址
"hls_url":"", //hls 拉流URL
"rtmp_url":"", //rtmp 拉流URL
"flv_url":"", //flv 拉流URL
"pv": 1003, //PV
"uv": 934, //UV
"live_status":1 //直播间状态，0，已创建；1，直播中；2，已结束
}
}
# 离开直播
直播间内的用户离开直播间。
## 路径
DELETE /client/live/room/user/{live_id}
路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间ID | live_123
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Body 参数
无。
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 心跳
用户加入直播间后，需要通过心跳，确认自己还在直播间。
用户加入直播间后，每5秒需要发送一个心跳。服务端在连续丢失3个心跳后，会认为用户已经离开直播间。
如果主播心跳丢失，会在直播间内提示主播离线。主播离线10分钟，会关闭直播间。
## 路径
GET /client/live/room/heartbeat/{live_id}
路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间ID | live_123
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Body 参数
无。
## 返回
{
"request_id": "xxxxx",
"code": 0,
"message": "success",
"data": {
"live_id": "live_123",
"live_status": 1
}
}
# 更新直播扩展
更新直播间的扩展信息。
## 路径
PUT /client/live/room/extends
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Body参数
{
"live_id":"live_1", //直播间ID
"extends": {
"age":"18"
}
}
## 返回
{
"request_id": "xxxxx",
"code": 0,
"message": "success"
}
# 房间用户列表
获取直播间内的用户列表。
## 路径
GET /client/live/room/user_list
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Query参数
{
"live_id":"live_123" //直播ID
"page_num": 1, //页码
"page_size": 20 //分页数量
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success", //code 非0 时，错误原因描述
"data": {
"total_count":100, //总数
"page_total": 5, //总页数
"end_page": false, //当前是否最后一页
"list": [
{
"user_id":"user_1", //用户ID
"im_userid":9000990, //用户的的IM 账号ID
"im_username":"", //IM用户名
"nick":"主播1", //昵称
"avatar":"", //用户头像
"extends": { //用户扩展信息
"age":"18"
},
}
]
}
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) >
[服务端API参考](https://developer.qiniu.com/lowcode/api/12008/qlive-server-api-
reference) > [客户端交互接口](https://developer.qiniu.com/lowcode/api/12188/client-
apis) > 直播间管理接口
# 直播间管理接口
最近更新时间: 2022-09-07 17:15:51
直播间相关接口。
# 创建直播间
创建一个直播间。创建直播间的用户，作为直播间的主播。
## 路径
POST /client/live/room/instance
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Body 参数
使用JSON 格式数据
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
title | string | 是 | 直播标题 | XXX直播
notice | string | 否 | 直播公告 | 直播公告
cover_url | string | 否 | 用户头像，URL 地址 | https://xxx.com/avator.png
extends | map[string]string | 否 | 扩展信息，key value 结构 |
start_at | string | 否 | 直播开始时间 | “2021-12-02 11:11:11”
end_at | string | 否 | 直播结束时间 | “2021-12-02 11:11:11”
publish_expire_at | string | 否 | 自定义推流地址Token过期时间 | “2021-12-02 11:11:11”
举例如下
{
"title": "XXX直播",
"notice":"直播预告",
"cover_url":"http;//xxx.png",
"extends": {
"age":"18"
},
"start_at": "2021-12-02 11:11:11" ,
"end_at":"2021-12-02 11:11:11" ,
"publish_expire_at":"2021-12-02 11:11:11"
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data": {
"live_id":"live_1", //直播间ID
"title":"XXX直播", //直播间标题
"notice":"直播间公告", //直播间公告
"cover_url":"https://xxx.png", //
"extends": {
"age":"18"
},
"anchor_info": {
"user_id":"user_1", //主播用户ID
"im_userid":9000990, //主播的IM 用户ID
"nick":"主播1", //主播昵称
"avatar":"", //主播用户头像
"extends": { //主播用户扩展信息
"age":"18"
},
},
"anchor_status":1, //主播状态：0, 离线；1，在线
"pk_id":"", //跨房会话ID，跨房PK 时有效
"online_count": 3, //在线用户数
"start_time": 1656315406, //开始直播时间，秒级时间戳
"end_time": 1656315406, //结束直播时间，秒级时间戳
"chat_id": 19903902, //聊天室ID
"push_url": "", //推流地址
"hls_url":"", //hls 拉流URL
"rtmp_url":"", //rtmp 拉流URL
"flv_url":"", //flv 拉流URL
"pv": 1003, //PV
"uv": 934, //UV
"live_status":1 //直播间状态，0，已创建；1，直播中；2，已结束
}
}
# 查询直播间
查询直播间信息。
## 路径
GET /client/live/room/info/{live_id}
路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间ID | live_123
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Body 参数
无
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data": {
"live_id":"live_1", //直播间ID
"title":"XXX直播", //直播间标题
"notice":"直播间公告", //直播间公告
"cover_url":"https://xxx.png", //
"extends": {
"age":"18"
},
"anchor_info": {
"user_id":"user_1", //主播用户ID
"im_userid":9000990, //主播的IM 用户ID
"nick":"主播1", //主播昵称
"avatar":"", //主播用户头像
"extends": { //主播用户扩展信息
"age":"18"
},
},
"anchor_status":1, //主播状态：0, 离线；1，在线
"pk_id":"", //跨房会话ID，跨房PK 时有效
"online_count": 3, //在线用户数
"start_time": 1656315406, //开始直播时间，秒级时间戳
"end_time": 1656315406, //结束直播时间，秒级时间戳
"chat_id": 19903902, //聊天室ID
"push_url": "", //推流地址
"hls_url":"", //hls 拉流URL
"rtmp_url":"", //rtmp 拉流URL
"flv_url":"", //flv 拉流URL
"pv": 1003, //PV
"uv": 934, //UV
"live_status":1 //直播间状态，0，已创建；1，直播中；2，已结束
}
}
# 开始直播
开始直播间的直播。开始直播后，其他用户可以看到该直播间。
只有直播间的主播，才能开始直播。
直播间关闭之后，不能调用该接口开始直播。
## 路径
PUT /client/live/room/{live_id}
路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间ID | live_123
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Body 参数
无
## 返回
如果开启成功，返回直播间详情信息。
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success", //code 非0 时，错误原因描述
"data": {
"live_id":"live_1", //直播间ID
"title":"XXX直播", //直播间标题
"notice":"直播间公告", //直播间公告
"cover_url":"https://xxx.png", //
"extends": {
"age":"18"
},
"anchor_info": {
"user_id":"user_1", //主播用户ID
"im_userid":9000990, //主播的IM 用户ID
"nick":"主播1", //主播昵称
"avatar":"", //主播用户头像
"extends": { //主播用户扩展信息
"age":"18"
},
},
"anchor_status":1, //主播状态：0, 离线；1，在线
"pk_id":"", //跨房会话ID，跨房PK 时有效
"online_count": 3, //在线用户数
"start_time": 1656315406, //开始直播时间，秒级时间戳
"end_time": 1656315406, //结束直播时间，秒级时间戳
"chat_id": 19903902, //聊天室ID
"push_url": "", //推流地址
"hls_url":"", //hls 拉流URL
"rtmp_url":"", //rtmp 拉流URL
"flv_url":"", //flv 拉流URL
"pv": 1003, //PV
"uv": 934, //UV
"live_status":1 //直播间状态，0，已创建；1，直播中；2，已结束
}
}
# 停止直播
停止直播。
只有直播间的主播才能停止直播。
只有直播间在直播状态，才能停止直播。
## 路径
POST /client/live/room/{live_id}
路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间ID | live_123
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Body 参数
无
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 删除直播间
删除直播间。
只有直播间的主播才能删除直播间。
## 路径
DELETE /client/live/room/instance/{live_id}
路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间ID | live_123
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Body 参数
无
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 搜索直播
直播间搜索。
## 路径
GET /client/live/room
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Query 参数
{
"page_num": 1, //页码
"page_size": 20, //分页数量
"keyword":"" //搜索关键字
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success", //code 非0 时，错误原因描述
"data": {
"total_count":100, //总数
"page_total": 5, //总页数
"end_page": false, //当前是否最后一页
"list": [
{
"live_id":"live_1", //直播间ID
"title":"XXX直播", //直播间标题
"notice":"直播间公告", //直播间公告
"cover_url":"https://xxx.png", //
"extends": {
"age":"18"
},
"anchor_info": {
"user_id":"user_1", //主播用户ID
"im_userid":9000990, //主播的IM 用户ID
"nick":"主播1", //主播昵称
"avatar":"", //主播用户头像
"extends": { //主播用户扩展信息
"age":"18"
},
},
"anchor_status":1, //主播状态：0, 离线；1，在线
"pk_id":"", //跨房会话ID，跨房PK 时有效
"online_count": 3, //在线用户数
"start_time": 1656315406, //开始直播时间，秒级时间戳
"end_time": 1656315406, //结束直播时间，秒级时间戳
"chat_id": 19903902, //聊天室ID
"push_url": "", //推流地址
"hls_url":"", //hls 拉流URL
"rtmp_url":"", //rtmp 拉流URL
"flv_url":"", //flv 拉流URL
"pv": 1003, //PV
"uv": 934, //UV
"live_status":1 //直播间状态，0，已创建；1，直播中；2，已结束
}
]
}
}
# 直播列表
分页查看直播间列表。
只会看到正在直播的直播间。
## 路径
GET /client/live/room/list
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Query 参数
{
"page_num": 1, //页码
"page_size": 20 //分页数量
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success", //code 非0 时，错误原因描述
"data": {
"total_count":100, //总数
"page_total": 5, //总页数
"end_page": false, //当前是否最后一页
"list": [
{
"live_id":"live_1", //直播间ID
"title":"XXX直播", //直播间标题
"notice":"直播间公告", //直播间公告
"cover_url":"https://xxx.png", //
"extends": {
"age":"18"
},
"anchor_info": {
"user_id":"user_1", //主播用户ID
"im_userid":9000990, //主播的IM 用户ID
"nick":"主播1", //主播昵称
"avatar":"", //主播用户头像
"extends": { //主播用户扩展信息
"age":"18"
},
},
"anchor_status":1, //主播状态：0, 离线；1，在线
"pk_id":"", //跨房会话ID，跨房PK 时有效
"online_count": 3, //在线用户数
"start_time": 1656315406, //开始直播时间，秒级时间戳
"end_time": 1656315406, //结束直播时间，秒级时间戳
"chat_id": 19903902, //聊天室ID
"push_url": "", //推流地址
"hls_url":"", //hls 拉流URL
"rtmp_url":"", //rtmp 拉流URL
"flv_url":"", //flv 拉流URL
"pv": 1003, //PV
"uv": 934, //UV
"live_status":1 //直播间状态，0，已创建；1，直播中；2，已结束
}
]
}
}
# 加入直播
用户加入一个直播间。
一个用户在同一个时间，只能加入一个直播间。
加入第二个直播间，会主动从第一个直播间退出。
## 路径
POST /client/live/room/user/{live_id}
路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间ID | live_123
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success", //code 非0 时，错误原因描述
"data": {
"live_id":"live_1", //直播间ID
"title":"XXX直播", //直播间标题
"notice":"直播间公告", //直播间公告
"cover_url":"https://xxx.png", //
"extends": {
"age":"18"
},
"anchor_info": {
"user_id":"user_1", //主播用户ID
"im_userid":9000990, //主播的IM 用户ID
"nick":"主播1", //主播昵称
"avatar":"", //主播用户头像
"extends": { //主播用户扩展信息
"age":"18"
},
},
"anchor_status":1, //主播状态：0, 离线；1，在线
"pk_id":"", //跨房会话ID，跨房PK 时有效
"online_count": 3, //在线用户数
"start_time": 1656315406, //开始直播时间，秒级时间戳
"end_time": 1656315406, //结束直播时间，秒级时间戳
"chat_id": 19903902, //聊天室ID
"push_url": "", //推流地址
"hls_url":"", //hls 拉流URL
"rtmp_url":"", //rtmp 拉流URL
"flv_url":"", //flv 拉流URL
"pv": 1003, //PV
"uv": 934, //UV
"live_status":1 //直播间状态，0，已创建；1，直播中；2，已结束
}
}
# 离开直播
直播间内的用户离开直播间。
## 路径
DELETE /client/live/room/user/{live_id}
路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间ID | live_123
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Body 参数
无。
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 心跳
用户加入直播间后，需要通过心跳，确认自己还在直播间。
用户加入直播间后，每5秒需要发送一个心跳。服务端在连续丢失3个心跳后，会认为用户已经离开直播间。
如果主播心跳丢失，会在直播间内提示主播离线。主播离线10分钟，会关闭直播间。
## 路径
GET /client/live/room/heartbeat/{live_id}
路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间ID | live_123
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Body 参数
无。
## 返回
{
"request_id": "xxxxx",
"code": 0,
"message": "success",
"data": {
"live_id": "live_123",
"live_status": 1
}
}
# 更新直播扩展
更新直播间的扩展信息。
## 路径
PUT /client/live/room/extends
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Body参数
{
"live_id":"live_1", //直播间ID
"extends": {
"age":"18"
}
}
## 返回
{
"request_id": "xxxxx",
"code": 0,
"message": "success"
}
# 房间用户列表
获取直播间内的用户列表。
## 路径
GET /client/live/room/user_list
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Query参数
{
"live_id":"live_123" //直播ID
"page_num": 1, //页码
"page_size": 20 //分页数量
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success", //code 非0 时，错误原因描述
"data": {
"total_count":100, //总数
"page_total": 5, //总页数
"end_page": false, //当前是否最后一页
"list": [
{
"user_id":"user_1", //用户ID
"im_userid":9000990, //用户的的IM 账号ID
"im_username":"", //IM用户名
"nick":"主播1", //昵称
"avatar":"", //用户头像
"extends": { //用户扩展信息
"age":"18"
},
}
]
}
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,493 |
麦位管理 | 低代码 | [低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) >
[服务端API参考](https://developer.qiniu.com/lowcode/api/12008/qlive-server-api-
reference) > [客户端交互接口](https://developer.qiniu.com/lowcode/api/12188/client-
apis) > 麦位管理
# 麦位管理
最近更新时间: 2022-09-07 17:15:57
# 申请上麦
用户在直播间内，请求上麦。请求上麦成功后，返回上麦token，用户使用该token 发布视频语音流。
用户必须先加入直播间。
## 路径
POST /client/mic
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Body参数
{
"live_id":"live_123", //直播间ID
"mic": true, //是否开启麦克风
"camera": true, //是否开启摄像头
"extend":{
"ext-key":"ext-value"
}
}
## 返回结果
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data": {
"rtc_token": "" //返回连麦token，使用该token 完成连麦。
}
}
# 申请下麦
已上麦的用户申请下麦。
## 路径
DELETE /client/mic
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Body参数
{
"live_id":"live_123", //直播间ID
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 房间麦位列表
获取直播间内的麦位列表信息。
## 路径
GET /client/mic/room/list/{live_id}
路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间ID | live_123
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data": [{
"user": {
"user_id":"user_1", //用户ID
"im_userid":9000990, //用户的的IM 账号ID
"im_username":"", //IM用户名
"nick":"主播1", //昵称
"avatar":"", //用户头像
"extends": { //用户扩展信息
"ext-key":"ext-value"
}
},
"mic": true, //是否开启麦克风
"camera": true, //是否开启摄像头
"status": 1, //麦位状态：0, 在线；1，离开；2, 禁用
"extends": { //扩展信息
"ext-key":"ext-value"
}
}]
}
# 更新麦位扩展信息
更新麦位的扩展信息。
## 路径
PUT /client/mic/extension
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Body参数
{
"live_id":"live_123", //直播ID
"extends": { //扩展信息
"ext-key":"ext-value"
}
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 打开/关闭麦克风/摄像头
上麦用户更改自己的推流配置。
可以打开或者关闭麦克风；打开或者关闭摄像头。
## 路径
PUT /client/mic/switch
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Body参数
{
"live_id":"live_123", //直播ID
"user-id":"user_123", //上麦用户ID
"type":"mic", //类型：mic 麦克风；
"status": true //true 打开; false 关闭
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) >
[服务端API参考](https://developer.qiniu.com/lowcode/api/12008/qlive-server-api-
reference) > [客户端交互接口](https://developer.qiniu.com/lowcode/api/12188/client-
apis) > 麦位管理
# 麦位管理
最近更新时间: 2022-09-07 17:15:57
# 申请上麦
用户在直播间内，请求上麦。请求上麦成功后，返回上麦token，用户使用该token 发布视频语音流。
用户必须先加入直播间。
## 路径
POST /client/mic
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Body参数
{
"live_id":"live_123", //直播间ID
"mic": true, //是否开启麦克风
"camera": true, //是否开启摄像头
"extend":{
"ext-key":"ext-value"
}
}
## 返回结果
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data": {
"rtc_token": "" //返回连麦token，使用该token 完成连麦。
}
}
# 申请下麦
已上麦的用户申请下麦。
## 路径
DELETE /client/mic
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Body参数
{
"live_id":"live_123", //直播间ID
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 房间麦位列表
获取直播间内的麦位列表信息。
## 路径
GET /client/mic/room/list/{live_id}
路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间ID | live_123
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data": [{
"user": {
"user_id":"user_1", //用户ID
"im_userid":9000990, //用户的的IM 账号ID
"im_username":"", //IM用户名
"nick":"主播1", //昵称
"avatar":"", //用户头像
"extends": { //用户扩展信息
"ext-key":"ext-value"
}
},
"mic": true, //是否开启麦克风
"camera": true, //是否开启摄像头
"status": 1, //麦位状态：0, 在线；1，离开；2, 禁用
"extends": { //扩展信息
"ext-key":"ext-value"
}
}]
}
# 更新麦位扩展信息
更新麦位的扩展信息。
## 路径
PUT /client/mic/extension
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Body参数
{
"live_id":"live_123", //直播ID
"extends": { //扩展信息
"ext-key":"ext-value"
}
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 打开/关闭麦克风/摄像头
上麦用户更改自己的推流配置。
可以打开或者关闭麦克风；打开或者关闭摄像头。
## 路径
PUT /client/mic/switch
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Body参数
{
"live_id":"live_123", //直播ID
"user-id":"user_123", //上麦用户ID
"type":"mic", //类型：mic 麦克风；
"status": true //true 打开; false 关闭
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,517 |
商品模块接口 | 低代码 | [低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) >
[服务端API参考](https://developer.qiniu.com/lowcode/api/12008/qlive-server-api-
reference) > [客户端交互接口](https://developer.qiniu.com/lowcode/api/12188/client-
apis) > 商品模块接口
# 商品模块接口
最近更新时间: 2022-09-07 17:16:09
直播间商品管理接口。
# 批量导入商品到直播间
只有主播可以导入商品到直播间。
## 路径
POST /client/item/add
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | JWT 鉴权token |
## Body 参数
使用JSON 格式数据，传递商品信息数组。商品信息字段如下：
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间 ID |
items | []Item | 是 | 商品信息 |
Item 的结构如下
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
item_id | string | 是 | 商品 ID |
title | string | 是 | 商品标题 |
tags | string | 否 | 商品标签，多个以 ","分割。 |
thumbnail | string | 否 | 缩略图 url |
link | string | 否 | 商品链接 url |
current_price | string | 是 | 当前价格字符串 | 199元
origin_price | string | 否 | 原始价格字符串 | ￥298
status | int | 是 | 0，下架(用户不可见)；1，上架(用户可见)；2，上架不能购买 |
extends | map[string]string | 否 | 扩展信息，key value 结构 |
举例如下
{
"live_id":"live_1",
"items":[
{
"live_id":"live_1",
"item_id":"item_1",
"title": "精品皮鞋",
"tags": "皮具,一口价",
"thumbnail":"http;//xxx.png",
"link":"http;//xxx.png",
"current_price":"199元",
"origin_price":"298元",
"status":1,
"extends": {
"age":"18"
}
}
]
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 批量删除直播间商品
只有主播可以删除直播间商品。
## 路径
POST /client/item/delete
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | JWT鉴权token |
## Body 参数
使用JSON 格式数据，传递商品信息数组。商品信息字段如下：
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间 ID |
items | []string | 是 | 商品 ID 列表 |
举例如下
{
"live_id":"live_1",
"items":["item_1", "item_2"]
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 批量更新直播间商品状态
只有主播可以更新直播间商品状态。
## 路径
POST /client/item/status
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | JWT鉴权token |
## Body 参数
使用JSON 格式数据，传递商品信息数组。商品信息字段如下：
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间 ID |
items | []ItemStatus | 是 | 商品状态列表 |
ItemStatus 字段定义如下
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
item_id | string | 是 | 商品 ID |
status | int | 是 | 商品状态 |
举例如下
{
"live_id":"live_1",
"items": [
{
"item_id":"item_1",
"status":1
}
]
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 批量调整直播间商品顺序
只有主播可以调整直播间商品顺序。
## 路径
POST /client/item/order
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | JWT 鉴权token |
## Body 参数
使用JSON 格式数据，传递商品信息数组。商品信息字段如下：
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间 ID |
items | []ItemOrder | 是 | 商品状态列表 |
ItemOrder 字段定义如下
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
item_id | string | 是 | 商品 ID |
order | int | 是 | 调整后商品序号 |
举例如下
{
"live_id":"live_1",
"items": [
{
"item_id":"item_1",
"order":1
}
]
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 单个调整直播间商品顺序
只有主播可以调整直播间商品顺序。
## 路径
POST /client/item/order/single
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | JWT 鉴权token |
## Body 参数
使用JSON 格式数据，传递商品信息数组。商品信息字段如下：
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间 ID |
item_id | string | 是 | 商品 ID |
from | int | 是 | 调整前序号 |
to | int | 是 | 调整后序号 |
举例如下
{
"live_id":"live_1",
"item_id":"item_1",
"from":1,
"to":2
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 更新商品信息
## 路径
PUT /client/item/{liveId}/{itemId}
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | JWT 鉴权token |
## 路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
liveId | string | 是 | 直播间 ID |
itemId | string | 是 | 商品ID |
## Body 参数
使用JSON 格式数据，传递商品信息。商品信息字段如下：
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
title | string | 否 | 商品标题 |
tags | string | 否 | 商品标签，多个以 ","分割。 |
thumbnail | string | 否 | 缩略图 url |
link | string | 否 | 商品链接 url |
current_price | string | 否 | 当前价格字符串 | 199元
origin_price | string | 否 | 原始价格字符串 | ￥298
extends | map[string]string | 否 | 扩展信息，key value 结构 |
以上字段未填写则保持原来的信息不更新。
举例如下
{
"title": "精品皮鞋",
"tags": "皮具,一口价",
"thumbnail":"http;//xxx.png",
"link":"http;//xxx.png",
"current_price":"199元",
"origin_price":"298元",
"status":1,
"extends": {
"age":"18"
}
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 更新商品扩展信息
## 路径
PUT /client/item/{liveId}/{itemId}/extends
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | JWT 鉴权token | Qiniu AK:sign
## 路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
liveId | string | 是 | 直播间 ID |
itemId | string | 是 | 商品ID |
## Body 参数
使用JSON 格式数据，传递商品扩展信息。支持任意自定义的json 字段名，数据类型为字符串即可。
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
自定义 | string | 是 | 参数任意自定义，如：key1 |
只更新请求携带的扩展信息。
举例如下
{
"age": "18",
"key1": "value1",
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 查看直播间商品
## 路径
GET /client/item/{live_id}
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | JWT 鉴权token |
## 路径参数
使用JSON 格式数据，传递商品信息数组。商品信息字段如下：
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间 ID |
举例如下
curl "https://live-api.qiniu.com/client/item/live_1"
## 返回
* 返回结果，按照order 倒序排序。
* 不是房间的主播，无法看到status 为 0 的商品。
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success", //code 非0 时，错误原因描述
"data":[
{
"live_id":"live_1",
"item_id":"item_1",
"order":1,
"title": "精品皮鞋",
"tags": "皮具,一口价",
"thumbnail":"http;//xxx.png",
"link":"http;//xxx.png",
"current_price":"199元",
"origin_price":"298元",
"status":1,
"extends": {
"age":"18"
}
}
]
}
# 设置直播间讲解商品
只有主播可以设置。
## 路径
POST /client/item/demonstrate/{live_id}/{item_id}
## 请求头
参数 | 说明 | 举例
---|---|---
Authorizatio | JWT 鉴权token |
## 路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间 ID |
item_id | string | 是 | 商品 ID |
举例如下
curl -XPOST https://live-api.qiniu.com/client/item/demonstrate/live_1/item_1
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 取消直播间讲解商品
只有主播可以取消。
## 路径
DELETE /client/item/demonstrate/{live_id}
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | JWT 鉴权token |
## 路径参数参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间 ID |
举例如下
curl -XDELETE https://live-api.qiniu.com/client/item/demonstrate/live_1
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 查看直播间讲解商品
查看直播间当前讲解的商品信息。
## 路径
GET /client/item/demonstrate/{live_id}
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | JWT 鉴权token |
## 路径参数参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间 ID |
举例如下
curl https://live-api.qiniu.com/client/item/demonstrate/live_1
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data":
{
"live_id":"live_1",
"item_id":"item_1",
"title": "精品皮鞋",
"tags": "皮具,一口价",
"thumbnail":"http;//xxx.png",
"link":"http;//xxx.png",
"current_price":"199元",
"origin_price":"298元",
"status":1,
"extends": {
"age":"18"
}
}
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) >
[服务端API参考](https://developer.qiniu.com/lowcode/api/12008/qlive-server-api-
reference) > [客户端交互接口](https://developer.qiniu.com/lowcode/api/12188/client-
apis) > 商品模块接口
# 商品模块接口
最近更新时间: 2022-09-07 17:16:09
直播间商品管理接口。
# 批量导入商品到直播间
只有主播可以导入商品到直播间。
## 路径
POST /client/item/add
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | JWT 鉴权token |
## Body 参数
使用JSON 格式数据，传递商品信息数组。商品信息字段如下：
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间 ID |
items | []Item | 是 | 商品信息 |
Item 的结构如下
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
item_id | string | 是 | 商品 ID |
title | string | 是 | 商品标题 |
tags | string | 否 | 商品标签，多个以 ","分割。 |
thumbnail | string | 否 | 缩略图 url |
link | string | 否 | 商品链接 url |
current_price | string | 是 | 当前价格字符串 | 199元
origin_price | string | 否 | 原始价格字符串 | ￥298
status | int | 是 | 0，下架(用户不可见)；1，上架(用户可见)；2，上架不能购买 |
extends | map[string]string | 否 | 扩展信息，key value 结构 |
举例如下
{
"live_id":"live_1",
"items":[
{
"live_id":"live_1",
"item_id":"item_1",
"title": "精品皮鞋",
"tags": "皮具,一口价",
"thumbnail":"http;//xxx.png",
"link":"http;//xxx.png",
"current_price":"199元",
"origin_price":"298元",
"status":1,
"extends": {
"age":"18"
}
}
]
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 批量删除直播间商品
只有主播可以删除直播间商品。
## 路径
POST /client/item/delete
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | JWT鉴权token |
## Body 参数
使用JSON 格式数据，传递商品信息数组。商品信息字段如下：
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间 ID |
items | []string | 是 | 商品 ID 列表 |
举例如下
{
"live_id":"live_1",
"items":["item_1", "item_2"]
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 批量更新直播间商品状态
只有主播可以更新直播间商品状态。
## 路径
POST /client/item/status
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | JWT鉴权token |
## Body 参数
使用JSON 格式数据，传递商品信息数组。商品信息字段如下：
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间 ID |
items | []ItemStatus | 是 | 商品状态列表 |
ItemStatus 字段定义如下
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
item_id | string | 是 | 商品 ID |
status | int | 是 | 商品状态 |
举例如下
{
"live_id":"live_1",
"items": [
{
"item_id":"item_1",
"status":1
}
]
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 批量调整直播间商品顺序
只有主播可以调整直播间商品顺序。
## 路径
POST /client/item/order
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | JWT 鉴权token |
## Body 参数
使用JSON 格式数据，传递商品信息数组。商品信息字段如下：
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间 ID |
items | []ItemOrder | 是 | 商品状态列表 |
ItemOrder 字段定义如下
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
item_id | string | 是 | 商品 ID |
order | int | 是 | 调整后商品序号 |
举例如下
{
"live_id":"live_1",
"items": [
{
"item_id":"item_1",
"order":1
}
]
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 单个调整直播间商品顺序
只有主播可以调整直播间商品顺序。
## 路径
POST /client/item/order/single
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | JWT 鉴权token |
## Body 参数
使用JSON 格式数据，传递商品信息数组。商品信息字段如下：
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间 ID |
item_id | string | 是 | 商品 ID |
from | int | 是 | 调整前序号 |
to | int | 是 | 调整后序号 |
举例如下
{
"live_id":"live_1",
"item_id":"item_1",
"from":1,
"to":2
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 更新商品信息
## 路径
PUT /client/item/{liveId}/{itemId}
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | JWT 鉴权token |
## 路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
liveId | string | 是 | 直播间 ID |
itemId | string | 是 | 商品ID |
## Body 参数
使用JSON 格式数据，传递商品信息。商品信息字段如下：
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
title | string | 否 | 商品标题 |
tags | string | 否 | 商品标签，多个以 ","分割。 |
thumbnail | string | 否 | 缩略图 url |
link | string | 否 | 商品链接 url |
current_price | string | 否 | 当前价格字符串 | 199元
origin_price | string | 否 | 原始价格字符串 | ￥298
extends | map[string]string | 否 | 扩展信息，key value 结构 |
以上字段未填写则保持原来的信息不更新。
举例如下
{
"title": "精品皮鞋",
"tags": "皮具,一口价",
"thumbnail":"http;//xxx.png",
"link":"http;//xxx.png",
"current_price":"199元",
"origin_price":"298元",
"status":1,
"extends": {
"age":"18"
}
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 更新商品扩展信息
## 路径
PUT /client/item/{liveId}/{itemId}/extends
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | JWT 鉴权token | Qiniu AK:sign
## 路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
liveId | string | 是 | 直播间 ID |
itemId | string | 是 | 商品ID |
## Body 参数
使用JSON 格式数据，传递商品扩展信息。支持任意自定义的json 字段名，数据类型为字符串即可。
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
自定义 | string | 是 | 参数任意自定义，如：key1 |
只更新请求携带的扩展信息。
举例如下
{
"age": "18",
"key1": "value1",
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 查看直播间商品
## 路径
GET /client/item/{live_id}
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | JWT 鉴权token |
## 路径参数
使用JSON 格式数据，传递商品信息数组。商品信息字段如下：
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间 ID |
举例如下
curl "https://live-api.qiniu.com/client/item/live_1"
## 返回
* 返回结果，按照order 倒序排序。
* 不是房间的主播，无法看到status 为 0 的商品。
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success", //code 非0 时，错误原因描述
"data":[
{
"live_id":"live_1",
"item_id":"item_1",
"order":1,
"title": "精品皮鞋",
"tags": "皮具,一口价",
"thumbnail":"http;//xxx.png",
"link":"http;//xxx.png",
"current_price":"199元",
"origin_price":"298元",
"status":1,
"extends": {
"age":"18"
}
}
]
}
# 设置直播间讲解商品
只有主播可以设置。
## 路径
POST /client/item/demonstrate/{live_id}/{item_id}
## 请求头
参数 | 说明 | 举例
---|---|---
Authorizatio | JWT 鉴权token |
## 路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间 ID |
item_id | string | 是 | 商品 ID |
举例如下
curl -XPOST https://live-api.qiniu.com/client/item/demonstrate/live_1/item_1
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 取消直播间讲解商品
只有主播可以取消。
## 路径
DELETE /client/item/demonstrate/{live_id}
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | JWT 鉴权token |
## 路径参数参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间 ID |
举例如下
curl -XDELETE https://live-api.qiniu.com/client/item/demonstrate/live_1
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 查看直播间讲解商品
查看直播间当前讲解的商品信息。
## 路径
GET /client/item/demonstrate/{live_id}
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | JWT 鉴权token |
## 路径参数参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间 ID |
举例如下
curl https://live-api.qiniu.com/client/item/demonstrate/live_1
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data":
{
"live_id":"live_1",
"item_id":"item_1",
"title": "精品皮鞋",
"tags": "皮具,一口价",
"thumbnail":"http;//xxx.png",
"link":"http;//xxx.png",
"current_price":"199元",
"origin_price":"298元",
"status":1,
"extends": {
"age":"18"
}
}
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,523 |
跨房连麦 | 低代码 | [低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) >
[服务端API参考](https://developer.qiniu.com/lowcode/api/12008/qlive-server-api-
reference) > [客户端交互接口](https://developer.qiniu.com/lowcode/api/12188/client-
apis) > 跨房连麦
# 跨房连麦
最近更新时间: 2022-09-07 17:16:18
# 开始跨房连麦
开始跨房连麦。
只有直播间的主播，才能发起跨房连麦请求。
## 路径
POST /client/relay/start
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Body参数
{
"init_room_id":"live_1", //发起方的直播ID
"recv_room_id":"live_2", //接收方的直播ID
"recv_user_id":"user_2" //接收方的主播ID
}
## 返回结果
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data": {
"relay_id": "relay_id_1", //跨房PK 会话ID
"relay_status": 1, //跨房状态：0, 等待接收方同意; 1，接收方已同意；2，发起方已完成跨房；3，接收方已完成跨房；4，两方都完成跨房；5，接收方拒绝；6，跨房已结束
"relay_token": "" //跨房token
}
}
# 获取跨房会话信息
查询跨房连麦的会话信息。
## 路径
GET /client/relay/{relay_id}
路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
relay_id | string | 是 | 跨房会话ID | relay_123
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## 返回结果
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data": {
"sid": "relay_id_1", //跨房PK 会话ID
"init_user_id":"user_1", //发起方的主播ID
"init_room_id":"live_1", //发起方的直播ID
"recv_room_id":"live_2", //接收方的直播ID
"recv_user_id":"user_2" //接收方的主播ID
"status": 1, //跨房状态：0, 等待接收方同意; 1，接收方已同意；2，发起方已完成跨房；3，接收方已完成跨房；4，两方都完成跨房；5，接收方拒绝；6，跨房已结束
"start_at":"2022-08-01 15:00:00", //跨房开始时间
"stop_at":"2022-08-01 16:00:00", //跨房结束时间
"extends": {
"ext-key":"ext-value"
}
}
}
# 获取跨房会话Token
获取跨房连麦的会话Token，使用该token 可以向目的房间进行推流。
## 路径
GET /client/relay/{relay_id}/token
路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
relay_id | string | 是 | 跨房会话ID | relay_123
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## 返回结果
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data": {
"relay_id": "relay_id_1", //跨房PK 会话ID
"relay_status": 1, //跨房状态：0, 等待接收方同意; 1，接收方已同意；2，发起方已完成跨房；3，接收方已完成跨房；4，两方都完成跨房；5，接收方拒绝；6，跨房已结束
"relay_token": "" //跨房token
}
}
# 停止跨房
停止跨房连麦。
## 路径
POST /client/relay/{relay_id}/stop
路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
relay_id | string | 是 | 跨房会话ID | relay_123
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## 返回结果
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 上报跨房完成
本地推流到跨房的目的房间后，上报状态完成。更新跨房会话的状态。
## 路径
POST /client/relay/{relay_id}/started
路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
relay_id | string | 是 | 跨房会话ID | relay_123
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## 返回结果
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 更新跨房扩展信息
更新跨房连麦会话的扩展信息。
## 路径
POST /client/relay/{relay_id}/extends
路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
relay_id | string | 是 | 跨房会话ID | relay_123
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Body 参数
{
"extends": {
"ext-key":"ext-value"
}
}
## 返回结果
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) >
[服务端API参考](https://developer.qiniu.com/lowcode/api/12008/qlive-server-api-
reference) > [客户端交互接口](https://developer.qiniu.com/lowcode/api/12188/client-
apis) > 跨房连麦
# 跨房连麦
最近更新时间: 2022-09-07 17:16:18
# 开始跨房连麦
开始跨房连麦。
只有直播间的主播，才能发起跨房连麦请求。
## 路径
POST /client/relay/start
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Body参数
{
"init_room_id":"live_1", //发起方的直播ID
"recv_room_id":"live_2", //接收方的直播ID
"recv_user_id":"user_2" //接收方的主播ID
}
## 返回结果
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data": {
"relay_id": "relay_id_1", //跨房PK 会话ID
"relay_status": 1, //跨房状态：0, 等待接收方同意; 1，接收方已同意；2，发起方已完成跨房；3，接收方已完成跨房；4，两方都完成跨房；5，接收方拒绝；6，跨房已结束
"relay_token": "" //跨房token
}
}
# 获取跨房会话信息
查询跨房连麦的会话信息。
## 路径
GET /client/relay/{relay_id}
路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
relay_id | string | 是 | 跨房会话ID | relay_123
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## 返回结果
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data": {
"sid": "relay_id_1", //跨房PK 会话ID
"init_user_id":"user_1", //发起方的主播ID
"init_room_id":"live_1", //发起方的直播ID
"recv_room_id":"live_2", //接收方的直播ID
"recv_user_id":"user_2" //接收方的主播ID
"status": 1, //跨房状态：0, 等待接收方同意; 1，接收方已同意；2，发起方已完成跨房；3，接收方已完成跨房；4，两方都完成跨房；5，接收方拒绝；6，跨房已结束
"start_at":"2022-08-01 15:00:00", //跨房开始时间
"stop_at":"2022-08-01 16:00:00", //跨房结束时间
"extends": {
"ext-key":"ext-value"
}
}
}
# 获取跨房会话Token
获取跨房连麦的会话Token，使用该token 可以向目的房间进行推流。
## 路径
GET /client/relay/{relay_id}/token
路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
relay_id | string | 是 | 跨房会话ID | relay_123
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## 返回结果
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data": {
"relay_id": "relay_id_1", //跨房PK 会话ID
"relay_status": 1, //跨房状态：0, 等待接收方同意; 1，接收方已同意；2，发起方已完成跨房；3，接收方已完成跨房；4，两方都完成跨房；5，接收方拒绝；6，跨房已结束
"relay_token": "" //跨房token
}
}
# 停止跨房
停止跨房连麦。
## 路径
POST /client/relay/{relay_id}/stop
路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
relay_id | string | 是 | 跨房会话ID | relay_123
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## 返回结果
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 上报跨房完成
本地推流到跨房的目的房间后，上报状态完成。更新跨房会话的状态。
## 路径
POST /client/relay/{relay_id}/started
路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
relay_id | string | 是 | 跨房会话ID | relay_123
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## 返回结果
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 更新跨房扩展信息
更新跨房连麦会话的扩展信息。
## 路径
POST /client/relay/{relay_id}/extends
路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
relay_id | string | 是 | 跨房会话ID | relay_123
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Body 参数
{
"extends": {
"ext-key":"ext-value"
}
}
## 返回结果
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,538 |
管理员交互接口 | 低代码 | [低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) >
[服务端API参考](https://developer.qiniu.com/lowcode/api/12008/qlive-server-api-
reference) > 管理员交互接口
# 管理员交互接口
最近更新时间: 2022-12-15 17:33:34
# 管理员登录
## 路径
GET /manager/login
## Query 参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
user_name | string | 是 | 用户名 |
password | string | 是 | 密码 |
## 返回
该接口正确处理请求时返回如下 JSON 数据
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success", //code 非0 时，错误原因描述
"data": {
"access_token":"xxx", //客户端访问token
"expires_at":1655882609 //过期时间，秒级时间戳
}
}
# 服务端获取管理员token
互动直播客户端，需要访问三鉴服务等，需要使用jwt 鉴权token。
该接口用于颁发管理员访问token。
## 路径
GET /server/auth/admin/token
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | AK/SK 鉴权token | Qiniu AK:sign
## Query 参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
app_id | string | 是 | 互动直播的应用ID | live_app_1
user_id | string | 是 | 客户端用户ID，唯一标识一个用户 | user_1
device_id | string | 否 | 客户端设备ID | device_1
expires_at | int64 | 否 | token 过期时间，秒级时间戳。默认7 天过期 | 1655882609
## 返回
该接口正确处理请求时返回如下 JSON 数据
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success", //code 非0 时，错误原因描述
"data": {
"access_token":"xxx", //客户端访问token
"expires_at":1655882609 //过期时间，秒级时间戳
}
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) >
[服务端API参考](https://developer.qiniu.com/lowcode/api/12008/qlive-server-api-
reference) > 管理员交互接口
# 管理员交互接口
最近更新时间: 2022-12-15 17:33:34
# 管理员登录
## 路径
GET /manager/login
## Query 参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
user_name | string | 是 | 用户名 |
password | string | 是 | 密码 |
## 返回
该接口正确处理请求时返回如下 JSON 数据
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success", //code 非0 时，错误原因描述
"data": {
"access_token":"xxx", //客户端访问token
"expires_at":1655882609 //过期时间，秒级时间戳
}
}
# 服务端获取管理员token
互动直播客户端，需要访问三鉴服务等，需要使用jwt 鉴权token。
该接口用于颁发管理员访问token。
## 路径
GET /server/auth/admin/token
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | AK/SK 鉴权token | Qiniu AK:sign
## Query 参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
app_id | string | 是 | 互动直播的应用ID | live_app_1
user_id | string | 是 | 客户端用户ID，唯一标识一个用户 | user_1
device_id | string | 否 | 客户端设备ID | device_1
expires_at | int64 | 否 | token 过期时间，秒级时间戳。默认7 天过期 | 1655882609
## 返回
该接口正确处理请求时返回如下 JSON 数据
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success", //code 非0 时，错误原因描述
"data": {
"access_token":"xxx", //客户端访问token
"expires_at":1655882609 //过期时间，秒级时间戳
}
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,545 |
三鉴模块 | 低代码 | [低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) >
[服务端API参考](https://developer.qiniu.com/lowcode/api/12008/qlive-server-api-
reference) > [管理员交互接口](https://developer.qiniu.com/lowcode/api/12363/qlive-
admin-api-token) > 三鉴模块
# 三鉴模块
最近更新时间: 2023-08-10 10:50:37
# 修改审核设置
修改审核设置信息。
## 路径
POST /admin/censor/config
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | JWT 鉴权token(管理员） |
## Body 参数
使用JSON 格式数据，传递商品信息数组。商品信息字段如下：
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
enable | bool | 是 | 是否开启鉴定 | true：开启 false：不开启
pulp | bool | 是 | 是否开启涉黄 |
terror | bool | 是 | 是否开启暴恐 |
politician | bool | 是 | 是否开启敏感人物 |
ads | bool | 是 | 是否开启广告 |
interval | int | 是 | 截帧时长，单位秒 |
举例如下
{
"enable": true,
"interval": 20,
"pulp": true,
"terror": true,
"politician":true,
"ads":true
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data": {
"enable": true,
"pulp": true,
"terror": true,
"politician": true,
"ads": true,
"interval": 20
}
}
# 获取审核设置
获取审核设置信息
##路径
GET /admin/censor/config
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | JWT 鉴权token(管理员） |
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data": {
"enable": true,
"pulp": true,
"terror": true,
"politician": true,
"ads": true,
"interval": 20
}
}
# 查看待审核图片/已审核图片详情
## 路径
GET /admin/censor/record
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | JWT 鉴权token(管理员） |
## Query 参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
is_review | string | 否 | 图片是否审核 | 0：没审核 1：审核 2：默认：全部
page_num | string | 否 | 第几页 | 1
page_size | string | 否 | 每页大小 | 10
live_id | string | 否 | 直播间id |
## 返回
该接口正确处理请求时返回如下 JSON 数据
{
"request_id": "8lemqfC2LK3w1xIX",
"code": 200,
"message": "success",
"data": {
"total_count": 955,
"page_total": 319,
"end_page": false,
"list": [
{
"ID": 1079,
"url": "qiniu:///iu-cbe/img/7xrx000000kWAJ4000000coQU=/2022-09-06-06-45-15_1662446715.jpg",
"job_id": "0000008200018704300000000b6c4c63",
"created_at": 1662466006,
"suggestion": "pass",
"pulp": "pass",
"terror": "pass",
"politician": "pass",
"ads": "pass",
"live_id": "1500000078429000000",
"is_review": 0,
"review_answer": 0,
"review_user_id": "0",
"review_time": null
},
{
"ID": 1076,
"url": "qiniu:///iu-cbe/img/-0mFoIGNaT_I0000000000EMzU=/2022-09-06-06-45-13_1662446713.jpg",
"job_id": "6316e882000187043001d2562000000",
"created_at": 1662465944,
"suggestion": "pass",
"pulp": "pass",
"terror": "pass",
"politician": "pass",
"ads": "pass",
"live_id": "0000004678429000000",
"is_review": 0,
"review_answer": 0,
"review_user_id": "0",
"review_time": null
}
]
}
}
# 查看待审核直播间/已审核直播间
## 路径
GET /admin/censor/live
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | JWT 鉴权token(管理员） |
## Query 参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
audit | string | 否 | 图片是否审核 | 0：全部直播间（默认 1：未审核
page_num | string | 否 | 第几页 | 1
page_size | string | 否 | 每页大小 | 10
## 返回
该接口正确处理请求时返回如下 JSON 数据
{
"request_id": "8lemqZh5gZEJ0BIX",
"code": 200,
"message": "success",
"data": {
"total_count": 5,
"page_total": 2,
"end_page": false,
"list": [
{
"live_id": "1559000000835264",
"title": "XXX直播",
"anchor_id": "test_user_222",
"live_status": 2,
"count": 960,
"time": 1662453912
},
{
"live_id": "155503300000069472",
"title": "XXX直播",
"anchor_id": "test_user_222",
"live_status": 2,
"count": 11,
"time": 1662540372
}
]
}
}
# 审核图片
## 路径
POST /admin/censor/audit
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | JWT 鉴权token(管理员） |
## Body 参数
使用JSON 格式数据，传递商品信息数组。商品信息字段如下：
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间id |
review_answer | int | 是 | 审核结果 | 1 通过；2 违规
image_list | []int | 是 | 待审核图片的id |
notify | boolean | 否 | 是否发送通知 |
举例如下
{
"live_id": "1555105000000984",
"image_list": [1077,1078,1070],
"review_answer": 2
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 强制结束直播
管理员强制关闭直播间。
## 路径
POST /admin/censor/stoplive/{live_id}
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | JWT 鉴权token |
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) >
[服务端API参考](https://developer.qiniu.com/lowcode/api/12008/qlive-server-api-
reference) > [管理员交互接口](https://developer.qiniu.com/lowcode/api/12363/qlive-
admin-api-token) > 三鉴模块
# 三鉴模块
最近更新时间: 2023-08-10 10:50:37
# 修改审核设置
修改审核设置信息。
## 路径
POST /admin/censor/config
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | JWT 鉴权token(管理员） |
## Body 参数
使用JSON 格式数据，传递商品信息数组。商品信息字段如下：
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
enable | bool | 是 | 是否开启鉴定 | true：开启 false：不开启
pulp | bool | 是 | 是否开启涉黄 |
terror | bool | 是 | 是否开启暴恐 |
politician | bool | 是 | 是否开启敏感人物 |
ads | bool | 是 | 是否开启广告 |
interval | int | 是 | 截帧时长，单位秒 |
举例如下
{
"enable": true,
"interval": 20,
"pulp": true,
"terror": true,
"politician":true,
"ads":true
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data": {
"enable": true,
"pulp": true,
"terror": true,
"politician": true,
"ads": true,
"interval": 20
}
}
# 获取审核设置
获取审核设置信息
##路径
GET /admin/censor/config
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | JWT 鉴权token(管理员） |
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data": {
"enable": true,
"pulp": true,
"terror": true,
"politician": true,
"ads": true,
"interval": 20
}
}
# 查看待审核图片/已审核图片详情
## 路径
GET /admin/censor/record
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | JWT 鉴权token(管理员） |
## Query 参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
is_review | string | 否 | 图片是否审核 | 0：没审核 1：审核 2：默认：全部
page_num | string | 否 | 第几页 | 1
page_size | string | 否 | 每页大小 | 10
live_id | string | 否 | 直播间id |
## 返回
该接口正确处理请求时返回如下 JSON 数据
{
"request_id": "8lemqfC2LK3w1xIX",
"code": 200,
"message": "success",
"data": {
"total_count": 955,
"page_total": 319,
"end_page": false,
"list": [
{
"ID": 1079,
"url": "qiniu:///iu-cbe/img/7xrx000000kWAJ4000000coQU=/2022-09-06-06-45-15_1662446715.jpg",
"job_id": "0000008200018704300000000b6c4c63",
"created_at": 1662466006,
"suggestion": "pass",
"pulp": "pass",
"terror": "pass",
"politician": "pass",
"ads": "pass",
"live_id": "1500000078429000000",
"is_review": 0,
"review_answer": 0,
"review_user_id": "0",
"review_time": null
},
{
"ID": 1076,
"url": "qiniu:///iu-cbe/img/-0mFoIGNaT_I0000000000EMzU=/2022-09-06-06-45-13_1662446713.jpg",
"job_id": "6316e882000187043001d2562000000",
"created_at": 1662465944,
"suggestion": "pass",
"pulp": "pass",
"terror": "pass",
"politician": "pass",
"ads": "pass",
"live_id": "0000004678429000000",
"is_review": 0,
"review_answer": 0,
"review_user_id": "0",
"review_time": null
}
]
}
}
# 查看待审核直播间/已审核直播间
## 路径
GET /admin/censor/live
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | JWT 鉴权token(管理员） |
## Query 参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
audit | string | 否 | 图片是否审核 | 0：全部直播间（默认 1：未审核
page_num | string | 否 | 第几页 | 1
page_size | string | 否 | 每页大小 | 10
## 返回
该接口正确处理请求时返回如下 JSON 数据
{
"request_id": "8lemqZh5gZEJ0BIX",
"code": 200,
"message": "success",
"data": {
"total_count": 5,
"page_total": 2,
"end_page": false,
"list": [
{
"live_id": "1559000000835264",
"title": "XXX直播",
"anchor_id": "test_user_222",
"live_status": 2,
"count": 960,
"time": 1662453912
},
{
"live_id": "155503300000069472",
"title": "XXX直播",
"anchor_id": "test_user_222",
"live_status": 2,
"count": 11,
"time": 1662540372
}
]
}
}
# 审核图片
## 路径
POST /admin/censor/audit
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | JWT 鉴权token(管理员） |
## Body 参数
使用JSON 格式数据，传递商品信息数组。商品信息字段如下：
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间id |
review_answer | int | 是 | 审核结果 | 1 通过；2 违规
image_list | []int | 是 | 待审核图片的id |
notify | boolean | 否 | 是否发送通知 |
举例如下
{
"live_id": "1555105000000984",
"image_list": [1077,1078,1070],
"review_answer": 2
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 强制结束直播
管理员强制关闭直播间。
## 路径
POST /admin/censor/stoplive/{live_id}
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | JWT 鉴权token |
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,549 |
礼物配置设计接口 | 低代码 | [低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) >
[服务端API参考](https://developer.qiniu.com/lowcode/api/12008/qlive-server-api-
reference) > [管理员交互接口](https://developer.qiniu.com/lowcode/api/12363/qlive-
admin-api-token) > 礼物配置设计接口
# 礼物配置设计接口
最近更新时间: 2022-12-15 17:33:21
# 保存礼物配置
保存礼物配置。
对于原来没有的礼物类型，新增配置。
对于相同的配置类型，覆盖原有的配置。
## 路径
POST /admin/gift/config
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Body 参数
[
{
"type": 1, //礼物类型
"name": "红包", //礼物名称
"amount": 5, //礼物金额，0 表示自定义金额,
"img": "", //礼物图片,
"animation_type":0, //动态效果类型,
"animation_img":"", //动态效果图片,
"order": 0 //排序，从小到大排序，相同order 根据创建时间排序',
}
]
## 返回
该接口正确处理请求时返回如下 JSON 数据
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 删除礼物配置
删除指定的礼物配置。
## 路径
DELETE /admin/gift/config/{gift_id}
路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
gift_id | integer | 是 | 礼物id | 3
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Body 参数
无。
## 返回
该接口正确处理请求时返回如下 JSON 数据
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 查看礼物配置
查看所有的礼物配置。
## 路径
GET /admin/gift/config/{type}
路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
type | int | 是 | 类型 ID，type==-1时表示全部类型 |
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Body 参数
无。
## 返回
该接口正确处理请求时返回如下 JSON 数据
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data": [
{
"type": 1, //礼物类型
"gift_id":3, //礼物id
"name": "红包", //礼物名称
"amount": 5, //礼物金额，0 表示自定义金额,
"img": "", //礼物图片,
"animation_type":0, //动态效果类型,
"animation_img":"", //动态效果图片,
"order": 0, //排序，从小到大排序，相同order 根据创建时间排序',
"created_at":"2022-09-15 13:00:00", //创建时间
"updated_at":"2022-09-20 15:00:00" //更新时间
}
]
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) >
[服务端API参考](https://developer.qiniu.com/lowcode/api/12008/qlive-server-api-
reference) > [管理员交互接口](https://developer.qiniu.com/lowcode/api/12363/qlive-
admin-api-token) > 礼物配置设计接口
# 礼物配置设计接口
最近更新时间: 2022-12-15 17:33:21
# 保存礼物配置
保存礼物配置。
对于原来没有的礼物类型，新增配置。
对于相同的配置类型，覆盖原有的配置。
## 路径
POST /admin/gift/config
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Body 参数
[
{
"type": 1, //礼物类型
"name": "红包", //礼物名称
"amount": 5, //礼物金额，0 表示自定义金额,
"img": "", //礼物图片,
"animation_type":0, //动态效果类型,
"animation_img":"", //动态效果图片,
"order": 0 //排序，从小到大排序，相同order 根据创建时间排序',
}
]
## 返回
该接口正确处理请求时返回如下 JSON 数据
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 删除礼物配置
删除指定的礼物配置。
## 路径
DELETE /admin/gift/config/{gift_id}
路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
gift_id | integer | 是 | 礼物id | 3
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Body 参数
无。
## 返回
该接口正确处理请求时返回如下 JSON 数据
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 查看礼物配置
查看所有的礼物配置。
## 路径
GET /admin/gift/config/{type}
路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
type | int | 是 | 类型 ID，type==-1时表示全部类型 |
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Body 参数
无。
## 返回
该接口正确处理请求时返回如下 JSON 数据
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data": [
{
"type": 1, //礼物类型
"gift_id":3, //礼物id
"name": "红包", //礼物名称
"amount": 5, //礼物金额，0 表示自定义金额,
"img": "", //礼物图片,
"animation_type":0, //动态效果类型,
"animation_img":"", //动态效果图片,
"order": 0, //排序，从小到大排序，相同order 根据创建时间排序',
"created_at":"2022-09-15 13:00:00", //创建时间
"updated_at":"2022-09-20 15:00:00" //更新时间
}
]
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,558 |
礼物模块接口 | 低代码 | [低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) >
[服务端API参考](https://developer.qiniu.com/lowcode/api/12008/qlive-server-api-
reference) > 礼物模块接口
# 礼物模块接口
最近更新时间: 2022-12-15 17:33:14
# 保存礼物配置
保存礼物配置。
对于原来没有的礼物类型，新增配置。
对于相同的配置类型，覆盖原有的配置。
## 路径
POST /server/gift/config
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Body 参数
[
{
"type": 1, //礼物类型
"name": "红包", //礼物名称
"amount": 5, //礼物金额，0 表示自定义金额,
"img": "", //礼物图片,
"animation_type":0, //动态效果类型,
"animation_img":"", //动态效果图片,
"order": 0 //排序，从小到大排序，相同order 根据创建时间排序',
}
]
## 返回
该接口正确处理请求时返回如下 JSON 数据
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 删除礼物配置
删除指定的礼物配置。
## 路径
DELETE /server/gift/config/{gift_id}
路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
gift_id | integer | 是 | 礼物id | 3
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Body 参数
无。
## 返回
该接口正确处理请求时返回如下 JSON 数据
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 查看礼物配置
查看所有的礼物配置。
## 路径
GET /server/gift/config/{type}
路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
type | int | 是 | 类型 ID，type==-1时表示全部类型 |
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Body 参数
无。
## 返回
该接口正确处理请求时返回如下 JSON 数据
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data": [
{
"type": 1, //礼物类型
"gift_id":3, //礼物id
"name": "红包", //礼物名称
"amount": 5, //礼物金额，0 表示自定义金额,
"img": "", //礼物图片,
"animation_type":0, //动态效果类型,
"animation_img":"", //动态效果图片,
"order": 0, //排序，从小到大排序，相同order 根据创建时间排序',
"created_at":"2022-09-15 13:00:00", //创建时间
"updated_at":"2022-09-20 15:00:00" //更新时间
}
]
}
# 查看直播间礼物列表
查看直播间的礼物记录。只有主播才能查看。
## 路径
GET /server/gift/list/user/{live_id}
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
liveId | string | 是 | 直播间 ID |
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Query 参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
page_num | integer | 否 | 页码 |
page_size | integer | 否 | 分页大小 |
## 返回
该接口正确处理请求时返回如下 JSON 数据
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data":{
"total_count":100, //总数
"page_total": 5, //总页数
"end_page": false, //当前是否最后一页
"list":[
{
"biz_id":"", //交易ID，唯一标识一次礼物发送，业务方生成
"user_id":"", //发送礼物的用户ID
"live_id":""// 直播间ID
"type":1, //礼物类型，用户在礼物配置接口配置
"gift_id":1, //礼物id，用户在礼物配置接口配置
"amount":99, //礼物金额
"created_at":"2022-09-01 00:00:00", //发送时间
}
]
}
}
# 查看主播礼物列表
查看直播间的礼物记录。只有主播才能查看。
## 路径
GET /server/gift/list/anchor/{anchor_id}
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Query 参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
page_num | integer | 否 | 页码 |
page_size | integer | 否 | 分页大小 |
## 返回
该接口正确处理请求时返回如下 JSON 数据
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data":{
"total_count":100, //总数
"page_total": 5, //总页数
"end_page": false, //当前是否最后一页
"list":[
{
"biz_id":"", //交易ID，唯一标识一次礼物发送，业务方生成
"user_id":"", //发送礼物的用户ID
"live_id":""// 直播间ID
"type":1, //礼物类型，用户在礼物配置接口配置
"gift_id":1, //礼物id，用户在礼物配置接口配置
"amount":99, //礼物金额
"created_at":"2022-09-01 00:00:00", //发送时间
}
]
}
}
# 查看用户打赏礼物列表
查看直播间的礼物记录。
## 路径
GET /server/gift/list/user/{user_id}
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Query 参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
page_num | integer | 否 | 页码 |
page_size | integer | 否 | 分页大小 |
## 返回
该接口正确处理请求时返回如下 JSON 数据
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data":{
"total_count":100, //总数
"page_total": 5, //总页数
"end_page": false, //当前是否最后一页
"list":[
{
"biz_id":"", //交易ID，唯一标识一次礼物发送，业务方生成
"user_id":"", //发送礼物的用户ID
"live_id":""// 直播间ID
"type":1, //礼物类型，用户在礼物配置接口配置
"gift_id":1, //礼物id，用户在礼物配置接口配置
"amount":99, //礼物金额
"created_at":"2022-09-01 00:00:00", //发送时间
}
]
}
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) >
[服务端API参考](https://developer.qiniu.com/lowcode/api/12008/qlive-server-api-
reference) > 礼物模块接口
# 礼物模块接口
最近更新时间: 2022-12-15 17:33:14
# 保存礼物配置
保存礼物配置。
对于原来没有的礼物类型，新增配置。
对于相同的配置类型，覆盖原有的配置。
## 路径
POST /server/gift/config
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Body 参数
[
{
"type": 1, //礼物类型
"name": "红包", //礼物名称
"amount": 5, //礼物金额，0 表示自定义金额,
"img": "", //礼物图片,
"animation_type":0, //动态效果类型,
"animation_img":"", //动态效果图片,
"order": 0 //排序，从小到大排序，相同order 根据创建时间排序',
}
]
## 返回
该接口正确处理请求时返回如下 JSON 数据
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 删除礼物配置
删除指定的礼物配置。
## 路径
DELETE /server/gift/config/{gift_id}
路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
gift_id | integer | 是 | 礼物id | 3
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Body 参数
无。
## 返回
该接口正确处理请求时返回如下 JSON 数据
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 查看礼物配置
查看所有的礼物配置。
## 路径
GET /server/gift/config/{type}
路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
type | int | 是 | 类型 ID，type==-1时表示全部类型 |
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Body 参数
无。
## 返回
该接口正确处理请求时返回如下 JSON 数据
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data": [
{
"type": 1, //礼物类型
"gift_id":3, //礼物id
"name": "红包", //礼物名称
"amount": 5, //礼物金额，0 表示自定义金额,
"img": "", //礼物图片,
"animation_type":0, //动态效果类型,
"animation_img":"", //动态效果图片,
"order": 0, //排序，从小到大排序，相同order 根据创建时间排序',
"created_at":"2022-09-15 13:00:00", //创建时间
"updated_at":"2022-09-20 15:00:00" //更新时间
}
]
}
# 查看直播间礼物列表
查看直播间的礼物记录。只有主播才能查看。
## 路径
GET /server/gift/list/user/{live_id}
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
liveId | string | 是 | 直播间 ID |
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Query 参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
page_num | integer | 否 | 页码 |
page_size | integer | 否 | 分页大小 |
## 返回
该接口正确处理请求时返回如下 JSON 数据
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data":{
"total_count":100, //总数
"page_total": 5, //总页数
"end_page": false, //当前是否最后一页
"list":[
{
"biz_id":"", //交易ID，唯一标识一次礼物发送，业务方生成
"user_id":"", //发送礼物的用户ID
"live_id":""// 直播间ID
"type":1, //礼物类型，用户在礼物配置接口配置
"gift_id":1, //礼物id，用户在礼物配置接口配置
"amount":99, //礼物金额
"created_at":"2022-09-01 00:00:00", //发送时间
}
]
}
}
# 查看主播礼物列表
查看直播间的礼物记录。只有主播才能查看。
## 路径
GET /server/gift/list/anchor/{anchor_id}
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Query 参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
page_num | integer | 否 | 页码 |
page_size | integer | 否 | 分页大小 |
## 返回
该接口正确处理请求时返回如下 JSON 数据
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data":{
"total_count":100, //总数
"page_total": 5, //总页数
"end_page": false, //当前是否最后一页
"list":[
{
"biz_id":"", //交易ID，唯一标识一次礼物发送，业务方生成
"user_id":"", //发送礼物的用户ID
"live_id":""// 直播间ID
"type":1, //礼物类型，用户在礼物配置接口配置
"gift_id":1, //礼物id，用户在礼物配置接口配置
"amount":99, //礼物金额
"created_at":"2022-09-01 00:00:00", //发送时间
}
]
}
}
# 查看用户打赏礼物列表
查看直播间的礼物记录。
## 路径
GET /server/gift/list/user/{user_id}
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
## Query 参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
page_num | integer | 否 | 页码 |
page_size | integer | 否 | 分页大小 |
## 返回
该接口正确处理请求时返回如下 JSON 数据
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
"data":{
"total_count":100, //总数
"page_total": 5, //总页数
"end_page": false, //当前是否最后一页
"list":[
{
"biz_id":"", //交易ID，唯一标识一次礼物发送，业务方生成
"user_id":"", //发送礼物的用户ID
"live_id":""// 直播间ID
"type":1, //礼物类型，用户在礼物配置接口配置
"gift_id":1, //礼物id，用户在礼物配置接口配置
"amount":99, //礼物金额
"created_at":"2022-09-01 00:00:00", //发送时间
}
]
}
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,563 |
商品模块接口 | 低代码 | [低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) >
[服务端API参考](https://developer.qiniu.com/lowcode/api/12008/qlive-server-api-
reference) > 商品模块接口
# 商品模块接口
最近更新时间: 2022-12-15 17:33:07
直播间商品管理接口。
# 批量导入商品到直播间
## 路径
POST /server/item/add
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | AK/SK 鉴权token | Qiniu AK:sign
## Body 参数
使用JSON 格式数据，传递商品信息数组。商品信息字段如下：
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间 ID |
items | []Item | 是 | 商品信息 |
Item 的结构如下
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
item_id | string | 是 | 商品 ID |
title | string | 是 | 商品标题 |
tags | string | 否 | 商品标签，多个以 ","分割。 |
thumbnail | string | 否 | 缩略图 url |
link | string | 否 | 商品链接 url |
current_price | string | 是 | 当前价格字符串 | 199元
origin_price | string | 否 | 原始价格字符串 | ￥298
status | int | 是 | 0，下架(用户不可见)；1，上架(用户可见)；2，上架不能购买 |
extends | map[string]string | 否 | 扩展信息，key value 结构 |
举例如下
{
"live_id":"live_1",
"items":[
{
"live_id":"live_1",
"item_id":"item_1",
"title": "精品皮鞋",
"tags": "皮具,一口价",
"thumbnail":"http;//xxx.png",
"link":"http;//xxx.png",
"current_price":"199元",
"origin_price":"298元",
"status":1,
"extends": {
"age":"18"
}
}
]
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 批量删除直播间商品
## 路径
POST /server/item/delete
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | AK/SK 鉴权token | Qiniu AK:sign
## Body 参数
使用JSON 格式数据，传递商品信息数组。商品信息字段如下：
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间 ID |
items | []string | 是 | 商品 ID 列表 |
举例如下
{
"live_id":"live_1",
"items":["item_1", "item_2"]
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 批量更新直播间商品状态
## 路径
POST /server/item/status
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | AK/SK 鉴权token | Qiniu AK:sign
## Body 参数
使用JSON 格式数据，传递商品信息数组。商品信息字段如下：
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间 ID |
items | []ItemStatus | 是 | 商品状态列表 |
ItemStatus 字段定义如下
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
item_id | string | 是 | 商品 ID |
status | int | 是 | 商品状态 |
举例如下
{
"live_id":"live_1",
"items": [
{
"item_id":"item_1",
"status":1
}
]
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 批量调整直播间商品顺序
## 路径
POST /server/item/order
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | AK/SK 鉴权token | Qiniu AK:sign
## Body 参数
使用JSON 格式数据，传递商品信息数组。商品信息字段如下：
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间 ID |
items | []ItemOrder | 是 | 商品状态列表 |
ItemOrder 字段定义如下
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
item_id | string | 是 | 商品 ID |
order | int | 是 | 调整后商品序号 |
举例如下
{
"live_id":"live_1",
"items": [
{
"item_id":"item_1",
"order":1
}
]
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 更新商品信息
## 路径
PUT /server/item/{liveId}/{itemId}
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | AK/SK 鉴权token | Qiniu AK:sign
## 路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
liveId | string | 是 | 直播间 ID |
itemId | string | 是 | 商品ID |
## Body 参数
使用JSON 格式数据，传递商品信息。商品信息字段如下：
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
title | string | 否 | 商品标题 |
tags | string | 否 | 商品标签，多个以 ","分割。 |
thumbnail | string | 否 | 缩略图 url |
link | string | 否 | 商品链接 url |
current_price | string | 否 | 当前价格字符串 | 199元
origin_price | string | 否 | 原始价格字符串 | ￥298
extends | map[string]string | 否 | 扩展信息，key value 结构 |
以上字段未填写则保持原来的信息不更新。
举例如下
{
"title": "精品皮鞋",
"tags": "皮具,一口价",
"thumbnail":"http;//xxx.png",
"link":"http;//xxx.png",
"current_price":"199元",
"origin_price":"298元",
"status":1,
"extends": {
"age":"18"
}
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 更新商品扩展信息
## 路径
PUT /server/item/{liveId}/{itemId}/extends
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | AK/SK 鉴权token | Qiniu AK:sign
## 路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
liveId | string | 是 | 直播间 ID |
itemId | string | 是 | 商品ID |
## Body 参数
使用JSON 格式数据，传递商品扩展信息。支持任意自定义的json 字段名，数据类型为字符串即可。
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
自定义 | string | 是 | 参数任意自定义，如：key1 |
只更新请求携带的扩展信息。
举例如下
{
"age": "18",
"key1": "value1",
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 查看直播间商品
## 路径
GET /server/items/{live_id}
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | AK/SK 鉴权token | Qiniu AK:sign
## 路径参数
使用JSON 格式数据，传递商品信息数组。商品信息字段如下：
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间 ID |
举例如下
curl "https://live-api.qiniu.com/server/items/live_1"
## 返回
返回结果，按照order 倒序排序。
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success", //code 非0 时，错误原因描述
"data":[
{
"live_id":"live_1",
"item_id":"item_1",
"order":1,
"title": "精品皮鞋",
"tags": "皮具,一口价",
"thumbnail":"http;//xxx.png",
"link":"http;//xxx.png",
"current_price":"199元",
"origin_price":"298元",
"status":1,
"extends": {
"age":"18"
}
}
]
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) >
[服务端API参考](https://developer.qiniu.com/lowcode/api/12008/qlive-server-api-
reference) > 商品模块接口
# 商品模块接口
最近更新时间: 2022-12-15 17:33:07
直播间商品管理接口。
# 批量导入商品到直播间
## 路径
POST /server/item/add
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | AK/SK 鉴权token | Qiniu AK:sign
## Body 参数
使用JSON 格式数据，传递商品信息数组。商品信息字段如下：
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间 ID |
items | []Item | 是 | 商品信息 |
Item 的结构如下
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
item_id | string | 是 | 商品 ID |
title | string | 是 | 商品标题 |
tags | string | 否 | 商品标签，多个以 ","分割。 |
thumbnail | string | 否 | 缩略图 url |
link | string | 否 | 商品链接 url |
current_price | string | 是 | 当前价格字符串 | 199元
origin_price | string | 否 | 原始价格字符串 | ￥298
status | int | 是 | 0，下架(用户不可见)；1，上架(用户可见)；2，上架不能购买 |
extends | map[string]string | 否 | 扩展信息，key value 结构 |
举例如下
{
"live_id":"live_1",
"items":[
{
"live_id":"live_1",
"item_id":"item_1",
"title": "精品皮鞋",
"tags": "皮具,一口价",
"thumbnail":"http;//xxx.png",
"link":"http;//xxx.png",
"current_price":"199元",
"origin_price":"298元",
"status":1,
"extends": {
"age":"18"
}
}
]
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 批量删除直播间商品
## 路径
POST /server/item/delete
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | AK/SK 鉴权token | Qiniu AK:sign
## Body 参数
使用JSON 格式数据，传递商品信息数组。商品信息字段如下：
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间 ID |
items | []string | 是 | 商品 ID 列表 |
举例如下
{
"live_id":"live_1",
"items":["item_1", "item_2"]
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 批量更新直播间商品状态
## 路径
POST /server/item/status
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | AK/SK 鉴权token | Qiniu AK:sign
## Body 参数
使用JSON 格式数据，传递商品信息数组。商品信息字段如下：
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间 ID |
items | []ItemStatus | 是 | 商品状态列表 |
ItemStatus 字段定义如下
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
item_id | string | 是 | 商品 ID |
status | int | 是 | 商品状态 |
举例如下
{
"live_id":"live_1",
"items": [
{
"item_id":"item_1",
"status":1
}
]
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 批量调整直播间商品顺序
## 路径
POST /server/item/order
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | AK/SK 鉴权token | Qiniu AK:sign
## Body 参数
使用JSON 格式数据，传递商品信息数组。商品信息字段如下：
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间 ID |
items | []ItemOrder | 是 | 商品状态列表 |
ItemOrder 字段定义如下
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
item_id | string | 是 | 商品 ID |
order | int | 是 | 调整后商品序号 |
举例如下
{
"live_id":"live_1",
"items": [
{
"item_id":"item_1",
"order":1
}
]
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 更新商品信息
## 路径
PUT /server/item/{liveId}/{itemId}
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | AK/SK 鉴权token | Qiniu AK:sign
## 路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
liveId | string | 是 | 直播间 ID |
itemId | string | 是 | 商品ID |
## Body 参数
使用JSON 格式数据，传递商品信息。商品信息字段如下：
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
title | string | 否 | 商品标题 |
tags | string | 否 | 商品标签，多个以 ","分割。 |
thumbnail | string | 否 | 缩略图 url |
link | string | 否 | 商品链接 url |
current_price | string | 否 | 当前价格字符串 | 199元
origin_price | string | 否 | 原始价格字符串 | ￥298
extends | map[string]string | 否 | 扩展信息，key value 结构 |
以上字段未填写则保持原来的信息不更新。
举例如下
{
"title": "精品皮鞋",
"tags": "皮具,一口价",
"thumbnail":"http;//xxx.png",
"link":"http;//xxx.png",
"current_price":"199元",
"origin_price":"298元",
"status":1,
"extends": {
"age":"18"
}
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 更新商品扩展信息
## 路径
PUT /server/item/{liveId}/{itemId}/extends
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | AK/SK 鉴权token | Qiniu AK:sign
## 路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
liveId | string | 是 | 直播间 ID |
itemId | string | 是 | 商品ID |
## Body 参数
使用JSON 格式数据，传递商品扩展信息。支持任意自定义的json 字段名，数据类型为字符串即可。
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
自定义 | string | 是 | 参数任意自定义，如：key1 |
只更新请求携带的扩展信息。
举例如下
{
"age": "18",
"key1": "value1",
}
## 返回
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
# 查看直播间商品
## 路径
GET /server/items/{live_id}
## 请求头
参数 | 说明 | 举例
---|---|---
Authorization | AK/SK 鉴权token | Qiniu AK:sign
## 路径参数
使用JSON 格式数据，传递商品信息数组。商品信息字段如下：
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
live_id | string | 是 | 直播间 ID |
举例如下
curl "https://live-api.qiniu.com/server/items/live_1"
## 返回
返回结果，按照order 倒序排序。
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success", //code 非0 时，错误原因描述
"data":[
{
"live_id":"live_1",
"item_id":"item_1",
"order":1,
"title": "精品皮鞋",
"tags": "皮具,一口价",
"thumbnail":"http;//xxx.png",
"link":"http;//xxx.png",
"current_price":"199元",
"origin_price":"298元",
"status":1,
"extends": {
"age":"18"
}
}
]
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,574 |
pk模块接口 | 低代码 | [低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) >
[服务端API参考](https://developer.qiniu.com/lowcode/api/12008/qlive-server-api-
reference) > pk模块接口
# pk模块接口
最近更新时间: 2023-03-03 18:15:18
# 更新跨房扩展信息
更新跨房连麦会话的扩展信息。
## 路径
POST /server/relay/{relay_id}/extends
路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
relay_id | string | 是 | 跨房会话ID | relay_123
请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
Body 参数
{
"extends": {
"ext-key":"ext-value"
}
}
返回结果
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
客户端sdk PK监听会收到扩展字段变更回调 回调方法为：
QPKServiceListener.onPKExtensionChange(QExtension extension)
## PK回调
在pk开始和结束时会进行回调通知，回调地址需要配置在配置文件中
callback:
addr: https://niucube-api.qiniu.com/v1/live/callback
字段名 | 类型 | 示例 | 说明
---|---|---|---
addr | string | https://niucube-api.qiniu.com/v1/live/callback | 配置低代码服务的回调地址,该地址由业务服务来实现. 低代码服务会将状态信息，通过回调的方式，通知给业务服务
### PK开始回调
{
"type": "pk_started",
"body": { // pk的RelaySession
"ID": 6, // 序号，无业务含义
"sid": "1630474797764845568", // PK 会话ID
"init_user_id": "user_092002", // 发起方主播ID
"init_room_id": "1630471052524003328", // 发起方直播间ID
"recv_user_id": "user_092002", // 接收方主播ID
"recv_room_id": "1630471052524086565", // 接收方直播间ID
"extends": { // 扩展数据，kv结构
},
"status": 1, // PK 会话状态
"start_at": null, // 开始时间 (十位时间戳)
"stop_at": null, // 结束时间 (十位时间戳)
"created_at": 1677570459, // 创建时间 (十位时间戳)
"updated_at": 1677570459 // 更新时间 (十位时间戳)
}
}
**字段名** | **类型** | **示例** | **说明**
---|---|---|---
status | number | 0 | 等待接收方同意
1 | 接收方已同意
2 | 发起方已经完成跨房，等待对方完成
3 | 接收方已经完成跨房，等待对方完成
4 | 两方都完成跨房
5 | 接收方拒绝
6 | 结束
### PK结束回调
{
"type": "pk_stopped",
"body": { // pk的RelaySession
"ID": 6, // 序号，无业务含义
"sid": "1630474797764845568", // PK 会话ID
"init_user_id": "user_092002", // 发起方主播ID
"init_room_id": "1630471052524003328", // 发起方直播间ID
"recv_user_id": "user_092002", // 接收方主播ID
"recv_room_id": "1630471052524086565", // 接收方直播间ID
"extends": { // 扩展数据，kv结构
},
"status": 1, // PK 会话状态
"start_at": null, // 开始时间 (十位时间戳)
"stop_at": null, // 结束时间 (十位时间戳)
"created_at": 1677570459, // 创建时间 (十位时间戳)
"updated_at": 1677570459 // 更新时间 (十位时间戳)
}
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) >
[服务端API参考](https://developer.qiniu.com/lowcode/api/12008/qlive-server-api-
reference) > pk模块接口
# pk模块接口
最近更新时间: 2023-03-03 18:15:18
# 更新跨房扩展信息
更新跨房连麦会话的扩展信息。
## 路径
POST /server/relay/{relay_id}/extends
路径参数
参数 | 类型 | 必填 | 说明 | 举例
---|---|---|---|---
relay_id | string | 是 | 跨房会话ID | relay_123
请求头
参数 | 说明 | 举例
---|---|---
Authorization | 鉴权token |
Body 参数
{
"extends": {
"ext-key":"ext-value"
}
}
返回结果
{
"request_id":"xxxxx", //请求ID
"code": 0, //错误码：0，成功；其他，失败
"message": "success" //code 非0 时，错误原因描述
}
客户端sdk PK监听会收到扩展字段变更回调 回调方法为：
QPKServiceListener.onPKExtensionChange(QExtension extension)
## PK回调
在pk开始和结束时会进行回调通知，回调地址需要配置在配置文件中
callback:
addr: https://niucube-api.qiniu.com/v1/live/callback
字段名 | 类型 | 示例 | 说明
---|---|---|---
addr | string | https://niucube-api.qiniu.com/v1/live/callback | 配置低代码服务的回调地址,该地址由业务服务来实现. 低代码服务会将状态信息，通过回调的方式，通知给业务服务
### PK开始回调
{
"type": "pk_started",
"body": { // pk的RelaySession
"ID": 6, // 序号，无业务含义
"sid": "1630474797764845568", // PK 会话ID
"init_user_id": "user_092002", // 发起方主播ID
"init_room_id": "1630471052524003328", // 发起方直播间ID
"recv_user_id": "user_092002", // 接收方主播ID
"recv_room_id": "1630471052524086565", // 接收方直播间ID
"extends": { // 扩展数据，kv结构
},
"status": 1, // PK 会话状态
"start_at": null, // 开始时间 (十位时间戳)
"stop_at": null, // 结束时间 (十位时间戳)
"created_at": 1677570459, // 创建时间 (十位时间戳)
"updated_at": 1677570459 // 更新时间 (十位时间戳)
}
}
**字段名** | **类型** | **示例** | **说明**
---|---|---|---
status | number | 0 | 等待接收方同意
1 | 接收方已同意
2 | 发起方已经完成跨房，等待对方完成
3 | 接收方已经完成跨房，等待对方完成
4 | 两方都完成跨房
5 | 接收方拒绝
6 | 结束
### PK结束回调
{
"type": "pk_stopped",
"body": { // pk的RelaySession
"ID": 6, // 序号，无业务含义
"sid": "1630474797764845568", // PK 会话ID
"init_user_id": "user_092002", // 发起方主播ID
"init_room_id": "1630471052524003328", // 发起方直播间ID
"recv_user_id": "user_092002", // 接收方主播ID
"recv_room_id": "1630471052524086565", // 接收方直播间ID
"extends": { // 扩展数据，kv结构
},
"status": 1, // PK 会话状态
"start_at": null, // 开始时间 (十位时间戳)
"stop_at": null, // 结束时间 (十位时间戳)
"created_at": 1677570459, // 创建时间 (十位时间戳)
"updated_at": 1677570459 // 更新时间 (十位时间戳)
}
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,585 |
android API文档 | 低代码 | [低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) > android
API文档
# android API文档
最近更新时间: 2022-10-31 14:19:47
[QLive](https://developer.qiniu.com/lowcode/api/12045/QLive)
低代码直播客户端
[QLiveUIKit](https://developer.qiniu.com/lowcode/api/12046/QLiveUIKit)
UIkit客户端
[QUserInfo](https://developer.qiniu.com/lowcode/api/12047/QUserInfo)
跟新用户资料参数
[QTokenGetter](https://developer.qiniu.com/lowcode/api/12048/QTokenGetter)
token获取回调 当token过期后自动调用getTokenInfo
[QLiveConfig](https://developer.qiniu.com/lowcode/api/12049/QLiveConfig)
sdk 配置
[QRooms](https://developer.qiniu.com/lowcode/api/12050/QRooms)
房间管理接口
[QLiveStatus](https://developer.qiniu.com/lowcode/api/12051/QLiveStatus)
直播状态枚举
[QLiveCallBack](https://developer.qiniu.com/lowcode/api/12052/QLiveCallBack)
基础回调函数
[QClientType](https://developer.qiniu.com/lowcode/api/12053/QClientType)
客户端类型枚举
[QClientLifeCycleListener](https://developer.qiniu.com/lowcode/api/12054/QClientLifeCycleListener)
ui组件实现的房间生命周期
[QInvitationHandler](https://developer.qiniu.com/lowcode/api/12055/QInvitationHandler)
邀请处理器
[QInvitationHandlerListener](https://developer.qiniu.com/lowcode/api/12056/QInvitationHandlerListener)
邀请监听
[QCreateRoomParam](https://developer.qiniu.com/lowcode/api/12057/QCreateRoomParam)
创建房间参数
[QDanmaku](https://developer.qiniu.com/lowcode/api/12058/QDanmaku)
弹幕实体
[QExtension](https://developer.qiniu.com/lowcode/api/12059/QExtension)
扩展字段
[QInvitation](https://developer.qiniu.com/lowcode/api/12060/QInvitation)
邀请信息
[QLiveRoomInfo](https://developer.qiniu.com/lowcode/api/12061/QLiveRoomInfo)
房间信息
[QLiveUser](https://developer.qiniu.com/lowcode/api/12062/QLiveUser)
用户
[QMicLinker](https://developer.qiniu.com/lowcode/api/12063/QMicLinker)
连麦用户
[QPKSession](https://developer.qiniu.com/lowcode/api/12064/QPKSession)
pk 会话
[QPublicChat](https://developer.qiniu.com/lowcode/api/12065/QPublicChat)
公屏类型消息
[QPlayerEventListener](https://developer.qiniu.com/lowcode/api/12066/QPlayerEventListener)
拉流事件回调
[QBeautySetting](https://developer.qiniu.com/lowcode/api/12067/QBeautySetting)
默认美颜参数（免费）
[QConnectionStatusLister](https://developer.qiniu.com/lowcode/api/12068/QConnectionStatusLister)
rtc推流链接状态监听
[QPlayerRenderView](https://developer.qiniu.com/lowcode/api/12069/QPlayerRenderView)
观众播放器预览 子类 QPlayerTextureRenderView 和 QSurfaceRenderView
[QMicrophoneParam](https://developer.qiniu.com/lowcode/api/12073/QMicrophoneParam)
麦克风参数
[QCameraParam](https://developer.qiniu.com/lowcode/api/12074/QCameraParam)
摄像头参数
[QMixStreaming.MixStreamParams](https://developer.qiniu.com/lowcode/api/12075/QMixStreaming_MixStreamParams)
混流画布参数
[QMixStreaming.TranscodingLiveStreamingImage](https://developer.qiniu.com/lowcode/api/12076/QMixStreaming_TranscodingLiveStreamingImage)
背景图片
[QMixStreaming.CameraMergeOption](https://developer.qiniu.com/lowcode/api/12078/QMixStreaming_CameraMergeOption)
摄像头混流参数
[QMixStreaming.MergeOption](https://developer.qiniu.com/lowcode/api/12079/QMixStreaming_MergeOption)
某个用户的混流参数 只需要指定用户ID 和他的摄像头麦克风混流参数
[QMixStreaming.MicrophoneMergeOption](https://developer.qiniu.com/lowcode/api/12080/QMixStreaming_MicrophoneMergeOption)
麦克风混流参数
[QPusherClient](https://developer.qiniu.com/lowcode/api/12081/QPusherClient)
推流客户端（主播端）
[QPushRenderView](https://developer.qiniu.com/lowcode/api/12082/QPushRenderView)
推流预览窗口 子类实现 QPushSurfaceView 和 QPushTextureView
[QPlayerClient](https://developer.qiniu.com/lowcode/api/12083/QPlayerClient)
拉流客户端
[QLiveStatusListener](https://developer.qiniu.com/lowcode/api/12084/QLiveStatusListener)
直播状态监听
[QLinkMicService](https://developer.qiniu.com/lowcode/api/12085/QLinkMicService)
连麦服务
[QLinkMicServiceListener](https://developer.qiniu.com/lowcode/api/12086/QLinkMicServiceListener)
麦位监听
[QAnchorHostMicHandler](https://developer.qiniu.com/lowcode/api/12087/QAnchorHostMicHandler)
主播端连麦器
[QLinkMicMixStreamAdapter](https://developer.qiniu.com/lowcode/api/12088/QLinkMicMixStreamAdapter)
混流适配器
[QAudienceMicHandler](https://developer.qiniu.com/lowcode/api/12089/QAudienceMicHandler)
观众连麦器
[QAudienceMicHandler.LinkMicHandlerListener](https://developer.qiniu.com/lowcode/api/12090/QAudienceMicHandler_LinkMicHandlerListener)
观众连麦处理器监听 观众需要处理的事件
[QAudioFrameListener](https://developer.qiniu.com/lowcode/api/12091/QAudioFrameListener)
音频帧监听
[QVideoFrameListener](https://developer.qiniu.com/lowcode/api/12092/QVideoFrameListener)
视频帧监听
[QPKService](https://developer.qiniu.com/lowcode/api/12093/QPKService)
pk服务
[QPKServiceListener](https://developer.qiniu.com/lowcode/api/12094/QPKServiceListener)
pk回调
[QPKMixStreamAdapter](https://developer.qiniu.com/lowcode/api/12095/QPKMixStreamAdapter)
pk混流适配器
[QPublicChatService](https://developer.qiniu.com/lowcode/api/12096/QPublicChatService)
公屏服务
[QPublicChatServiceLister](https://developer.qiniu.com/lowcode/api/12097/QPublicChatServiceLister)
[QRoomService](https://developer.qiniu.com/lowcode/api/12098/QRoomService)
房间服务
[QRoomServiceListener](https://developer.qiniu.com/lowcode/api/12099/QRoomServiceListener)
房间服务监听
[QDanmakuService](https://developer.qiniu.com/lowcode/api/12100/QDanmakuService)
弹幕服务
[QDanmakuServiceListener](https://developer.qiniu.com/lowcode/api/12101/QDanmakuServiceListener)
弹幕消息监听
[QChatRoomService](https://developer.qiniu.com/lowcode/api/12102/QChatRoomService)
聊天室服务
[QChatRoomServiceListener](https://developer.qiniu.com/lowcode/api/12103/QChatRoomServiceListener)
聊天室监听
[RoomPage](https://developer.qiniu.com/lowcode/api/12105/RoomPage)
[RoomListPage](https://developer.qiniu.com/lowcode/api/12106/RoomListPage)
房间列表页面
[QLiveFuncComponent](https://developer.qiniu.com/lowcode/api/12107/QLiveFuncComponent)
[QLiveComponent](https://developer.qiniu.com/lowcode/api/12108/QLiveComponent)
[QLiveUIKitContext](https://developer.qiniu.com/lowcode/api/12109/QLiveUIKitContext)
uikit 房间里的UI组件上下文 1在UI组件中能获取平台特性的能力 如activiy 显示弹窗 2能获取房间client 主要资源和关键操作
[QItem](https://developer.qiniu.com/lowcode/api/12128/QItem)
商品信息
[QItem.RecordInfo](https://developer.qiniu.com/lowcode/api/12186/QItem_RecordInfo)
商品讲解录制信息
[QItemStatus](https://developer.qiniu.com/lowcode/api/12129/QItemStatus)
商品状态枚举
[QOrderParam](https://developer.qiniu.com/lowcode/api/12130/QOrderParam)
商品顺序参数
[QSingleOrderParam](https://developer.qiniu.com/lowcode/api/12131/QSingleOrderParam)
单个商品调节顺序
[QShoppingService](https://developer.qiniu.com/lowcode/api/12132/QShoppingService)
购物服务
[QShoppingServiceListener](https://developer.qiniu.com/lowcode/api/12133/QShoppingServiceListener)
购物车服务监听
[QGift](https://developer.qiniu.com/lowcode/api/12277/qgift)
礼物模型
[QGiftMsg](https://developer.qiniu.com/lowcode/api/12278/qgiftmsg)
礼物消息
[QGiftService](https://developer.qiniu.com/lowcode/api/12279/qgiftservice)
礼物服务
[QGiftServiceListener](https://developer.qiniu.com/lowcode/api/12280/qgiftservicelistener)
礼物监听
[QLike](https://developer.qiniu.com/lowcode/api/12281/qlike)
点赞
[QLikeResponse](https://developer.qiniu.com/lowcode/api/12282/qlikeresponse)
点赞响应
[QLikeService](https://developer.qiniu.com/lowcode/api/12283/qlikeservice)
点赞服务
[QLikeServiceListener](https://developer.qiniu.com/lowcode/api/12284/qlikeservicelistener)
点赞监听
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) > android
API文档
# android API文档
最近更新时间: 2022-10-31 14:19:47
[QLive](https://developer.qiniu.com/lowcode/api/12045/QLive)
低代码直播客户端
[QLiveUIKit](https://developer.qiniu.com/lowcode/api/12046/QLiveUIKit)
UIkit客户端
[QUserInfo](https://developer.qiniu.com/lowcode/api/12047/QUserInfo)
跟新用户资料参数
[QTokenGetter](https://developer.qiniu.com/lowcode/api/12048/QTokenGetter)
token获取回调 当token过期后自动调用getTokenInfo
[QLiveConfig](https://developer.qiniu.com/lowcode/api/12049/QLiveConfig)
sdk 配置
[QRooms](https://developer.qiniu.com/lowcode/api/12050/QRooms)
房间管理接口
[QLiveStatus](https://developer.qiniu.com/lowcode/api/12051/QLiveStatus)
直播状态枚举
[QLiveCallBack](https://developer.qiniu.com/lowcode/api/12052/QLiveCallBack)
基础回调函数
[QClientType](https://developer.qiniu.com/lowcode/api/12053/QClientType)
客户端类型枚举
[QClientLifeCycleListener](https://developer.qiniu.com/lowcode/api/12054/QClientLifeCycleListener)
ui组件实现的房间生命周期
[QInvitationHandler](https://developer.qiniu.com/lowcode/api/12055/QInvitationHandler)
邀请处理器
[QInvitationHandlerListener](https://developer.qiniu.com/lowcode/api/12056/QInvitationHandlerListener)
邀请监听
[QCreateRoomParam](https://developer.qiniu.com/lowcode/api/12057/QCreateRoomParam)
创建房间参数
[QDanmaku](https://developer.qiniu.com/lowcode/api/12058/QDanmaku)
弹幕实体
[QExtension](https://developer.qiniu.com/lowcode/api/12059/QExtension)
扩展字段
[QInvitation](https://developer.qiniu.com/lowcode/api/12060/QInvitation)
邀请信息
[QLiveRoomInfo](https://developer.qiniu.com/lowcode/api/12061/QLiveRoomInfo)
房间信息
[QLiveUser](https://developer.qiniu.com/lowcode/api/12062/QLiveUser)
用户
[QMicLinker](https://developer.qiniu.com/lowcode/api/12063/QMicLinker)
连麦用户
[QPKSession](https://developer.qiniu.com/lowcode/api/12064/QPKSession)
pk 会话
[QPublicChat](https://developer.qiniu.com/lowcode/api/12065/QPublicChat)
公屏类型消息
[QPlayerEventListener](https://developer.qiniu.com/lowcode/api/12066/QPlayerEventListener)
拉流事件回调
[QBeautySetting](https://developer.qiniu.com/lowcode/api/12067/QBeautySetting)
默认美颜参数（免费）
[QConnectionStatusLister](https://developer.qiniu.com/lowcode/api/12068/QConnectionStatusLister)
rtc推流链接状态监听
[QPlayerRenderView](https://developer.qiniu.com/lowcode/api/12069/QPlayerRenderView)
观众播放器预览 子类 QPlayerTextureRenderView 和 QSurfaceRenderView
[QMicrophoneParam](https://developer.qiniu.com/lowcode/api/12073/QMicrophoneParam)
麦克风参数
[QCameraParam](https://developer.qiniu.com/lowcode/api/12074/QCameraParam)
摄像头参数
[QMixStreaming.MixStreamParams](https://developer.qiniu.com/lowcode/api/12075/QMixStreaming_MixStreamParams)
混流画布参数
[QMixStreaming.TranscodingLiveStreamingImage](https://developer.qiniu.com/lowcode/api/12076/QMixStreaming_TranscodingLiveStreamingImage)
背景图片
[QMixStreaming.CameraMergeOption](https://developer.qiniu.com/lowcode/api/12078/QMixStreaming_CameraMergeOption)
摄像头混流参数
[QMixStreaming.MergeOption](https://developer.qiniu.com/lowcode/api/12079/QMixStreaming_MergeOption)
某个用户的混流参数 只需要指定用户ID 和他的摄像头麦克风混流参数
[QMixStreaming.MicrophoneMergeOption](https://developer.qiniu.com/lowcode/api/12080/QMixStreaming_MicrophoneMergeOption)
麦克风混流参数
[QPusherClient](https://developer.qiniu.com/lowcode/api/12081/QPusherClient)
推流客户端（主播端）
[QPushRenderView](https://developer.qiniu.com/lowcode/api/12082/QPushRenderView)
推流预览窗口 子类实现 QPushSurfaceView 和 QPushTextureView
[QPlayerClient](https://developer.qiniu.com/lowcode/api/12083/QPlayerClient)
拉流客户端
[QLiveStatusListener](https://developer.qiniu.com/lowcode/api/12084/QLiveStatusListener)
直播状态监听
[QLinkMicService](https://developer.qiniu.com/lowcode/api/12085/QLinkMicService)
连麦服务
[QLinkMicServiceListener](https://developer.qiniu.com/lowcode/api/12086/QLinkMicServiceListener)
麦位监听
[QAnchorHostMicHandler](https://developer.qiniu.com/lowcode/api/12087/QAnchorHostMicHandler)
主播端连麦器
[QLinkMicMixStreamAdapter](https://developer.qiniu.com/lowcode/api/12088/QLinkMicMixStreamAdapter)
混流适配器
[QAudienceMicHandler](https://developer.qiniu.com/lowcode/api/12089/QAudienceMicHandler)
观众连麦器
[QAudienceMicHandler.LinkMicHandlerListener](https://developer.qiniu.com/lowcode/api/12090/QAudienceMicHandler_LinkMicHandlerListener)
观众连麦处理器监听 观众需要处理的事件
[QAudioFrameListener](https://developer.qiniu.com/lowcode/api/12091/QAudioFrameListener)
音频帧监听
[QVideoFrameListener](https://developer.qiniu.com/lowcode/api/12092/QVideoFrameListener)
视频帧监听
[QPKService](https://developer.qiniu.com/lowcode/api/12093/QPKService)
pk服务
[QPKServiceListener](https://developer.qiniu.com/lowcode/api/12094/QPKServiceListener)
pk回调
[QPKMixStreamAdapter](https://developer.qiniu.com/lowcode/api/12095/QPKMixStreamAdapter)
pk混流适配器
[QPublicChatService](https://developer.qiniu.com/lowcode/api/12096/QPublicChatService)
公屏服务
[QPublicChatServiceLister](https://developer.qiniu.com/lowcode/api/12097/QPublicChatServiceLister)
[QRoomService](https://developer.qiniu.com/lowcode/api/12098/QRoomService)
房间服务
[QRoomServiceListener](https://developer.qiniu.com/lowcode/api/12099/QRoomServiceListener)
房间服务监听
[QDanmakuService](https://developer.qiniu.com/lowcode/api/12100/QDanmakuService)
弹幕服务
[QDanmakuServiceListener](https://developer.qiniu.com/lowcode/api/12101/QDanmakuServiceListener)
弹幕消息监听
[QChatRoomService](https://developer.qiniu.com/lowcode/api/12102/QChatRoomService)
聊天室服务
[QChatRoomServiceListener](https://developer.qiniu.com/lowcode/api/12103/QChatRoomServiceListener)
聊天室监听
[RoomPage](https://developer.qiniu.com/lowcode/api/12105/RoomPage)
[RoomListPage](https://developer.qiniu.com/lowcode/api/12106/RoomListPage)
房间列表页面
[QLiveFuncComponent](https://developer.qiniu.com/lowcode/api/12107/QLiveFuncComponent)
[QLiveComponent](https://developer.qiniu.com/lowcode/api/12108/QLiveComponent)
[QLiveUIKitContext](https://developer.qiniu.com/lowcode/api/12109/QLiveUIKitContext)
uikit 房间里的UI组件上下文 1在UI组件中能获取平台特性的能力 如activiy 显示弹窗 2能获取房间client 主要资源和关键操作
[QItem](https://developer.qiniu.com/lowcode/api/12128/QItem)
商品信息
[QItem.RecordInfo](https://developer.qiniu.com/lowcode/api/12186/QItem_RecordInfo)
商品讲解录制信息
[QItemStatus](https://developer.qiniu.com/lowcode/api/12129/QItemStatus)
商品状态枚举
[QOrderParam](https://developer.qiniu.com/lowcode/api/12130/QOrderParam)
商品顺序参数
[QSingleOrderParam](https://developer.qiniu.com/lowcode/api/12131/QSingleOrderParam)
单个商品调节顺序
[QShoppingService](https://developer.qiniu.com/lowcode/api/12132/QShoppingService)
购物服务
[QShoppingServiceListener](https://developer.qiniu.com/lowcode/api/12133/QShoppingServiceListener)
购物车服务监听
[QGift](https://developer.qiniu.com/lowcode/api/12277/qgift)
礼物模型
[QGiftMsg](https://developer.qiniu.com/lowcode/api/12278/qgiftmsg)
礼物消息
[QGiftService](https://developer.qiniu.com/lowcode/api/12279/qgiftservice)
礼物服务
[QGiftServiceListener](https://developer.qiniu.com/lowcode/api/12280/qgiftservicelistener)
礼物监听
[QLike](https://developer.qiniu.com/lowcode/api/12281/qlike)
点赞
[QLikeResponse](https://developer.qiniu.com/lowcode/api/12282/qlikeresponse)
点赞响应
[QLikeService](https://developer.qiniu.com/lowcode/api/12283/qlikeservice)
点赞服务
[QLikeServiceListener](https://developer.qiniu.com/lowcode/api/12284/qlikeservicelistener)
点赞监听
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,591 |
QLive | 低代码 | [低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) > [android
API文档](https://developer.qiniu.com/lowcode/api/12032/the-android-api-
documentation) > QLive
# QLive
最近更新时间: 2022-08-31 09:59:01
class com.qlive.sdk.QLive
低代码直播客户端
Index
方法
* init
* auth
* setUser
* getLoginUser
* createPusherClient
* createPlayerClient
* getRooms
* getLiveUIKit
方法
init
* public static void init(Context context, QLiveConfig config, QTokenGetter tokenGetter);
* 初始化
Parameters
* context: Context
安卓上下文
* config: [QLiveConfig](https://developer.qiniu.com/lowcode/api/12049/QLiveConfig)
sdk配置
* tokenGetter: [QTokenGetter](https://developer.qiniu.com/lowcode/api/12048/QTokenGetter)
token获取
Returns void
auth
* public static void auth(@NotNull() QLiveCallBack<Void> callBack);
* 登陆 认证成功后才能使用qlive的功能
> 认证成功后才能使用qlive的功能
Parameters
* callBack: [QLiveCallBack](https://developer.qiniu.com/lowcode/api/12052/QLiveCallBack)
操作回调
Returns void
setUser
* public static void setUser(@NotNull() QUserInfo userInfo, @NotNull() QLiveCallBack<Void> callBack);
* 跟新用户信息
Parameters
* userInfo: [QUserInfo](https://developer.qiniu.com/lowcode/api/12047/QUserInfo)
用户参数
* callBack: [QLiveCallBack](https://developer.qiniu.com/lowcode/api/12052/QLiveCallBack)
回调函数
Returns void
getLoginUser
* public static QLiveUser getLoginUser();
* 获取当前登陆用户资料
Returns [QLiveUser](https://developer.qiniu.com/lowcode/api/12062/QLiveUser)
createPusherClient
* public static QPusherClient createPusherClient();
* 创建推流客户端
Returns
[QPusherClient](https://developer.qiniu.com/lowcode/api/12081/QPusherClient)
createPlayerClient
* public static QPlayerClient createPlayerClient();
* 创建拉流客户端
Returns
[QPlayerClient](https://developer.qiniu.com/lowcode/api/12083/QPlayerClient)
getRooms
* public static QRooms getRooms();
* 获取房间管理接口
Returns [QRooms](https://developer.qiniu.com/lowcode/api/12050/QRooms)
getLiveUIKit
* public static QLiveUIKit getLiveUIKit();
* 获得UIkit
Returns [QLiveUIKit](https://developer.qiniu.com/lowcode/api/12046/QLiveUIKit)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) > [android
API文档](https://developer.qiniu.com/lowcode/api/12032/the-android-api-
documentation) > QLive
# QLive
最近更新时间: 2022-08-31 09:59:01
class com.qlive.sdk.QLive
低代码直播客户端
Index
方法
* init
* auth
* setUser
* getLoginUser
* createPusherClient
* createPlayerClient
* getRooms
* getLiveUIKit
方法
init
* public static void init(Context context, QLiveConfig config, QTokenGetter tokenGetter);
* 初始化
Parameters
* context: Context
安卓上下文
* config: [QLiveConfig](https://developer.qiniu.com/lowcode/api/12049/QLiveConfig)
sdk配置
* tokenGetter: [QTokenGetter](https://developer.qiniu.com/lowcode/api/12048/QTokenGetter)
token获取
Returns void
auth
* public static void auth(@NotNull() QLiveCallBack<Void> callBack);
* 登陆 认证成功后才能使用qlive的功能
> 认证成功后才能使用qlive的功能
Parameters
* callBack: [QLiveCallBack](https://developer.qiniu.com/lowcode/api/12052/QLiveCallBack)
操作回调
Returns void
setUser
* public static void setUser(@NotNull() QUserInfo userInfo, @NotNull() QLiveCallBack<Void> callBack);
* 跟新用户信息
Parameters
* userInfo: [QUserInfo](https://developer.qiniu.com/lowcode/api/12047/QUserInfo)
用户参数
* callBack: [QLiveCallBack](https://developer.qiniu.com/lowcode/api/12052/QLiveCallBack)
回调函数
Returns void
getLoginUser
* public static QLiveUser getLoginUser();
* 获取当前登陆用户资料
Returns [QLiveUser](https://developer.qiniu.com/lowcode/api/12062/QLiveUser)
createPusherClient
* public static QPusherClient createPusherClient();
* 创建推流客户端
Returns
[QPusherClient](https://developer.qiniu.com/lowcode/api/12081/QPusherClient)
createPlayerClient
* public static QPlayerClient createPlayerClient();
* 创建拉流客户端
Returns
[QPlayerClient](https://developer.qiniu.com/lowcode/api/12083/QPlayerClient)
getRooms
* public static QRooms getRooms();
* 获取房间管理接口
Returns [QRooms](https://developer.qiniu.com/lowcode/api/12050/QRooms)
getLiveUIKit
* public static QLiveUIKit getLiveUIKit();
* 获得UIkit
Returns [QLiveUIKit](https://developer.qiniu.com/lowcode/api/12046/QLiveUIKit)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,600 |
QLiveUIKit | 低代码 | [低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) > [android
API文档](https://developer.qiniu.com/lowcode/api/12032/the-android-api-
documentation) > QLiveUIKit
# QLiveUIKit
最近更新时间: 2022-07-11 09:57:38
interface com.qlive.sdk.QLiveUIKit
UIkit客户端
Index
方法
* getPage
* launch
方法
getPage
* <T extends QPage>T getPage(Class<T> pageClass);
* 获取内置页面 每个页面有相应的UI配置
Parameters
* pageClass: Class
页面的类 目前子类为 RoomListPage-> 房间列表页面 RoomPage->直播间页面
Returns QPage
launch
* void launch(Context context);
* 跳转到直播列表页面
Parameters
* context: Context
安卓上下文
Returns void
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) > [android
API文档](https://developer.qiniu.com/lowcode/api/12032/the-android-api-
documentation) > QLiveUIKit
# QLiveUIKit
最近更新时间: 2022-07-11 09:57:38
interface com.qlive.sdk.QLiveUIKit
UIkit客户端
Index
方法
* getPage
* launch
方法
getPage
* <T extends QPage>T getPage(Class<T> pageClass);
* 获取内置页面 每个页面有相应的UI配置
Parameters
* pageClass: Class
页面的类 目前子类为 RoomListPage-> 房间列表页面 RoomPage->直播间页面
Returns QPage
launch
* void launch(Context context);
* 跳转到直播列表页面
Parameters
* context: Context
安卓上下文
Returns void
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,603 |
QUserInfo | 低代码 | [低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) > [android
API文档](https://developer.qiniu.com/lowcode/api/12032/the-android-api-
documentation) > QUserInfo
# QUserInfo
最近更新时间: 2022-07-11 09:58:58
class com.qlive.sdk.QUserInfo
跟新用户资料参数
Index
字段
* avatar
* nick
* extension
字段
avatar
* public String avatar
* 头像
nick
* public String nick
* 名称
extension
* public HashMap extension
* 扩展字段
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) > [android
API文档](https://developer.qiniu.com/lowcode/api/12032/the-android-api-
documentation) > QUserInfo
# QUserInfo
最近更新时间: 2022-07-11 09:58:58
class com.qlive.sdk.QUserInfo
跟新用户资料参数
Index
字段
* avatar
* nick
* extension
字段
avatar
* public String avatar
* 头像
nick
* public String nick
* 名称
extension
* public HashMap extension
* 扩展字段
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,605 |
QTokenGetter | 低代码 | [低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) > [android
API文档](https://developer.qiniu.com/lowcode/api/12032/the-android-api-
documentation) > QTokenGetter
# QTokenGetter
最近更新时间: 2022-07-11 10:00:46
interface com.qlive.core.QTokenGetter
token获取回调 当token过期后自动调用getTokenInfo
Index
方法
* getTokenInfo
方法
getTokenInfo
* public void getTokenInfo (com.qlive.core.QLiveCallBack)
* 如何获取token
Parameters
* callback: [QLiveCallBack](https://developer.qiniu.com/lowcode/api/12052/QLiveCallBack)
业务（同步/异步）获取后把结果通知给sdk
Returns void
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) > [android
API文档](https://developer.qiniu.com/lowcode/api/12032/the-android-api-
documentation) > QTokenGetter
# QTokenGetter
最近更新时间: 2022-07-11 10:00:46
interface com.qlive.core.QTokenGetter
token获取回调 当token过期后自动调用getTokenInfo
Index
方法
* getTokenInfo
方法
getTokenInfo
* public void getTokenInfo (com.qlive.core.QLiveCallBack)
* 如何获取token
Parameters
* callback: [QLiveCallBack](https://developer.qiniu.com/lowcode/api/12052/QLiveCallBack)
业务（同步/异步）获取后把结果通知给sdk
Returns void
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,607 |
QLiveConfig | 低代码 | [低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) > [android
API文档](https://developer.qiniu.com/lowcode/api/12032/the-android-api-
documentation) > QLiveConfig
# QLiveConfig
最近更新时间: 2022-08-31 09:58:38
class com.qlive.core.QSdkConfig
sdk 配置
Index
字段
* isLogAble
* serverURL
字段
isLogAble
* public boolean isLogAble
* 打印日志开关
serverURL
* public String serverURL
* 服务器地址 默认为低代码demo地址 如果自己部署可改为自己的服务地址
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) > [android
API文档](https://developer.qiniu.com/lowcode/api/12032/the-android-api-
documentation) > QLiveConfig
# QLiveConfig
最近更新时间: 2022-08-31 09:58:38
class com.qlive.core.QSdkConfig
sdk 配置
Index
字段
* isLogAble
* serverURL
字段
isLogAble
* public boolean isLogAble
* 打印日志开关
serverURL
* public String serverURL
* 服务器地址 默认为低代码demo地址 如果自己部署可改为自己的服务地址
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,609 |
QRooms | 低代码 | [低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) > [android
API文档](https://developer.qiniu.com/lowcode/api/12032/the-android-api-
documentation) > QRooms
# QRooms
最近更新时间: 2022-10-31 14:18:46
interface com.qlive.sdk.QRooms
房间管理接口
Index
方法
* createRoom
* deleteRoom
* getRoomInfo
* listRoom
* liveRecord
* getLiveStatistics
* getGiftConfig
* getLiveGiftStatistics
* getAnchorGiftStatistics
* getUserGiftStatistics
方法
createRoom
* public void createRoom(QCreateRoomParam param,QLiveCallBack callBack)
* 创建房间
Parameters
* param: [QCreateRoomParam](https://developer.qiniu.com/lowcode/api/12057/QCreateRoomParam)
创建房间参数
* callBack: [QLiveCallBack](https://developer.qiniu.com/lowcode/api/12052/QLiveCallBack)
Returns void
deleteRoom
* public void deleteRoom(String roomID,QLiveCallBack callBack)
* 删除房间
Parameters
* roomID: String
房间ID
* callBack: [QLiveCallBack](https://developer.qiniu.com/lowcode/api/12052/QLiveCallBack)
Returns void
getRoomInfo
* public void getRoomInfo(String roomID,QLiveCallBack callBack)
* 根据ID获取房间信息
Parameters
* roomID: String
房间ID
* callBack: [QLiveCallBack](https://developer.qiniu.com/lowcode/api/12052/QLiveCallBack)
Returns void
listRoom
* public void listRoom(int pageNumber,int pageSize,QLiveCallBack callBack)
* 房间列表
Parameters
* pageNumber: int
* pageSize: int
* callBack: [QLiveCallBack](https://developer.qiniu.com/lowcode/api/12052/QLiveCallBack)
Returns void
liveRecord
* public void liveRecord(int pageNumber,int pageSize,QLiveCallBack callBack)
* 我的直播记录
Parameters
* pageNumber: int
* pageSize: int
* callBack: [QLiveCallBack](https://developer.qiniu.com/lowcode/api/12052/QLiveCallBack)
Returns void
getLiveStatistics
* public void getLiveStatistics(String roomID,QLiveCallBack callBack)
* 获取直播间数据统计
Parameters
* roomID: String
* callBack: [QLiveCallBack](https://developer.qiniu.com/lowcode/api/12052/QLiveCallBack)
Returns void
getGiftConfig
* public void getGiftConfig(int type,QLiveCallBack callback)
* 获取礼物配置
Parameters
* type: int
礼物类型 -1代表全部
* callback: [QLiveCallBack](https://developer.qiniu.com/lowcode/api/12052/QLiveCallBack)
Returns void
getLiveGiftStatistics
* public void getLiveGiftStatistics(String roomID,int pageNumber,int pageSize,QLiveCallBack callback)
* 获取直播间礼物统计
Parameters
* roomID: String
* pageNumber: int
* pageSize: int
* callback: [QLiveCallBack](https://developer.qiniu.com/lowcode/api/12052/QLiveCallBack)
Returns void
getAnchorGiftStatistics
* public void getAnchorGiftStatistics(int pageNumber,int pageSize,QLiveCallBack callback)
* 获取主播礼物统计
Parameters
* pageNumber: int
* pageSize: int
* callback: [QLiveCallBack](https://developer.qiniu.com/lowcode/api/12052/QLiveCallBack)
Returns void
getUserGiftStatistics
* public void getUserGiftStatistics(int pageNumber,int pageSize,QLiveCallBack callback)
* 获取用户礼物统计
Parameters
* pageNumber: int
* pageSize: int
* callback: [QLiveCallBack](https://developer.qiniu.com/lowcode/api/12052/QLiveCallBack)
Returns void
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) > [android
API文档](https://developer.qiniu.com/lowcode/api/12032/the-android-api-
documentation) > QRooms
# QRooms
最近更新时间: 2022-10-31 14:18:46
interface com.qlive.sdk.QRooms
房间管理接口
Index
方法
* createRoom
* deleteRoom
* getRoomInfo
* listRoom
* liveRecord
* getLiveStatistics
* getGiftConfig
* getLiveGiftStatistics
* getAnchorGiftStatistics
* getUserGiftStatistics
方法
createRoom
* public void createRoom(QCreateRoomParam param,QLiveCallBack callBack)
* 创建房间
Parameters
* param: [QCreateRoomParam](https://developer.qiniu.com/lowcode/api/12057/QCreateRoomParam)
创建房间参数
* callBack: [QLiveCallBack](https://developer.qiniu.com/lowcode/api/12052/QLiveCallBack)
Returns void
deleteRoom
* public void deleteRoom(String roomID,QLiveCallBack callBack)
* 删除房间
Parameters
* roomID: String
房间ID
* callBack: [QLiveCallBack](https://developer.qiniu.com/lowcode/api/12052/QLiveCallBack)
Returns void
getRoomInfo
* public void getRoomInfo(String roomID,QLiveCallBack callBack)
* 根据ID获取房间信息
Parameters
* roomID: String
房间ID
* callBack: [QLiveCallBack](https://developer.qiniu.com/lowcode/api/12052/QLiveCallBack)
Returns void
listRoom
* public void listRoom(int pageNumber,int pageSize,QLiveCallBack callBack)
* 房间列表
Parameters
* pageNumber: int
* pageSize: int
* callBack: [QLiveCallBack](https://developer.qiniu.com/lowcode/api/12052/QLiveCallBack)
Returns void
liveRecord
* public void liveRecord(int pageNumber,int pageSize,QLiveCallBack callBack)
* 我的直播记录
Parameters
* pageNumber: int
* pageSize: int
* callBack: [QLiveCallBack](https://developer.qiniu.com/lowcode/api/12052/QLiveCallBack)
Returns void
getLiveStatistics
* public void getLiveStatistics(String roomID,QLiveCallBack callBack)
* 获取直播间数据统计
Parameters
* roomID: String
* callBack: [QLiveCallBack](https://developer.qiniu.com/lowcode/api/12052/QLiveCallBack)
Returns void
getGiftConfig
* public void getGiftConfig(int type,QLiveCallBack callback)
* 获取礼物配置
Parameters
* type: int
礼物类型 -1代表全部
* callback: [QLiveCallBack](https://developer.qiniu.com/lowcode/api/12052/QLiveCallBack)
Returns void
getLiveGiftStatistics
* public void getLiveGiftStatistics(String roomID,int pageNumber,int pageSize,QLiveCallBack callback)
* 获取直播间礼物统计
Parameters
* roomID: String
* pageNumber: int
* pageSize: int
* callback: [QLiveCallBack](https://developer.qiniu.com/lowcode/api/12052/QLiveCallBack)
Returns void
getAnchorGiftStatistics
* public void getAnchorGiftStatistics(int pageNumber,int pageSize,QLiveCallBack callback)
* 获取主播礼物统计
Parameters
* pageNumber: int
* pageSize: int
* callback: [QLiveCallBack](https://developer.qiniu.com/lowcode/api/12052/QLiveCallBack)
Returns void
getUserGiftStatistics
* public void getUserGiftStatistics(int pageNumber,int pageSize,QLiveCallBack callback)
* 获取用户礼物统计
Parameters
* pageNumber: int
* pageSize: int
* callback: [QLiveCallBack](https://developer.qiniu.com/lowcode/api/12052/QLiveCallBack)
Returns void
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,611 |
QLiveStatus | 低代码 | [低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) > [android
API文档](https://developer.qiniu.com/lowcode/api/12032/the-android-api-
documentation) > QLiveStatus
# QLiveStatus
最近更新时间: 2022-07-11 09:58:05
class com.qlive.core.QLiveStatus
直播状态枚举
Index
字段
* PREPARE
* ON
* ANCHOR_ONLINE
* ANCHOR_OFFLINE
* OFF
方法
* values
* valueOf
字段
PREPARE
* public static final [QLiveStatus](https://developer.qiniu.com/lowcode/api/12051/QLiveStatus) PREPARE
* 房间已创建
ON
* public static final [QLiveStatus](https://developer.qiniu.com/lowcode/api/12051/QLiveStatus) ON
* 房间已发布
ANCHOR_ONLINE
* public static final [QLiveStatus](https://developer.qiniu.com/lowcode/api/12051/QLiveStatus) ANCHOR_ONLINE
* 主播上线
ANCHOR_OFFLINE
* public static final [QLiveStatus](https://developer.qiniu.com/lowcode/api/12051/QLiveStatus) ANCHOR_OFFLINE
* 主播已离线
OFF
* public static final [QLiveStatus](https://developer.qiniu.com/lowcode/api/12051/QLiveStatus) OFF
* 房间已关闭
方法
values
* public static com.qlive.core.QLiveStatus[] values();
* Returns [QLiveStatus](https://developer.qiniu.com/lowcode/api/12051/QLiveStatus)
valueOf
* public static com.qlive.core.QLiveStatus valueOf(java.lang.String name);
* Returns [QLiveStatus](https://developer.qiniu.com/lowcode/api/12051/QLiveStatus)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[低代码](https://developer.qiniu.com/lowcode) > API 文档 >
[互动直播](https://developer.qiniu.com/lowcode/api/12007/qlive-api) > [android
API文档](https://developer.qiniu.com/lowcode/api/12032/the-android-api-
documentation) > QLiveStatus
# QLiveStatus
最近更新时间: 2022-07-11 09:58:05
class com.qlive.core.QLiveStatus
直播状态枚举
Index
字段
* PREPARE
* ON
* ANCHOR_ONLINE
* ANCHOR_OFFLINE
* OFF
方法
* values
* valueOf
字段
PREPARE
* public static final [QLiveStatus](https://developer.qiniu.com/lowcode/api/12051/QLiveStatus) PREPARE
* 房间已创建
ON
* public static final [QLiveStatus](https://developer.qiniu.com/lowcode/api/12051/QLiveStatus) ON
* 房间已发布
ANCHOR_ONLINE
* public static final [QLiveStatus](https://developer.qiniu.com/lowcode/api/12051/QLiveStatus) ANCHOR_ONLINE
* 主播上线
ANCHOR_OFFLINE
* public static final [QLiveStatus](https://developer.qiniu.com/lowcode/api/12051/QLiveStatus) ANCHOR_OFFLINE
* 主播已离线
OFF
* public static final [QLiveStatus](https://developer.qiniu.com/lowcode/api/12051/QLiveStatus) OFF
* 房间已关闭
方法
values
* public static com.qlive.core.QLiveStatus[] values();
* Returns [QLiveStatus](https://developer.qiniu.com/lowcode/api/12051/QLiveStatus)
valueOf
* public static com.qlive.core.QLiveStatus valueOf(java.lang.String name);
* Returns [QLiveStatus](https://developer.qiniu.com/lowcode/api/12051/QLiveStatus)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 11,615 |
Subsets and Splits