Skip to content
Shortcut: /, ⌘K or Ctrl+K

polymorfa chat

Read stored chats on enrolled HMS Numbers (beta).

Polymorfa CLI · CLI API requests

View as Markdown

polymorfa chat list

List stored chats for an enrolled HMS Number (beta). Requires chats:read.

Usage

polymorfa chat list [flags]

Flags

  • --active-before <value>takes a value

    Last activity before this ISO 8601 time.

  • --active-since <value>takes a value

    Last activity at or after this ISO 8601 time.

  • --cursor <value>takes a value

    Opaque page cursor; reuse with the same filters.

  • --kind <value>takes a value

    Conversation kind.

    Allowed valuesdirectgroupchannelbroadcast
  • --limit <value>takes a value

    Page size (1–100, default 50).

  • --session <value>takes a valuerequired

    Messaging Number ID.

Also accepts the global flags.

polymorfa chat message list

List stored messages in a chat for an enrolled HMS Number (beta). Requires messages:read.

Usage

polymorfa chat message list CONVERSATION [flags]

Arguments

  • CONVERSATIONrequired

    Conversation ID or E.164 phone number.

Flags

  • --cursor <value>takes a value

    Opaque page cursor; reuse with the same filters.

  • --direction <value>takes a value

    Message direction.

    Allowed valuesinboundoutbound
  • --limit <value>takes a value

    Page size (1–100, default 50).

  • --order <value>takes a value

    Message order (default desc).

    Allowed valuesdescasc
  • --session <value>takes a valuerequired

    Messaging Number ID.

  • --since <value>takes a value

    Messages at or after this ISO 8601 time.

  • --types <value>takes a value

    Comma-separated message types, up to 16 (for example text,image).

  • --until <value>takes a value

    Messages before this ISO 8601 time.

Also accepts the global flags.

polymorfa chat message media

Download a stored Official API message media copy for an enrolled HMS Number (beta). Requires messages:read and media:read.

Usage

polymorfa chat message media CONVERSATION MESSAGE [flags]

Example

polymorfa chat message media +15550001111 739182640518204 --session NUMBER_ID --output ./attachment.bin

Arguments

  • CONVERSATIONrequired

    Conversation ID or E.164 phone number.

  • MESSAGErequired

    Opaque Polymorfa message ID.

Flags

  • --forceboolean

    Overwrite an existing output file.

  • --max-bytes <value>takes a value

    Maximum bytes to download (default 32 MiB).

    Default 33554432
  • -o, --output <value>takes a valuerequired

    Destination file path.

  • --session <value>takes a valuerequired

    Messaging Number ID.

Also accepts the global flags.

polymorfa chat message view

View one stored message for an enrolled HMS Number (beta). Requires messages:read.

Usage

polymorfa chat message view CONVERSATION MESSAGE [flags]

Arguments

  • CONVERSATIONrequired

    Conversation ID or E.164 phone number.

  • MESSAGErequired

    Opaque Polymorfa message ID.

Flags

  • --session <value>takes a valuerequired

    Messaging Number ID.

Also accepts the global flags.

polymorfa chat view

View one stored chat for an enrolled HMS Number (beta). Requires chats:read.

Usage

polymorfa chat view CONVERSATION [flags]

Arguments

  • CONVERSATIONrequired

    Conversation ID or E.164 phone number.

Flags

  • --session <value>takes a valuerequired

    Messaging Number ID.

Also accepts the global flags.