The optional visitorContext attribute (JSON object) that can be passed in the request data can contain the following contextual information about the visitor and the call request:
Attribute Name | Usage | Notes |
---|---|---|
visitorId | Optional | Identifies the visitor. |
referrerUrl | Optional | URL of the page from which the call initiated. |
language | Optional | Two‐digit ISO code that identifies the language to be used for the call request. |
<optionalDataFieldName> | Optional | Specifies value for the optional data field identified using either its account‐specific label or the internal varN field name, where N is 1 to 10. Up to 10 optional data fields can be specified in this way. Refer to Appendix B: Handling Optional Data for further information. |
The Call Setup API also captures the caller’s IP address from the HTTP request.