The WeSeeDo Personal API allows video calling in the right way and distinguishes itself in human contact, ease of use and safety.
openapi: 3.0.0
info:
title: WeSeeDo Personal - WeSeeDo
version: "v2.0.2"
description: >-
The WeSeeDo Personal API allows video calling in the right way and distinguishes itself in human contact, ease of use and safety.
### Key highlights
- **Sandbox:** Full-fledged capabilities.
- **Security:** HTTPS, OAuth, Rate limit.
- **Versioning:** Supports version-less API, version tight. If no version
is provided (in header) it defaults to latest version.
---
[Source view](https://app.swaggerhub.com/apis/kpn/weseedo-personal-weseedo/)<br/>
[Documentation view](https://app.swaggerhub.com/apis-docs/kpn/weseedo-personal-weseedo/)
---
[KPN Developer](https://developer.kpn.com/)<br/>
[Getting Started](https://developer.kpn.com/getting-started)
---
contact:
name: API Support
email: api_developer@kpn.com
url: "https://developer.kpn.com/support"
termsOfService: "https://developer.kpn.com/legal"
servers:
- url: https://api-prd.kpn.com/communication/weseedo/weseedopersonal
externalDocs:
description: HTTP response headers
url: https://developer.kpn.com/documentation-response-headers
tags:
- name: Personal
- name: Users
- name: Packages
paths:
/personal/meetings:
post:
summary: Creates a new meeting
description: Creates a new meeting.
tags:
- Personal
security:
- oauth2: []
parameters:
- $ref: "#/components/parameters/api_version"
- $ref: "#/components/parameters/user-email"
requestBody:
$ref: "#/components/requestBodies/MeetingObjectPost"
responses:
"200":
$ref: "#/components/responses/MeetingObject"
400:
$ref: "#/components/responses/bad_request"
401:
$ref: "#/components/responses/unauthorized"
403:
$ref: "#/components/responses/forbidden"
404:
$ref: "#/components/responses/not_found"
429:
$ref: "#/components/responses/too_many"
500:
$ref: "#/components/responses/server_error"
503:
$ref: "#/components/responses/service_unavailable"
get:
summary: Retrieves a list of meetings
description: Retrieves a list of meetings.
tags:
- Personal
security:
- oauth2: []
parameters:
- $ref: "#/components/parameters/api_version"
- $ref: "#/components/parameters/MeetingQueryCompanyParameter"
responses:
"200":
$ref: "#/components/responses/MeetingObjectArray"
400:
$ref: "#/components/responses/bad_request"
401:
$ref: "#/components/responses/unauthorized"
403:
$ref: "#/components/responses/forbidden"
404:
$ref: "#/components/responses/not_found"
429:
$ref: "#/components/responses/too_many"
500:
$ref: "#/components/responses/server_error"
503:
$ref: "#/components/responses/service_unavailable"
"/personal/meetings/{id}":
get:
summary: Retrieves a meeting
description: Retrieves information about a meeting.
tags:
- Personal
security:
- oauth2: []
parameters:
- $ref: "#/components/parameters/api_version"
- $ref: "#/components/parameters/MeetingIDParameter"
responses:
"200":
$ref: "#/components/responses/MeetingObject"
400:
$ref: "#/components/responses/bad_request"
401:
$ref: "#/components/responses/unauthorized"
403:
$ref: "#/components/responses/forbidden"
404:
$ref: "#/components/responses/not_found"
429:
$ref: "#/components/responses/too_many"
500:
$ref: "#/components/responses/server_error"
503:
$ref: "#/components/responses/service_unavailable"
delete:
summary: Deletes a meeting
description: Deletes a specific meeting.
tags:
- Personal
security:
- oauth2: []
parameters:
- $ref: "#/components/parameters/api_version"
- $ref: "#/components/parameters/MeetingIDParameter"
responses:
"200":
$ref: "#/components/responses/MeetingDeletedObject"
400:
$ref: "#/components/responses/bad_request"
401:
$ref: "#/components/responses/unauthorized"
403:
$ref: "#/components/responses/forbidden"
404:
$ref: "#/components/responses/not_found"
429:
$ref: "#/components/responses/too_many"
500:
$ref: "#/components/responses/server_error"
503:
$ref: "#/components/responses/service_unavailable"
/personal/sms:
post:
summary: Sends an SMS to a participant
description: Sends an SMS to a participant. SMS can only be sent once per participant.
tags:
- Personal
security:
- oauth2: []
parameters:
- $ref: "#/components/parameters/api_version"
requestBody:
$ref: "#/components/requestBodies/MeetingSmsObject"
responses:
"200":
$ref: "#/components/responses/MeetingSmsObject"
400:
$ref: "#/components/responses/bad_request"
401:
$ref: "#/components/responses/unauthorized"
403:
$ref: "#/components/responses/forbidden"
404:
$ref: "#/components/responses/not_found"
429:
$ref: "#/components/responses/too_many"
500:
$ref: "#/components/responses/server_error"
503:
$ref: "#/components/responses/service_unavailable"
/management/packages:
get:
summary: Retrieves a list of available packages
description: "Retrieves a list of packages. Only packages that you have access to will be returned. You need at least **dealer** or **reseller** privileges to use this endpoint."
tags:
- Packages
security:
- oauth2: []
parameters:
- $ref: "#/components/parameters/api_version"
responses:
200:
$ref: "#/components/responses/PackageObjectArray"
400:
$ref: "#/components/responses/bad_request"
401:
$ref: "#/components/responses/unauthorized"
403:
$ref: "#/components/responses/forbidden"
404:
$ref: "#/components/responses/not_found"
429:
$ref: "#/components/responses/too_many"
500:
$ref: "#/components/responses/server_error"
503:
$ref: "#/components/responses/service_unavailable"
"/management/packages/{id}":
get:
summary: Retrieves a package
description: "Retrieves information about a package. You need at least **dealer** or **reseller** privileges to use this endpoint."
tags:
- Packages
security:
- oauth2: []
parameters:
- $ref: "#/components/parameters/api_version"
- $ref: "#/components/parameters/PackageIDParameter"
responses:
"200":
$ref: "#/components/responses/PackageObject"
400:
$ref: "#/components/responses/bad_request"
401:
$ref: "#/components/responses/unauthorized"
403:
$ref: "#/components/responses/forbidden"
404:
$ref: "#/components/responses/not_found"
429:
$ref: "#/components/responses/too_many"
500:
$ref: "#/components/responses/server_error"
503:
$ref: "#/components/responses/service_unavailable"
/management/users:
post:
summary: Creates a new user
description: Creates a new user. You need to provide the company ID that you received in the onboarding e-mail.
tags:
- Users
security:
- oauth2: []
parameters:
- $ref: "#/components/parameters/api_version"
- $ref: "#/components/parameters/UserQueryUserStatusParameter"
requestBody:
$ref: "#/components/requestBodies/UserObjectPost"
responses:
"200":
$ref: "#/components/responses/UserObject"
400:
$ref: "#/components/responses/bad_request"
401:
$ref: "#/components/responses/unauthorized"
403:
$ref: "#/components/responses/forbidden"
404:
$ref: "#/components/responses/not_found"
429:
$ref: "#/components/responses/too_many"
500:
$ref: "#/components/responses/server_error"
503:
$ref: "#/components/responses/service_unavailable"
get:
summary: Retrieves a list of users
description: "Retrieves a list of users. Only users that you have access to will be returned."
tags:
- Users
security:
- oauth2: []
parameters:
- $ref: "#/components/parameters/api_version"
- $ref: "#/components/parameters/UserQueryUserStatusParameter"
- $ref: "#/components/parameters/UserQueryCompanyParameter"
- $ref: "#/components/parameters/UserQueryDealerParameter"
- $ref: "#/components/parameters/UserQueryResellerParameter"
responses:
"200":
$ref: "#/components/responses/UserObjectArray"
400:
$ref: "#/components/responses/bad_request"
401:
$ref: "#/components/responses/unauthorized"
403:
$ref: "#/components/responses/forbidden"
404:
$ref: "#/components/responses/not_found"
429:
$ref: "#/components/responses/too_many"
500:
$ref: "#/components/responses/server_error"
503:
$ref: "#/components/responses/service_unavailable"
"/management/users/{id}":
get:
summary: Retrieves a user
description: "Retrieves a specific user."
tags:
- Users
security:
- oauth2: []
parameters:
- $ref: "#/components/parameters/api_version"
- $ref: "#/components/parameters/UserIDParameter"
- $ref: "#/components/parameters/UserQueryUserStatusParameter"
responses:
"200":
$ref: "#/components/responses/UserObject"
400:
$ref: "#/components/responses/bad_request"
401:
$ref: "#/components/responses/unauthorized"
403:
$ref: "#/components/responses/forbidden"
404:
$ref: "#/components/responses/not_found"
429:
$ref: "#/components/responses/too_many"
500:
$ref: "#/components/responses/server_error"
503:
$ref: "#/components/responses/service_unavailable"
put:
summary: Updates a user
description: "Updates a specific user. Replace **{id}** with the **id** attribute of a user."
tags:
- Users
security:
- oauth2: []
parameters:
- $ref: "#/components/parameters/api_version"
- $ref: "#/components/parameters/UserIDParameter"
- $ref: "#/components/parameters/UserQueryUserStatusParameter"
requestBody:
$ref: "#/components/requestBodies/UserObjectPut"
responses:
"200":
$ref: "#/components/responses/UserObject"
400:
$ref: "#/components/responses/bad_request"
401:
$ref: "#/components/responses/unauthorized"
403:
$ref: "#/components/responses/forbidden"
404:
$ref: "#/components/responses/not_found"
429:
$ref: "#/components/responses/too_many"
500:
$ref: "#/components/responses/server_error"
503:
$ref: "#/components/responses/service_unavailable"
patch:
summary: Updates a user
description: "Updates a specific user. Replace **{id}** with the **id** attribute of a user."
tags:
- Users
security:
- oauth2: []
parameters:
- $ref: "#/components/parameters/api_version"
- $ref: "#/components/parameters/UserIDParameter"
- $ref: "#/components/parameters/UserQueryUserStatusParameter"
requestBody:
$ref: "#/components/requestBodies/UserObjectPatch"
responses:
"200":
$ref: "#/components/responses/UserObject"
400:
$ref: "#/components/responses/bad_request"
401:
$ref: "#/components/responses/unauthorized"
403:
$ref: "#/components/responses/forbidden"
404:
$ref: "#/components/responses/not_found"
429:
$ref: "#/components/responses/too_many"
500:
$ref: "#/components/responses/server_error"
503:
$ref: "#/components/responses/service_unavailable"
delete:
summary: Deletes a user
description: "Deletes a specific user. Replace **{id}** with the **id** attribute of a user."
tags:
- Users
security:
- oauth2: []
parameters:
- $ref: "#/components/parameters/api_version"
- $ref: "#/components/parameters/UserIDParameter"
- $ref: "#/components/parameters/UserQueryUserStatusParameter"
responses:
"200":
$ref: "#/components/responses/UserDeletedObject"
400:
$ref: "#/components/responses/bad_request"
401:
$ref: "#/components/responses/unauthorized"
403:
$ref: "#/components/responses/forbidden"
404:
$ref: "#/components/responses/not_found"
429:
$ref: "#/components/responses/too_many"
500:
$ref: "#/components/responses/server_error"
503:
$ref: "#/components/responses/service_unavailable"
/management/sites:
post:
summary: Creates a new site
description: Creates a new site. You need at least **company admin** privileges to use this endpoint.
tags:
- Sites
security:
- oauth2: []
parameters:
- $ref: "#/components/parameters/api_version"
- $ref: "#/components/parameters/AccountQueryUserStatusParameter"
requestBody:
$ref: "#/components/requestBodies/AccountObjectPost"
responses:
"200":
$ref: "#/components/responses/AccountObject"
400:
$ref: "#/components/responses/bad_request"
401:
$ref: "#/components/responses/unauthorized"
403:
$ref: "#/components/responses/forbidden"
404:
$ref: "#/components/responses/not_found"
429:
$ref: "#/components/responses/too_many"
500:
$ref: "#/components/responses/server_error"
503:
$ref: "#/components/responses/service_unavailable"
get:
summary: Retrieves a list of sites
description: Retrieves a list of sites. Only sites that you have access to will be returned.
tags:
- Sites
security:
- oauth2: []
parameters:
- $ref: "#/components/parameters/api_version"
- $ref: "#/components/parameters/AccountQueryUserStatusParameter"
- $ref: "#/components/parameters/AccountQueryCompanyParameter"
responses:
"200":
$ref: "#/components/responses/AccountObjectArray"
400:
$ref: "#/components/responses/bad_request"
401:
$ref: "#/components/responses/unauthorized"
403:
$ref: "#/components/responses/forbidden"
404:
$ref: "#/components/responses/not_found"
429:
$ref: "#/components/responses/too_many"
500:
$ref: "#/components/responses/server_error"
503:
$ref: "#/components/responses/service_unavailable"
components:
securitySchemes:
oauth2:
type: oauth2
flows:
clientCredentials:
tokenUrl: https://api-prd.kpn.com/oauth/client_credential/accesstoken?grant_type=client_credentials
scopes: {}
schemas:
AccountRequestBodyPost:
required:
- name
allOf:
- $ref: "#/components/schemas/AccountRequestBody"
- type: object
properties:
company:
description: Company ID
type: string
AccountRequestBodyPut:
required:
- name
allOf:
- $ref: "#/components/schemas/AccountRequestBody"
AccountRequestBodyPatch:
allOf:
- $ref: "#/components/schemas/AccountRequestBody"
AccountRequestBody:
type: object
properties:
name:
description: Site name
type: string
logo:
description: "Base64 image excluded mimetype (e.g. data:image/png;base64,)"
type: string
users:
type: array
items:
type: string
description: List of User IDs
videochat_font_type:
description: "Chat font type."
enum:
- Roboto
- Helvetica
- Arial
type: string
videochat_font_color:
description: "Chat font color. Valid hex-formatted color code (#000000 to FFFFFF)."
type: string
AccountUsersRequestBody:
required:
- users
type: object
properties:
users:
type: array
items:
type: string
description: "List of User IDs"
AccountResponse:
type: object
properties:
id:
description: Site ID
type: string
name:
description: Site name
type: string
company:
$ref: "#/components/schemas/CompanyResponseShort"
logo:
description: Base64 image
type: string
users:
type: array
items:
$ref: "#/components/schemas/UserResponse"
videochat_font_type:
description: Chat font type
type: string
videochat_font_color:
description: "Chat font color. Valid hex-formatted color code (#000000 to FFFFFF)."
type: string
AccountResponseShort:
type: object
properties:
id:
description: Site ID
type: string
name:
description: Site name
type: string
AccountResponseDeleted:
type: object
properties:
id:
description: Site ID
type: string
AuthRequestBodyAutoLoginUser:
required:
- product
type: object
properties:
agent:
description: "Agent ID. Not required for agents."
type: string
product:
description: Product name
enum:
- personal
- direct
type: string
AuthRequestBodyForgotPassword:
required:
- product
- email
type: object
properties:
product:
description: Product
enum:
- personal
- direct
type: string
email:
description: Email address
type: string
AuthResponseAutoLoginUser:
type: object
properties:
url:
description: Agent dashboard URL
type: string
AuthResponseForgotPassword:
type: object
properties:
status:
description: Status
type: string
AuthResponseMe:
oneOf:
- $ref: "#/components/schemas/UserResponse"
- $ref: "#/components/schemas/ClientResponse"
ClientRequestBodyPost:
required:
- name
allOf:
- $ref: "#/components/schemas/ClientRequestBody"
- type: object
properties:
entity:
oneOf:
- type: object
required:
- type
- id
properties:
type:
description: Entity type dealer
type: string
id:
description: Dealer ID
type: string
- type: object
required:
- type
- id
properties:
type:
description: Entity type reseller
type: string
id:
description: Reseller ID
type: string
- type: object
required:
- type
- id
properties:
type:
description: Entity type company
type: string
id:
description: Company ID
type: string
ClientRequestBodyPut:
required:
- name
allOf:
- $ref: "#/components/schemas/ClientRequestBody"
- type: object
properties:
suspended:
description: Is suspended
type: boolean
ClientRequestBodyPatch:
allOf:
- $ref: "#/components/schemas/ClientRequestBody"
- type: object
properties:
suspended:
description: Is suspended
type: boolean
ClientRequestBody:
type: object
properties:
name:
description: Client name
type: string
ClientResponsePost:
allOf:
- $ref: "#/components/schemas/ClientResponse"
- type: object
properties:
client_secret:
description: OAuth Client secret
type: string
ClientResponse:
type: object
properties:
id:
description: Client ID
type: string
name:
description: Client name
type: string
client_id:
description: OAuth Client ID
type: string
created_at:
description: Created date and time
type: string
format: date-time
entity:
oneOf:
- type: object
properties:
type:
description: Entity type dealer
type: string
id:
description: Dealer ID
type: string
name:
description: Dealer name
type: string
- type: object
properties:
type:
description: Entity type reseller
type: string
id:
description: Reseller ID
type: string
name:
description: Reseller name
type: string
- type: object
properties:
type:
description: Entity type company
type: string
id:
description: Company ID.
type: string
name:
description: Company name
type: string
package:
$ref: "#/components/schemas/PackageResponse"
suspended:
description: Is suspended
type: boolean
ClientResponseDeleted:
type: object
properties:
id:
description: Client ID
type: string
ClientResponseResetSecret:
type: object
properties:
id:
description: Client ID
type: string
client_id:
description: OAuth Client ID
type: string
client_secret:
description: OAuth Client secret
type: string
CompanyRequestBodyPost:
required:
- name
- contact
- package
allOf:
- $ref: "#/components/schemas/CompanyRequestBody"
CompanyRequestBodyPut:
required:
- name
- contact
- package
allOf:
- $ref: "#/components/schemas/CompanyRequestBody"
- type: object
properties:
suspended:
description: Is suspended
type: boolean
CompanyRequestBodyPatch:
allOf:
- $ref: "#/components/schemas/CompanyRequestBody"
- type: object
properties:
suspended:
description: Is suspended
type: boolean
CompanyRequestBody:
type: object
properties:
name:
description: Company name
type: string
contact:
$ref: "#/components/schemas/ContactRequestBody"
package:
description: Package ID
type: string
dealer:
description: Dealer ID
type: string
CompanyResponse:
type: object
properties:
id:
description: Company ID
type: string
name:
description: Company name
type: string
package:
$ref: "#/components/schemas/PackageResponse"
contact:
$ref: "#/components/schemas/ContactResponse"
dealer:
$ref: "#/components/schemas/DealerResponseShort"
suspended:
description: Is suspended
type: boolean
CompanyResponseShort:
type: object
properties:
id:
description: Company ID
type: string
name:
description: Company name
type: string
contact:
$ref: "#/components/schemas/ContactResponse"
suspended:
description: Is suspended
type: boolean
CompanyResponseDeleted:
type: object
properties:
id:
description: Company ID
type: string
ContactRequestBody:
type: object
required:
- first_name
- last_name
- email
properties:
first_name:
description: First name
type: string
last_name:
description: Last name
type: string
email:
description: E-mail address
type: string
phone:
description: Phone number
type: string
language:
description: "Language code (e.g. nl, en, etc.)"
type: string
ContactResponse:
type: object
properties:
id:
description: Contact ID
type: string
first_name:
description: First name
type: string
last_name:
description: Last name
type: string
email:
description: E-mail address
type: string
phone:
description: Phone number
type: string
language:
description: "Language code (e.g. nl, en, etc.)"
type: string
DealerRequestBodyPost:
required:
- name
- contact
allOf:
- $ref: "#/components/schemas/DealerRequestBody"
DealerRequestBodyPut:
required:
- name
- contact
allOf:
- $ref: "#/components/schemas/DealerRequestBody"
- type: object
properties:
suspended:
description: Is suspended
type: boolean
DealerRequestBodyPatch:
allOf:
- $ref: "#/components/schemas/DealerRequestBody"
- type: object
properties:
suspended:
description: Is suspended
type: boolean
DealerRequestBody:
type: object
properties:
name:
description: Dealer name
type: string
contact:
$ref: "#/components/schemas/ContactRequestBody"
notification_contact:
$ref: "#/components/schemas/NotificationContactRequestBody"
reseller:
description: Reseller ID
type: string
DealerResponse:
type: object
properties:
id:
description: Dealer ID
type: string
name:
description: Dealer name
type: string
contact:
$ref: "#/components/schemas/ContactResponse"
notification_contact:
$ref: "#/components/schemas/NotificationContactResponse"
reseller:
$ref: "#/components/schemas/ResellerResponse"
suspended:
description: Is suspended
type: boolean
DealerResponseShort:
type: object
properties:
id:
description: Dealer ID
type: string
name:
description: Dealer name
type: string
contact:
$ref: "#/components/schemas/ContactResponse"
notification_contact:
$ref: "#/components/schemas/NotificationContactResponse"
suspended:
description: Is suspended
type: boolean
DealerResponseDeleted:
type: object
properties:
id:
description: Dealer ID
type: string
MeetingRequestBodyPost:
required:
- site
- participants
type: object
properties:
site:
type: string
description: Site ID
agent:
type: string
description: "User ID. Not required for agents. It will create a meeting on behalf of the specified agent."
is_appointment:
type: boolean
description: "Define if meeting start directly or on specific start time. Set on true for specific time and false to start the meeting directly. Default true."
time_start:
type: string
format: date-time
description: "Date and time when meeting start (YYYY-MM-DD HH:mm:ss or ISO date). Only required when is_appointment is set on true."
time_end:
type: string
format: date-time
description: "Date and time when meeting is not valid anymore (YYYY-MM-DD HH:mm:ss or ISO date). Leave empty to set it one hour later as start time."
participants:
type: array
items:
required:
- name
type: object
properties:
name:
type: string
description: Participant name
email:
type: string
description: "Participant email for invite. Make sure that `send_email` is true. Leave empty to not send for specific participant."
phone:
type: string
description: "Participant phone for invite. Make sure that `send_sms` is true. Leave empty to not send for specific participant."
subject:
type: string
description: Meeting subject
invitation:
type: string
description: Invite message. Leave empty to get invite message from specified site.
invitation_sms:
type: string
description: Invite message SMS. Leave empty to get invite message from specified site.
send_email:
type: boolean
description: Send invite mail to participants. Default false
send_sms:
type: boolean
description: Send invite SMS to participants. Default false
MeetingResponse:
type: object
properties:
id:
type: string
description: The generated ID for this meeting.
company:
$ref: "#/components/schemas/CompanyResponseShort"
room_id:
type: string
description: "The room ID that is being used for this meeting. You generally do not need to use this information."
room_password:
type: string
description: "The room password that is being used for this meeting. You generally do not need to use this information."
duration:
type: integer
description: Duration of the meeting in seconds.
is_appointment:
type: boolean
description: "Define if meeting start directly or on specific start time. Value is true for specific time and false to start the meeting directly."
room_created:
type: string
format: date-time
description: "ISO date that described when the room is created."
room_available_from:
type: string
format: date-time
description: "ISO date that described from when the room will be available."
room_available_till:
type: string
format: date-time
description: "ISO date that describes until when the room will be available. If the conversation is still active at this time, it will NOT be automatically terminated!"
created_by:
type: object
# --- truncated at 32 KB (118 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/kpn/refs/heads/main/openapi/weseedo-personal-openapi.yml