SIGN UP

Dialogflow Credentials

Methods

AddDialogflowKey

Add Dialogflow key

Parameters

  • Follow link for authentication parameter names and details.

  • application_id:

    string

    The application ID.

  • application_name:

    string
    OPTIONAL

    The application name. Can be used instead of application_id.

  • json_credentials:

    string

    Dialogflow credentials, provided by JWK (Json web key).

  • description:

    string
    OPTIONAL

    The Dialogflow keys's description.

Returns

  • result:

    number
  • dialogflow_key_id:

    number

Examples

request:

Add new Dialogflow credential.

curl -F json_credentials=@dialogflow.json  'https://api.voximplant.com/platform_api/AddDialogflowKey/?account_id=1&api_key=4ed6066e-4688-443a-90e8-3f8f8481287c'

response:

{
    "result": 1,
    "dialogflow_key_id": 1
}

BindDialogflowKeys

Bind a Dialogflow key to the specified applications

Parameters

  • Follow link for authentication parameter names and details.

  • dialogflow_key_id:

    number

    The Dialogflow key's ID

  • application_id:

    intlist

    The application ID list separated by the ';' symbol or the 'all' value.

  • bind:

    boolean
    OPTIONAL

    Set to false to unbind. Default value is true.

Returns

  • result:

    number

Examples

request:

Bind a Dialogflow key to the application.

https://api.voximplant.com/platform_api/BindDialogflowKeys/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&dialogflow_key_id=1&application_id=1

response:

{
    "result": 1
}

DelDialogflowKey

Remove Dialogflow key

Parameters

  • Follow link for authentication parameter names and details.

  • dialogflow_key_id:

    number

    The Dialogflow key's ID.

Returns

  • result:

    number

Examples

request:

Remove key.

https://api.voximplant.com/platform_api/DelDialogflowKey/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&dialogflow_key_id=1

response:

{
    "result": 1
}

GetDialogflowKeys

Get Dialogflow keys

Parameters

  • Follow link for authentication parameter names and details.

  • dialogflow_key_id:

    number
    OPTIONAL

    The Dialogflow key's ID.

  • application_name:

    string
    OPTIONAL

    The name of bound application.

  • application_id:

    number
    OPTIONAL

    The id of bound application.

Returns

Examples

request:

Get push credentials.

https://api.voximplant.com/platform_api/GetDialogflowKeys/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&dialogflow_key_id=1

response:

{
    "result": [
        {
            "content": {
                "project_id": "test.app"
            },
            "applications": [
                {
                    "application_id": 1,
                    "application_name": "test.test.voximplant.com"
                }
            ],
            "dialogflow_key_id": 1
        }
    ]
}

SetDialogflowKey

Edit Dialogflow key

Parameters

  • Follow link for authentication parameter names and details.

  • dialogflow_key_id:

    number

    The Dialogflow key's ID.

  • description:

    string

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

Returns

  • result:

    number

Examples

request:

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

curl -F json_credentials=@dialogflow.json  'https://api.voximplant.com/platform_api/SetDialogflowKey/?account_id=1&api_key=4ed6066e-4688-443a-90e8-3f8f8481287c&dialogflow_key_id=3324&description=new description'

response:

{
    "result": 1
}