如果要使用参会人的相关功能,就需要将用户注册为参会人才能使用。
获取必备静态参数:https://api-help.31huiyi.com/zh/registerParams
如果拿不到管理后台账号或者根据此接口文档获取必要参数: https://api-help.31huiyi.com/zh/new-getTypeList
注册参会人之前,首先要在主办方后台创建会议和创建人群类别。参会人注册用到的动态字段需要通过这两个参数来获取。
选项型字段需要传code值过来不要传文本过来。
手机或邮箱必须要有一个
Path: {$OpenAPIHost}/op/notoken/api/Attendee/v1/Register
Method: POST
接口描述:
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| InvitationCode | string | 非必须 | 邀约码 | ||
| BventId | string | 必须 | 会议id | ||
| AttendeeTypeId | string | 必须 | 类别id | ||
| Attendee | object | 必须 | 参会人字段 | ||
| ├─ Fields | object [] | 非必须 | item 类型: object | ||
| ├─ FieldName | string | 必须 | 字段名 | ||
| ├─ FieldValue | string | 必须 | 字段值 | ||
| Purchaser | object | 非必须 | 联系人(当联系人和参会人为同一人时不填) | ||
| ├─ Name | string | 非必须 | 联系人姓名 | ||
| ├─ AreaCode | string | 非必须 | 手机区号(例如+86) | ||
| ├─ Mobile | string | 非必须 | 联系人手机号 | ||
| ├─ Company | string | 非必须 | 公司 | ||
| Items | object [] | 必须 | 商品(门票商品必须) | item 类型: object | |
| ├─ ItemSkuId | string | 必须 | 商品id | ||
| ├─ ItemSkuName | string | 必须 | 商品名称 | ||
| ├─ Quantity | string | 必须 | 数量 | ||
| Agendas | object [] | 非必须 | 日程 | item 类型: object | |
| ├─ AgendaId | string | 非必须 | 日程id | ||
| ├─ ParentSkuId | string | 非必须 | 父级商品id |
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| data | object | 非必须 | |||
| ├─ status | number | 非必须 | |||
| ├─ orderId | string | 非必须 | 订单号 | ||
| ├─ orderNo | string | 非必须 | 订单编号 | ||
| ├─ orderStatus | string | 非必须 | 订单状态 | ||
| ├─ orderAmount | number | 非必须 | 订单金额 | ||
| ├─ orderType | string | 非必须 | 订单类型(main:主订单,) | ||
| ├─ orderAttendees | object [] | 非必须 | 订单参会人 | item 类型: object | |
| ├─ attendeeId | string | 非必须 | 参会人id | ||
| ├─ name | string | 非必须 | 参会人名称 | ||
| ├─ mobile | string | 非必须 | 手机号 | ||
| businessMessage | string | 非必须 | 业务消息 | ||
| businessCode | number | 非必须 | 业务code | 0表示成功 |
示例请求参数
url:https://31api.31huiyi.com/op/notoken/api/Attendee/v1/Register
header:Content-Type: application/json; charset=utf-8
示例数据body:
{
"bventId": "",//会议id
"AttendeeTypeId": "",//参会人类别id
"Attendee": {
"Fields": [{
"fieldName": "FullName",
"fieldValue": "测试姓名"
},
{
"fieldName": "Mobile",
"fieldValue": ""
},
{
"fieldName": "Email",
"fieldValue": "邮箱"
},
{
"fieldName": "Company",
"fieldValue": "公司测试"
},
{
"fieldName": "Position",
"fieldValue": "职位"
}
]
},
"Items": [{
"ItemSkuId": "",//门票id
"ItemSkuName": "嘉宾",
"Quantity": 1
}]
}
返回示例:
{
"businessMessage": "",
"businessCode": 0,
"data": {
"status": 0,
"orderId": "b0e50000-6b13-9276-9e47-08d99f646f52",
"orderNo": "2111041526362863634",
"orderStatus": "Paid",
"orderAmount": 0.0,
"orderType": "Main",
"orderAttendees": [
{
"attendeeId": "b0e50000-6b13-9276-9e9a-08d99f646f52",
"attendeeAbstractType": 0,
"name": "test姓名",
"mobile": "15647474728",
"status": "",
"checkinCode":"1475765432202956800" //签到码
}
]
}
}