{ "opencollection": "1.0.0", "info": { "name": "Webex Admin Address Book Call Settings For Me API", "version": "1.0.0" }, "items": [ { "info": { "name": "Call Settings For Me", "type": "folder" }, "items": [ { "info": { "name": "Get List Available Preferred Answer Endpoints", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/settings/availablePreferredAnswerEndpoints", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get the person's preferred answer endpoint and the list of endpoints available for selection. The list of endpoints is empty if the person has no endpoints assigned which support the preferred answer endpoint functionality.\n\n A Webex Calling user may be associated with multiple endpoints such as Webex App (desktop or mobile), Cisco desk IP phone, Webex Calling-supported analog devices or third-party endpoints. Preferred answering endpoints allow users to specify which of these devices should be " }, { "info": { "name": "Get My Secondary Line Owner's Available Preferred Answer Endpoint List", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/settings/secondaryLines/:lineOwnerId/availablePreferredAnswerEndpoints", "params": [ { "name": "lineOwnerId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU", "type": "path", "description": "Unique identifier for the secondary line owner (applicable only for Virtual Lines)." } ] }, "docs": "Retrieve the list of available preferred answer endpoints for the secondary line owner of the authenticated person. \n\n A Webex Calling user may be associated with multiple endpoints such as Webex App (desktop or mobile), Cisco desk IP phone, Webex Calling-supported analog devices or third-party endpoints. Preferred answering endpoints allow users to specify which of these devices should be prioritized for answering calls, particularly when a person's extension (or a virtual line assigned to them" }, { "info": { "name": "Get Preferred Answer Endpoint", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/settings/preferredAnswerEndpoint", "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieve the selected preferred answering endpoint for the user. If a preferred endpoint is not set for the person, API returns empty \n\n A Webex Calling user may be associated with multiple endpoints such as Webex App (desktop or mobile), Cisco desk IP phone, Webex Calling-supported analog devices or third-party endpoints. Preferred answering endpoints allow users to specify which of these devices should be prioritized for answering calls, particularly when a person's extension (or a virtual lin" }, { "info": { "name": "Modify Preferred Answer Endpoint", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/me/settings/preferredAnswerEndpoint", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Sets or clears the person’s preferred answer endpoint. To clear the preferred answer endpoint the `id` attribute must be set to null.\n\n A Webex Calling user may be associated with multiple endpoints such as Webex App (desktop or mobile), Cisco desk IP phone, Webex Calling-supported analog devices or third-party endpoints. Preferred answering endpoints allow users to specify which of these devices should be prioritized for answering calls, particularly when a person's extension (or a virtual line" }, { "info": { "name": "Get My Secondary Line Owner's Preferred Answer Endpoint", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/settings/secondaryLines/:lineOwnerId/preferredAnswerEndpoint", "params": [ { "name": "lineOwnerId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU", "type": "path", "description": "Unique identifier for the secondary line owner (applicable only for Virtual Lines)." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieve the selected preferred answering endpoint for the secondary line owner of the authenticated person. If a preferred endpoint is not set for the person, API returns empty \n\n A Webex Calling user may be associated with multiple endpoints such as Webex App (desktop or mobile), Cisco desk IP phone, Webex Calling-supported analog devices or third-party endpoints. Preferred answering endpoints allow users to specify which of these devices should be prioritized for answering calls, particularly" }, { "info": { "name": "Modify My Secondary Line Owner's Preferred Answer Endpoint", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/me/settings/secondaryLines/:lineOwnerId/preferredAnswerEndpoint", "params": [ { "name": "lineOwnerId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU", "type": "path", "description": "Unique identifier for the secondary line owner (applicable only for Virtual Lines)." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Sets or clears the preferred answer endpoint for the secondary line owner of the authenticated person. To clear the preferred answer endpoint the `id` attribute must be set to null.\n\n A Webex Calling user may be associated with multiple endpoints such as Webex App (desktop or mobile), Cisco desk IP phone, Webex Calling-supported analog devices or third-party endpoints. Preferred answering endpoints allow users to specify which of these devices should be prioritized for answering calls, particula" }, { "info": { "name": "Get My WebexGoOverride Settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/settings/webexGoOverride" }, "docs": "Retrieve \"Mobile User Aware\" override setting for Do Not Disturb feature.\n\nWhen enabled, a mobile device will still ring even if Do Not Disturb, Quiet Hours, or Presenting Status are enabled.\n\nWhen disabled, a mobile device will return busy for all incoming calls if Do Not Disturb, Quiet Hours, or Presenting Status are enabled.\n\nIt requires a user auth token with `spark:telephony_config_read` scope." }, { "info": { "name": "Modify My WebexGoOverride Settings", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/me/settings/webexGoOverride", "body": { "type": "json", "data": "{}" } }, "docs": "Update \"Mobile User Aware\" override setting for Do Not Disturb feature.\n\nWhen enabled, a mobile device will still ring even if Do Not Disturb, Quiet Hours, or Presenting Status are enabled.\n\nWhen disabled, a mobile device will return busy for all incoming calls if Do Not Disturb, Quiet Hours, or Presenting Status are enabled.\n\nIt requires a user auth token with the `spark:telephony_config_write` scope." }, { "info": { "name": "Get My Caller ID Settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/settings/callerId" }, "docs": "Get Caller ID Settings for the authenticated user.\n\nCalling Line ID Delivery Blocking in Webex prevents your name and phone number from being shown to people you call.\nConnected Line Identification Restriction allows you to block your name and phone number from being shown when receiving a call.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`." }, { "info": { "name": "Modify My Caller ID Settings", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/me/settings/callerId", "body": { "type": "json", "data": "{}" } }, "docs": "Update Caller ID Settings for the authenticated user.\n\nCalling Line ID Delivery Blocking in Webex prevents your name and phone number from being shown to people you call.\nConnected Line Identification Restriction allows you to block your name and phone number from being shown when receiving a call.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`." }, { "info": { "name": "Get My Secondary Line Owner Caller ID Settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/settings/secondaryLines/:lineownerId/callerId", "params": [ { "name": "lineownerId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU", "type": "path", "description": "Unique identifier for the secondary line owner (applicable only for Virtual Lines)." } ] }, "docs": "Get Caller ID Settings for the secondary line owner of the authenticated user.\n\nNote that the secondary line information is only available for the authenticated user.\n\nCalling Line ID Delivery Blocking in Webex prevents your name and phone number from being shown to people you call.\nConnected Line Identification Restriction allows you to block your name and phone number from being shown when receiving a call.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`." }, { "info": { "name": "Modify My Secondary Line Owner Caller ID Settings", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/me/settings/secondaryLines/:lineownerId/callerId", "params": [ { "name": "lineownerId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU", "type": "path", "description": "Unique identifier for the secondary line owner (applicable only for Virtual Lines)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Caller ID Settings for the secondary line owner of the authenticated user.\n\nNote that the secondary line information is only available for the authenticated user.\n\nCalling Line ID Delivery Blocking in Webex prevents your name and phone number from being shown to people you call.\nConnected Line Identification Restriction allows you to block your name and phone number from being shown when receiving a call.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`." }, { "info": { "name": "Read My Selected Caller ID Settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/settings/selectedCallerId" }, "docs": "Read selected caller ID settings associated with the authenticated user.\n\nCaller ID settings control how a person's information is displayed when making outgoing calls.\nSelected Caller ID settings allow users to choose which configuration among available caller IDs is selected currently.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`." }, { "info": { "name": "Configure My Selected Caller ID Settings", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/me/settings/selectedCallerId", "body": { "type": "json", "data": "{}" } }, "docs": "Update selected caller ID settings associated with the authenticated user.\n\nCaller ID settings control how a person's information is displayed when making outgoing calls.\nSelected Caller ID settings allow users to choose which configuration among available caller IDs is selected currently.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`." }, { "info": { "name": "Get My Secondary Line Owner's Selected Caller ID Settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/settings/secondaryLines/:lineownerId/selectedCallerId", "params": [ { "name": "lineownerId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU", "type": "path", "description": "Unique identifier for the secondary line owner (applicable only for Virtual Lines)." } ] }, "docs": "Get details of selected caller ID settings associated with a secondary line of the authenticated user.\n\nNote that an authenticated user can only retrieve information for their configured secondary lines.\n\nCaller ID settings control how a person's information is displayed when making outgoing calls.\nSelected Caller ID settings allow users to choose which configuration among available caller IDs is selected currently.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_rea" }, { "info": { "name": "Modify My Secondary Line Owner's Selected Caller ID Settings", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/me/settings/secondaryLines/:lineownerId/selectedCallerId", "params": [ { "name": "lineownerId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU", "type": "path", "description": "Unique identifier for the secondary line owner (applicable only for Virtual Lines)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update selected caller ID settings associated with a secondary line owner of the authenticated user.\n\nNote that an authenticated user can only modify information for their configured secondary lines.\n\nCaller ID settings control how a person's information is displayed when making outgoing calls.\nSelected Caller ID settings allow users to choose which configuration among available caller IDs is selected currently.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`." }, { "info": { "name": "Get My Available Caller ID List", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/settings/availableCallerIds" }, "docs": "Get details of available caller IDs of the authenticated user.\n\nCaller ID settings control how a person's information is displayed when making outgoing calls.\nThe available caller ID list shows the caller IDs that the user can choose from.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`." }, { "info": { "name": "Get My Secondary Line Owner's Available Caller ID List", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/settings/secondaryLines/:lineownerId/availableCallerIds", "params": [ { "name": "lineownerId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU", "type": "path", "description": "Unique identifier for the secondary line owner (applicable only for Virtual Lines)." } ] }, "docs": "Get details of available caller IDs for a secondary line of the authenticated user.\n\nNote that an authenticated user can only retrieve information for their configured secondary lines.\n\nCaller ID settings control how a person's information is displayed when making outgoing calls.\nThe available caller ID list shows the caller IDs that the user can choose from.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`." }, { "info": { "name": "Read the List of My Endpoints", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/endpoints" }, "docs": "Retrieve the list of endpoints associated with the authenticated user.\n\nEndpoints are devices, applications, or hotdesking guest profiles. Endpoints can be owned by an authenticated user or have the user as a secondary line.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`." }, { "info": { "name": "Get My Endpoints Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/endpoints/:endpointId", "params": [ { "name": "endpointId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS80NmNmMGEyYi0yNTE5LTQ1NGEtYTAzMi1iODYxMWZjYmZkNTQ", "type": "path", "description": "Unique identifier of the endpoint." } ] }, "docs": "Get details of an endpoint associated with the authenticated user.\n\nEndpoints are devices, applications, or hotdesking guest profiles. Endpoints can be owned by an authenticated user or have the user as a secondary line.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`." }, { "info": { "name": "Modify My Endpoints Details", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/me/endpoints/:endpointId", "params": [ { "name": "endpointId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS85MGQyMmM0Yy0wMGI3LTQ4YzAtYjUwNi0yM2UwY2E2MTlkYmM", "type": "path", "description": "Unique identifier of the endpoint." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update alerting settings of the mobility endpoint associated with the authenticated user.\n\nEndpoints are devices, applications, or hotdesking guest profiles. Endpoints can be owned by an authenticated user or have the user as a secondary line.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`." }, { "info": { "name": "Get My Call Recording Settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/settings/callRecording" }, "docs": "Get details of call recording settings associated with the authenticated user.\n\nCall recording settings allow you to access and customize options that determine when and how your calls are recorded, providing control over recording modes and notifications.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`." }, { "info": { "name": "Get My Secondary Line Owner's Call Recording Settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/settings/secondaryLines/:lineownerId/callRecording", "params": [ { "name": "lineownerId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU", "type": "path", "description": "Unique identifier for the secondary line owner (applicable only for Virtual Lines)." } ] }, "docs": "Get details of call recording settings associated with a secondary line of the authenticated user.\n\nNote that an authenticated user can only retrieve information for their configured secondary lines.\n\nCall recording settings allow you to access and customize options that determine when and how your calls are recorded, providing control over recording modes and notifications.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`." }, { "info": { "name": "Get My Own Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me" }, "docs": "Get profile details for the authenticated user.\n\nProfile details include the user's name, email, location and calling details.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`." }, { "info": { "name": "Get My Feature Access Codes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/settings/featureAccessCode" }, "docs": "Retrieve all Feature Access Codes configured for services that are assigned to the authenticated user. For each feature access code, the name and code are returned. If an alternate code is defined, it is also returned.\n\nFeature access codes (FACs), also known as star codes, give users access to advanced calling features.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`." }, { "info": { "name": "Get My Feature Access Codes For Secondary Line Owner", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/settings/secondaryLines/:lineownerId/featureAccessCode", "params": [ { "name": "lineownerId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS82NDhjYjBkMC1kODU2LTQzNzQtYmI4My0zNWFhNTIxZDhiZmI", "type": "path", "description": "Unique identifier for the secondary line owner (applicable only for Virtual Lines)." } ] }, "docs": "Retrieve all Feature Access Codes configured for services that are assigned for the secondary line owner. For each feature access code, the name and code are returned. If an alternate code is defined, it is also returned.\n\nFeature access codes (FACs), also known as star codes, give users access to advanced calling features.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`." }, { "info": { "name": "Get My Executive Assigned Assistants", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/settings/executive/assignedAssistants" }, "docs": "Get list of assigned executive assistants for an authenticated user.\n\nAs an executive, you can add assistants to your executive pool to manage calls for you. You can set when and which types of calls they can handle. Assistants can opt in when needed or opt out when not required.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`." }, { "info": { "name": "Modify My Executive Assigned Assistants", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/me/settings/executive/assignedAssistants", "body": { "type": "json", "data": "{}" } }, "docs": "Update assigned executive assistants for the authenticated user.\n\nAs an executive, you can add assistants to your executive pool to manage calls for you. You can set when and which types of calls they can handle. Assistants can opt in when needed or opt out when not required.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`." }, { "info": { "name": "Get My Executive Available Assistants", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/settings/executive/availableAssistants" }, "docs": "Get a list of available executive assistants for the authenticated user.\n\nAs an executive, you can add assistants to your executive pool to manage calls for you. You can set when and which types of calls they can handle. Assistants can opt in when needed or opt out when not required.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`." }, { "info": { "name": "Get My Executive Assistant Settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/settings/executive/assistant" }, "docs": "Get settings for an executive assistant.\n\nExecutive assistants can make, answer, intercept, and route calls appropriately on behalf of their executive.\nAssistants can also set the call forwarding destination, and join or leave an executive’s pool.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`." }, { "info": { "name": "Modify My Executive Assistant Settings", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/me/settings/executive/assistant", "body": { "type": "json", "data": "{}" } }, "docs": "Update Settings for an executive assistant.\n\nExecutive assistants can make, answer, intercept, and route calls appropriately on behalf of their executive.\nAssistants can also set the call forwarding destination, and join or leave an executive’s pool.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`." }, { "info": { "name": "Get My Calling Services List", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/settings/services" }, "docs": "Retrieves the list of enabled calling services for the authenticated user.\n\nThese services are designed to improve call handling and ensure that users can manage their communications effectively. They are commonly found in both personal and business telephony systems.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`." }, { "info": { "name": "Get My Secondary Line Owner Calling Services List", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/settings/secondaryLines/:lineownerId/services", "params": [ { "name": "lineownerId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU", "type": "path", "description": "Unique identifier for the secondary line owner (applicable only for Virtual Lines)." } ] }, "docs": "Retrieves the list of enabled calling services for the secondary line owner of the authenticated user.\n\nThese services are designed to improve call handling and ensure that users can manage their communications effectively. They are commonly found in both personal and business telephony systems.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`." }, { "info": { "name": "Get User's Single Number Reach Settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/settings/singleNumberReach" }, "docs": "Retrieves all single number reach settings configured for the authenticated user.\n\nThe \"Single Number Reach\" feature in Webex allows users to access their business phone capabilities from any device, making it easy to make and receive calls as if at their office. This is especially useful for remote or mobile workers needing flexibility.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`." }, { "info": { "name": "Modify User's Single Number Reach Settings", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/me/settings/singleNumberReach", "body": { "type": "json", "data": "{}" } }, "docs": "Updates single number reach settings associated with the authenticated user.\n\nThe \"Single Number Reach\" feature in Webex allows users to access their business phone capabilities from any device, making it easy to make and receive calls as if at their office. This is especially useful for remote or mobile workers needing flexibility.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`." }, { "info": { "name": "Add phone number as User's Single Number Reach", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/people/me/settings/singleNumberReach/numbers", "body": { "type": "json", "data": "{}" } }, "docs": "Add a phone number as a single number reach for the authenticated user.\n\nThe \"Single Number Reach\" feature in Webex allows users to access their business phone capabilities from any device, making it easy to make and receive calls as if at their office. This is especially useful for remote or mobile workers needing flexibility.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`." }, { "info": { "name": "Modify User's Single Number Reach Contact Settings", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/me/settings/singleNumberReach/numbers/:phoneNumberId", "params": [ { "name": "phoneNumberId", "value": "Y2lzY29zcGFyazovL3VzL1BIT05FX05VTUJFUi9LekU0T1RjMk5UUXpNekUx", "type": "path", "description": "Unique identifier of the phone number." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the contact settings of single number reach for the authenticated user.\n\nThe \"Single Number Reach\" feature in Webex allows users to access their business phone capabilities from any device, making it easy to make and receive calls as if at their office. This is especially useful for remote or mobile workers needing flexibility.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`." }, { "info": { "name": "Delete User's Single Number Reach Contact Settings", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/telephony/config/people/me/settings/singleNumberReach/numbers/:phoneNumberId", "params": [ { "name": "phoneNumberId", "value": "Y2lzY29zcGFyazovL3VzL1BIT05FX05VTUJFUi9LekU0T1RjMk5UUXpNekUx", "type": "path", "description": "Unique identifier of the phone number." } ] }, "docs": "Delete contact settings associated with the authenticated user.\n\nThe \"Single Number Reach\" feature in Webex allows users to access their business phone capabilities from any device, making it easy to make and receive calls as if at their office. This is especially useful for remote or mobile workers needing flexibility.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`." }, { "info": { "name": "Read My Call Forwarding Settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/settings/callForwarding" }, "docs": "Read call forwarding settings associated with the authenticated user.\n\nThree types of call forwarding are supported:\n\n+ Always - forwards all incoming calls to the destination you choose.\n\n+ When busy - forwards all incoming calls to the destination you chose while the phone is in use or the person is busy.\n\n+ When no answer - forwarding only occurs when you are away or not answering your phone.\n\nIn addition, the Business Continuity feature will send calls to a destination of your choice if your" }, { "info": { "name": "Configure My Call Forwarding Settings", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/me/settings/callForwarding", "body": { "type": "json", "data": "{}" } }, "docs": "Update call forwarding settings associated with the authenticated user.\n\nThree types of call forwarding are supported:\n\n+ Always - forwards all incoming calls to the destination you choose.\n\n+ When busy - forwards all incoming calls to the destination you chose while the phone is in use or the person is busy.\n\n+ When no answer - forwarding only occurs when you are away or not answering your phone.\n\nIn addition, the Business Continuity feature will send calls to a destination of your choice if yo" }, { "info": { "name": "Get My Secondary Line Owner's Call Forwarding Settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/settings/secondaryLines/:lineownerId/callForwarding", "params": [ { "name": "lineownerId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU", "type": "path", "description": "Unique identifier for the secondary line owner (applicable only for Virtual Lines)." } ] }, "docs": "Get details of call forwarding settings associated with a secondary line of the authenticated user.\n\nNote that an authenticated user can only retrieve information for their configured secondary lines.\n\nThree types of call forwarding are supported:\n\n+ Always - forwards all incoming calls to the destination you choose.\n\n+ When busy - forwards all incoming calls to the destination you chose while the phone is in use or the person is busy.\n\n+ When no answer - forwarding only occurs when you are away" }, { "info": { "name": "Modify My Secondary Line Owner's Call Forwarding Settings", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/me/settings/secondaryLines/:lineownerId/callForwarding", "params": [ { "name": "lineownerId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU", "type": "path", "description": "Unique identifier for the secondary line owner (applicable only for Virtual Lines)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update call forwarding settings associated with a secondary line owner of the authenticated user.\n\nNote that an authenticated user can only modify information for their configured secondary lines.\n\nThree types of call forwarding are supported:\n\n+ Always - forwards all incoming calls to the destination you choose.\n\n+ When busy - forwards all incoming calls to the destination you chose while the phone is in use or the person is busy.\n\n+ When no answer - forwarding only occurs when you are away or " }, { "info": { "name": "Get My Call Pickup Group Settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/settings/callPickupGroup" }, "docs": "Get Call Pickup Group Settings for the authenticated user.\n\nCall pickup group enables a user to answer any ringing line within their pickup group. A call pickup group is an administrator-defined set of users within a location, to which the call pickup feature applies.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`." }, { "info": { "name": "Get My Secondary Line Owner Call Pickup Group Settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/settings/secondaryLines/:lineownerId/callPickupGroup", "params": [ { "name": "lineownerId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU", "type": "path", "description": "Unique identifier for the secondary line owner (applicable only for Virtual Lines)." } ] }, "docs": "Get Call Pickup Group Settings for the secondary line owner of the authenticated user.\n\nNote that the secondary line information is only available for the authenticated user.\n\nCall pickup group enables a user to answer any ringing line within their pickup group. A call pickup group is an administrator-defined set of users within a location, to which the call pickup feature applies.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`." }, { "info": { "name": "Get My Call Park Settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/settings/callPark" }, "docs": "Get details of call park settings associated with the authenticated user.\n\nCall Park allows call recipients to place a call on hold so that it can be retrieved from another device.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`." }, { "info": { "name": "Get My Secondary Line Owner Call Park Settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/settings/secondaryLines/:lineownerId/callPark", "params": [ { "name": "lineownerId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU", "type": "path", "description": "Unique identifier for the secondary line owner (applicable only for Virtual Lines)." } ] }, "docs": "Get details of call park settings for the secondary line owner of the authenticated user.\n\nNote that the secondary line information is only available for the authenticated user.\n\nCall Park allows call recipients to place a call on hold so that it can be retrieved from another device.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`." }, { "info": { "name": "Read Voicemail Settings for a Person", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/settings/voicemail" }, "docs": "Retrieve a person's voicemail settings.\n\nThe voicemail feature transfers callers to voicemail based on your settings. You can then retrieve voice messages via voicemail.\n\nOptionally, notifications can be sent to a mobile phone via text or email. These notifications will not include the voicemail files.\n\nThis API requires a user auth token with a scope of `spark-admin:people_read`." }, { "info": { "name": "Configure Voicemail Settings for a Person", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/me/settings/voicemail", "body": { "type": "json", "data": "{}" } }, "docs": "Configure a person's voicemail settings.\n\nThe voicemail feature transfers callers to voicemail based on your settings. You can then retrieve voice messages via voicemail.\n\nOptionally, notifications can be sent to a mobile phone via text or email. These notifications will not include the voicemail files.\n\nThis API requires a user auth token with a scope of `spark-admin:people_write`." }, { "info": { "name": "Get My Secondary Line Owner's Voicemail Settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/settings/secondaryLines/:lineownerId/voicemail", "params": [ { "name": "lineownerId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU", "type": "path", "description": "Unique identifier for the secondary line owner (applicable only for Virtual Lines)." } ] }, "docs": "GET voicemail settings for a secondary line of the authenticated user.\n\nThe voicemail feature transfers callers to voicemail based on your settings. You can then retrieve voice messages via voicemail.\n\nOptionally, notifications can be sent to a mobile phone via text or email. These notifications will not include the voicemail files.\n\nThis API requires a user auth token with a scope of `spark-admin:people_read`." }, { "info": { "name": "Modify My Secondary Line Owner's Voicemail Settings", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/me/settings/secondaryLines/:lineownerId/voicemail", "params": [ { "name": "lineownerId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU", "type": "path", "description": "Unique identifier for the secondary line owner (applicable only for Virtual Lines)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update voicemail settings associated with a secondary line owner of the authenticated user.\n\nThe voicemail feature transfers callers to voicemail based on your settings. You can then retrieve voice messages via voicemail.\n\nOptionally, notifications can be sent to a mobile phone via text or email. These notifications will not include the voicemail files.\n\nThis API requires a user auth token with a scope of `spark-admin:people_write`." }, { "info": { "name": "Get My Call Block Settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/settings/callBlock" }, "docs": "Get details of call block settings associated with the authenticated user.\n\nCall block settings allow you to get the User Call Block Number List.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`." }, { "info": { "name": "Add a phone number to user's Call Block List", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/people/me/settings/callBlock/numbers", "body": { "type": "json", "data": "{}" } }, "docs": "Add a phone number to the call block list for the authenticated user.\n\nCall block settings allow you to get the User Call Block Number List.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`." }, { "info": { "name": "Get My Call Block State For Specific Number", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/settings/callBlock/numbers/:phoneNumberId", "params": [ { "name": "phoneNumberId", "value": "Y2lzY29zcGFyazovL3VzL1BIT05FX05VTUJFUi9LekU0T1RjMk5UUXpNekUx", "type": "path", "description": "Unique identifier of the phone number." } ] }, "docs": "Get call block state details for a specific number associated with the authenticated user.\n\nCall block settings allow you to get the User Call Block Number List.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`." }, { "info": { "name": "Delete User Call Block Number", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/telephony/config/people/me/settings/callBlock/numbers/:phoneNumberId", "params": [ { "name": "phoneNumberId", "value": "Y2lzY29zcGFyazovL3VzL1BIT05FX05VTUJFUi9LekU0T1RjMk5UUXpNekUx", "type": "path", "description": "Unique identifier of the phone number." } ] }, "docs": "Delete call block number settings associated with the authenticated user.\n\nCall block settings allow you to delete a number from the User Call Block Number List.\n\nThis API requires a user auth token with a scope of `spark-admin:people_write`." }, { "info": { "name": "Get My Monitoring Settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/settings/monitoring" }, "docs": "Retrieves the monitoring settings of the logged in person, which shows specified people, places, virtual lines or call park extensions that are being monitored.\n\nMonitors the line status which indicates if a person, place or virtual line is on a call and if a call has been parked on that extension.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`." }, { "info": { "name": "Get My Call Center Settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/settings/queues" }, "docs": "Retrieves the call center settings and list of all call centers the logged in user belongs to.\n\nCalls from the Call Centers are routed to agents based on configuration. An agent can be assigned to one or more call queues and can be managed by supervisors.\nThe user must have the call center service assigned.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`." }, { "info": { "name": "Modify My Call Center Settings", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/me/settings/queues", "body": { "type": "json", "data": "{}" } }, "docs": "Modify the call center settings and availability for an agent in one or more call centers to which the logged in user belongs.\n\nCalls from the Call Centers are routed to agents based on configuration. An agent can be assigned to one or more call queues and can be managed by supervisors.\nContains a list specifying the desired availability status of one or more call centers.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`." }, { "info": { "name": "Get My Secondary Line Owner's Call Center Settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/settings/secondaryLines/:lineownerId/queues", "params": [ { "name": "lineownerId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU", "type": "path", "description": "Unique identifier for the secondary line owner (applicable only for Virtual Lines)." } ] }, "docs": "Retrieves the call center settings and list of all call centers associated with a secondary line of the authenticated user.\nNote that an authenticated user can only retrieve information for their configured secondary lines.\n\nCalls from the Call Centers are routed to agents based on configuration. An agent can be assigned to one or more call queues and can be managed by supervisors.\nThe secondary line must have the call center service assigned.\n\nThis API requires a user auth token with a scope of" }, { "info": { "name": "Modify My Secondary Line Owner's Call Center Settings", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/me/settings/secondaryLines/:lineownerId/queues", "params": [ { "name": "lineownerId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU", "type": "path", "description": "Unique identifier for the secondary line owner (applicable only for Virtual Lines)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify the call center settings and availability for an agent in one or more call centers associated with a secondary line owner of the authenticated user.\nNote that an authenticated user can only modify information for their configured secondary lines.\n\nCalls from the Call Centers are routed to agents based on configuration. An agent can be assigned to one or more call queues and can be managed by supervisors.\nContains a list specifying the desired availability status of one or more call center" }, { "info": { "name": "Get my call captions settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/me/settings/callCaptions" }, "docs": "Retrieve the effective call captions settings of the authenticated user.\n\n**NOTE**: The call captions feature is not supported for Webex Calling Standard users or users assigned to locations in India.\n\nThe call caption feature allows the customer to enable and manage closed captions and transcript functionality (rolling caption panel) in Webex Calling, without requiring the user to escalate the call to a meeting.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`." } ] } ], "bundled": true }