Odin's Spear
  • Welcome
  • Getting Started
    • Getting the Essentials
    • Create API Object
  • API Coverage
  • Docs
    • API Object
    • Standard Methods
      • Session
        • GET - Session
        • POST - Session Logout
        • POST - Session
        • POST - Switch Session
        • PUT - Change Password
        • PUT - My Password
        • PUT - Password
        • PUT - Session
      • Administrators
        • POST - Service Provider Admin
        • PUT - Service Provider Admin Policies
        • POST - Group Admin Polices Bulk
        • POST - Group Admin
      • Alternate Numbers
        • GET - User Alternate Numbers
      • Authentication
        • GET - User Authentication Service
        • PUT - User Web Authentication Password
        • PUT - User Authentication Service
      • Auto Attendants
        • GET - Auto Attendants
        • POST - Auto Attendant
        • GET - Auto Attendant
        • GET - Auto Attendant User
        • POST - Auto Attendant Remove User
        • PUT - Auto Attendant
        • DELETE - Auto Attendant
        • GET - Auto Attendant Submenus
        • POST - Auto Attendant Submenu
        • GET - Auto Attendant Submenu Usage
        • PUT - Auto Attendant Submenu
        • PUT - Auto Attendant Status
        • DELETE - Auto Attendant Submenu
      • Call Centers
        • GET - Group Call Center
        • PUT - Group Call Center
        • GET - Group Call Centers
        • PUT - Group Call Center Agents
        • PUT - Group Call Center Agents Levels
        • GET - Group Call Center Bounced Calls
        • PUT - Group Call Center Bounced Call
        • PUT - Group Call Center DNIS Instance
        • GET - Group Call Center Forced Forwarding
        • PUT - Group Call Center Forced Forwarding
        • GET - Group Call Center Overflow
        • PUT - Group Call Center Overflow
        • GET - Group Call Center Stranded Calls
        • GET - Group Call Center Stranded Calls Unavailable
        • PUT - Group Call Center Status
        • PUT - Group Call Center Stranded Calls
        • PUT - Group Call Center Stranded Calls Unavailable
        • GET - User Call Center
        • PUT - User Call Center
        • PUT - User Call Center Agent Sign Out
        • PUT - User Call Center Agents Update
        • PUT - User Call Center Supervised Agents
      • Call Forwarding Always
        • GET - Bulk Call Forwarding Always
        • GET - User Call Forwarding Always
      • Call Forwarding Busy
        • GET - Bulk Call Forwarding Busy
        • GET - User Call Forwarding Busy
      • Call Forwarding No Answer
        • GET - Bulk User Call Forwarding No Answer
        • GET - User Call Forwarding No Answer
      • Call Forwarding Not Reachable
        • GET - Bulk User Call Forwarding Not Reachable
        • GET - User Call Forwarding Not Reachable
      • Call Forwarding Selective
        • GET - User Call Forwarding Selective
        • GET - User Call Forwarding Selective Criteria
        • GET - User Call Forwarding Selective Criterias
      • Call Pickup
        • GET - Call Pickup Avilable User
        • GET - Call Pickup Group User
        • GET - Call Pickup Groups
        • GET - Call Pickup Group
        • POST - Call Pickup Group
        • PUT - Call Pickup Group
        • DELETE - Call Pickup Group
      • Call Processing Policies
        • PUT - User Call Processing Policy
      • Call Records
        • GET - User Stats
      • Devices
        • POST - Group Device
        • PUT - Group Devices
        • PUT - Group Device File
        • PUT - Group Device Tag
        • PUT - Group Device Type File
        • PUT - Group Device Tags Profile
        • PUT - Group Device Type Tag
        • PUT - Service Provider Device
        • PUT - Service Provider Device File
        • PUT - Service Provider Device Tag
        • PUT - Service Provider Device Type Tag
        • PUT - System Devices
        • PUT - System Device File
        • PUT - System Device Tag
      • DNs
        • GET - Group DNs
        • POST - Group DNs
        • DELETE - Group DNs
        • PUT - Group DNs Activate
        • POST - Group DNs Assign Bulk
        • GET - Group DN Details
        • GET - Group DN Search
        • POST - Group DNs Unassign Bulk
        • GET - Service Provider DNs
        • POST - Service Provider DNs
        • GET - Service Provider DN Search
        • DELETE - Service Provider DNs
        • GET - System DNs
        • GET - System DN Search
        • GET - System DN Summary
        • GET - System DN Utilisation
      • Do Not Disturb
        • GET - User Do Not Disturb
        • PUT - User Do Not Disturb
      • Emergency Zones
        • POST - Group Emergency Zones
        • PUT - Group Emergency Zones
      • Extensions
        • GET - Extensions
        • PUT - Extensions
      • Groups
        • GET - Group Information
        • POST - Create Group
        • PUT - Update Group
        • DELETE - Delete Group
        • GET - Service Provider Groups
      • Hunt Groups
        • GET - Group Hunt Groups
        • GET - Group Hunt Group
        • POST - Group Hunt Group
        • PUT - Group Hunt Group
        • DELETE - Group Hunt Group
        • GET - Group Hunt Groups Available Users
        • PUT - Group Hunt Groups Status
        • GET - Group Hunt Group User
        • PUT - Group Hunt Group Weighted Call Distribution
        • POST - Group Hunt Groups Remove User
      • Password Generate
        • GET - Password Generate
        • GET - Passwords Generate
        • GET - Passcode Generate
        • GET - Passcodes Generate
        • GET - SIP Password Generate
        • GET - SIP Passwords Generate
      • Registration
        • GET - User Registration
        • GET - Bulk User Registration
      • Reports
        • GET - User Report
      • Schedules
        • GET - Group Schedules
        • GET - Group Events
      • Service Providers
        • GET - Service Provider
        • GET - Service Providers
      • Services
        • GET - Group Services
        • GET - Group Services Assigned
        • GET - User-Services
        • PUT - User Services
        • GET - User Services Assigned
        • GET - User Service Settings
        • PUT - User Service Settings
      • Shared Call Appearance
        • GET - User Shared Call Appearance
        • GET - User Shared Call Appearance Bulk
        • GET - User Shared Call Appearance Endpoint
        • PUT - User Shared Call Appearance
        • PUT - User Shared Call Appearance Endpoint
        • POST - User Shared Call Appearance Endpoint
        • DELETE - User Shared Call Appearance Endpoint
      • Trunk Groups
        • GET - Group Trunk Group
        • GET - Group Trunk Groups
        • GET - Group Trunk Groups Call Capacity
        • GET - Service Provider Call Capacity Report
        • GET - Group Trunk Available Hosted Users
        • GET - Group Trunk Group Users
        • GET - Group Trunk Available Hosted Users
        • GET - Service Providers Trunk Call Capacity Report Show
        • POST - Group Trunk Group
        • PUT - Group Trunk Groups Call Capacity
        • PUT - Group Trunk Group
        • PUT - Service Provider Trunk Group Call Capacity
        • DELETE - Group Trunk Group
      • User
        • GET - User By ID
        • GET - Users
        • GET - Group User Audit
        • GET - User Audit
        • GET - User Password
        • PUT - User ID
        • PUT - User SIP Contacts
        • POST - User
        • PUT - User
        • DELETE - User
        • PUT - User ID
        • PUT - Users Bulk
        • PUT - User Group ID Update
        • GET - User Login Info
        • GET - User Portal Passcode
        • PUT - User Portal Passcode
        • POST - User Reset
      • Voice Messaging
        • GET - Group Voice Messaging
        • GET - Group Voice Messaging Portal
        • GET - User Voice Messaging Advanced
        • GET - User Voice Messaging Bulk
        • GET - User Voice Messaging Greetings
        • GET - User Voice Messaging Message Details
        • GET - User Voice Messaging Message Download
        • GET - User Voice Messaging Messages
        • GET - User Voice Messaging User Distribution List
        • GET - User Voice Messaging User Distribution Lists
        • GET - User Voice Messaging Voice Portal
        • GET - User Voice Messaging
        • PUT - Group Voice Messaging
        • PUT - Group Voice Messaging Portal
        • PUT - User Voice Messaging Bulk
        • PUT - User Voice Messaging Greetings
        • PUT - User Voice Messaging Messages Read
        • PUT - User Voice Messaging Messages Unread
        • PUT - User Voice Messaging User Distribution List
        • PUT - User Voice Messaging Voice Portal
        • PUT - User Voice Messaging
        • DELETE - User Voice Messaging Messages
    • Advanced Features
      • Scripter
        • Find Alias
        • User Association
        • Group Audit
        • Move Numbers
        • Remove Numbers
        • Bulk Password Reset
        • Service Provider Trunking Capacity
        • Webex Builder
        • Locate Free Extension
        • User Registration
        • VM Auto Login
      • Reporter
        • Call Flow
          • Making Sense of The Call Flow
          • Graphviz
        • Group Users Call Statistics
        • User Registration Report
    • Utils
      • Config Manager
        • Template Configs
          • Auto Attendant
          • Call Center
          • Device
          • Group
          • Hunt Group
          • Service Provider
          • Trunk Group
          • User
      • Checkers
      • Constants
      • Formatters
      • Parsers
    • Logging
  • Powered By Odin's Spear
    • AA, CC, HG Audit
    • Bulk Build Group Admins
    • Bulk Build Service Provider Admins
    • Service Pack Audit
    • VM Bulk Passcode Set CSV
  • 14IP
    • Custom Logger
  • Development
  • Troubleshooting & FAQ
    • Frequently Asked Questions
    • Common Issues
      • Graphviz Troubleshooting
  • Bugs and Issues
  • Contact
Powered by GitBook
On this page
  • Parameters
  • Returns
  • How To Use:
  • Example Data Returned (Formatted)

Was this helpful?

  1. Docs
  2. Standard Methods
  3. Shared Call Appearance

GET - User Shared Call Appearance Bulk

Gets all Shared Call Appearances (SCAs) within a specified group.

Parameters

  • service_provider_id (str): Service Provider/ Enterprise ID where Group is hosted.

  • group_id (str): Target Group ID where users are located.

Returns

  • List[Dict]: List of SCA details for the group

How To Use:

my_api.shared_call_appearance.get_user_shared_call_appearance_bulk(
    service_provider_id="provider1",
    group_id="group1"
)

Example Data Returned (Formatted)

[
    {
        "userId": "user1@example.com",
        "isActive": true,
        "allowOrigination": true,
        "allowTermination": true,
        "deviceName": "device1",
        "deviceLevel": "Group",
        "linePort": "line1"
    },
    {
        "userId": "user2@example.com",
        "isActive": true,
        "allowOrigination": true,
        "allowTermination": true,
        "deviceName": "device2",
        "deviceLevel": "Group",
        "linePort": "line2"
    }
]
PreviousGET - User Shared Call AppearanceNextGET - User Shared Call Appearance Endpoint

Last updated 1 day ago

Was this helpful?