{ "opencollection": "1.0.0", "info": { "name": "Webex Admin Address Book Call Settings For Me With UserHub Phase2 API", "version": "1.0.0" }, "items": [ { "info": { "name": "Call Settings For Me With UserHub Phase2", "type": "folder" }, "items": [ { "info": { "name": "Get Priority Alert Settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/settings/priorityAlert" }, "docs": "Get Priority Alert Settings for the authenticated user.\n\nPriority alert allows you to set up a unique ringtone based on predefined criteria. This is helpful, when the user wants to be quickly notified that a specific phone number is calling.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`." }, { "info": { "name": "Modify Priority Alert Settings for User", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/me/settings/priorityAlert", "body": { "type": "json", "data": "{}" } }, "docs": "Update Priority Alert Settings for the authenticated user.\n\nPriority alert allows you to set up a unique ringtone based on predefined criteria. This is helpful, when the user wants to be quickly notified that a specific phone number is calling.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`." }, { "info": { "name": "Add a Priority Alert Criteria", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/people/me/settings/priorityAlert/criteria", "body": { "type": "json", "data": "{}" } }, "docs": "Create a Priority Alert Criteria for the authenticated user.\n\nPriority alert allows you to set up a unique ringtone based on predefined criteria. This is helpful, when the user wants to be quickly notified that a specific phone number is calling.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`." }, { "info": { "name": "Get Priority Alert Criteria Settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/settings/priorityAlert/criteria/:id", "params": [ { "name": "id", "value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY", "type": "path", "description": "The `id` parameter specifies the unique identifier for the priority alert criteria. Example: `Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY`." } ] }, "docs": "Get Priority Alert Criteria Settings for the authenticated user.\n\nPriority alert allows you to set up a unique ringtone based on predefined criteria. This is helpful, when the user wants to be quickly notified that a specific phone number is calling.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`." }, { "info": { "name": "Modify Settings for a Priority Alert Criteria", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/me/settings/priorityAlert/criteria/:id", "params": [ { "name": "id", "value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY", "type": "path", "description": "The `id` parameter specifies the unique identifier for the priority alert criteria. Example: `Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify Priority Alert Criteria Settings for the authenticated user.\n\nPriority alert allows you to set up a unique ringtone based on predefined criteria. This API allows modifying attributes such as name, phoneNumbers etc for a particular criteria.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`." }, { "info": { "name": "Delete a Priority Alert Criteria", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/telephony/config/people/me/settings/priorityAlert/criteria/:id", "params": [ { "name": "id", "value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY", "type": "path", "description": "The `id` parameter specifies the unique identifier for the priority alert criteria. Example: `Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY`." } ] }, "docs": "Delete a Priority Alert criteria for the authenticated user.\n\nPriority alert allows you to set up a unique ringtone based on predefined criteria. This API removes a specific criteria rule by its unique identifier.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`." }, { "info": { "name": "Get User (and Location) Schedules", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/schedules" }, "docs": "Get Schedules for Call Settings for the authenticated user.\n\nSchedules are used to define specific time periods which can be applied to various Call Settings, such as Sequential Ring, or Priority Alert. These call settings perform the defined actions based on the time frame in the schedule, making it more convenient for users to manage their calls.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`." }, { "info": { "name": "Add a User level Schedule for Call Settings", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/people/me/schedules", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Schedule for the authenticated user.\n\nSchedules are used to define specific time periods which can be applied to various Call Settings, such as Sequential Ring, or Priority Alert. These call settings perform the defined actions based on the time frame in the schedule, making it more convenient for users to manage their calls.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`." }, { "info": { "name": "Get User Schedule", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/schedules/:scheduleType/:scheduleId", "params": [ { "name": "scheduleType", "value": "businessHours", "type": "path", "description": "Type of the schedule.\n * `businessHours` - Business hours schedule type.\n * `holidays` - Holidays schedule type.\n" }, { "name": "scheduleId", "value": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvU0c5c2FXUmhlU0JXTWc", "type": "path", "description": "Retrieve the schedule with the matching ID." } ] }, "docs": "Get a Schedule details for Call Settings of the authenticated user.\n\nSchedules are used to define specific time periods which can be applied to various Call Settings, such as Sequential Ring, or Priority Alert. These call settings perform the defined actions based on the time frame in the schedule, making it more convenient for users to manage their calls.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`." }, { "info": { "name": "Modify User Schedule", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/me/schedules/:scheduleType/:scheduleId", "params": [ { "name": "scheduleType", "value": "businessHours", "type": "path", "description": "Type of the schedule.\n * `businessHours` - Business hours schedule type.\n * `holidays` - Holidays schedule type.\n" }, { "name": "scheduleId", "value": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvU0c5c2FXUmhlU0JXTWc", "type": "path", "description": "Update the schedule with the matching ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify a Schedule details for Call Settings of the authenticated user.\n\nSchedules are used to define specific time periods which can be applied to various Call Settings, such as Sequential Ring, or Priority Alert. These call settings perform the defined actions based on the time frame in the schedule, making it more convenient for users to manage their calls.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`." }, { "info": { "name": "Delete a User Schedule", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/telephony/config/people/me/schedules/:scheduleType/:scheduleId", "params": [ { "name": "scheduleType", "value": "businessHours", "type": "path", "description": "Type of the schedule.\n * `businessHours` - Business hours schedule type.\n * `holidays` - Holidays schedule type.\n" }, { "name": "scheduleId", "value": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvU0c5c2FXUmhlU0JXTWc", "type": "path", "description": "Delete the schedule with the matching ID." } ] }, "docs": "Delete a specific schedule for the authenticated user.\n\nSchedules are used to define specific time periods which can be applied to various Call Settings, such as Sequential Ring, or Priority Alert. These call settings perform the defined actions based on the time frame in the schedule, making it more convenient for users to manage their calls.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`." }, { "info": { "name": "Add an event for a User Schedule", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/people/me/schedules/:scheduleType/:scheduleId/events", "params": [ { "name": "scheduleType", "value": "businessHours", "type": "path", "description": "Type of the schedule.\n * `businessHours` - Business hours schedule type.\n * `holidays` - Holidays schedule type.\n" }, { "name": "scheduleId", "value": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvU0c5c2FXUmhlU0JXTWc", "type": "path", "description": "add an event for the specified schedule ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Event for for the authenticated user's specified schedule.\n\nSchedules are used to define specific time periods which can be applied to various Call Settings, such as Sequential Ring, or Priority Alert. These call settings perform the defined actions based on the time frame in the schedule, making it more convenient for users to manage their calls.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`." }, { "info": { "name": "Get User Schedule Event", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/schedules/:scheduleType/:scheduleId/events/:eventId", "params": [ { "name": "scheduleType", "value": "businessHours", "type": "path", "description": "Type of the schedule.\n * `businessHours` - Business hours schedule type.\n * `holidays` - Holidays schedule type.\n" }, { "name": "scheduleId", "value": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvU0c5c2FXUmhlU0JXTWc", "type": "path", "description": "Retrieve the schedule with the matching ID." }, { "name": "eventId", "value": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEVfRVZFTlQvUlZaRlRsUk9RVTFG", "type": "path", "description": "Retrieve the event with the matching ID." } ] }, "docs": "Get a Schedule Event details for Call Settings of the authenticated user.\n\nSchedules are used to define specific time periods which can be applied to various Call Settings, such as Sequential Ring, or Priority Alert. These call settings perform the defined actions based on the time frame in the schedule, making it more convenient for users to manage their calls.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`." }, { "info": { "name": "Modify User Schedule Event", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/me/schedules/:scheduleType/:scheduleId/events/:eventId", "params": [ { "name": "scheduleType", "value": "businessHours", "type": "path", "description": "Type of the schedule.\n * `businessHours` - Business hours schedule type.\n * `holidays` - Holidays schedule type.\n" }, { "name": "scheduleId", "value": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvU0c5c2FXUmhlU0JXTWc", "type": "path", "description": "Update an event for the specified schedule ID." }, { "name": "eventId", "value": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEVfRVZFTlQvUlZaRlRsUk9RVTFG", "type": "path", "description": "Update the event with the matching ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify a Schedule event details for Call Settings of the authenticated user.\n\nSchedules are used to define specific time periods which can be applied to various Call Settings, such as Sequential Ring, or Priority Alert. These call settings perform the defined actions based on the time frame in the schedule, making it more convenient for users to manage their calls.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`." }, { "info": { "name": "Delete User a Schedule Event", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/telephony/config/people/me/schedules/:scheduleType/:scheduleId/events/:eventId", "params": [ { "name": "scheduleType", "value": "businessHours", "type": "path", "description": "Type of the schedule.\n * `businessHours` - Business hours schedule type.\n * `holidays` - Holidays schedule type.\n" }, { "name": "scheduleId", "value": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvU0c5c2FXUmhlU0JXTWc", "type": "path", "description": "Delete an event for the specified schedule ID." }, { "name": "eventId", "value": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEVfRVZFTlQvUlZaRlRsUk9RVTFG", "type": "path", "description": "Delete the event with the matching ID." } ] }, "docs": "Delete a specific schedule event for the authenticated user.\n\nSchedules are used to define specific time periods which can be applied to various Call Settings, such as Sequential Ring, or Priority Alert. These call settings perform the defined actions based on the time frame in the schedule, making it more convenient for users to manage their calls.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`." }, { "info": { "name": "Get User's Location Level Schedule", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/locations/schedules/:scheduleType/:scheduleId", "params": [ { "name": "scheduleType", "value": "businessHours", "type": "path", "description": "Type of the schedule.\n * `businessHours` - Business hours schedule type.\n * `holidays` - Holidays schedule type.\n" }, { "name": "scheduleId", "value": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvU0c5c2FXUmhlU0JXTWc", "type": "path", "description": "Retrieve the schedule with the matching ID." } ] }, "docs": "Get Location Schedule for Call Settings of the authenticated user.\n\nSchedules are used to define specific time periods which can be applied to various Call Settings, such as Sequential Ring, or Priority Alert. These call settings perform the defined actions based on the time frame in the schedule, making it more convenient for users to manage their calls.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`." }, { "info": { "name": "Get Call Notify Settings for User", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/settings/callNotify" }, "docs": "Get Call Notify Settings for the authenticated user.\n\nCall Notify allows you to set up a unique ringtone based on predefined criteria. This is helpful, when the user wants to be quickly notified that a specific phone number is calling.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`." }, { "info": { "name": "Modify Call Notify Settings for User", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/me/settings/callNotify", "body": { "type": "json", "data": "{}" } }, "docs": "Update Call Notify Settings for the authenticated user.\n\nCall Notify allows you to set up a unique ringtone based on predefined criteria. This API allows modifying attributes such as name, phoneNumbers etc for a particular criteria.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`." }, { "info": { "name": "Add a Call Notify Criteria", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/people/me/settings/callNotify/criteria", "body": { "type": "json", "data": "{}" } }, "docs": "Create a Call Notify Criteria for the authenticated user.\n\nCall Notify allows you to set up a unique ringtone based on predefined criteria. This is helpful, when the user wants to be quickly notified that a specific phone number is calling.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`." }, { "info": { "name": "Get Call Notify Criteria Settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/settings/callNotify/criteria/:id", "params": [ { "name": "id", "value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY", "type": "path", "description": "The `id` parameter specifies the unique identifier for the call notify criteria. Example: `Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY`." } ] }, "docs": "Get Call Notify Criteria Settings for the authenticated user.\n\nCall Notify allows you to set up a unique ringtone based on predefined criteria. This is helpful, when the user wants to be quickly notified that a specific phone number is calling.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`." }, { "info": { "name": "Modify a Call Notify Criteria", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/me/settings/callNotify/criteria/:id", "params": [ { "name": "id", "value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY", "type": "path", "description": "The `id` parameter specifies the unique identifier for the call notify criteria. Example: `Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify Call Notify Criteria Settings for the authenticated user.\n\nCall Notify allows you to set up a unique ringtone based on predefined criteria. This API allows modifying attributes such as name, phoneNumbers etc for a particular criteria.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`." }, { "info": { "name": "Delete a Call Notify Criteria", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/telephony/config/people/me/settings/callNotify/criteria/:id", "params": [ { "name": "id", "value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY", "type": "path", "description": "The `id` parameter specifies the unique identifier for the call notify criteria. Example: `Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY`." } ] }, "docs": "Delete a Call Notify criteria for the authenticated user.\n\nCall Notify allows you to set up a unique ringtone based on predefined criteria. This API removes a specific criteria rule by its unique identifier.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`." }, { "info": { "name": "Get Selective Call Accept Settings for User", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/settings/selectiveAccept" }, "docs": "Get Selective Call Accept Settings for the authenticated user.\n\nSelective Call Accept allows you to create customized rules to accept specific calls for users based on the phone number,identity and the time or day of the call.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`." }, { "info": { "name": "Modify Selective Call Accept Settings for User", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/me/settings/selectiveAccept", "body": { "type": "json", "data": "{}" } }, "docs": "Update Selective Call Accept Settings for the authenticated user.\n\nSelective Call Accept allows you to create customized rules to accept specific calls for users based on the phone number,identity and the time or day of the call.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`." }, { "info": { "name": "Add User Selective Call Accept Criteria", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/people/me/settings/selectiveAccept/criteria", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Selective Call Accept Criteria for the authenticated user.\n\nSelective Call Accept allows you to create customized rules to accept specific calls for users based on the phone number,identity and the time or day of the call.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`." }, { "info": { "name": "Get Selective Call Accept Criteria Settings for User", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/settings/selectiveAccept/criteria/:id", "params": [ { "name": "id", "value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY", "type": "path", "description": "The `id` parameter specifies the unique identifier for the selective call accept criteria. Example: `Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY`." } ] }, "docs": "Get Selective Call Accept Criteria Settings for the authenticated user.\n\nSelective Call Accept allows you to create customized rules to accept specific calls for users based on the phone number,identity and the time or day of the call.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`." }, { "info": { "name": "Modify a Selective Call Accept Criteria", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/me/settings/selectiveAccept/criteria/:id", "params": [ { "name": "id", "value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY", "type": "path", "description": "The `id` parameter specifies the unique identifier for the selective call accept. Example: `Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify Selective Call Accept Criteria Settings for the authenticated user.\n\n\n\nSelective Call Accept allows you to create customized rules to accept specific calls for users based on the phone number,identity and the time or day of the call.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`." }, { "info": { "name": "Delete a Selective Call Accept Criteria", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/telephony/config/people/me/settings/selectiveAccept/criteria/:id", "params": [ { "name": "id", "value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY", "type": "path", "description": "The `id` parameter specifies the unique identifier for the selective call accept criteria. Example: `Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY`." } ] }, "docs": "Delete a Selective Call Accept Criteria for the authenticated user.\n\n\n\nSelective Call Accept allows you to create customized rules to accept specific calls for users based on the phone number,identity and the time or day of the call.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`." }, { "info": { "name": "Get Available Numbers for User's Location", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/location/assignedNumbers", "params": [ { "name": "max", "value": "100", "type": "query", "description": "Limit the maximum number of numbers in the response." }, { "name": "start", "value": "0", "type": "query", "description": "Specify the offset from the first result that you want to fetch." }, { "name": "name", "value": "Denver", "type": "query", "description": "List numbers whose owner name contains this string." }, { "name": "phoneNumber", "value": "27888", "type": "query", "description": "List numbers whose phoneNumber contains this string." }, { "name": "extension", "value": "7899", "type": "query", "description": "List numbers whose extension contains this string." }, { "name": "order", "value": "lastName-asc", "type": "query", "description": "Sort the list of numbers based on `lastName`, `dn`, `extension` either asc or desc." } ] }, "docs": "Get Available Numbers for User's Location.\n\nFetch all the numbers available in User's location.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`." }, { "info": { "name": "Add a Selective Call Forwarding Criteria", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/people/me/settings/selectiveForward/criteria", "body": { "type": "json", "data": "{}" } }, "docs": "Create a Selective Call Forwarding Criteria for the authenticated user.\n\nSelective Call Forward allows you to define rules that automatically forward incoming calls based on specific criteria, such as the caller’s phone number, caller identity, and the time and day the call is received.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`." }, { "info": { "name": "Get Settings for a Selective Call Forwarding Criteria", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/settings/selectiveForward/criteria/:id", "params": [ { "name": "id", "value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY", "type": "path", "description": "The `id` parameter specifies the unique identifier for the selective call forwarding criteria. Example: `Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY`." } ] }, "docs": "Get settings for a Selective Call Forwarding Criteria for the authenticated user.\n\nSelective Call Forward allows you to define rules that automatically forward incoming calls based on specific criteria, such as the caller’s phone number, caller identity, and the time and day the call is received.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`." }, { "info": { "name": "Modify Settings for a Selective Call Forwarding Criteria", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/me/settings/selectiveForward/criteria/:id", "params": [ { "name": "id", "value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY", "type": "path", "description": "The `id` parameter specifies the unique identifier for the selective call forwarding criteria. Example: `Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY`." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify settings for a Selective Call Forwarding Criteria for the authenticated user.\n\nSelective Call Forward allows you to define rules that automatically forward incoming calls based on specific criteria, such as the caller’s phone number, caller identity, and the time and day the call is received.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`." }, { "info": { "name": "Delete a Selective Call Forwarding Criteria", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/telephony/config/people/me/settings/selectiveForward/criteria/:id", "params": [ { "name": "id", "value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY", "type": "path", "description": "The `id` parameter specifies the unique identifier for the selective call forwarding criteria. Example: `Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY`." } ] }, "docs": "Delete a Selective Call Forwarding Criteria for the authenticated user.\n\nSelective call forwarding allows you to define rules that automatically forward incoming calls based on specific criteria. This API removes a specific criteria rule by its unique identifier.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`." }, { "info": { "name": "Get Selective Call Forward Settings for User", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/settings/selectiveForward" }, "docs": "Get Selective Call Forward Settings for the authenticated user.\n\nSelective Call Forward allows you to create customized rules to forward specific calls for users based on the phone number,identity and the time or day of the call.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`." }, { "info": { "name": "Modify Selective Call Forward Settings for User", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/me/settings/selectiveForward", "body": { "type": "json", "data": "{}" } }, "docs": "Update the Selective Call Forward Settings for the authenticated user.\n\nSelective Call Accept allows you to create customized rules to accept specific calls for users based on the phone number, identity, and the time or day of the call.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`." } ] } ], "bundled": true }