Skip to main content
FlownallyAPI Docs

object

MessageRecipient

LLM
View as Markdown
Open llms.txt

Choose how Flownally should find the customer thread: an existing conversation a known contact, or a phone recipient for first-message sends.

Variants

Use type to choose one of `conversation`, `contact`, `phone`.

ConversationRecipient

conversation

Continue a known conversation.

Required: `type`, `conversationId`.

  • Name
    type
    Type
    const
    Description
    Required property.
  • Name
    conversationId
    Type
    string
    Description
    Required property.

Example

conversation
{
  "type": "conversation",
  "conversationId": "cnv_01HV8Z2JH0Q7K4M9N6P2A1B3C5"
}

ContactRecipient

contact

Send to a contact through the request inbox. Flownally uses an existing contact conversation for that inbox when available, otherwise the contact `cf_phone` custom field.

Required: `type`, `contactId`.

  • Name
    type
    Type
    const
    Description
    Required property.
  • Name
    contactId
    Type
    string
    Description
    Required property.

Example

contact
{
  "type": "contact",
  "contactId": "ctc_01HV8Z2JH0Q7K4M9N6P2A1B3C5"
}

PhoneRecipient

phone

Start a conversation with a phone number through the request inbox.

Required: `type`, `phoneNumber`.

  • Name
    type
    Type
    const
    Description
    Required property.
  • Name
    phoneNumber
    Type
    string
    Description
    E.164 phone number. Common formatting is accepted and normalized.

Example

phone
{
  "type": "phone",
  "phoneNumber": "+48123456789"
}

Related operations