Rate this page:

customData

Copy URL
customData(cData: 

string

):

string

|

void

Set or get custom string associated with current JavaScript session. There are two kinds of the customData values: one is for JavaScript session (i.e., VoxEngine object), another is for the particular call (i.e., Call.customData and WEB SDK parameter of the method). It's possible to use them at the same time because they are independent entities. Remember that if you receive some value from WEB SDK, it doesn't overwrite the VoxEngine's value. Any of customData's type values can be later obtained from Call History using HTTP API or Control Panel.

Parameters

  • cData:

    string

    Optional

    Custom session data to set. Maximum size is 200 bytes.

Returns

  • type:

    string

  • type:

    void