POST
/api/chat/proactive_invite
Send a visitor a proactive invitation
Scope:
client
or
operator
Request Parameters
Query
message
required
The message that will be inserted into the chat
visitor_id
required
The visitor ID to send the invite to
Response
Schema
payload
The proactive invite data
chatMessage
The message that was sent for the invite
createdTime
he date and time the invite was sent in format YYYY-MM-DDTHH:MM:SSZ
fromName
The name of the operator who sent the invite
messageId
The id of the message
messageSubType
The message subtype
messageType
The message type
operatorId
The id of the operator who sent the invite
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
}