Chat

Get the current chat widget information (status, settings, etc.)

Changed on
get/v1/chat/widget

Request

Query parameters

apiKeystring

Chat widget API key

urlstring

Url

iosKeystring

Chat widget iOS key

androidKeystring

Chat widget Android key

visitorIdstring

Contact Visitor ID

emailstring

Contact email

phonestring

Contact phone

userHashstring

User hash (SHA256 HMAC, required if identity verification is forced)

Response

OK

statusCodeinteger nullable
successboolean
messagestring nullable

Changes

    • warning

      added the new -3311.00 enum value to the / response property for the response status

    • warning

      added the new -3312.00 enum value to the / response property for the response status

    • warning

      added the new -3313.00 enum value to the / response property for the response status

    • warning

      added the new -3314.00 enum value to the / response property for the response status

    • info

      added the optional property // to the response with the status

    • warning

      added the new -341.00 enum value to the / response property for the response status