1. References
  2. Management API
  3. DialogflowCredentials
Rate this page:

DialogflowCredentials

Methods

AddDialogflowKey

Copy URL

Adds a Dialogflow key.

Available for roles

To call this method, make sure your service account has one of the following roles:

See Available Roles
Owner
Admin
Developer
AddDialogflowKey example
Copy

AddDialogflowKey example

Add new Dialogflow credential.

Parameters

  • application_id:

    string

    The application ID

  • application_name:

    string

    Optional

    The application name. Can be used instead of application_id

  • description:

    string

    Optional

    The Dialogflow key's description

  • json_credentials:

    string

    Dialogflow credentials, provided by JWK (Json web key)

Returns

  • dialogflow_key_id:

    number

  • result:

    number

BindDialogflowKeys

Copy URL

Binds a Dialogflow key to the specified applications.

Available for roles

To call this method, make sure your service account has one of the following roles:

See Available Roles
Owner
Admin
Developer
BindDialogflowKeys example
Copy

BindDialogflowKeys example

Bind a Dialogflow key to the application.

Parameters

  • application_id:

    intlist

    The application ID list separated by semicolons (;). Use the 'all' value to select all applications

  • bind:

    boolean

    Optional

    Whether to bind or unbind (set true or false respectively)

  • dialogflow_key_id:

    number

    The Dialogflow key's ID

Returns

  • result:

    number

DelDialogflowKey

Copy URL

Removes a Dialogflow key.

Available for roles

To call this method, make sure your service account has one of the following roles:

See Available Roles
Owner
Admin
Developer
DelDialogflowKey example
Copy

DelDialogflowKey example

Remove key.

Parameters

  • dialogflow_key_id:

    number

    The Dialogflow key's ID

Returns

  • result:

    number

GetDialogflowKeys

Copy URL

Gets Dialogflow keys.

Available for roles

To call this method, make sure your service account has one of the following roles:

See Available Roles
Owner
Admin
Developer
GetDialogflowKeys example
Copy

GetDialogflowKeys example

Get push credentials.

Parameters

  • application_id:

    number

    Optional

    The id of the bound application

  • application_name:

    string

    Optional

    The name of the bound application

  • dialogflow_key_id:

    number

    Optional

    The Dialogflow key's ID

Returns

SetDialogflowKey

Copy URL

Edits a Dialogflow key.

SetDialogflowKey example
Copy

SetDialogflowKey example

Set the new description for dialogflow_key_id = 3324 and account_id = 1.

Parameters

  • description:

    string

    The Dialogflow keys's description. To clear previously set description leave the parameter blank or put whitespaces only

  • dialogflow_key_id:

    number

    The Dialogflow key's ID

Returns

  • result:

    number