Naar navigatie springen
ReceptionReceptionistsProcedures

Add Procedure

Add a procedure (SOP) to the named receptionist.

Padparameters

agent_idstringVerplicht

Headers

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

Verzoek

This endpoint expects an object.
namestringVerplicht
Name of the procedure.
triggerstringVerplicht
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'.
bodystringOptioneel<=40000 charactersStandaard

Step-by-step instructions, as markdown.

Response

Geslaagde response
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'.
bodystringOptioneel<=40000 charactersStandaard

Step-by-step instructions, as markdown.

idstringOptioneel
created_at_unixintegerOptioneel

Unix timestamp (seconds since epoch)

source_keystring or nullOptioneel

Fouten

422
Unprocessable Entity Error