Documentation
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

/ activity / conversationStart

  • Article
  • 2 minutes to read

Description

Initiate a conversation between yourself and one or more other users.

API Details

  • Status:
  • The required privilege level to invoke this method is user
  • The supported database role for this method is none
  • Transactional database functions are used during this method when supported by the target database.
System Rights Database Rights Mail Rights Calendar Rights
sys.e.startConversation
 --- --- ---

Request Parameters

The conversationStart method takes the following input parameters. It is important to note that the parameters must be passed to the method in the same order as they appear here in order to satisfy the requirement of the input validation checks.

Name Type Attributes Description
participant Array<xs:anyURI> Required The participants you are starting a conversation with.
content xs:string Optional The conversation title.
extra xs:string Optional An arbitary string value, could be a JSON/XML/Other undocumented (here) structure defined by the front end devs, representing additional embedded or referenced content for the message.
location geoLocationType Optional You can specify a geographical location to associate to this conversation.
messageContent xs:string Optional The first message in the conversation.
messageExtra xs:string Optional A JSON structure representing additional embedded or referenced content for the first message in the conversation.
sourceImage xs:anyURI Optional A URL where the image can be found. If the URL begins with a forward slash then the image is assumed to be in the WebDAV path of our instance. If the URL begins with http:// or https:// then the image will be fetched from that location. Please be aware that any external URL’s provided will need to be accessible by the server.
deleteSourceFile xs:boolean Optional
Default=false		 Set this to ‘true’ if you want the source image to be deleted once the profile image set has been created. This is generally only needed when you have uploaded (via WebDav) a temporary image. If you reference an absolute external URL then setting this either way will have no effect.

Response Parameters

Name Type Attributes Description
conversationId xs:anyURI Required The unique ID of the conversation.
messageId xs:anyURI Optional The unique ID of the conversation message.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document