ParseDeepLink parses a link in the form of berty://xxx or https://berty.tech/id# and returns a structure that can be used to display information. This action is read-only.

POST /messenger/v1/ParseDeepLink

Body Required

link string

Responses

200

A successful response.
Hide response attributes Show response attributes object
- kind string
  
  Values are UnknownKind, BertyID, or BertyGroup. Default value is UnknownKind.
- berty_id object
  
  Hide berty_id attributes Show berty_id attributes object
  
  public_rendezvous_seed string(byte)
  
  account_pk string(byte)
  
  display_name string
- berty_group object
  
  Hide berty_group attributes Show berty_group attributes object
  
  group object
  
  Hide group attributes Show group attributes object
  
  public_key string(byte)
  
  secret string(byte)
  
  secret_sig string(byte)
  
  group_type string
  
  GroupTypeUndefined: GroupTypeUndefined indicates that the value has not been set. Should not happen.
  
  GroupTypeAccount: GroupTypeAccount is the group managing an account, available to all its devices.
  
  GroupTypeContact: GroupTypeContact is the group created between two accounts, available to all their devices.
  
  GroupTypeMultiMember: GroupTypeMultiMember is a group containing an undefined number of members.
  
  Values are GroupTypeUndefined, GroupTypeAccount, GroupTypeContact, or GroupTypeMultiMember. Default value is GroupTypeUndefined.
  
  display_name string
default

An unexpected error response
Hide response attributes Show response attributes object
- error string
- code integer(int32)
- message string
- details array[object]
  
  Hide details attributes Show details attributes array[object]
  
  type_url string
  
  value string(byte)

POST /messenger/v1/ParseDeepLink

curl \
 -X POST http://api.example.com/messenger/v1/ParseDeepLink \
 -d '{"link":"string"}'

Request example

{
  "link": "string"
}

Request examples

{
  "link": "string"
}

Response examples (200)

{
  "kind": "UnknownKind",
  "berty_id": {
    "public_rendezvous_seed": "string",
    "account_pk": "string",
    "display_name": "string"
  },
  "berty_group": {
    "group": {
      "public_key": "string",
      "secret": "string",
      "secret_sig": "string",
      "group_type": "GroupTypeUndefined"
    },
    "display_name": "string"
  }
}

Response examples (200)

{
  "kind": "UnknownKind",
  "berty_id": {
    "public_rendezvous_seed": "string",
    "account_pk": "string",
    "display_name": "string"
  },
  "berty_group": {
    "group": {
      "public_key": "string",
      "secret": "string",
      "secret_sig": "string",
      "group_type": "GroupTypeUndefined"
    },
    "display_name": "string"
  }
}

Response examples (default)

{
  "error": "string",
  "code": 42,
  "message": "string",
  "details": [
    {
      "type_url": "string",
      "value": "string"
    }
  ]
}

Response examples (default)

{
  "error": "string",
  "code": 42,
  "message": "string",
  "details": [
    {
      "type_url": "string",
      "value": "string"
    }
  ]
}