Skip to main content
Create a calling session for the Landbase dialer from an imported contact tag, optionally assign it to a teammate, and inspect its live contact counts. The command has two subcommands: create and status.
dialer-sessions is a platform-mode command. Before running it:
  1. landbase-cli auth login — authenticate the session.
  2. Optionally run landbase-cli account set to persist a target account. Without a saved choice, the CLI auto-selects your only account. With several accounts it prompts only in an interactive terminal; non-interactive agents must use account set beforehand or pass --account=<id>.
  3. landbase-cli contacts-import start — import contacts and wait for the import to produce a tag.

dialer-sessions create

Create a dialer session from a tag. The command reads the complete session definition from a JSON file or stdin. Usage
string
required
Path to a JSON file containing the session definition, or - to read it from stdin.

create --json config

The audience currently supports imported tags only. Use exactly one tag identifier:
  • tagName is the human-readable tag name you supplied to contacts-import.
  • tagId is the numeric tag id. Use it when a tag name is ambiguous; the tag_name_ambiguous error includes matching candidates under error.meta.tags[]. Copy a candidate’s id into audience.tagId.
If both values are present, or both are omitted, the CLI exits with INVALID_INPUT before sending the request.

Enrichment modes

Assign the session to a teammate

List assignable users and copy the target user’s identityId into assignedUserId in the create config:
Account Owners can assign a session to any current member returned by account users; everyone else may only self-assign. The assigned user must have the dialer channel permission. Unlike email and LinkedIn readiness, dialer readiness is checked by the server when the session is created and is not included as a flag in account users.

Create response

See Output schemas for the response field reference.
contactsCount: 0 is a successful create, not an API failure. The session exists, but dialer selection produced no primary contact rows. Check that the tag contains contacts whose phone availability is AVAILABLE or TO_ENRICH. The selected enrichment mode changes how those contacts are processed; it does not decide whether they are counted.
After creation, use the returned numeric id to inspect the session:

dialer-sessions status

Return the current owner, enrichment mode, and live contact counts for a dialer session. Usage
integer
required
Positive numeric session id returned by dialer-sessions create. The CLI accepts 1–12 decimal digits.
Response
See Output schemas for the response field reference. createdBy is the caller’s identityId for sessions created through the CLI. It can be null for sessions created in the web app. contacts.byDialStatus is a live breakdown by server-provided dial status; use it to monitor progress or investigate a low contact count.

Errors

Local CLI checks use stable uppercase codes. Gateway and back-end validation errors without a typed Landbase envelope surface as http_422 or http_400. Typed back-end errors pass through verbatim and are safe to inspect as error.code: To create a session from a new CSV, complete contacts-import first, then use the resulting tag in the create config.