orbis.createConversation()

Creates a new conversation with a set of recipients in which the messages will be sent.

How to use?

let res = await orbis.createConversation(
    {
      recipients: [
        "did:pkh:001...",
        "did:pkh:002...",
        "did:pkh:003..."
      ]
      name: "Beta testers chat",
      description: "Conversation to chat with Orbis beta testers"
    }
  );

Parameters

  • content: JSON object that contains the details of the conversation
  • recipients: array Array of dids that should be part of the conversation
  • name: string optional Name of the conversation
  • description: string optional Description of the conversation
  • context: string optional Can be used to group conversations

Returns

{
    status: 200,
    doc: "kjzl6cwe1...e4wvxhiqj",
    result: "Success creating TileDocument."
  }

Next steps

Explore other parts of the API.

orbis.setGroupMember()

orbis.sendMessage()