Get Agent

string

default:"507f1f77bcf86cd799439011"

required

Unique identifier for the created agent

string

default:"LOC123456789ABCDEF"

required

Unique identifier for the account where this agent operates

string

default:"Customer Support Agent"

required

Display name of the voice AI agent

string

default:"Acme Corporation"

required

Name of the business this agent represents

string

required

Greeting message spoken when the agent answers calls

string

required

Custom instructions defining the agent’s behavior

string

default:"507f1f77bcf86cd799439011"

required

Identifier for the speech synthesis voice being used

string

default:"en-US"

required

Language code for the agent’s speech and understanding

string

default:"medium"

required

Current tolerance level for caller response delays

number

default:"600"

required

Maximum call duration in seconds, between 180-900

boolean

default:"True"

required

Indicates whether automatic idle reminders are enabled

number

default:"5"

required

Seconds to wait before sending idle reminders, between 1-20

string

default:"+1234567890"

Phone number for receiving inbound calls

string

default:"pool_507f1f77bcf86cd799439011"

Identifier for the number pool managing this agent’s phone allocation

string[]

Array of workflow IDs triggered automatically when calls end

object

Current post-call notification settings including recipient configuration

object[]

Time intervals when the agent accepts calls, organized by day of week

Show cada item

number

default:"1"

required

Day of the week for this working hours configuration (Monday=1 to Sunday=7) Posibles valores: 1, 2, 3, 4, 5, 6, 7

object[]

required

Array of time intervals when the agent is available on this day

Show cada item

number

default:"9"

required

Starting hour of the working interval in 24-hour format (0-23)

number

default:"17"

required

Ending hour of the working interval in 24-hour format (0-23)

number

default:"0"

required

Starting minute of the working interval (0-59)

number

default:"30"

required

Ending minute of the working interval (0-59)

string

default:"America/New_York"

required

IANA timezone identifier for working hours and scheduling

boolean

default:"False"

required

Indicates whether this agent is excluded from backup scenarios

object

Current language translation settings including enablement status and target language

object[]

required

Raw actions configured for this agent with complete actionParameters structure

Show cada item

string

default:"507f1f77bcf86cd799439011"

required

Unique identifier for this action

string

default:"CALL_TRANSFER"

required

Type of action Posibles valores: ‘CALL_TRANSFER’, ‘DATA_EXTRACTION’, ‘IN_CALL_DATA_EXTRACTION’, ‘WORKFLOW_TRIGGER’, ‘SMS’, ‘APPOINTMENT_BOOKING’, ‘CUSTOM_ACTION’, ‘KNOWLEDGE_BASE’

string

default:"Transfer to Manager"

required

Human-readable name for this action

object

required

Action parameters - structure varies by actionType

{
  "id": "507f1f77bcf86cd799439011",
  "locationId": "LOC123456789ABCDEF",
  "agentName": "Customer Support Agent",
  "businessName": "Acme Corporation",
  "welcomeMessage": "Hello! Thank you for calling. How can I assist you today?",
  "agentPrompt": "You are a helpful customer service representative.",
  "voiceId": "507f1f77bcf86cd799439011",
  "language": "en-US",
  "patienceLevel": "medium",
  "maxCallDuration": 600,
  "sendUserIdleReminders": true,
  "reminderAfterIdleTimeSeconds": 5,
  "inboundNumber": "+1234567890",
  "numberPoolId": "pool_507f1f77bcf86cd799439011",
  "callEndWorkflowIds": [],
  "agentWorkingHours": [],
  "timezone": "America/New_York",
  "isAgentAsBackupDisabled": false,
  "actions": [
    {
      "_id": "507f1f77bcf86cd799439011",
      "actionType": "CALL_TRANSFER",
      "name": "Transfer to Manager",
      "actionParameters": {
        "triggerPrompt": "When caller asks for manager",
        "triggerMessage": "Let me transfer you",
        "transferToType": "number",
        "transferToValue": "+1234567890"
      }
    }
  ]
}

Empezar

Scopes

Autorización

Path parameters

Query parameters

Respuestas

Ejemplo

​Autorización

​Path parameters

​Query parameters

​Respuestas

​Ejemplo

Autorización

Path parameters

Query parameters

Respuestas

Ejemplo