Zur Navigation springen
ReceptionReceptionistsProcedures

Add Procedure

Add a procedure (SOP) to the named receptionist.

Pfadparameter

agent_idstringErforderlich

Header

xi-api-keystringOptional
xi-workspace-idstring or nullOptional
The customer workspace a reseller's API key acts on.

Anfrage

This endpoint expects an object.
namestringErforderlich
Name of the procedure.
triggerstringErforderlich
When the receptionist should run the procedure, in natural language. The receptionist matches caller requests against it, e.g. 'When the caller wants to book an appointment'.
bodystringOptional<=40000 charactersStandardwert ist

Step-by-step instructions, as markdown.

Antwort

Erfolgreiche Antwort
namestring
Name of the procedure.
triggerstring
When the receptionist should run the procedure, in natural language. The receptionist matches caller requests against it, e.g. 'When the caller wants to book an appointment'.
bodystringOptional<=40000 charactersStandardwert ist

Step-by-step instructions, as markdown.

idstringOptional
created_at_unixintegerOptional

Unix timestamp (seconds since epoch)

source_keystring or nullOptional

Fehler

422
Unprocessable Entity Error