-
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
77 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# 💬 Auto Attendants | ||
|
||
All things updating auto attendants. |
72 changes: 72 additions & 0 deletions
72
docs/docs/methods/call-pickup/get-call-pickup-group-user.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
--- | ||
description: my_api.get.call_pickup_group_user() | ||
--- | ||
|
||
# 🤳 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: | ||
|
||
{% code overflow="wrap" %} | ||
```python | ||
from odins_spear import api | ||
|
||
my_api= api.Api(base_url="https://base_url/api/vx", username="john.smith", password="ODIN_INSTANCE_1") | ||
my_api.authenticate() | ||
|
||
my_api.put.call_pickup_group_user( | ||
"my_service_provider_id", | ||
"my_group_id", | ||
"[email protected]" | ||
) | ||
``` | ||
{% endcode %} | ||
|
||
### Example Data Returned (Formatted) | ||
|
||
```json | ||
|
||
{ | ||
"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 | ||
} | ||
] | ||
} | ||
|
||
|
||
``` | ||
|