用户收发通
创建收发通信息
创建用户收发通信息（用户联系人）
POST https://jianyiyun.com/open_v1/user_contacts/create
免费API 需要登录者信息，即Cookie内需增加X-JYY-UserId和X-JYY-SecurityHash，否则视为匿名请求，无权限。
X-JYY-UserId和X-JYY-SecurityHash字段在登录时已提供。
收费API 无需传递 X-JYY-UserId 与 X-JYY-SecurityHash cookie
Headers
Api-Key*
String
sk-xkze4N8V...lyUTKY93
Content—Type*
String
application/x-www-form-urlencoded
Cookies
X-JYY-UserId*
String
200...nDc
X-JYY-SecurityHash*
String
dal...3jk
Request Body
name*
String
联系人名
address*
String
联系人地址
type*
enum
联系人类型，详见UserContactType 枚举
phone
String
联系人手机号
landline
String
联系人座机号
fax
String
联系人传真号
String
联系人邮箱地址
remakr
String
联系人备注信息
修改收发通信息
修改收发通信息
POST https://jianyiyun.com/open_v1/user_contacts/{id}
这个接口需要登录者信息，即Cookie内需增加X-JYY-UserId和X-JYY-SecurityHash，否则视为匿名请求，无权限。
X-JYY-UserId和X-JYY-SecurityHash字段在登录时已提供。
Path Parameters
id*
String
联系人信息id
Headers
Api-Key*
String
sk-xkze4N8V...lyUTKY93
Content-Type*
String
application/x-www-form-urlencoded
Cookies
X-JYY-UserId*
String
200...nDc
X-JYY-SecurityHash*
String
dal...3jk
Request Body
name
String
联系人名
传该参数时才修改
address
String
联系人地址
传该参数时才修改
phone
String
联系人手机号
传该参数时才修改
landline
String
联系人座机号
传该参数时才修改
fax
String
联系人传真号
传该参数时才修改
String
联系人邮箱地址
传该参数时才修改
remark
String
联系人备注信息
传该参数时才修改
{
// 收发通信息id（联系人信息id）
"id": "230525031422aZUpx23A",
// 创建时间，UTC时间戳
"addedAt": 1684984462872,
// 最后修改时间，UTC时间戳
"lastUpdatedAt": 1684985045187,
// 创建人
"createdBy": { User },
// 联系人名
"name": "dj - updated",
// 联系人地址
"address": "上海",
// 联系人手机号
"phone": "",
// 联系人邮箱地址
"email": "",
// 联系人备注信息
"remark": "",
// 联系人座机号
"landlineNumber": "",
// 联系人传真号
"faxNumber": "",
// 联系人类型，详情请见 UserContactsType 枚举
"type": "Shipper"
}删除收发通信息
删除收发通信息
DELETE https://jianyiyun.com/open_v1/user_contacts/{id}
这个接口需要登录者信息，即Cookie内需增加X-JYY-UserId和X-JYY-SecurityHash，否则视为匿名请求，无权限。
X-JYY-UserId和X-JYY-SecurityHash字段在登录时已提供。
Path Parameters
id*
String
联系人信息id
Headers
Api-Key*
String
sk-xkze4N8V...lyUTKY93
Cookies
X-JYY-UserId*
String
200...nDc
X-JYY-SecurityHash*
String
dal...3jk
查询用户的收发通信息
查询用户自己的收发通信息
GET https://jianyiyun.com/open_v1/user_contacts/query
这个接口需要登录者信息，即Cookie内需增加X-JYY-UserId和X-JYY-SecurityHash，否则视为匿名请求，无权限。
X-JYY-UserId和X-JYY-SecurityHash字段在登录时已提供。
Query Parameters
q
String
查询的文字，模糊匹配name 或 address，默认为null
type
enum
收发通类型，xiang jian详见UserContactType枚举，默认为null
page
int
页号，默认为0，第0页
size
int
分页大小，默认为20。最大值为200，若size超过200，会强制设置为200
Headers
Api-Key*
String
sk-xkze4N8V...lyUTKY93
Cookies
X-JYY-UserId*
String
200...nDc
X-JYY-SecurityHash*
String
dal...3jk
{
// 是否有下一页，布尔型
"hasNext": false,
// 总共记录的数量
"totalElements": 3,
// 分页数量
"totalPages": 1,
// 收发通信息，数组
"contacts": [
{ UserContacts },
...
]
}最后更新于