Create interaction context mapping

Creates an interaction context mapping, returned as interaction_context_mapping, with the same rules as the Interaction context mapping page of the contact center.

  • imported (default): values come from the given sources. At least one source type with at least one key is required; description is not allowed.
  • collected_by_ai_agent: an AI agent fills the field from the conversation. description is required; sources is not allowed, and show_in_ai_agents cannot be true.

context_key is derived from name. show_in_ai_agents cannot be true together with a sip_header source. A rule broken answers 422 and creates nothing.

Requires the contact_center.interaction_context_mappings.manage scope.

Body Params
string
required
length ≤ 100

The field name, unique in the contact center. Must contain at least one Latin letter or digit.

string
enum
Defaults to imported

The field type. Defaults to imported.

Allowed:
string
length ≤ 2048

What the AI agent listens for, at most 2048 characters and 2048 bytes. Required for collected_by_ai_agent; not allowed for imported.

sources
object

The metadata sources. Required for imported, with at least one source type; not allowed for collected_by_ai_agent.

boolean
Defaults to true

Whether the field is shown in Agent Workspace. Defaults to true.

boolean

Whether the field can be used in the prompt and greeting message of Voiso AI agents. Not allowed with a sip_header source or for collected_by_ai_agent. When left out, true for an imported field whose only source is dialer_lead_list, otherwise false.

Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json