Introduction
This reference documents the OCST REST API used by the Contact Center or external CRM systems. These calls usually require authentication which is documented in the "REST API OCST - Get User Details" call.
From version 7.6 on this REST API is part of the Standard ICM. For prior versions this REST API has to be installed separately with an extension cartridge app_sf_contactcenter_rest. This cartridge is part of the OCST package.
Software Version Information
The content of the present document is valid for the following combinations of software versions:
| Intershop | Omni-Channel Services Toolset |
|---|---|
| 7.5.1 | 1.0 |
REST API
This section describes all available REST API calls.
| Title | Http Method | URI | Product Version | Product To Version | Short Description | Cartridge | Application |
|---|---|---|---|---|---|---|---|
| REST API OCST - Create a Promotion Code | POST | /channels/<channelID>/promotions/<promotionID>/codes | 7.5.1 | Creates a new promotion code for an existing promotion. | app_sf_contactcenter_rest | ContactCenter | |
| REST API OCST - Create an access token | POST | /customers/<customer-id>/tokens | 7.5.1 | Create a new authentication token to access, e.g., the WebShop REST API as another user. | app_sf_contactcenter_rest | ContactCenter | |
| REST API OCST - Get Channel Application Details | GET | /channels/<channelID>/applications/<applicationURLID> | 7.5.1 | Get detail information on an application, including the REST API's URI | app_sf_contactcenter_rest | ContactCenter | |
| REST API OCST - Get Channel Applications | GET | /channels/<channelID>/applications | 7.5.1 | Returns a channel's applications | app_sf_contactcenter_rest | ContactCenter | |
| REST API OCST - Get Channel Details | GET | /channels/<channelID> | 7.5.1 | Returns a channel's detail information | app_sf_contactcenter_rest | ContactCenter | |
| REST API OCST - Get Channels | GET | /channels | 7.5.1 | Returns the current organization's sales channels to the client | app_sf_contactcenter_rest | ContactCenter | |
| REST API OCST - Get Customer Details | GET | /customers/<customer-id> | 7.8 | Retrieves and returns details about a customer to the client. | app_sf_contactcenter_rest | ContactCenter | |
| REST API OCST - Get Customer List | GET | /customers | 7.5.1 | Retrieves a fixed maximum number of customers based on the query parameters given | app_sf_contactcenter_rest | ContactCenter | |
| REST API OCST - Get Promotion Details | GET | /channels/<channelID>/promotions/<promotionID> | 7.5.1 | Returns information on a single promotion | app_sf_contactcenter_rest | ContactCenter | |
| REST API OCST - Get Promotions | GET | /channels/<channelID>/promotions | 7.5.1 | Returns promotions that are only available within the Contact Center | app_sf_contactcenter_rest | ContactCenter | |
| REST API OCST - Get User Details | GET | /users/- | 7.5.1 | CC Login / Gets the profile details of a currently authenticated user (Account Representative) | app_sf_contactcenter_rest | ContactCenter | |
| REST API OCST - Send a Promotion Code to a Customer | POST | /customers/<customerID>/mails | 7.8 | Puts a promotion code into the mail queue for the customer. | app_sf_contactcenter_rest | ContactCenter |