POST api/Webhook/Receiver

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Messages	Collection of Message	None.
ChatEnded	boolean	None.
StatusCode	integer	None.
Alias	string	None.
SecureKey	string	None.
UserId	string	None.
ChatId	string	None.
Errors	Collection of Error	None.
ChannelId	string	None.
ReceipientId	string	None.
NextPosition	integer	None.
Monitored	boolean	None.
SmartcardNumber	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Messages": [
    {
      "From": {
        "nickname": "sample string 1",
        "participantId": 2,
        "type": "sample string 3"
      },
      "Index": 1,
      "Type": "sample string 2",
      "UtcTime": {},
      "Text": "sample string 4",
      "EventAttributes": {
        "GCTI_SYSTEM": {
          "Quit_reason_code": "sample string 1"
        }
      },
      "UserData": {
        "File_document_id": "sample string 1",
        "File_source": "sample string 2",
        "File_id": "sample string 3",
        "File_deleted": "sample string 4",
        "File_size": "sample string 5",
        "File_name": "sample string 6",
        "Uploaded_event_id": "sample string 7"
      }
    },
    {
      "From": {
        "nickname": "sample string 1",
        "participantId": 2,
        "type": "sample string 3"
      },
      "Index": 1,
      "Type": "sample string 2",
      "UtcTime": {},
      "Text": "sample string 4",
      "EventAttributes": {
        "GCTI_SYSTEM": {
          "Quit_reason_code": "sample string 1"
        }
      },
      "UserData": {
        "File_document_id": "sample string 1",
        "File_source": "sample string 2",
        "File_id": "sample string 3",
        "File_deleted": "sample string 4",
        "File_size": "sample string 5",
        "File_name": "sample string 6",
        "Uploaded_event_id": "sample string 7"
      }
    }
  ],
  "ChatEnded": true,
  "StatusCode": 2,
  "Alias": "sample string 3",
  "SecureKey": "sample string 4",
  "UserId": "sample string 5",
  "ChatId": "sample string 6",
  "Errors": [
    {
      "code": 1,
      "advice": "sample string 2"
    },
    {
      "code": 1,
      "advice": "sample string 2"
    }
  ],
  "ChannelId": "sample string 7",
  "ReceipientId": "sample string 8",
  "NextPosition": 9,
  "Monitored": true,
  "SmartcardNumber": "sample string 11"
}

application/xml, text/xml

Sample:

<SendAndRecieveMessageResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LiveChatClient.Model">
  <Alias>sample string 3</Alias>
  <ChannelId>sample string 7</ChannelId>
  <ChatEnded>true</ChatEnded>
  <ChatId>sample string 6</ChatId>
  <Errors>
    <Error>
      <advice>sample string 2</advice>
      <code>1</code>
    </Error>
    <Error>
      <advice>sample string 2</advice>
      <code>1</code>
    </Error>
  </Errors>
  <Messages>
    <Message>
      <EventAttributes>
        <GCTI_SYSTEM>
          <Quit_reason_code>sample string 1</Quit_reason_code>
        </GCTI_SYSTEM>
      </EventAttributes>
      <From xmlns:d4p1="http://schemas.datacontract.org/2004/07/LiveChatClient">
        <d4p1:nickname>sample string 1</d4p1:nickname>
        <d4p1:participantId>2</d4p1:participantId>
        <d4p1:type>sample string 3</d4p1:type>
      </From>
      <Index>1</Index>
      <Text>sample string 4</Text>
      <Type>sample string 2</Type>
      <UserData>
        <File_deleted>sample string 4</File_deleted>
        <File_document_id>sample string 1</File_document_id>
        <File_id>sample string 3</File_id>
        <File_name>sample string 6</File_name>
        <File_size>sample string 5</File_size>
        <File_source>sample string 2</File_source>
        <Uploaded_event_id>sample string 7</Uploaded_event_id>
      </UserData>
      <UtcTime />
    </Message>
    <Message>
      <EventAttributes>
        <GCTI_SYSTEM>
          <Quit_reason_code>sample string 1</Quit_reason_code>
        </GCTI_SYSTEM>
      </EventAttributes>
      <From xmlns:d4p1="http://schemas.datacontract.org/2004/07/LiveChatClient">
        <d4p1:nickname>sample string 1</d4p1:nickname>
        <d4p1:participantId>2</d4p1:participantId>
        <d4p1:type>sample string 3</d4p1:type>
      </From>
      <Index>1</Index>
      <Text>sample string 4</Text>
      <Type>sample string 2</Type>
      <UserData>
        <File_deleted>sample string 4</File_deleted>
        <File_document_id>sample string 1</File_document_id>
        <File_id>sample string 3</File_id>
        <File_name>sample string 6</File_name>
        <File_size>sample string 5</File_size>
        <File_source>sample string 2</File_source>
        <Uploaded_event_id>sample string 7</Uploaded_event_id>
      </UserData>
      <UtcTime />
    </Message>
  </Messages>
  <Monitored>true</Monitored>
  <NextPosition>9</NextPosition>
  <ReceipientId>sample string 8</ReceipientId>
  <SecureKey>sample string 4</SecureKey>
  <SmartcardNumber>sample string 11</SmartcardNumber>
  <StatusCode>2</StatusCode>
  <UserId>sample string 5</UserId>
</SendAndRecieveMessageResponse>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'SendAndRecieveMessageResponse'.

Response Information

Resource Description

None.