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

POST

/api/chat/proactive_invite

Send a visitor a proactive invitation

Scope:

client

or

client

or

client

or

client

or

operator

Request Parameters

Query

A

message

required

The message that will be inserted into the chat

A

visitor_id

required

The visitor ID to send the invite to

Response

Schema

{}

payload

The proactive invite data

{}

A

chatMessage

The message that was sent for the invite

A

createdTime

he date and time the invite was sent in format YYYY-MM-DDTHH:MM:SSZ

A

fromName

The name of the operator who sent the invite

2

messageId

The id of the message

2

messageSubType

The message subtype

2

messageType

The message type

2

operatorId

The id of the operator who sent the invite

A

status

The system response status. Will be ok or error

curl

example request

1

curl -X POST -d '{"message":"Test Message","visitor_id":"6f83df80-d39b-4a9f-a2b6-892d88ea4ab2-1-BDgXtjZ1"}'

2

-H "Content-Type: application/json"

3

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

4

https://developer.livehelpnow.net/api/chat/proactive_invite

example response

      
        

1

 {

2

   "payload": {

3

     "chatMessage"

: "Testing proactive chat message endpoint",

4

     "createdTime"

: "2021-07-01T07:47:20",

5

     "fromName"

: "John",

6

     "messageId"

: "12345678",

7

     "messageSubType"

: 9,

8

     "messageType"

: 3,

9

     "operatorId"

: 24638

10

  },

11

  "status": "ok"

12

 }