createBlankTask

This API endpoint allows you to create a new appointment by specifying the appointment time, the details of the person making the reservation, and the details of the host's organization. The API will schedule the appointment and include all relevant details for both the host and the person making the reservation.

Request:

example

{
    "business_id": 15,
    "out_task_num": "XXXXXXXXX",
    "out_task_type": "XXXXXXXXX",
    "task_type": "normal",
    "task_notify": false,
    "task_time": "1703141398",
    "task_remark": "remark_somthing",
    "branch_code": 943,
    "business_code": 2,
    "room_type": "normal",
    "video": true
}

Parameter	Meaning	Type	Required	Default value	Description
`HEADERS`
Authorization	After logging in, the server returns an Authorization token.	string	Y	Bearer

`BODY`
business_id	Business Process ID	number	Y
out_task_num	Externally Accessible Unique Identifier	string	Y
out_task_type	Externally Accessible Type Identifier	string	N
task_type	Case Classification	string	Y		normal:General Appointment
custom:Customer Service Case
task_notify	Create Notification	boolean	Y	false	Considerations for Sending Notifications
task_time	Scheduled Video Appointment Time	string	N	Defaults to the current time if not provided.	Required if `room_type` is `normal`
task_remarks	Remarks	string	N
branch_code	A unique code for the department or unit where the appointment is scheduled.	string	Y
business_code	The office or department type responsible for the task.	string	N
room_type	Video Appointment Types	enum	Y		realtime:Real-Time Video room
normal:Scheduled Video room
video	a video call is required for the appointment or meeting	string	Y
true
false

Response:

{
    "status": 1,
    "message": "success",
    "info": {
        "task_num": "202312210000001"
    }
}

Parameter	Meaning	Type	Existed	Description
`BODY`
status	response status	string	Y	0: fail
1: success
2: warning
message	message	string	Y	Error messages should be shown when there are errors.
info	Return Information	object	Y
task_num	task number	string	Y

Error code:

The following is a table of error messages returned by the API.

Code	Status	Message
`200`	1	success
	0	error message
`404`		Resource Not Found
`403`		Access to the requested resource is not allowed