Pwyntiau Terfynol sydd ar Gael

Dylid postio pob cais i URL Sylfaen a ddarperir a rhaid iddo gynnwys tocyn Cludwr dilys (gweler Dilysu ) ynghyd ag unrhyw gynnwys corff wedi'i fformatio JSON lle bo angen. Darperir yr URL Sylfaen fel rhan o'ch ymsefydlu API.

Apwyntiadau

Mae'r Apwyntiadau Endpoint yn caniatáu ichi drefnu, rheoli a chanslo apwyntiadau.

Enghraifft o gais i greu apwyntiad

import requests

url = "{Base_URL}/api/v1/appointments"

payload = {
'reference': 'SXW5qOJBYeIEf0G',
'appointment_at': '2025-08-19T16:50:00.000000',
'duration_in_minutes': '30',
'is_interpreter_needed': 'false',
'interpreter_language': '',
'department': '',

# Claimant details
'claimant[name]': 'John Doe',
'claimant[date_of_birth]': '1990-01-01',
'claimant[phone_number]': '+442071234567',
'claimant[email]': 'test@test.com',

# Feature flags
'features_call_recording_enable': 'false',
'features_breakout_room_enable': 'false',
'features_webcam_access_agent_enable': 'true',
'features_webcam_access_claimant_enable': 'true',
'features_webcam_background_blurring_enable': 'false',
'features_microphone_access_enable': 'true',
'features_screen_sharing_enable': 'false',
'features_messages_chat_enable': 'false',
'features_participant_list_enable': 'false',
'features_bandwidth': '',

# Redirect options
'use_custom_post_call_redirect': 'false',
'custom_user_post_call_redirect_url': '',
'custom_agent_post_call_redirect_url': 'https://www.sampleurl.co.uk'
}

headers = {
'Accept': 'application/json',
'Authorization': 'Bearer YOUR_ACCESS_TOKEN'
}

response = requests.post(url, headers=headers, data=payload)

print(response.text)

Ymateb Enghraifft

{
    "data": {
        "id": "9fac14a0-4829-4b7b-b3d6-d2b189290409",
        "reference": "SXW5qOJBYeIEf0G",
        "appointment_at": "2025-08-19T16:50:00.000000Z",
        "duration_in_minutes": 30,
        "is_interpreter_needed": false,
        "interpreter_language": null,
        "status": "scheduled",
        "url": "{Base-URL}/client-web/schedule/pre-call/summary?reference=SXW5qOJBYeIEf0G",
        "created_at": "2025-08-19T14:38:12.000000Z",
        "cancelled_at": null,
        "cancellation_reason": null,
        "department": null,
        "claimant": {
            "name": "John Doe",
            "date_of_birth": "1990-01-01",
            "phone_number": "+442071234567",
            "email": "test@test.com",
            "data": []
        },
        "meeting": {
            "id": "108330411",
            "room_name": "/bdf24dae-87e0-4925-bf28-9b6dfabc685c",
            "room_url": "https://involve-visual.whereby.com/bdf24dae-87e0-4925-bf28-9b6dfabc685c?roomKey=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJtZWV0aW5nSWQiOiIxMDgzMzA0MTEiLCJyb29tUmVmZXJlbmNlIjp7InJvb21OYW1lIjoiL2JkZjI0ZGFlLTg3ZTAtNDkyNS1iZjI4LTliNmRmYWJjNjg1YyIsIm9yZ2FuaXphdGlvbklkIjoiMTgwMjk1In0sImlzcyI6Imh0dHBzOi8vYWNjb3VudHMuc3J2LndoZXJlYnkuY29tIiwiaWF0IjoxNzU1NjE0MjkyLCJyb29tS2V5VHlwZSI6Im1lZXRpbmdIb3N0In0.U4Gk0fqI-R3Kd0bRGQcKw5_8LxtuDlly0wwrTuEAKdU&metadata=O%3A24%3A%22App%5CDto%5CWhereby%5CMetadata%22%3A3%3A%7Bs%3A4%3A%22type%22%3BE%3A45%3A%22App%5CEnum%5CWhereby%5CMetadataTypeEnum%3AAPPOINTMENT%22%3Bs%3A6%3A%22typeId%22%3Bs%3A36%3A%229fac14a0-4829-4b7b-b3d6-d2b189290409%22%3Bs%3A6%3A%22userId%22%3Bs%3A36%3A%229f8fb625-5a38-4221-b742-1ce22508b096%22%3B%7D&breakout=off&cameraAccess=on&audio=on&screenshare=off&chat=off&people=off&autoSpotlight=on&floatSelf=on&participantCount=off&localization=off&precallReview=off",
            "start_date": "2025-08-19T14:38:12+00:00",
            "end_date": "2025-08-19T23:59:59+00:00"
        },
        "session_started_at": null,
        "session_ended_at": null,
        "on_hold_started_at": null,
        "on_hold_ended_at": null,
        "features_call_recording_enable": false,
        "features_breakout_room_enable": false,
        "features_webcam_access_agent_enable": true,
        "features_webcam_access_claimant_enable": true,
        "features_webcam_background_blurring_enable": false,
        "features_microphone_access_enable": true,
        "features_screen_sharing_enable": false,
        "features_messages_chat_enable": false,
        "features_participant_list_enable": false,
        "features_bandwidth": null,
        "use_custom_post_call_redirect": false,
        "custom_user_post_call_redirect_url": null,
        "custom_agent_post_call_redirect_url": "https://www.sampleurl.co.uk"
    }
}