PEC-Developer/Current/WebAPIs/Openmedia - Revision history

WikiSysop: Created page with "{{ArticleUnstructured |Standalone=No |DisplayName=Openmedia API }} == Base path: /nexus/v3 ==

2023-11-26T16:01:23Z

Created page with "{{ArticleUnstructured |Standalone=No |DisplayName=Openmedia API }} == Base path: /nexus/v3 ==  <div class="web-api-po..."

New page
{{ArticleUnstructured
|Standalone=No
|DisplayName=Openmedia API
}}

== 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">/openmedia/{openMediaService}/interactions</div>
<div class="web-api-summary">Create an interaction</div>
|}
<div class="mw-collapsible-content">
<div class="web-api-description">Create a new open media interaction.</div>
<div class="web-api-section-heading">Parameters</div>
{| class="web-api-parameters-table"
! Name !! Default !! Description !! Parameter Type !! Data Type !! Required
|-
| x-api-key
|
| A unique key required to use the API. If you do not already have this API key, contact your Customer Care representative.
| header
| string
| true
|-
| openMediaService
|
| A unique name of the open media service
| path
| string
| true
|-
| data
|
|
| body
|
|
|-
| colspan=6 |
<div class="web-api-example">
{|
| <source>{object}</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> createInteractionRequest </div>
|-
| style="text-align:right;" | externalId
| (string, optional): The external ID to associate with the new interaction.
|-
| style="text-align:right;" | parentInteractionId
| (string, optional): The ID of the parent interaction.
|-
| style="text-align:right;" | receivedAt
| (string, optional):
|-
| style="text-align:right;" | userData
| (object, optional):
|-
| colspan=2 | <div class="web-api-body-obj"> data </div>
|-
| style="text-align:right;" | data
| (object, optional):
|}
|}
</div>
|}
<div class="web-api-section-heading">Responses</div>
{| class="web-api-responses-table"
! Code !! Reason
|-
| 200
| Successful response
|-
| colspan=2 |
{|
| <source>{object}</source>
|
|}
|-
| 400
| Invalid request parameters provided
|-
| colspan=2 |
{|
| <source>{object}</source>
|
|}
|-
| 404
| Resource is not found
|-
| colspan=2 |
{|
| <source>{object}</source>
|
|}
|-
| 409
| Resource already exists
|-
| colspan=2 |
{|
| <source>{object}</source>
|
|}
|-
| 500
| Internal Server Error
|-
| colspan=2 |
{|
| <source>{object}</source>
|
|}
|}
<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 '{object}'
"https://api-demo.com/nexus/v3/openmedia/{openMediaService}/interactions?"
</source>
</div>
</div>


<div class="web-api-get mw-collapsible mw-collapsed">
{| class="web-api-introduction-table"
| style="width: 150px" | <div class="web-api-get-text"> GET </div>
| <div class="web-api-urlpath">/openmedia/{openMediaService}/interactions/ext_{externalId}</div>
<div class="web-api-summary">Get an interaction by external ID</div>
|}
<div class="mw-collapsible-content">
<div class="web-api-description">Get the interaction specified by its external ID.</div>
<div class="web-api-section-heading">Parameters</div>
{| class="web-api-parameters-table"
! Name !! Default !! Description !! Parameter Type !! Data Type !! Required
|-
| x-api-key
|
| A unique key required to use the API. If you do not already have this API key, contact your Customer Care representative.
| header
| string
| true
|-
| openMediaService
|
| A unique name of the open media service
| path
| string
| true
|-
| externalId
|
| Interaction external ID
| path
| string
| true
|}
<div class="web-api-section-heading">Responses</div>
{| class="web-api-responses-table"
! Code !! Reason
|-
| 200
| Successful response
|-
| colspan=2 |
{|
| <source>{object}</source>
|
|}
|-
| 400
| Invalid request parameters provided
|-
| colspan=2 |
{|
| <source>{object}</source>
|
|}
|-
| 404
| Resource is not found
|-
| colspan=2 |
{|
| <source>{object}</source>
|
|}
|-
| 500
| Internal Server Error
|-
| colspan=2 |
{|
| <source>{object}</source>
|
|}
|}
<div class="web-api-section-heading">Usage</div>
<source lang="cURL">
curl -X GET
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/nexus/v3/openmedia/{openMediaService}/interactions/ext_{externalId}?"
</source>
</div>
</div>


<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">/openmedia/{openMediaService}/interactions/ext_{externalId}/stop</div>
<div class="web-api-summary">Stop an interaction by external ID</div>
|}
<div class="mw-collapsible-content">
<div class="web-api-description">Stop the interaction specified by its external ID.</div>
<div class="web-api-section-heading">Parameters</div>
{| class="web-api-parameters-table"
! Name !! Default !! Description !! Parameter Type !! Data Type !! Required
|-
| x-api-key
|
| A unique key required to use the API. If you do not already have this API key, contact your Customer Care representative.
| header
| string
| true
|-
| openMediaService
|
| A unique name of the open media service
| path
| string
| true
|-
| externalId
|
| Interaction external ID
| path
| string
| true
|-
| data
|
|
| body
|
|
|-
| colspan=6 |
<div class="web-api-example">
{|
| <source>{object}</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> stopInteractionRequest </div>
|-
| style="text-align:right;" | reasonSystemName
| (string, optional):
|-
| style="text-align:right;" | reasonDescription
| (string, optional):
|-
| colspan=2 | <div class="web-api-body-obj"> data </div>
|-
| style="text-align:right;" | data
| (stopInteractionRequest, optional):
|}
|}
</div>
|}
<div class="web-api-section-heading">Responses</div>
{| class="web-api-responses-table"
! Code !! Reason
|-
| 200
| Successful response
|-
| colspan=2 |
{|
| <source>{object}</source>
|
|}
|-
| 400
| Invalid request parameters provided
|-
| colspan=2 |
{|
| <source>{object}</source>
|
|}
|-
| 404
| Resource is not found
|-
| colspan=2 |
{|
| <source>{object}</source>
|
|}
|-
| 500
| Internal Server Error
|-
| colspan=2 |
{|
| <source>{object}</source>
|
|}
|}
<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 '{object}'
"https://api-demo.com/nexus/v3/openmedia/{openMediaService}/interactions/ext_{externalId}/stop?"
</source>
</div>
</div>


<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">/openmedia/{openMediaService}/interactions/ext_{externalId}/update</div>
<div class="web-api-summary">Update an interaction by external ID</div>
|}
<div class="mw-collapsible-content">
<div class="web-api-description">Update the properties of an interaction specified by its external ID.</div>
<div class="web-api-section-heading">Parameters</div>
{| class="web-api-parameters-table"
! Name !! Default !! Description !! Parameter Type !! Data Type !! Required
|-
| x-api-key
|
| A unique key required to use the API. If you do not already have this API key, contact your Customer Care representative.
| header
| string
| true
|-
| openMediaService
|
| A unique name of the open media service
| path
| string
| true
|-
| externalId
|
| Interaction external ID
| path
| string
| true
|-
| data
|
|
| body
|
| true
|-
| colspan=6 |
<div class="web-api-example">
{|
| <source>{object}</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> changePropertiesRequest </div>
|-
| style="text-align:right;" | changedProperties
| (object, optional):
|-
| style="text-align:right;" | addedProperties
| (object, optional):
|-
| style="text-align:right;" | deletedProperties
| (array:string, optional):
|-
| colspan=2 | <div class="web-api-body-obj"> data </div>
|-
| style="text-align:right;" | data
| (changePropertiesRequest, optional):
|}
|}
</div>
|}
<div class="web-api-section-heading">Responses</div>
{| class="web-api-responses-table"
! Code !! Reason
|-
| 200
| Successful response
|-
| colspan=2 |
{|
| <source>{object}</source>
|
|}
|-
| 400
| Invalid request parameters provided
|-
| colspan=2 |
{|
| <source>{object}</source>
|
|}
|-
| 404
| Resource is not found
|-
| colspan=2 |
{|
| <source>{object}</source>
|
|}
|-
| 500
| Internal Server Error
|-
| colspan=2 |
{|
| <source>{object}</source>
|
|}
|}
<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 '{object}'
"https://api-demo.com/nexus/v3/openmedia/{openMediaService}/interactions/ext_{externalId}/update?"
</source>
</div>
</div>


<div class="web-api-get mw-collapsible mw-collapsed">
{| class="web-api-introduction-table"
| style="width: 150px" | <div class="web-api-get-text"> GET </div>
| <div class="web-api-urlpath">/openmedia/{openMediaService}/interactions/{interactionId}</div>
<div class="web-api-summary">Get an interaction</div>
|}
<div class="mw-collapsible-content">
<div class="web-api-description">Get the specified interaction.</div>
<div class="web-api-section-heading">Parameters</div>
{| class="web-api-parameters-table"
! Name !! Default !! Description !! Parameter Type !! Data Type !! Required
|-
| x-api-key
|
| A unique key required to use the API. If you do not already have this API key, contact your Customer Care representative.
| header
| string
| true
|-
| openMediaService
|
| A unique name of the open media service
| path
| string
| true
|-
| interactionId
|
| Interaction ID
| path
| string
| true
|}
<div class="web-api-section-heading">Responses</div>
{| class="web-api-responses-table"
! Code !! Reason
|-
| 200
| Successful response
|-
| colspan=2 |
{|
| <source>{object}</source>
|
|}
|-
| 400
| Invalid request parameters provided
|-
| colspan=2 |
{|
| <source>{object}</source>
|
|}
|-
| 404
| Resource is not found
|-
| colspan=2 |
{|
| <source>{object}</source>
|
|}
|-
| 500
| Internal Server Error
|-
| colspan=2 |
{|
| <source>{object}</source>
|
|}
|}
<div class="web-api-section-heading">Usage</div>
<source lang="cURL">
curl -X GET
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/nexus/v3/openmedia/{openMediaService}/interactions/{interactionId}?"
</source>
</div>
</div>


<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">/openmedia/{openMediaService}/interactions/{interactionId}/stop</div>
<div class="web-api-summary">Stop an interaction</div>
|}
<div class="mw-collapsible-content">
<div class="web-api-description">Stop the specified interaction.</div>
<div class="web-api-section-heading">Parameters</div>
{| class="web-api-parameters-table"
! Name !! Default !! Description !! Parameter Type !! Data Type !! Required
|-
| x-api-key
|
| A unique key required to use the API. If you do not already have this API key, contact your Customer Care representative.
| header
| string
| true
|-
| openMediaService
|
| A unique name of the open media service
| path
| string
| true
|-
| interactionId
|
| Interaction ID
| path
| string
| true
|-
| data
|
|
| body
|
|
|-
| colspan=6 |
<div class="web-api-example">
{|
| <source>{object}</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> stopInteractionRequest </div>
|-
| style="text-align:right;" | reasonSystemName
| (string, optional):
|-
| style="text-align:right;" | reasonDescription
| (string, optional):
|-
| colspan=2 | <div class="web-api-body-obj"> data </div>
|-
| style="text-align:right;" | data
| (stopInteractionRequest, optional):
|}
|}
</div>
|}
<div class="web-api-section-heading">Responses</div>
{| class="web-api-responses-table"
! Code !! Reason
|-
| 200
| Successful response
|-
| colspan=2 |
{|
| <source>{object}</source>
|
|}
|-
| 400
| Invalid request parameters provided
|-
| colspan=2 |
{|
| <source>{object}</source>
|
|}
|-
| 404
| Resource is not found
|-
| colspan=2 |
{|
| <source>{object}</source>
|
|}
|-
| 500
| Internal Server Error
|-
| colspan=2 |
{|
| <source>{object}</source>
|
|}
|}
<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 '{object}'
"https://api-demo.com/nexus/v3/openmedia/{openMediaService}/interactions/{interactionId}/stop?"
</source>
</div>
</div>


<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">/openmedia/{openMediaService}/interactions/{interactionId}/update</div>
<div class="web-api-summary">Update an interaction</div>
|}
<div class="mw-collapsible-content">
<div class="web-api-description">Update the properties of the specified interaction.</div>
<div class="web-api-section-heading">Parameters</div>
{| class="web-api-parameters-table"
! Name !! Default !! Description !! Parameter Type !! Data Type !! Required
|-
| x-api-key
|
| A unique key required to use the API. If you do not already have this API key, contact your Customer Care representative.
| header
| string
| true
|-
| openMediaService
|
| A unique name of the open media service
| path
| string
| true
|-
| interactionId
|
| Interaction ID
| path
| string
| true
|-
| data
|
|
| body
|
| true
|-
| colspan=6 |
<div class="web-api-example">
{|
| <source>{object}</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> changePropertiesRequest </div>
|-
| style="text-align:right;" | changedProperties
| (object, optional):
|-
| style="text-align:right;" | addedProperties
| (object, optional):
|-
| style="text-align:right;" | deletedProperties
| (array:string, optional):
|-
| colspan=2 | <div class="web-api-body-obj"> data </div>
|-
| style="text-align:right;" | data
| (changePropertiesRequest, optional):
|}
|}
</div>
|}
<div class="web-api-section-heading">Responses</div>
{| class="web-api-responses-table"
! Code !! Reason
|-
| 200
| Successful response
|-
| colspan=2 |
{|
| <source>{object}</source>
|
|}
|-
| 400
| Invalid request parameters provided
|-
| colspan=2 |
{|
| <source>{object}</source>
|
|}
|-
| 404
| Resource is not found
|-
| colspan=2 |
{|
| <source>{object}</source>
|
|}
|-
| 500
| Internal Server Error
|-
| colspan=2 |
{|
| <source>{object}</source>
|
|}
|}
<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 '{object}'
"https://api-demo.com/nexus/v3/openmedia/{openMediaService}/interactions/{interactionId}/update?"
</source>
</div>
</div>