Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This function calls the CT7 url configured to start The configured webhook is called to notify the CTI about the start of a new chat.

Method:

Status
colourYellow
titlehttp post

Authorization

...

Type

Mandatory

Status
titlebearer

Status
colourRed
titleyes

Request Body:

Type:
Status
titlejson

Name

Mandatory

Type

Description

cid

Status
colourRed
titleyes

Status
titlestring

Unique contact identifier

media

Status
colourRed
titleyes

Status
titlestring

Identifies media channel. In this case set it to “chat”

serv

Status
colourRed
titleyes

Status
titlestring

Unique service identifier

event

Status
colourRed
titleyes

Status
titlestring

Identifies event: new

serv_name

Status
colourRed
titleyes

Status
titlestring

Service name

beginTime

Status
colourRed
titleyes

Status
titlenumber
/
Status
titlestring

Chat start time

endTime

Status
colourRed
titleyes

Status
titlenumber
/
Status
titlestring

Chat end time: ““. In this case set it to empty string

title

Status
colourRed
titleyes

Status
titlestring

Chat title

lang

Status
colourRed
titleyes

Status
titlestring

Chat language

userID

Status
colourRed
titleyes

Status
titlestring

Unique user identifier

users

Status
colourRed
titleyes

Status
titleobject

An object that contains the participants to the chat room.

dataCollections

Status
colourRed
titleyes

Status
titleobject

An object that contains the chat data collections.widgetID Data Collection Object

widgetid

Status
colourRed
titleyes

Status
titlestring

Unique widget identifier

Example:

Request Body

Code Block
languagejson
{
  cid: contact.id,
  media: "chat",
  serv: contact.servid,
  event: "new",
  serv_name: contact.serv_name,
  beginTime: contact.beginTime,
  endTime: contact.endTime,
  title: contact.title,
  lang: contact.lang,
  userID: contact.userID,
  users: contact.users,
  dataCollections: contact.dataCollections,
  widgetid: contact.widgetid
}