Update Dialogflow agent

PUT

https://{your_space_name}.signalwire.com/api/fabric/resources/dialogflow_agents/:id

PUT

/api/fabric/resources/dialogflow_agents/:id

curl -X PUT https://{your_space_name}.signalwire.com/api/fabric/resources/dialogflow_agents/id \
     -H "Content-Type: application/json" \
     -u "<project_id>:<api_token>" \
     -d '{}'

{
  "id": "993ed018-9e79-4e50-b97b-984bd5534095",
  "project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
  "display_name": "Customer Service Agent",
  "type": "dialogflow_agent",
  "created_at": "2024-05-06T12:20:00Z",
  "updated_at": "2024-05-06T12:20:00Z",
  "dialogflow_agent": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "say_enabled": true,
    "say": "Welcome to the Booking Assistant",
    "voice": "en-US-Wavenet-D",
    "display_name": "Booking Assistant",
    "dialogflow_reference_id": "12345678-1234-1234-1234-1234567890ab",
    "dialogflow_reference_name": "my dialogflow agent"
  }
}

Updates how SignalWire connects to and presents a Dialogflow-backed AI Agent. This changes the linked resource in your SignalWire project, not the agent hosted in Dialogflow. Use Update AI agent for an agent configured directly in SignalWire.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice, Messaging, Fax, or Video.

Learn more about API scopes.

Authentication

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)

Path parameters

idstringRequiredformat: "uuid"

Unique ID of a Dialogflow Agent.

Request

This endpoint expects an object.

namestringOptional

Name of the Dialogflow Agent

say_enabledbooleanOptional

Whether to enable the 'say' feature

saystringOptional

Default message to say

voicestringOptional

Voice to use for speech

Response

The request has succeeded.

idstringformat: "uuid"

Unique ID of the Dialogflow Agent.

project_idstringformat: "uuid"

Unique ID of the Project.

display_namestring

Display name of the Dialogflow Agent Fabric Resource

typeenum

Type of the Fabric Resource

Allowed values:

created_atdatetime

Date and time when the resource was created.

updated_atdatetime

Date and time when the resource was updated.

dialogflow_agentobject

Dialogflow Agent data.

Errors

401

Unauthorized Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error