WikiSysop: Created page with "{{ArticleUnstructured |Standalone=No }} == Base path: /nexus/v3 ==
{| cl..."

2023-11-26T04:31:18Z

Created page with "{{ArticleUnstructured |Standalone=No }} == Base path: /nexus/v3 ==  <div class="web-api-post mw-collapsible mw-collapsed"> {| cl..."

New page

{{ArticleUnstructured
|Standalone=No
}}

== Base path: /nexus/v3 ==


<div class="web-api-post mw-collapsible mw-collapsed">
{| class="web-api-introduction-table"
| style="width: 150px" | <div class="web-api-post-text"> POST </div>
| <div class="web-api-urlpath">/some/interactions/webhook/path</div>
<div class="web-api-summary">Send interaction state change events</div>
|}
<div class="mw-collapsible-content">
<div class="web-api-description">Send interaction state change events to the third-party system. Events are sent when an interaction is STARTED, which means it was created in Universal Contact Server and submitted in an interaction queue, or FINISHED, which means processing was stopped by Agent Desktop or the workflow.</div>
<div class="web-api-section-heading">Parameters</div>
{| class="web-api-parameters-table"
! Name !! Default !! Description !! Parameter Type !! Data Type !! Required
|-
| X-Hub-Signature
|
| The request signature, for example <tt>sha1=hash</tt>. The hash is built using the body of the message and secret for the channel.
| header
| string
| true
|-
| X-B3-TraceId
|
| A unique trace ID for the request.
| header
| string
|
|-
| events
|
| The events payload.
| body
|
| true
|-
| colspan=6 |
<div class="web-api-example">
{|
| <source>
{
"operationId": "f6c49d91-926b-4473-b2f3-8d8fd295c968",
"data": {
"entities": [
{
}
]
}
}
</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> entity </div>
|-
| style="text-align:right;" | id
| (string, optional): The interaction ID.<br/>8e09e19f-b8ba-4db0-b6e7-dfc8a7776176
|-
| style="text-align:right;" | mediaType
| (string, optional): The interaction's media type.<br/>chat Valid Values: chat, email
|-
| style="text-align:right;" | interactionSubtype
| (string, optional): The interaction's subtype<br/>InboundNew Valid Values: InboundNew, Outbound, SMS, WhatsApp, FacebookPublic, FacebookPrivate, TwitterPublic, TwitterPrivate
|-
| style="text-align:right;" | selfUri
| (string, optional): The URL to retrieve the interaction data.<br/>NexusURL/nexus/v3/chat/sessions/49a0ed5c-77b8-4091-a0c2-1d904ff709b0/8e09e19f-b8ba-4db0-b6e7-dfc8a7776176
|-
| colspan=2 | <div class="web-api-body-obj"> Event </div>
|-
| style="text-align:right;" | event
| (string, optional): The type of event.<br/>FINISHED Valid Values: STARTED, FINISHED
|-
| style="text-align:right;" | entity
| (object, optional):
|-
| colspan=2 | <div class="web-api-body-obj"> data </div>
|-
| style="text-align:right;" | entities
| (array:Event, optional):
|-
| colspan=2 | <div class="web-api-body-obj"> EventsPayload </div>
|-
| style="text-align:right;" | operationId
| (string, optional): The ID of the operation.<br/>f6c49d91-926b-4473-b2f3-8d8fd295c968
|-
| style="text-align:right;" | data
| (object, optional):
|}
|}
</div>
|}
<div class="web-api-section-heading">Responses</div>
{| class="web-api-responses-table"
! Code !! Reason
|-
| 200
| Operation was successful
|-
| colspan=2 |
{|
| <source>
{
"status": {
"code": 0,
"message": "string"
},
"data": {
"ids": [
{
"id": "string"
}
]
}
}
</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> status </div>
|-
| style="text-align:right;" | code
| (integer):
|-
| style="text-align:right;" | message
| (string):
|-
| colspan=2 | <div class="web-api-body-obj"> ids </div>
|-
| style="text-align:right;" | id
| (string):
|-
| colspan=2 | <div class="web-api-body-obj"> data </div>
|-
| style="text-align:right;" | ids
| (array:object):
|-
| colspan=2 | <div class="web-api-body-obj"> EventsResponse </div>
|-
| style="text-align:right;" | status
| (object):
|-
| style="text-align:right;" | data
| (object):
|}
|}
|-
| 500
| Internal Server Error
|}
<div class="web-api-section-heading">Usage</div>
<source lang="cURL">
curl -X POST
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"
-d '{
"operationId": "f6c49d91-926b-4473-b2f3-8d8fd295c968",
"data": {
"entities": [
{
}
]
}
}'
"https://api-demo.com/nexus/v3/some/interactions/webhook/path?"
</source>
</div>
</div>

PEC-Developer/Current/WebAPIs/Interactions Webhook - Revision history

WikiSysop: Created page with "{{ArticleUnstructured |Standalone=No }} == Base path: /nexus/v3 == {| cl..."

WikiSysop: Created page with "{{ArticleUnstructured |Standalone=No }} == Base path: /nexus/v3 ==
{| cl..."