Go Headless

Build Apps

Client

API Preview

Develop Websites

REST

Velo

GraphQL (Alpha)

# Conversation ID

Conversation participants are assigned IDs based on
whether they've provided contact information
or registered as a site member.
The typical lifecycle is **anonymous visitor** > **contact** > **site member**,
although it's possible to skip a step
or to become a contact and site member at the same time.

| Type              | ID property          | Details                                                                                                                                                                                                                                                                                                                                                 |
| ----------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Anonymous visitor | `anonymousVisitorId` | When the participant first opens the site, they're an anonymous visitor.                                                                                                                                                                                                                                                                                |
| Contact           | `contactId`          | <ul><li>An anonymous visitor converts to a contact when they provide some contact information, such as a name, phone number, or email address. This most often happens when they submit a contact form, purchase something, or become a site member.</li> <li>When a visitor converts to a contact, they’re added to the site’s Contact List.</li></ul> |
| Member            | `memberId`           | <ul><li>An anonymous visitor or contact becomes a member when they're registered as a site member.</li> <li>Members are always linked to a contact, so they have both a member ID and a contact ID.</li></ul>                                                                                                                                           |

Behind the scenes, when a participant changes type,
a new conversation is created and the previous conversation is merged into the new one.
Before sending a message, you can ensure you're using the most current conversation ID
by calling
[Get or Create Conversation](#get-or-create-conversation)
with the participant's visitor, contact, or member ID.

The sections below tell you how your app can get the relevant ID
to use the Inbox API.

## Anonymous visitor ID

Anonymous visitor IDs are available to your app
only after the visitor sends a message to the business using the
[Message Sent To Business Webhook][message-sent-to-business-webhook].
The ID is available at `actionEvent.body.message.sender.anonymousVisitorId`.

## Contact ID

When a visitor provides contact details to the site,
they're converted to a contact.
Once this happens,
the ID used to access the visitor's conversations changes to the contact ID:

- Like the anonymous visitor,
  the contact ID is available when the contact sends a message to the business
  using the [Message Sent To Business Webhook][message-sent-to-business-webhook].
  The ID is available at `actionEvent.body.message.sender.contactId`.
- You can also use [Query Contacts][query-contacts] or [List Contacts][list-contacts]
  in the Contacts API to retrieve the contact.

## Member ID

If the visitor is a [site member][kb-members-area],
the conversation must be accessed using the member ID:

- Like the anonymous visitor and contact,
  the member ID is available when the contact sends a message to the business
  using the [Message Sent To Business Webhook][message-sent-to-business-webhook].
  The ID is available at `actionEvent.body.message.sender.memberId`.
- You can also use [Query Members][query-members] or [List Members][list-members]
  in the Members API to retrieve the member.

[kb-members-area]: https://support.wix.com/en/article/about-the-members-area
[inbox-deeplink]: https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Finbox
[send-message-endpoint]: https://dev.wix.com/api/rest/drafts/inbox/send-message
[list-messages-endpoint]: https://dev.wix.com/api/rest/drafts/inbox/list-messages
[message-sent-to-business-webhook]: https://dev.wix.com/api/rest/all-apis/inbox/message-sent-to-business-webhook
[query-contacts]: https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/query-contacts
[list-contacts]: https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/list-contacts
[query-members]: https://dev.wix.com/api/rest/members/members/query-members
[list-members]: https://dev.wix.com/api/rest/members/members/list-members

oldChatroomIds

targetChatroomId

ChatroomsMerged

conversationChannels

conversationId

AddConversationChannelsRequest

AddConversationChannelsResponse

ChannelType

Display name and avatar for the business.

List of communication channels where the visitor, contact, or member can receive messages.

channels

ID of the visitor, contact, or member who is chatting with the business.

Display name and avatar for the visitor, contact, or member.

Conversation

channel

recipients

ConversationChannel

imageUrl

name

ConversationDisplayData

oldConversationIds

targetConversationId

ConversationsMerged

DeleteConversationRequest

DeleteConversationResponse

GetConversationRequest

GetConversationResponse

ID of the visitor, contact, or member chatting with the business.

Required for 3rd-party apps.

GetOrCreateConversationRequest

Indicates whether the conversation was just created.

If `true`, the conversation was just created.
If `false`, the conversation already existed.

newConversation

GetOrCreateConversationResponse

only message time is supported for field name

ListConversationsRequest

conversations

ListConversationsResponse

ParticipantId

anonymousVisitorId

ID of a site
[contact](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fcontacts).

contactId

ID of a site
[member](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Fmember-permissions/members).

memberId

IdentificationData

value

BoolValue

Empty

Int32Value

StringValue

Pointer to the next or previous page in the list of results.

You can get the relevant cursor token
from the `pagingMetadata` object in the previous call's response.
Not relevant for the first request.

cursor

limit

CursorPaging

Cursor pointing to next page in the list of results.

Cursors

Number of items returned in the response.

count

Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used.

offset

Flag that indicates the server failed to calculate the `total` field.

tooManyToCount

Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set.

total

PagingMetadataV2

SortOrder

fieldName

order

Sorting

Retrieves a conversation by conversation ID.

If you don't have the conversation ID,
use [Get Or Create Conversation](#get-or-create-conversation)
to retrieve the conversation with the visitor, contact, or member ID.

Read Inbox Messages

GetConversation

Retrieves a conversation for the specified visitor, contact, or member ID,
or creates one if it doesn't exist.

Manage Inbox Messages

GetOrCreateConversation

Triggered when the conversation
is merged, for example when contacts are merged
or when a visitor becomes a contact.

If messages exist in both conversations when they merge,
the messages are preserved in chronological order.

Get Or Create Conversation

Permission Scopes