Find me Follow me feature functionality
Endpoints
| Request | |
| endpoint | https://{portalURL}:9443/ucp/v2/login |
| verb | POST |
| request body |
{ "username": "yourUserName", "password": "yourPassword", "domain": "yourTenant" } |
| Response | |
| Code | Description |
| 200 |
Response body: { "user": { ... }, "access_token": "{access_token_value}", "refresh_token": "{refresh_token_value}" } |
| 400 | The information sent is invalid. |
| 500 | Error due to an internal issue. |
| Request | |
| endpoint | https://{portalURL}:9443/ucp/v2/fmfm |
| verb | PUT |
| header | Authorization: “Bearer {access_token_value}” |
| Request Body |
{ “enabled”: true } |
| Response | |
| Code | Description |
| 200 | OK |
| 400 | The information sent is invalid. |
| 500 | Internal server error |
| Request | |
| endpoint | https://{portalURL}:9443/ucp/v2/fmfm/profiles |
| verb | GET |
| header | Authorization: “Bearer {access_token_value}” |
| Response | |
| Code | Description |
| 200 |
Response body: [ { "id": "string", "name": "string", "active": true }, { "id": "string", "name": "string", "active": true } ] |
| 400 | The information sent is invalid. |
| 500 | Internal server error |
| Request | |
| endpoint | https://{portalURL}:9443/ucp/v2/fmfm/profiles |
| verb | POST |
| header | Authorization: “Bearer {access_token_value}” |
| Request body |
{ "name": "new_fmfm_profile", "active": false, "devices": [ { "id": "device_id_1", "not_ring": false, "start": 0, "end": 40 }, { "id": "device_id_2", "not_ring": false, "start": 0, "end": 40 } ] } |
| Response | |
| Code | Description |
| 200 | OK |
| 400 | The information sent is invalid. |
| 500 | Internal server error |
| Request | |
| endpoint | https://{portalURL}:9443/ucp/v2/fmfm/profiles/{profile_id} |
| verb | PUT |
| header | Authorization: “Bearer {access_token_value}” |
| Request body |
{ "name": "new_fmfm_profile", "active": false, "devices": [ { "id": "device_id_1", "not_ring": false, "start": 0, "end": 40 }, { "id": "device_id_2", "not_ring": false, "start": 0, "end": 40 } ] } |
| Response | |
| Code | Description |
| 200 | OK |
| 400 | The information sent is invalid. |
| 500 | Internal server error |
| Request | |
| endpoint | https://{portalURL}:9443/ucp/v2/fmfm/profiles/{profile_id} |
| verb | DELETE |
| header | Authorization: “Bearer {access_token_value}” |
| Response | |
| Code | Description |
| 200 | OK |
| 400 | The information sent is invalid. |
| 500 | Internal server error |
| Request | |
| endpoint | https://{portalURL}:9443/ucp/v2/devices |
| verb | GET |
| header | Authorization: “Bearer {access_token_value}” |
| Response | |
| Code | Description |
| 200 |
Response body: [ { "id": "device_1_id", "name": "device_1_name", "sip": {}, "push": {}, "media": { "audio": { "codecs": [] }, "video": { "codecs": [] }, "encryption": {}, "webrtc": false }, "device_type": "softphone", "enabled": false }, ] |
| 400 | The information sent is invalid. |
| 500 | Internal server error |