1-877-548-3001 Sign in About Contact
Developer

GET

/api/visitor/{id}

Get the information for a specific visitor

Scope:

client

or

operator

Request Parameters

Path

A

id

required

The id of the visitor

Response

Schema

{}

payload

The visitor data

{}

visitor

The visitor data

{}

details

The visitor details

[]

{}

2

crm

The crm id

A

name

The visitor details key

A

2

value

The visitor details value

A

status

The system response status. Will be ok or error

curl

example request

1

curl -H "Authorization: Bearer {{Oauth Token}}"

2

https://developer.livehelpnow.net/api/visitor/{{6f83df80-d39b-4a9f-a2b6-892d88ea4ab2-1-BDgXtjZ1}}

example response

      
        

1

 {

2

   "payload": {

3

     "visitor": {

4

       "details": [{

5

         "name"

: "id",

6

         "value"

: "da866935-a344-451b-ae42-1690f5c92f84-1-qik3nsTY"

7

         }, {

8

         "name"

: "ip address",

9

         "value"

: "127.0.0.1"

10

        }, {

11

        "name"

: "hostname",

12

        "value"

: "127.0.0.1"

13

        }, {

14

        "name"

: "browser",

15

        "value"

: "Chrome"

16

        }, {

17

        "name"

: "browser version",

18

        "value"

: "89.0"

19

        }, {

20

        "name"

: "browser platform",

21

        "value"

: "Mac"

22

        }, {

23

        "name"

: "javascript enabled",

24

        "value"

: true

25

        }, {

26

        "name"

: "current status",

27

        "value"

: 1

28

        }, {

29

        "name"

: "image url",

30

        "value"

: ""

31

        }, {

32

        "name"

: "chat state id",

33

        "value"

: 4

34

        }, {

35

        "name"

: "chat state",

36

        "value"

: "disconnected"

37

        }, {

38

        "name"

: "page visited count",

39

        "value"

: 21

40

        }, {

41

        "name"

: "current page",

42

        "value"

: "http://localhost:4002/test/hoc/"

43

        }, {

44

        "name"

: "department",

45

        "value"

: "Help Desk"

46

        }, {

47

        "name"

: "country name",

48

        "value"

: "United States"

49

        }, {

50

        "name"

: "country iso2",

51

        "value"

: "US"

52

        }, {

53

        "crm"

: 111,

54

        "name"

: "Name <a href="http://www.google.com">testing</a>",

55

        "value"

: "John Doe"

56

        }, {

57

        "crm"

: 48,

58

        "name"

: "Email",

59

        "value"

: "john.doe@livehelpnow.com"

60

        }, {

61

        "crm"

: 46146,

62

        "name"

: "Question",

63

        "value"

: "test"

64

        }, {

65

        "name"

: "Custom1",

66

        "value"

: "test - 2"

67

        }, {

68

        "name"

: "Custom2",

69

        "value"

: ""

70

        }, {

71

        "name"

: "Custom3",

72

        "value"

: ""

73

        }, {

74

        "name"

: "score",

75

        "value"

: 0

76

        }, {

77

        "name"

: "search engine",

78

        "value"

: null

79

        }, {

80

        "name"

: "search query",

81

        "value"

: null

82

        }, {

83

        "name"

: "city",

84

        "value"

: null

85

        }, {

86

        "name"

: "regions",

87

        "value"

: null

88

        }, {

89

        "name"

: "postal code",

90

        "value"

: null

91

        }, {

92

        "name"

: "isp",

93

        "value"

: null

94

      }],

95

      "notes" : [{

96

        "created_by"

: "John Doe",

97

        "created_time"

: "2021-07-13T12:40:51",

98

        "note"

: "This is a test note for visitor"

99

      }]

100

    }

101

  },

102

  "status": "ok"

103

 }