Create a Meeting
Create a meeting schedule.
Request URL
POST {base_url}/services/openapi/v1.0/room/meeting_create
Request parameters
Body parameters
Parameter | Required | Type | Description |
---|---|---|---|
subject | Yes | String | The subject of the meeting. |
startTime | Yes | Long | The start time of the meeting. Note: Enter timestamp instead of exact date and time. For
example, 1689928200 . |
endTime | Yes | Long | The end time of the meeting. Note:
|
hostId | Yes | Long | The member ID of the meeting organizer. Note: You can query the user's member ID
using the Query Multiple Users
interface. |
participantIds | No | Array <Long> | The member ID(s) of internal participant(s). Note:
|
guestEmails | No | Array <String> | The email address(es) of external participant(s). Note: Use a comma to separate multiple email
addresses. For example,
["test@yeastar.com","test2@yeastar.com"] . |
roomId | Yes | Long | The ID of the meeting room. Note: You
can query the meeting room ID using the Query Multiple Meeting Rooms
interface. |
notificationTimes | No | Array <Integer> | How far in advance should the system send meeting reminders
to participants before the meeting starts. (Unit:
minute). Valid
range: 5 - 1440. Note:
|
online | No | Boolean | Whether the meeting is a Microsoft Teams online meeting. Note: This parameter only takes effect when
Yeastar Workplace is integrated with Microsoft Teams or
Microsoft 365. Valid value:
|
repeat | No | Object <Repeat_Strategy> | The recurrence pattern of recurring meetings. |
meetingServices | No | Array <Meeting_Services> | The services for the meeting. |
remark | No | String | Remark. |
- Repeat_Strategy
-
Parameter Required Type Description type Yes String Recurring type. DAILY
: Repeat every few days.WEEKLY
: Repeat on a specific weekday of every few weeks.ABSOLUTE_MONTHLY
: Repeat on a specific date of every few months.RELATIVE_MONTHLY
: Repeat on a specific weekday of every few months.
frequency Yes Integer Recurring frequency. dayOfWeek No Array <Integer> The specific weekday of the week. Valid range: 1 - 7.
Note:1
represents Monday, and so on in sequence.dayOfMonth No Interger The specific date of the month. Valid range: 1 - 31.
Note:-1
represents the last day of a month.weekOfMonth No Integer The Xth specific weekday of the month. Valid range: -1 - 5.
Note:1
represents the first one, while-1
represents the last one.endDate Yes String The end date of the meeting recurring. Note: Enter the date using the ISO-8601 format with timezone extension, namelyYYYY-MM-DDThh:mm:ssTZD
. For example,2023-01-01T00:00:00+08:00[Asia/Shanghai]
. - Meeting_Servives
-
Parameter Required Type Description serviceType Yes String The name of the meeting service. notificationRules Yes Array <Notif_Rule> The notification rule of the meeting service. contactIds Yes Array <Long> The member ID of the internal service contacts. Note: Use a comma to separate multiple IDs. For example,[1001,1002]
.serviceRemark No String Remark for the meeting service.
Response parameters
Parameter | Type | Description |
---|---|---|
data | Object <Details> | The detailed information. |
status | String | The result of the request.
|
requestId | String | The ID of the request, which can be used to quickly locate the request. |
- Details
-
Parameter Type Description meetingId String Meeting ID. Note: For recurring meetings, only the meeting ID of the first meeting schedule will be returned.
Example
Request example
Create a meeting:
- Start at
2023-07-24 15:30:00
and end at2023-07-24 16:30:00
. - Repeat on the 1st Wednesday every month until
2024-07-23 UTC+8:00 Asia/Shanghai
. - Require the "Tech Support" meeting service, and notify the service contacts 15 minutes before the meeting starts.
POST /services/openapi/v1.0/room/meeting_create HTTP/1.1
Host: workplace.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJncmFudF90eXBlIjoiY2xpZW50X2NyZWRlbnRpYWxzIiwic2NvcGUiOlsiL29wZW5hcGkvIl0sImVudGVycHJpc2VfaWQiOjEwMDQzMywicmVnaW9uIjoiR0wiLCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiJiZTc0ZGY0OS1hNjdmLTQ2NzMtYTkzMi1iMzY3YWY4NDM5ZjYiLCJjbGllbnRfaWQiOiI3OTU2OGFhMC0wYjBkLTQyZjYtOGRiNC03OWExNmQ3MzQ3MmEiLCJ0cyI6MTY5MDE4MTA0NCwiZXhwX2luIjo4NjQwMH0.jEj9xU4KGu4phUKaIX1WLX_aW6ycjcU-iJV1_9b73QU
Content-Type: application/json
{
"subject": "Test Meeting",
"startTime": 1690183800,
"endTime": 1690187400,
"hostId": 466,
"participantIds": [3084,54172],
"guestEmails": ["test@yeastar.com","ete@test.com"],
"roomId": 2863,
"notificationTimes": [15],
"online":false,
"repeat":{
"type":"RELATIVE_MONTHLY",
"frequency":1,
"weekOfMonth":1,
"dayOfWeek":[3],
"endDate":"2024-07-23T00:00:00+08:00[Asia/Shanghai]"
},
"meetingServices":[
{
"serviceType":"Tech Support",
"notificationRules":[
{
"meetingStatus":"NOT_STARTED",
"notificationTime":15
}
],
"contactIds":[3084,2904],
"serviceRemark": "Test service"
}
],
"remark": "A Monthly Meeting"
}
Response example
HTTP/1.1 200 OK
{
"data": {
"meetingId": "WzEsNzM5ODQsMjMyMDYsMTY5MDk2MTQwMCwwXQ=="
},
"status": "Success",
"requestId": "ab27d634ceb575615221258623027790"
}