Lexicon Garden

app.bsky.contact.importContacts

Import contacts for securely matching with other users. This follows the protocol explained in https://docs.bsky.app/blog/contact-import-rfc. Requires authentication.

Repository @bsky-lexicons.bsky.social did:plc:4v4y5r3lwsbtmsxhile2ljac namespace authority
Details · procedure
Kindprocedure
Authoritycontact.bsky.app
Indexed
Compare Edit in builder → Fork →

Procedure

procedure · POST

Input

application/json

contacts

requiredarray

List of phone numbers in global E.164 format (e.g., '+12125550123'). Phone numbers that cannot be normalized into a valid phone number will be discarded. Should not repeat the 'phone' input used in `app.bsky.contact.verifyPhone`.

  • minLength: 1
  • maxLength: 1000
itemsstring

token

requiredstring

JWT to authenticate the call. Use the JWT received as a response to the call to `app.bsky.contact.verifyPhone`.

Output

application/json

matchesAndContactIndexes

requiredarray

The users that matched during import and their indexes on the input contacts, so the client can correlate with its local list.

Errors

InvalidDid

No description in schema.

InvalidContacts

No description in schema.

TooManyContacts

No description in schema.

InvalidToken

No description in schema.

InternalError

No description in schema.

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.

  • town.delve.contact.importContacts

    procedure not from the namespace authority

    Import contacts for securely matching with other users. This follows the protocol explained in https://docs.bsky.app/blog/contact-import-rfc. Requires authentication.

  • app.bsky.contact.verifyPhone

    procedure

    Verifies control over a phone number with a code received via SMS and starts a contact import session. Requires authentication.

  • town.delve.contact.verifyPhone

    procedure not from the namespace authority

    Verifies control over a phone number with a code received via SMS and starts a contact import session. Requires authentication.

  • app.bsky.contact.defs

    Associates a profile with the positional index of the contact import input in the call to `app.bsky.contact.importContacts`, so clients can know which phone caused a particular match.