Metadata

Interakce v UCS (hovory, e-maily, SMS, tásky) s sebou mohou nést uživatelská data ve formě klíč hodnota.

Sufixy

Pro nastavení metadat hovorů přímo v dialplanu je nutné k názvu dané proměnné přidat sufix __DATA__ (předává skalární hodnotu) nebo __JSON__ (předává JSON serializovanou hodnotu). Případně lze využít sufix __SIP__ (nenastaví metadata, ale předá hodnotu jako SIP hlavičku).

Především se těchto sufixů využívá při volání API metody call.originate, která jako šestý argument akceptuje metadata.

caller = "Company <+420222333444>"
channel = "Local/+420555666777@filter-1-internal"
context = "dialer"
extension = "s"
timeout = 120
metadata = {
    "deliver__DATA__": "ringing",
    "customer__JSON__": '{"id": 1234, "name": "Some Name"}',
    "X-External-Id__SIP__": "abcd1234",
}
ucs.call.originate(caller, channel, context, extension, timeout, metadata)

Sufix __SIP__ má význam i v nastavení metadat na jednotlivých Extensions v dialplanu UCS, který se využije v poli Metadata key. Případně v metadatatech Outbound campaigns a Leads.

Dialer

Dialer umožňuje pro sufix __SIP__ v Outbound campaigns a Leads použít proměnné %call.attribute%, %call.metadata.key%, %lead.attribute% a %lead.metadata.key%. Pozor, proměnné %call. jsou dostupné pouze pro kanál vytáčený na telefon agenta.