{"id":6304,"date":"2025-07-03T11:28:31","date_gmt":"2025-07-03T11:28:31","guid":{"rendered":"https:\/\/support.alfaview.com\/?page_id=6304"},"modified":"2025-07-03T11:29:47","modified_gmt":"2025-07-03T11:29:47","slug":"create-guest-links","status":"publish","type":"page","link":"https:\/\/cp-prod-wordpress.alfa.sx\/de\/developers\/request-your-api-credentials\/usage-examples\/create-guest-links\/","title":{"rendered":"Gastlinks erstellen"},"content":{"rendered":"\n<h2 class=\"wp-block-heading\" class=\"wp-block-heading\" id=\"summary\">Summary<a href=\"#summary\" class=\"av-heading-anchor\"><i class=\"bi bi-link\"><\/i><\/a><\/h2>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Guest links are non-shareable<\/li>\n\n\n\n<li>Guest links are for individual recipients<\/li>\n\n\n\n<li>Can create multiple guest links<\/li>\n\n\n\n<li>Optionally sends an email in the specified language (DE or EN)<\/li>\n\n\n\n<li>Required API calls: <mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-cyan-blue-color\"><code>guestService.v2\/createGuestLinks<\/code><\/mark><\/li>\n<\/ul>\n\n\n\n<h2 class=\"wp-block-heading\" class=\"wp-block-heading\" id=\"request\">Request<a href=\"#request\" class=\"av-heading-anchor\"><i class=\"bi bi-link\"><\/i><\/a><\/h2>\n\n\n\n<p>Request <button class=\"av-button av-button--error\">POST<\/button> to <mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-cyan-blue-color\"><code>https:\/\/apis.alfaview.com\/json\/v1\/guestService.v2\/createGuestLinks<\/code><\/mark><\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>{\n  \"accessInfo\": {\n    \"requestId\": \"### REQUEST ID ###\",\n    \"accessToken\": \"### ACCESS TOKEN ###\"\n  },\n  \"roomId\": \"### ROOM ID ###\",\n  \"guestLinkCreations\": &#91;\n    {\n      \"email\": \"### GUEST EMAIL ###\",\n      \"displayName\": \"### GUEST NAME ###\",\n      \"validFrom\": \"2022-07-25T07:25:48.057Z\",\n      \"validUntil\": \"2022-07-25T07:25:48.057Z\",\n      \"locale\": \"### GUEST LOCALE ###\",\n      \"sendEmail\": true,\n      \"permissionGroupId\": \"### PERMISSION GROUP ID ###\",\n      \"skipRoomPermissionsUpdate\": false\n    }\n  ]\n}\n<\/code><\/pre>\n\n\n\n<h2 class=\"wp-block-heading\" class=\"wp-block-heading\" id=\"response\">Response<a href=\"#response\" class=\"av-heading-anchor\"><i class=\"bi bi-link\"><\/i><\/a><\/h2>\n\n\n\n<pre class=\"wp-block-code\"><code>{\n  \"replyInfo\": {\n    ...\n    \"statusMessage\": \"OK\"\n  },\n  \"guestLinks\": &#91;\n    {\n      ...\n      \"joinLink\":\n      \"https:\/\/app.alfaview.com\/#\/join\/01FH0EX2VQQ378MV7Z5NAGHESK\/4173dafb-5cde\u00025c85-95a3-20ebdf43698a\/PHLlurwVkiY91KAlXVc8WtNsKBoRwStK\/v2\",\n      \"accessKey\": \"PHLlurwVkiY91KAlXVc8WtNsKBoRwStK\"\n    }\n  ]\n}<\/code><\/pre>\n\n\n\n<h2 class=\"wp-block-heading\" class=\"wp-block-heading\" id=\"notes\">Notes<a href=\"#notes\" class=\"av-heading-anchor\"><i class=\"bi bi-link\"><\/i><\/a><\/h2>\n\n\n\n<ul class=\"wp-block-list\">\n<li><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-cyan-blue-color\"><code>guestLinkCreations<\/code><\/mark> can contain multiple objects, contains the following attributes\n<ul class=\"wp-block-list\">\n<li><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-cyan-blue-color\"><code>displayName<\/code><\/mark> the name the guest will display during a meeting, optional<\/li>\n\n\n\n<li><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-cyan-blue-color\"><code>validFrom<\/code><\/mark> and <mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-cyan-blue-color\"><code>validUntil<\/code><\/mark> define the time frame in which the guest link is valid. If only validFrom is defined the time range has an open end. If none are defined time range is unlimited. Both values are optional.<\/li>\n\n\n\n<li>set <mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-cyan-blue-color\"><code>sendEmail<\/code><\/mark> to true if an invitation email needs to be sent out to the guest<\/li>\n\n\n\n<li><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-cyan-blue-color\"><code>locale<\/code><\/mark> applies to the invitation email, can be <mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-cyan-blue-color\"><code>de<\/code><\/mark> or <mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-cyan-blue-color\"><code>en<\/code><\/mark>, defaults to <mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-cyan-blue-color\"><code>en<\/code><\/mark><\/li>\n\n\n\n<li>retrieve the desired <mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-cyan-blue-color\"><code>permissionGroupId<\/code><\/mark> from the <em>Business Logic Service<\/em><\/li>\n\n\n\n<li><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-cyan-blue-color\"><code>skipRoomPermissionsUpdate<\/code><\/mark> should be set to <mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-cyan-blue-color\"><code>false<\/code><\/mark> when creating guest links<\/li>\n<\/ul>\n<\/li>\n\n\n\n<li>The response contains a corresponding array of guest links, which then contain an individual <mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-cyan-blue-color\"><code>joinLink<\/code><\/mark><\/li>\n\n\n\n<li>As of today, guest links created with this endpoint will not show up in the administration interface for a rooms guest links (known issue, will be fixed soon)<\/li>\n<\/ul>\n","protected":false},"excerpt":{"rendered":"<p>Summary Guest links are non-shareable Guest links are for individual recipients Can create multiple guest links Optionally sends an email in the specified language (DE or EN) Required API calls: guestService.v2\/createGuestLinks Request Request POST to [&hellip;]<\/p>\n","protected":false},"author":9,"featured_media":0,"parent":3170,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"class_list":["post-6304","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/cp-prod-wordpress.alfa.sx\/de\/wp-json\/wp\/v2\/pages\/6304","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/cp-prod-wordpress.alfa.sx\/de\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/cp-prod-wordpress.alfa.sx\/de\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/cp-prod-wordpress.alfa.sx\/de\/wp-json\/wp\/v2\/users\/9"}],"replies":[{"embeddable":true,"href":"https:\/\/cp-prod-wordpress.alfa.sx\/de\/wp-json\/wp\/v2\/comments?post=6304"}],"version-history":[{"count":2,"href":"https:\/\/cp-prod-wordpress.alfa.sx\/de\/wp-json\/wp\/v2\/pages\/6304\/revisions"}],"predecessor-version":[{"id":6305,"href":"https:\/\/cp-prod-wordpress.alfa.sx\/de\/wp-json\/wp\/v2\/pages\/6304\/revisions\/6305"}],"up":[{"embeddable":true,"href":"https:\/\/cp-prod-wordpress.alfa.sx\/de\/wp-json\/wp\/v2\/pages\/3170"}],"wp:attachment":[{"href":"https:\/\/cp-prod-wordpress.alfa.sx\/de\/wp-json\/wp\/v2\/media?parent=6304"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}