昌
APIP8V1_EncryptedInfoOnChain(zh-CN)
本协议接口提供密信、联系人、保险柜等链上加密信息。数据来源和相关规则遵循以下协议：
《FEIP7_MailOnChain》
《FEIP12_Contacts》
《FEIP17_Safe》
1. mailOnChain (链上密信接口)
根据筛选条件获取链上密信信息。
请求参数
{
"filterSender": [string, 按第一个输入地址筛选,参见“通用约定·筛选参数”],
"filterRecipient": [string, 按第一个输出地址筛选,参见“通用约定·筛选参数”],
"filterDeleted": [bool, 按是否已删除筛选,1为已删除，参见“通用约定·筛选参数”],
"filterAlg": [string, 按加密算法即data.alg的值筛选,参见“通用约定·筛选参数”],
"filterTxTimestamp": [string, 按交易时间戳筛选，参见“通用约定·筛选参数”],
"sortTxTimestamp": [string, 按交易时间戳排序，参见“通用约定·排序参数”],
"sortDeleted": [string, 按是否已删除排序，1为已删除，参见“通用约定·排序参数”],
"count": [int,本次请求数量，参见“通用约定·批量请求”],
"sequence": [int, 本次请求批次，参见“通用约定·批量请求”]
}
//请求还需加入timestamp、API的url(post)、requester、sign，用于验证身份和数据，参见“流程”或原协议.
响应参数
{
"mailList": [{
"alg": [string, 加密算法，data.alg的值],
"msgSend": [string, 第一个输入地址公钥加密的密文，data.msgSend的值],
"msgReci": [string, 第一个输出地址公钥加密的密文，data.msgReci的值],
"sender": [string, 第一个输入地址],
"recipient": [string, 第一个输出地址],
"deleted": [bool, 删除标记，1为已删除],
"txid": [string,交易id],
"txTimestamp": [timestamp,交易的时间戳],
"block": [int, 交易所在区块],
}
],
"heignt": [uint,响应时的最新区块高度]
}
//响应时还需加入sign，用于验证数据，参见“流程”或原协议.
返回值
code
msg
data
4000
No matching record.
signedRequest
2.contactsOnChain （链上联系人接口）
根据筛选条件获取链上联系人信息。
请求参数
{
"filterHost": [string, 按第一个输出地址筛选,参见“通用约定·筛选参数”],
"filterOperator": [string, 按第一个输入地址筛选,参见“通用约定·筛选参数”],
"filterDeleted": [bool, 按是否已删除筛选,1为已删除，参见“通用约定·筛选参数”],
"filterAlg": [string, 按加密算法即data.alg的值筛选,参见“通用约定·筛选参数”],
"filterTxTimestamp": [string, 按交易时间戳筛选，参见“通用约定·筛选参数”],
"sortTxTimestamp": [string, 按交易时间戳排序，参见“通用约定·排序参数”],
"sortDeleted": [string, 按是否已删除排序，1为已删除，参见“通用约定·排序参数”],
"count": [int,本次请求数量，参见“通用约定·批量请求”],
"sequence": [int, 本次请求批次，参见“通用约定·批量请求”]
}
//请求还需加入timestamp、API的url(post)、requester、sign，用于验证身份和数据，参见“流程”或原协议.
响应参数
{
"contactList": [{
"alg": [string, 加密算法，data.alg的值],
"msg": [string, 第一个输出地址公钥加密的密文，data.msg的值],
"host": [string, 第一个输出地址],
"operator": [string, 第一个输入地址],
"deleted": [bool, 删除标记，1为已删除],
"txid": [string,交易id],
"txTimestamp": [timestamp,交易的时间戳],
"block": [int, 交易所在区块],
}
],
"heignt": [uint,响应时的最新区块高度]
}
//响应时还需加入sign，用于验证数据，参见“流程”或原协议.
返回值
code
msg
data
4000
No matching record.
signedRequest
3.safeOnChain (链上保险柜接口)
根据筛选条件获取链上保险柜信息。
请求参数
{
"filterHost": [string, 按第一个输出地址筛选,参见“通用约定·筛选参数”],
"filterOperator": [string, 按第一个输入地址筛选,参见“通用约定·筛选参数”],
"filterDeleted": [bool, 按是否已删除筛选,1为已删除，参见“通用约定·筛选参数”],
"filterAlg": [string, 按加密算法即data.alg的值筛选,参见“通用约定·筛选参数”],
"filterTxTimestamp": [string, 按交易时间戳筛选，参见“通用约定·筛选参数”],
"sortTxTimestamp": [string, 按交易时间戳排序，参见“通用约定·排序参数”],
"sortDeleted": [string, 按是否已删除排序，1为已删除，参见“通用约定·排序参数”],
"count": [int,本次请求数量，参见“通用约定·批量请求”],
"sequence": [int, 本次请求批次，参见“通用约定·批量请求”]
}
//请求还需加入timestamp、API的url(post)、requester、sign，用于验证身份和数据，参见“流程”或原协议.
响应参数
{
"safeList": [{
"alg": [string, 加密算法，data.alg的值],
"msg": [string, 第一个输出地址公钥加密的密文，data.msg的值],
"host": [string, 第一个输出地址],
"operator": [string, 第一个输入地址],
"deleted": [bool, 删除标记，1为已删除],
"txid": [string,交易id],
"txTimestamp": [timestamp,交易的时间戳],
"block": [int, 交易所在区块],
}
],
"heignt": [uint,响应时的最新区块高度]
}
//响应时还需加入sign，用于验证数据，参见“流程”或原协议.
返回值
code
msg
data
4000
No matching record.
signedRequest
APIP9V1_GroupInfo(zh-CN)
本协议接口提供链上注册的各种群的相关信息。数据来源和相关规则遵循以下协议：
《FEIP19_Group》
1.gidInfoList (gid列表接口)
给定一个或多个gid获取除成员列表以外的群信息。
请求参数
{
"gidList": [string array, gid列表, 必填]
}
//请求还需加入timestamp、API的url(post)、requester、sign，用于验证身份和数据，参见“流程”或原协议.
响应参数
{
"gidInfoList": [{
"gid": [string, 群的gid],
"name": [string,群名，data.name的值],
"desc": [string,群的描述，data.desc的值],
"memberNumber": [uint64, 活跃成员的数量],
"sponsor": [string, 创建群的交易的第一个输入地址],
"updater": [string, 最后更新群信息的交易的第一个输入地址],
"firstTime": [timestamp,发布时间戳],
"lastTxid": [string, 群信息最后更新的txid],
"lastTime": [timestamp,群信息最后更新的时间戳],
"tCdd": [int64, 该群创建、更新和加群操作的所有交易累计销毁的币天]
}
],
"heignt": [uint,响应时的最新区块高度]
}
//响应时还需加入sign，用于验证数据，参见“流程”或原协议.
返回值
code
msg
data
9000
These GIDs do not exist.
missedGidList
9001
Too many GIDs are requested.
maxGidCount
2. gidDetails (群详情接口)
给定一个gid获取其包括群成员在内的全部信息。
请求参数
{
"gid": [string, 群的gid，必填]
}
响应参数
{
"gid": [string, 群的gid],
"name": [string,群名，data.name的值],
"desc": [string,群的描述，data.desc的值],
"memberNumber": [uint64, 活跃成员的数量],
"activeMembers": [string array, 活跃成员名单],
"exitedMembers": [string array, 已退出成员名单],
"sponsor": [string, 创建群的交易的第一个输入地址],
"updater": [string, 最后更新群信息的交易的第一个输入地址],
"firstTime": [timestamp,发布时间戳],
"lastTxid": [string,群信息最后更新的txid],
"lastTime": [timestamp,群信息最后更新的时间戳],
"tCdd": [int64, 该群创建、更新和加群操作的所有交易累计销毁的币天]
"heignt": [uint,响应时的最新区块高度]
}
//响应时还需加入sign，用于验证数据，参见“流程”或原协议.
返回值
code
msg
data
9002
The GID does not exist.
gid
3. groupSearch (群搜索接口)
按条件查询群。
请求参数
{
"filterName": [string,模糊匹配data.name，参见“通用约定·筛选参数”],
"filterDesc": [string,模糊匹配data.desc，参见“通用约定·筛选参数”],
"filterSponsor": [string, 模糊匹配sponsor，参见“通用约定·筛选参数”],
"filterUpdater": [string, 模糊匹配updater，参见“通用约定·筛选参数”],
"filterMemberNumber": [string,按memberNumber筛选，参见“通用约定·筛选参数”],
"filterFirstTime": [string, 按发布的交易时间筛选，参见“通用约定·筛选参数”],
"filterLastTime": [string, 按发布的交易时间筛选，参见“通用约定·筛选参数”],
"filterTCdd": [string, 按tCdd筛选，参见“通用约定·筛选参数”],
"sortMemberNumber": [string,按memberNumber排序，参见“通用约定·排序参数”],
"sortFirstTime": [string, 按发布的交易时间戳排序，参见“通用约定·排序参数”],
"sortLastTime": [string, 按最后更新的交易时间戳排序，参见“通用约定·排序参数”],
"sortTCdd": [string, 按累计销毁币天tCdd排序，参见“通用约定·排序参数”],
"sortName": [string, 按data.name排序，参见“通用约定·排序参数”],
"count": [int,本次请求数量，参见“通用约定·批量请求”],
"sequence": [int, 本次请求批次，参见“通用约定·批量请求”]
}
响应参数
{
"gidInfoList": [{
"gid": [string, 群的gid],
"name": [string,群名，data.name的值],
"desc": [string,群的描述，data.desc的值],
"memberNumber": [uint64, 活跃成员的数量],
"sponsor": [string, 创建群的交易的第一个输入地址],
"updater": [string, 最后更新群信息的交易的第一个输入地址],
"firstTime": [timestamp,发布时间戳],
"lastTxid": [string, 群信息最后更新的txid],
"lastTime": [timestamp,群信息最后更新的时间戳],
"tCdd": [int64, 该群创建、更新和加群操作的所有交易累计销毁的币天]
}
],
"heignt": [uint,响应时的最新区块高度]
}
//响应时还需加入sign，用于验证数据，参见“流程”或原协议.
返回值
code
msg
data
4000
No matching record.
signedRequest
4. gidHistory (群历史接口)
查询某gid群的所有历史操作记录。
请求参数
{
"gid": [string, 群的gid, 必填],
"filterSigner": [string, 按第一个输入地址筛选，参见“通用约定·筛选参数”],
"filterOp": [string, 按datga.op筛选，参见“通用约定·筛选参数”],
"filterTxTimestamp": [string, 按交易时间戳筛选，参见“通用约定·筛选参数”],
"filterCdd": [string, 按cdd筛选，参见“通用约定·筛选参数”],
"sortOp": [string, 按data.op排序，参见“通用约定·排序参数”],
"sortTxTimestamp": [string, 按交易时间戳排序，参见“通用约定·排序参数”],
"sortCdd": [string, 按销毁币天排序，参见“通用约定·排序参数”],
"count": [int,本次请求数量，参见“通用约定·批量请求”],
"sequence": [int, 本次请求批次，参见“通用约定·批量请求”]
}
//请求还需加入timestamp、API的url(post)、requester、sign，用于验证身份和数据，参见“流程”或原协议.
响应参数
{
"gid": [string, 群的aid],
"name": [string，群名, data.name的最新值],
"opList ": [{
"op": [string, data.op的值],
"signer": [string,群的创建者，即建群交易的第一个输入地址],
"name": [string，群名, data.name的值],
"desc": [string,群的描述，data.desc的值],
"txid": [string, txid],
"txTimestamp": [timestamp,交易的时间戳],
"cdd": [int, 本交易销毁币天],
"block": [int, 交易所在区块]
}
],
"heignt": [uint,响应时的最新区块高度]
}
//响应时还需加入sign，用于验证数据，参见“流程”或原协议.
返回值
code
msg
data
9002
The GID does not exist.
gid
5. gidMemberSearch (群成员搜索接口)
模糊查询某gid群的某个cid或地址，不区分大小写。
请求参数
{
"gid": [string, 群的gid，必填],
"searchMember": [string, 在cid和address中模糊搜索的内容，必填]
}
响应参数
{
"gid": [string, 查询的群的gid],
"memberList": [string array, 包含searchMember的cid或address列表]
"heignt": [uint,响应时的最新区块高度]
}
//响应时还需加入sign，用于验证数据，参见“流程”或原协议.
返回值
code
msg
data
4000
No matching record.
没有符合条件的信息。
6. myGroupList (我的群列表接口)
模糊查询某address当前参与和已经退出的群列表。
请求参数
{
"address": [string，FCH地址，必填],
"filterMemberStatus": [string, 按成员状态筛选，包括“active”和“exited”两种状态，参见“通用约定·筛选参数”],
}
响应参数
{
"gidInfoList": [{
"memberStatus": [string, 在该群的成员状态，“active”或“exited”],
"gid": [string, 群的gid],
"name": [string,群名，data.name的值],
"desc": [string,群的描述，data.desc的值],
"memberNumber": [uint64, 活跃成员的数量],
"sponsor": [string, 创建群的交易的第一个输入地址],
"updater": [string, 最后更新群信息的交易的第一个输入地址],
"firstTime": [timestamp,发布时间戳],
"lastTxid": [string, 群信息最后更新的txid],
"lastTime": [timestamp,群信息最后更新的时间戳],
"tCdd": [int64, 该群创建、更新和加群操作的所有交易累计销毁的币天]
}
],
"heignt": [uint,响应时的最新区块高度]
}
//响应时还需加入sign，用于验证数据，参见“流程”或原协议.
返回值
code
msg
data
4000
No matching record.
没有符合条件的信息。
APIP10V1_OrganizationInfo(zh-CN)
本协议接口提供链上注册的各种组织的相关信息。数据来源和相关规则遵循以下协议：
《FEIP28_Organization》
1.oidInfoList (组织概况列表接口)
给定一个或多个oid获取除成员列表以外的组织信息。
请求参数
{
"oidList": [string array, oid列表, 必填]
}
//请求还需加入timestamp、API的url(post)、requester、sign，用于验证身份和数据，参见“流程”或原协议.
响应参数
{
"oidInfoList": [{
"oid": [string, 组织的oid],
"owner": [string, 创建组织的交易的第一个输入地址],
"stdName": [string，组织的标准名, data.stdName的值],
"localName": [string array，组织的其他名称, data.localName的值],
"desc": [string,组织的描述，data.desc的值],
"memberNumber": [uint64, 活跃成员的数量],
"firstTime": [timestamp,创建交易的时间戳],
"lastTxid": [string, 组织最新操作的txid],
"lastTime": [timestamp,组织最新操作的时间戳],
"tCdd": [int64, data.op为“rate”的所有交易的累计币天销毁],
"tRate": [float, 服务的综合评分,tRate=(tCdd\*tRate+cdd\*rate)/(tCdd+cdd)]
}
],
"heignt": [uint,响应时的最新区块高度]
}
//响应时还需加入sign，用于验证数据，参见“流程”或原协议.
返回值
code
msg
data
1100
These OIDs do not exist.
missedOidList
1101
Too many OIDs are requested.
maxOidCount
2. memberList (组织成员列表接口)
获取oid的各种状态的成员列表。
请求参数
{
"oid": [string, 组织的oid，必填],
"filterMemberStatus": [string, 按成员状态筛选，包括“owner”，“active”，“administrators”，“exiting”和“delisted”5种状态，参见“通用约定·筛选参数”],
}
响应参数
{
"oid": [string, 组织的oid],
"owner": [string, 创建组织的交易的第一个输入地址],
"activeMembers": [string array, 活跃成员名单],
"exitingMembers": [string array, 已申请退出尚未除名的成员名单],
"administrators": [string array, 管理员名单],
"delistedMembers": [string array, 已除名成员名单],
"heignt": [uint,响应时的最新区块高度]
}
//响应时还需加入sign，用于验证数据，参见“流程”或原协议.
返回值
code
msg
data
1102
The OID does not exist.
oid
3. organizationSearch (组织搜索接口)
按条件查询组织。
请求参数
{
"filterStdName": [string,模糊匹配data.stdName，参见“通用约定·筛选参数”],
"filterLocalName": [string,模糊匹配data.localName，参见“通用约定·筛选参数”],
"filterDesc": [string,模糊匹配data.desc，参见“通用约定·筛选参数”],
"filterMemberNumber": [string,按memberNumber筛选，参见“通用约定·筛选参数”],
"filterFirstTime": [string, 按发布的交易时间筛选，参见“通用约定·筛选参数”],
"filterLastTime": [string, 按发布的交易时间筛选，参见“通用约定·筛选参数”],
"filterTCdd": [string, 按累计币天销毁tCdd筛选，参见“通用约定·筛选参数”],
"filterTRate": [string, 按总和评分tRate筛选，参见“通用约定·筛选参数”],
"sortMemberNumber": [string,按memberNumber排序，参见“通用约定·排序参数”],
"sortFirstTime": [string, 按发布的交易时间戳排序，参见“通用约定·排序参数”],
"sortLastTime": [string, 按最后更新的交易时间戳排序，参见“通用约定·排序参数”],
"sortTCdd": [string, 按累计销毁币天tCdd排序，参见“通用约定·排序参数”],
"sortStdName": [string, 按data.stdName排序，参见“通用约定·排序参数”],
"count": [int,本次请求数量，参见“通用约定·批量请求”],
"sequence": [int, 本次请求批次，参见“通用约定·批量请求”]
}
响应参数
{
"oidInfoList": [{
"oid": [string, 组织的oid],
"owner": [string, 创建组织的交易的第一个输入地址],
"stdName": [string，组织的标准名, data.stdName的值],
"localName": [string array，组织的其他名称, data.localName的值],
"desc": [string,组织的描述，data.desc的值],
"memberNumber": [uint64, 活跃成员的数量],
"firstTime": [timestamp,发布时间戳],
"lastTxid": [string, 组织信息最后更新的txid],
"lastTime": [timestamp,组织信息最后更新的时间戳],
"tCdd": [int64, data.op为“rate”的所有交易的累计币天销毁],
"tRate": [float, 服务的综合评分,tRate=(tCdd\*tRate+cdd\*rate)/(tCdd+cdd)]
}
],
"heignt": [uint,响应时的最新区块高度]
}
//响应时还需加入sign，用于验证数据，参见“流程”或原协议.
返回值
code
msg
data
4000
No matching record.
signedRequest
4. oidHistory (组织历史接口)
查询某oid组织的除rate操作外的所有历史操作记录。
请求参数
{
"oid": [string, 组织的oid, 必填],
"filterSigner": [string, 按第一个输入地址筛选，参见“通用约定·筛选参数”],
"filterOp": [string, 按除了“rate”以外的10种datga.op值筛选，参见“通用约定·筛选参数”],
"filterTxTimestamp": [string, 按交易时间戳筛选，参见“通用约定·筛选参数”],
"sortOp": [string, 按data.op排序，参见“通用约定·排序参数”],
"sortTxTimestamp": [string, 按交易时间戳排序，参见“通用约定·排序参数”],
"count": [int,本次请求数量，参见“通用约定·批量请求”],
"sequence": [int, 本次请求批次，参见“通用约定·批量请求”]
}
//请求还需加入timestamp、API的url(post)、requester、sign，用于验证身份和数据，参见“流程”或原协议.
响应参数
{
"oid": [string, 组织的aid],
"stdName": [string，组织的标准名, data.stdName的值],
"opList ": [{
"op": [string, data.op的值],
"signer": [string,组织的创建者，即建组织交易的第一个输入地址],
"recipients": [string array, 所有输出地址列表],
"stdName": [string，组织的标准名, data.stdName的值],
"localName": [string array，组织的其他名称, data.localName的值],
"desc": [string,组织的描述，data.desc的值],
"days": [string,邀请的有效时间，data.days的值],
"txid": [string, txid],
"txTimestamp": [timestamp,交易的时间戳],
"cdd": [int, 本交易销毁币天],
"block": [int, 交易所在区块]
}
],
"heignt": [uint,响应时的最新区块高度]
}
//响应时还需加入sign，用于验证数据，参见“流程”或原协议.
返回值
code
msg
data
1102
The OID does not exist.
oid
5. oidMemberSearch (组织成员搜索接口)
在活跃成员中模糊查询某oid组织的某个cid或地址，不区分大小写。
请求参数
{
"oid": [string, 组织的oid，必填],
"searchMember": [string, 在cid和address中模糊搜索的内容，必填]
}
响应参数
{
"oid": [string, 查询的组织的oid],
"memberList": [string array, 包含searchMember的cid或address列表]
"heignt": [uint,响应时的最新区块高度]
}
//响应时还需加入sign，用于验证数据，参见“流程”或原协议.
返回值
code
msg
data
4000
No matching record.
没有符合条件的信息。
6. myGroupList (我的组织列表接口)
模糊查询某address当前拥有、当前参与、担任管理员、声明退出或已经退出的组织列表。
请求参数
{
"address": [string，FCH地址，必填],
"filterMemberStatus": [string, 按成员状态筛选，包括“owner”，“active”，“administrators”，“exiting”和“delisted”5种状态，参见“通用约定·筛选参数”],
}
响应参数
{
"oidInfoList": [{
"memberStatus": [string, 在该组织的成员状态，“owner”，“active”，“administrators”，“exiting”和“delisted”5种状态之一],
"oid": [string, 组织的oid],
"owner": [string, 创建组织的交易的第一个输入地址],
"stdName": [string，组织的标准名, data.stdName的值],
"localName": [string array，组织的其他名称, data.localName的值],
"desc": [string,组织的描述，data.desc的值],
"memberNumber": [uint64, 活跃成员的数量],
"firstTime": [timestamp,发布时间戳],
"lastTxid": [string, 组织信息最后更新的txid],
"lastTime": [timestamp,组织信息最后更新的时间戳],
"tCdd": [int64, data.op为“rate”的所有交易的累计币天销毁],
"tRate": [float, 服务的综合评分,tRate=(tCdd\*tRate+cdd\*rate)/(tCdd+cdd)]
}
],
"heignt": [uint,响应时的最新区块高度]
}
//响应时还需加入sign，用于验证数据，参见“流程”或原协议.
返回值
code
msg
data
4000
No matching record.
没有符合条件的信息。
7. oidRateList (组织评价列表接口)
查询对某oid组织的评价信息，即data.op值为“rate”的记录。
请求参数
name
type
description
required
oid
string
Y
filterRate
uint
Filter by data.rate
N
filterCdd
string
Filter by cdd
N
filterTxTimestamp
string
Filter by txTimestamp
N
filterRater
string
Filter by the address of the first input of the rating transaction
N
sortTxTimestamp
string
Sort by txTimestamp
N
sortCdd
string
Sort by cdd
N
sortRate
string
Sort by data.rate
N
sortRater
string
Sort by the address of the first input of the rating transaction
N
count
uint
How many entries are wanted in a single request.
N
sequence
uint
Sequence in continuous request.Start from 0.
N
请求参数
{
"oid": [string, 组织的oid],
"filterRate": [string, 按评分data.rate的值筛选，参见“通用约定·筛选参数”],
"filterCdd": [string, 按销毁币天筛选，参见“通用约定·排序参数”],
"filterTxTimestamp": [string, 按交易时间戳筛选，参见“通用约定·筛选参数”],
"filterRater": [string, 按评价者筛选，参见“通用约定·筛选参数”],
"sortTxTimestamp": [string, 按交易时间戳排序，参见“通用约定·排序参数”],
"sortCdd": [string, 按销毁币天排序，参见“通用约定·排序参数”],
"sortRate": [string, 按data.rate的值排序，参见“通用约定·排序参数”],
"sortRater": [string, 按评价者排序，参见“通用约定·排序参数”],
"count": [int,本次请求数量，参见“通用约定·批量请求”],
"sequence": [int, 本次请求批次，参见“通用约定·批量请求”]
}
响应参数
{
"oid": [string, 组织的oid],
"rateList ": [{
"rater": [string, 评价者地址],
"rate": [uint, 评分data.rate的值],
"cdd": [int64, 销毁币天值],
"txid": [string,交易id],
"txTimestamp": [timestamp,交易的时间戳],
"block": [int, 交易所在区块]
}
],
"heignt": [uint,响应时的最新区块高度]
}
//响应时还需加入sign，用于验证数据，参见“流程”或原协议.
返回值
code
msg
data
1102
The OID does not exist.
oid
4000
No matching record.
signedRequest