GET - Call Pickup Group User

Retrieves Pickup Group information for the specified user.

Parameters

  • service_provider_id (str): Target Service Provider ID

  • group_id (str): The Target Group ID the user is apart of.

  • user_id (str): Target User ID

Returns

  • Dict: Specified users pickup group, and the users within that group.

How To Use:

my_api.call_pickup.get_call_pickup_group_user(
    "my_service_provider_id", 
    "my_group_id", 
    "[email protected]"
)

Example Data Returned (Formatted)


{
  "serviceProviderId": "my_service_provider_id",
  "groupId": "my_group_id",
  "name": "Call Pickup 1",
  "users":  [
        {
        "userId": "[email protected]", 
        "lastName": "Smith", 
        "firstName": "John", 
        "hiraganaLastName": "Smith", 
        "hiraganaFirstName": "John", 
        "phoneNumber": "+1-23456789", 
        "extension": "1234", 
        "department": None, 
        "emailAddress": None
        }, 
        {
        "userId": "[email protected]", 
        "lastName": "Smith", 
        "firstName": "Jane", 
        "hiraganaLastName": "Smith", 
        "hiraganaFirstName": "jane", 
        "phoneNumber": "+1-98765432", 
        "extension": "4321", 
        "department": None, 
        "emailAddress": None
        }
    ]
}

Last updated

Was this helpful?