Przejdź do nawigacji
ReceptionReceptionistsProcedures

Add Procedure

Add a procedure (SOP) to the named receptionist.

Parametry ścieżki

agent_idstringWymagany

Nagłówki

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

Żądanie

This endpoint expects an object.
namestringWymagany
Name of the procedure.
triggerstringWymagany
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'.
bodystringOpcjonalny<=40000 charactersDomyślnie

Step-by-step instructions, as markdown.

Odpowiedź

Pomyślna odpowiedź

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'.
bodystringOpcjonalny<=40000 charactersDomyślnie

Step-by-step instructions, as markdown.

idstringOpcjonalny
created_at_unixintegerOpcjonalny

Unix timestamp (seconds since epoch)

source_keystring or nullOpcjonalny

Błędy

422
Unprocessable Entity Error