PEC-Developer/Current/WebAPIs/Third-party messaging - Revision history

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

2023-11-26T04:31:31Z

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

New page
{{ArticleUnstructured
|Standalone=No
|DisplayName=Third-Party Messaging 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">/channels/{channelId}/media</div>
<div class="web-api-summary">Upload a media resource</div>
|}
<div class="mw-collapsible-content">
<div class="web-api-description">Upload a binary media file to Genesys to use in a RichMedia message. The response to this request includes a URL you can use as the image in the outgoing message payload.</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-ccid
|
| The ID of the contact center the message is sent within.
| header
| string
| true
|-
| X-B3-TraceId
|
| The unique trace ID for the request.
| header
| string
|
|-
| channelId
|
| The ID of the channel.
| path
| string
| true
|-
| file
|
| The file to upload.
| formData
| file
|
|}
<div class="web-api-section-heading">Responses</div>
{| class="web-api-responses-table"
! Code !! Reason
|-
| 200
| Operation was successful
|-
| colspan=2 |
<div class="web-api-example">
{|
| <source>
{
"status": {
"code": 0,
"message": "string"
},
"data": {
"mediaId": "string",
"url": "string",
"filename": "string",
"mimetype": "string",
"length": 0
}
}
</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> status </div>
|-
| style="text-align:right;" | code
| (integer):
A code that can provide more information when an error occurs.
|-
| style="text-align:right;" | message
| (string):
Provides additional information when a request returns an error response.
|-
| colspan=2 | <div class="web-api-body-obj"> data </div>
|-
| style="text-align:right;" | mediaId
| (string):
The ID of the media resource.
bb4a9f86-dbbb-4464-a669-650da94fbad6
|-
| style="text-align:right;" | url
| (string):
A synthetic URL to be used as reference in the outgoing message payload.
genesys://nexus/bb4a9f86-dbbb-4464-a669-650da94fbad6
|-
| style="text-align:right;" | filename
| (string):
The name of the media resource.
MyImage
|-
| style="text-align:right;" | mimetype
| (string):
The type of file.
image/jpeg
|-
| style="text-align:right;" | length
| (integer):
The length of the media file.
|-
| colspan=2 | <div class="web-api-body-obj"> UploadResponse </div>
|-
| style="text-align:right;" | status
| (object):
|-
| style="text-align:right;" | data
| (object):
|}
|}
</div>
|-
| 400
| Bad Request
|-
| colspan=2 |
<div class="web-api-example">
{|
| <source>{}</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> BadRequest </div>
|-
| style="text-align:right;" | status
| (object):
|-
| colspan=2 | <div class="web-api-body-obj"> status </div>
|-
| style="text-align:right;" | code
| (integer):
A code that can provide more information when an error occurs.
|-
| style="text-align:right;" | message
| (string):
Provides additional information when a request returns an error response.
|-
| colspan=2 | <div class="web-api-body-obj"> ResponseError </div>
|-
| style="text-align:right;" | status
| (object):
|}
|}
</div>
|-
| 401
| Unauthorized
|-
| colspan=2 |
<div class="web-api-example">
{|
| <source>{}</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> Unauthorized </div>
|-
| style="text-align:right;" | status
| (object):
|-
| colspan=2 | <div class="web-api-body-obj"> status </div>
|-
| style="text-align:right;" | code
| (integer):
A code that can provide more information when an error occurs.
|-
| style="text-align:right;" | message
| (string):
Provides additional information when a request returns an error response.
|-
| colspan=2 | <div class="web-api-body-obj"> ResponseError </div>
|-
| style="text-align:right;" | status
| (object):
|}
|}
</div>
|-
| 403
| Forbidden
|-
| colspan=2 |
<div class="web-api-example">
{|
| <source>{}</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> Forbidden </div>
|-
| style="text-align:right;" | status
| (object):
|-
| colspan=2 | <div class="web-api-body-obj"> status </div>
|-
| style="text-align:right;" | code
| (integer):
A code that can provide more information when an error occurs.
|-
| style="text-align:right;" | message
| (string):
Provides additional information when a request returns an error response.
|-
| colspan=2 | <div class="web-api-body-obj"> ResponseError </div>
|-
| style="text-align:right;" | status
| (object):
|}
|}
</div>
|-
| 404
| Channel not found
|-
| colspan=2 |
<div class="web-api-example">
{|
| <source>{}</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> NotFound </div>
|-
| style="text-align:right;" | status
| (object):
|-
| colspan=2 | <div class="web-api-body-obj"> status </div>
|-
| style="text-align:right;" | code
| (integer):
A code that can provide more information when an error occurs.
|-
| style="text-align:right;" | message
| (string):
Provides additional information when a request returns an error response.
|-
| colspan=2 | <div class="web-api-body-obj"> ResponseError </div>
|-
| style="text-align:right;" | status
| (object):
|}
|}
</div>
|-
| 415
| Unsupported Media Type
|-
| colspan=2 |
<div class="web-api-example">
{|
| <source>{}</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> UnsupportedMedia </div>
|-
| style="text-align:right;" | status
| (object):
|-
| colspan=2 | <div class="web-api-body-obj"> status </div>
|-
| style="text-align:right;" | code
| (integer):
A code that can provide more information when an error occurs.
|-
| style="text-align:right;" | message
| (string):
Provides additional information when a request returns an error response.
|-
| colspan=2 | <div class="web-api-body-obj"> ResponseError </div>
|-
| style="text-align:right;" | status
| (object):
|}
|}
</div>
|-
| 500
| Internal Server Error
|-
| colspan=2 |
<div class="web-api-example">
{|
| <source>{}</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> ServerError </div>
|-
| style="text-align:right;" | status
| (object):
|-
| colspan=2 | <div class="web-api-body-obj"> status </div>
|-
| style="text-align:right;" | code
| (integer):
A code that can provide more information when an error occurs.
|-
| style="text-align:right;" | message
| (string):
Provides additional information when a request returns an error response.
|-
| colspan=2 | <div class="web-api-body-obj"> ResponseError </div>
|-
| style="text-align:right;" | status
| (object):
|}
|}
</div>
|}
<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"

"https://api-demo.com/nexus/v3/channels/{channelId}/media?"
</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">/channels/{channelId}/media/{mediaId}</div>
<div class="web-api-summary">Download a media resource</div>
|}
<div class="mw-collapsible-content">
<div class="web-api-description">Download a media resource you previously uploaded to Genesys with <tt>POST /channels/{channelId}/media</tt>.</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-ccid
|
| The ID of the contact center the message is sent within.
| header
| string
| true
|-
| X-B3-TraceId
|
| The unique trace ID for the request.
| header
| string
|
|-
| channelId
|
| The ID of the channel.
| path
| string
| true
|-
| mediaId
|
| The media resource ID.
| path
| string
| true
|}
<div class="web-api-section-heading">Responses</div>
{| class="web-api-responses-table"
! Code !! Reason
|-
| 200
| Operation was successful
|-
| 400
| Bad Request
|-
| colspan=2 |
{|
| <source>{}</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> BadRequest </div>
|-
| style="text-align:right;" | status
| (object):
|-
| colspan=2 | <div class="web-api-body-obj"> status </div>
|-
| style="text-align:right;" | code
| (integer):
A code that can provide more information when an error occurs.
|-
| style="text-align:right;" | message
| (string):
Provides additional information when a request returns an error response.
|-
| colspan=2 | <div class="web-api-body-obj"> ResponseError </div>
|-
| style="text-align:right;" | status
| (object):
|}
|}
|-
| 401
| Unauthorized
|-
| colspan=2 |
{|
| <source>{}</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> Unauthorized </div>
|-
| style="text-align:right;" | status
| (object):
|-
| colspan=2 | <div class="web-api-body-obj"> status </div>
|-
| style="text-align:right;" | code
| (integer):
A code that can provide more information when an error occurs.
|-
| style="text-align:right;" | message
| (string):
Provides additional information when a request returns an error response.
|-
| colspan=2 | <div class="web-api-body-obj"> ResponseError </div>
|-
| style="text-align:right;" | status
| (object):
|}
|}
|-
| 403
| Forbidden
|-
| colspan=2 |
{|
| <source>{}</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> Forbidden </div>
|-
| style="text-align:right;" | status
| (object):
|-
| colspan=2 | <div class="web-api-body-obj"> status </div>
|-
| style="text-align:right;" | code
| (integer):
A code that can provide more information when an error occurs.
|-
| style="text-align:right;" | message
| (string):
Provides additional information when a request returns an error response.
|-
| colspan=2 | <div class="web-api-body-obj"> ResponseError </div>
|-
| style="text-align:right;" | status
| (object):
|}
|}
|-
| 404
| Channel 1234567890 not found
|-
| colspan=2 |
{|
| <source>{}</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> NotFound </div>
|-
| style="text-align:right;" | status
| (object):
|-
| colspan=2 | <div class="web-api-body-obj"> status </div>
|-
| style="text-align:right;" | code
| (integer):
A code that can provide more information when an error occurs.
|-
| style="text-align:right;" | message
| (string):
Provides additional information when a request returns an error response.
|-
| colspan=2 | <div class="web-api-body-obj"> ResponseError </div>
|-
| style="text-align:right;" | status
| (object):
|}
|}
|-
| 500
| Internal Server Error
|-
| colspan=2 |
{|
| <source>{}</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> ServerError </div>
|-
| style="text-align:right;" | status
| (object):
|-
| colspan=2 | <div class="web-api-body-obj"> status </div>
|-
| style="text-align:right;" | code
| (integer):
A code that can provide more information when an error occurs.
|-
| style="text-align:right;" | message
| (string):
Provides additional information when a request returns an error response.
|-
| colspan=2 | <div class="web-api-body-obj"> ResponseError </div>
|-
| style="text-align:right;" | status
| (object):
|}
|}
|}
<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/channels/{channelId}/media/{mediaId}?"
</source>
</div>
</div>


<div class="web-api-delete mw-collapsible mw-collapsed">
{| class="web-api-introduction-table"
| style="width: 150px" | <div class="web-api-delete-text"> DELETE </div>
| <div class="web-api-urlpath">/channels/{channelId}/media/{mediaId}</div>
<div class="web-api-summary">Delete a media resource</div>
|}
<div class="mw-collapsible-content">
<div class="web-api-description">Delete a media resource you previously uploaded to Genesys with <tt>POST /channels/{channelId}/media</tt>.</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-ccid
|
| The ID of the contact center the message is sent within.
| header
| string
| true
|-
| X-B3-TraceId
|
| The unique trace ID for the request.
| header
| string
|
|-
| channelId
|
| The ID of the channel.
| header
| path
| true
|-
| mediaId
|
| The media resource ID.
| header
| path
| true
|}
<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": {
"mediaId": "string",
"url": "string",
"filename": "string",
"mimetype": "string",
"length": 0
}
}
</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> status </div>
|-
| style="text-align:right;" | code
| (integer):
A code that can provide more information when an error occurs.
|-
| style="text-align:right;" | message
| (string):
Provides additional information when a request returns an error response.
|-
| colspan=2 | <div class="web-api-body-obj"> data </div>
|-
| style="text-align:right;" | mediaId
| (string):
The ID of the media resource.
bb4a9f86-dbbb-4464-a669-650da94fbad6
|-
| style="text-align:right;" | url
| (string):
A synthetic URL to be used as reference in the outgoing message payload.
genesys://nexus/bb4a9f86-dbbb-4464-a669-650da94fbad6
|-
| style="text-align:right;" | filename
| (string):
The name of the media resource.
MyImage
|-
| style="text-align:right;" | mimetype
| (string):
The type of file.
image/jpeg
|-
| style="text-align:right;" | length
| (integer):
The length of the media file.
|-
| colspan=2 | <div class="web-api-body-obj"> UploadResponse </div>
|-
| style="text-align:right;" | status
| (object):
|-
| style="text-align:right;" | data
| (object):
|}
|}
|-
| 400
| Bad Request
|-
| colspan=2 |
{|
| <source>{}</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> BadRequest </div>
|-
| style="text-align:right;" | status
| (object):
|-
| colspan=2 | <div class="web-api-body-obj"> status </div>
|-
| style="text-align:right;" | code
| (integer):
A code that can provide more information when an error occurs.
|-
| style="text-align:right;" | message
| (string):
Provides additional information when a request returns an error response.
|-
| colspan=2 | <div class="web-api-body-obj"> ResponseError </div>
|-
| style="text-align:right;" | status
| (object):
|}
|}
|-
| 401
| Unauthorized
|-
| colspan=2 |
{|
| <source>{}</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> Unauthorized </div>
|-
| style="text-align:right;" | status
| (object):
|-
| colspan=2 | <div class="web-api-body-obj"> status </div>
|-
| style="text-align:right;" | code
| (integer):
A code that can provide more information when an error occurs.
|-
| style="text-align:right;" | message
| (string):
Provides additional information when a request returns an error response.
|-
| colspan=2 | <div class="web-api-body-obj"> ResponseError </div>
|-
| style="text-align:right;" | status
| (object):
|}
|}
|-
| 403
| Forbidden
|-
| colspan=2 |
{|
| <source>{}</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> Forbidden </div>
|-
| style="text-align:right;" | status
| (object):
|-
| colspan=2 | <div class="web-api-body-obj"> status </div>
|-
| style="text-align:right;" | code
| (integer):
A code that can provide more information when an error occurs.
|-
| style="text-align:right;" | message
| (string):
Provides additional information when a request returns an error response.
|-
| colspan=2 | <div class="web-api-body-obj"> ResponseError </div>
|-
| style="text-align:right;" | status
| (object):
|}
|}
|-
| 404
| Channel not found
|-
| colspan=2 |
{|
| <source>{}</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> NotFound </div>
|-
| style="text-align:right;" | status
| (object):
|-
| colspan=2 | <div class="web-api-body-obj"> status </div>
|-
| style="text-align:right;" | code
| (integer):
A code that can provide more information when an error occurs.
|-
| style="text-align:right;" | message
| (string):
Provides additional information when a request returns an error response.
|-
| colspan=2 | <div class="web-api-body-obj"> ResponseError </div>
|-
| style="text-align:right;" | status
| (object):
|}
|}
|-
| 500
| Internal Server Error
|-
| colspan=2 |
{|
| <source>{}</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> ServerError </div>
|-
| style="text-align:right;" | status
| (object):
|-
| colspan=2 | <div class="web-api-body-obj"> status </div>
|-
| style="text-align:right;" | code
| (integer):
A code that can provide more information when an error occurs.
|-
| style="text-align:right;" | message
| (string):
Provides additional information when a request returns an error response.
|-
| colspan=2 | <div class="web-api-body-obj"> ResponseError </div>
|-
| style="text-align:right;" | status
| (object):
|}
|}
|}
<div class="web-api-section-heading">Usage</div>
<source lang="cURL">
curl -X DELETE
-H "x-api-key: your_API_key"
-H "Content-Type: application/json"

"https://api-demo.com/nexus/v3/channels/{channelId}/media/{mediaId}?"
</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">/channels/{channelId}/messages</div>
<div class="web-api-summary">Send a message</div>
|}
<div class="mw-collapsible-content">
<div class="web-api-description">Send a message to an agent in Genesys from an external messaging system, such as SMS.</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-ccid
|
| The ID of the contact center the message is sent within.
| header
| string
| true
|-
| X-B3-TraceId
|
| The unique trace ID for the request.
| header
| string
|
|-
| channelId
|
| The ID of the channel.
| path
| string
| true
|-
| messages
|
| Message
| body
|
| true
|-
| colspan=6 |
<div class="web-api-example">
{|
| <source>{}</source>
|
|}
</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):
A code that can provide more information when an error occurs.
|-
| style="text-align:right;" | message
| (string):
Provides additional information when a request returns an error response.
|-
| 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):
The ID of the accepted message, if provided.
|-
| colspan=2 | <div class="web-api-body-obj"> InboundMessageResponse </div>
|-
| style="text-align:right;" | status
| (object):
|-
| style="text-align:right;" | data
| (object):
|}
|}
|-
| 400
| Bad Request
|-
| colspan=2 |
{|
| <source>{}</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> BadRequest </div>
|-
| style="text-align:right;" | status
| (object):
|-
| colspan=2 | <div class="web-api-body-obj"> status </div>
|-
| style="text-align:right;" | code
| (integer):
A code that can provide more information when an error occurs.
|-
| style="text-align:right;" | message
| (string):
Provides additional information when a request returns an error response.
|-
| colspan=2 | <div class="web-api-body-obj"> ResponseError </div>
|-
| style="text-align:right;" | status
| (object):
|}
|}
|-
| 401
| Unauthorized
|-
| colspan=2 |
{|
| <source>{}</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> Unauthorized </div>
|-
| style="text-align:right;" | status
| (object):
|-
| colspan=2 | <div class="web-api-body-obj"> status </div>
|-
| style="text-align:right;" | code
| (integer):
A code that can provide more information when an error occurs.
|-
| style="text-align:right;" | message
| (string):
Provides additional information when a request returns an error response.
|-
| colspan=2 | <div class="web-api-body-obj"> ResponseError </div>
|-
| style="text-align:right;" | status
| (object):
|}
|}
|-
| 403
| Forbidden
|-
| colspan=2 |
{|
| <source>{}</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> Forbidden </div>
|-
| style="text-align:right;" | status
| (object):
|-
| colspan=2 | <div class="web-api-body-obj"> status </div>
|-
| style="text-align:right;" | code
| (integer):
A code that can provide more information when an error occurs.
|-
| style="text-align:right;" | message
| (string):
Provides additional information when a request returns an error response.
|-
| colspan=2 | <div class="web-api-body-obj"> ResponseError </div>
|-
| style="text-align:right;" | status
| (object):
|}
|}
|-
| 404
| Channel not found
|-
| colspan=2 |
{|
| <source>{}</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> NotFound </div>
|-
| style="text-align:right;" | status
| (object):
|-
| colspan=2 | <div class="web-api-body-obj"> status </div>
|-
| style="text-align:right;" | code
| (integer):
A code that can provide more information when an error occurs.
|-
| style="text-align:right;" | message
| (string):
Provides additional information when a request returns an error response.
|-
| colspan=2 | <div class="web-api-body-obj"> ResponseError </div>
|-
| style="text-align:right;" | status
| (object):
|}
|}
|-
| 500
| Internal Server Error
|-
| colspan=2 |
{|
| <source>{}</source>
|
{| class="web-api-body-table"
| colspan=2 | <div class="web-api-body-obj"> ServerError </div>
|-
| style="text-align:right;" | status
| (object):
|-
| colspan=2 | <div class="web-api-body-obj"> status </div>
|-
| style="text-align:right;" | code
| (integer):
A code that can provide more information when an error occurs.
|-
| style="text-align:right;" | message
| (string):
Provides additional information when a request returns an error response.
|-
| colspan=2 | <div class="web-api-body-obj"> ResponseError </div>
|-
| style="text-align:right;" | status
| (object):
|}
|}
|}
<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 '{}'
"https://api-demo.com/nexus/v3/channels/{channelId}/messages?"
</source>
</div>
</div>