The method returns a source object.
Limitations
The method is available in accordance with the user’s rights.
Authorization type
OAuth 2.0 with Access Token/Long-lived token.
Data type header on success
Content-Type: application/hal+json
Data type header on error
Content-Type: application/problem+json
Response parameters
Parameter | Data type | Description |
|---|---|---|
id | int | Source id |
name | string | Source name |
pipeline_id | int | Pipeline id. The pipeline might be archived. |
external_id | string | External ID of the source on the integration side |
default | bool | A boolean indicates whether this source is the default source. It might be null. |
services | array | An array of services that are associated with the source. The data from this array is used to display in the website chat button (buttons on the site). |
services[type] | string | Service type. It might be empty. |
services[0][params] | object | An object with source settings. |
services[0][params][waba] | bool | Defines whether the source is official WhatsApp. Should be added to enable Salesbot to work with approved WhatsApp templates in the new Send Message step. This field is optional. |
services[0][params][is_supports_list_message][is_supports_list_message] | bool | Shows if the source supports the "List Message" step in Salesbot. It should be added to display a new List Message step in Salesbot. |
services[pages] | string | Contains a list of elements that can be selected when setting up the website chat button. |
services[0][pages][0][name] | string | The name of the item displayed to the user in the drop-down list when setting up a button on the site |
services[0][pages][0][id] | string | Identifier of the item in the dropdown list (not displayed to the client and user) |
services[0][pages][0][link] | string | The id of the user that will be indicated in the messenger button and to which the client will write on the site page. For example, for Whatsapp, the link will be generated as follows: |
origin_code | string | Main channel code of the source. This chat channel will be used when initializing the chat. The field is optional, but when specified, it shouldn’t be null, just numbers, have double quotations, or have more than 20 characters. |