Open a dialog for a user | Sample

3 parameters

dialogstringrequired

The dialog definition encoded as a JSON string.

trigger_idstringrequired

The interaction trigger to exchange when posting the dialog to the user.

tokenstringrequired

Authentication token with no additional scope requirement.

2 status codes

200Returns `ok: true` after the dialog has been opened.

okbooleanrequired

Allowed:true

defaultReturned when the dialog or trigger is missing, invalid, expired, or already exchanged, or when the dialog cannot be sent.

callstackstringoptional

Note: PHP callstack is only visible in dev/qa

errorstringrequired

Allowed:validation_errorsmissing_triggermissing_dialogtrigger_exchangedtrigger_expiredinvalid_triggerapp_missing_action_urlcannot_create_dialogfailed_sending_dialognot_authedinvalid_authaccount_inactive

okbooleanrequired

Allowed:false

Error handling

token, dialog, and trigger_id must all be supplied. Encode dialog as a JSON string, and use an unexpired, valid trigger_id that has not already been exchanged.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.dialogOpen.list({
  dialog: "example",
  triggerId: "c0a80123-4567-89ab-cdef-0123456789ab",
});

{
  "ok": true
}

Request

Response

Errors