List phone-system outcomes

GET

https://api.sailorhq.io/phone-system/outcomes

GET

/phone-system/outcomes

1 const url = 'https://api.sailorhq.io/phone-system/outcomes';
2 const options = {
3   method: 'GET',
4   headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
5   body: '{}'
6 };
7 
8 try {
9   const response = await fetch(url, options);
10   const data = await response.json();
11   console.log(data);
12 } catch (error) {
13   console.error(error);
14 }

200Retrieved

1 {
2   "ok": true,
3   "outcomes": [
4     {
5       "outcome_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
6       "outcome_name": "Add to VIP List",
7       "outcome_type": "action",
8       "order": 1,
9       "destination_type": "smart_list",
10       "destination": {
11         "destination_type": "smart_list",
12         "destination_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
13         "destination_name": "VIP Customers"
14       },
15       "webhook_url": "https://hooks.sailorhq.io/outcome/vip_add",
16       "created_at": "2024-05-10T09:15:00Z",
17       "updated_at": "2024-05-15T12:00:00Z"
18     },
19     {
20       "outcome_id": "1b4e28ba-2fa1-11d2-883f-0016d3cca427",
21       "outcome_name": "Remove from Trial List",
22       "outcome_type": "action",
23       "order": 2,
24       "destination_type": "remove_from_smart_list",
25       "destination": {
26         "destination_type": "remove_from_smart_list",
27         "selection": "selected",
28         "destination_ids": [
29           "9a7b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
30           "2f3e4d5c-6b7a-8c9d-0e1f-2a3b4c5d6e7f"
31         ],
32         "destination_names": [
33           "Trial Customers",
34           "Beta Testers"
35         ],
36         "destination_name": "Trial Customers"
37       },
38       "webhook_url": null,
39       "created_at": "2024-04-20T14:30:00Z",
40       "updated_at": "2024-05-01T08:45:00Z"
41     },
42     {
43       "outcome_id": "d2719f3e-8c4a-4f2b-9a1e-3b2c4d5e6f7a",
44       "outcome_name": "No Further Action",
45       "outcome_type": "disposition",
46       "order": 3,
47       "destination_type": "none",
48       "destination": null,
49       "webhook_url": null,
50       "created_at": "2024-01-10T10:00:00Z",
51       "updated_at": "2024-03-12T11:20:00Z"
52     }
53   ],
54   "disposition_popup_enabled": true
55 }

Returns the configured outcomes an agent can apply after a phone call, including smart-list add and smart-list removal destinations.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

Outcomes for the active workspace.

oktrue

outcomeslist of objects

disposition_popup_enabledboolean