POST API/Bot/whatsappNotification

Request Information

URI Parameters

None.

Body Parameters

WEBHOOK
NameDescriptionTypeAdditional information
userId

string

None.

source

string

None.

campaign

string

None.

templateId

string

None.

msgId

string

None.

workflowId

integer

None.

firstName

string

None.

phone

string

None.

UID

string

None.

event

Event

None.

Request Formats

application/json, text/json

Sample:
{
  "userId": "sample string 1",
  "source": "sample string 2",
  "campaign": "sample string 3",
  "templateId": "sample string 4",
  "msgId": "sample string 5",
  "workflowId": 6,
  "firstName": "sample string 7",
  "phone": "sample string 8",
  "UID": "sample string 9",
  "event": {
    "status": "sample string 1"
  }
}

application/xml, text/xml

Sample:
<WEBHOOK xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Phoenix.IN.Common.Models.Common">
  <UID>sample string 9</UID>
  <campaign>sample string 3</campaign>
  <event1>
    <status>sample string 1</status>
  </event1>
  <firstName>sample string 7</firstName>
  <msgId>sample string 5</msgId>
  <phone>sample string 8</phone>
  <source>sample string 2</source>
  <templateId>sample string 4</templateId>
  <userId>sample string 1</userId>
  <workflowId>6</workflowId>
</WEBHOOK>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResultInfoOfWEBHOOKResponse
NameDescriptionTypeAdditional information
AccessToken

string

None.

TokenType

string

None.

ResultType

TypeOfResult

None.

ResultCode

integer

None.

ResultDesc

string

None.

Result

WEBHOOKResponse

None.

Response Formats

application/json, text/json

Sample:
{
  "AccessToken": "sample string 1",
  "TokenType": "sample string 2",
  "ResultType": 0,
  "ResultCode": 3,
  "ResultDesc": "sample string 4",
  "Result": {
    "ResponseMSG": "sample string 1"
  }
}

application/xml, text/xml

Sample:
<ResultInfoOfWEBHOOKResponseJWNS7fKj xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Phoenix.IN.Common.Models.Common">
  <AccessToken>sample string 1</AccessToken>
  <Result>
    <ResponseMSG>sample string 1</ResponseMSG>
  </Result>
  <ResultCode>3</ResultCode>
  <ResultDesc>sample string 4</ResultDesc>
  <ResultType>Success</ResultType>
  <TokenType>sample string 2</TokenType>
</ResultInfoOfWEBHOOKResponseJWNS7fKj>