-
-
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.
Co-authored-by: Jordan Prescott <[email protected]> Co-authored-by: Malkin0xb <[email protected]> Co-authored-by: Jordan Prescott <[email protected]>
- Loading branch information
4 people
authored
Jul 19, 2024
1 parent
3d9c510
commit 622ce55
Showing
10 changed files
with
558 additions
and
1 deletion.
There are no files selected for viewing
.png){kind=link}
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
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 @@ | ||
| # 🗃️ Call Processing POlicies |
82 changes: 82 additions & 0 deletions
82
docs/docs/methods/call-processing-policies/put-user-call-processing-policy.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,82 @@ | ||
| --- | ||
| description: my_api.put.user_call_processing_policy() | ||
| --- | ||
|
|
||
| # 🗃️ PUT - User Call Processing Policy | ||
|
|
||
| Update the Call Processing Policies for a specified user. | ||
|
|
||
| ### Parameters  | ||
|
|
||
| * user\_id (str): The user ID of the user whose call processing policies need updating. | ||
| * updates (dict): Updates to apply to the specified user. | ||
|
|
||
| ### Returns | ||
|
|
||
| * Dict: Returns the updated call processing policies. | ||
|
|
||
| ### 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.user_call_processing_policy( | ||
| "[email protected]", | ||
| updates = { | ||
| "clidPolicy": "Use DN", | ||
| "emergencyClidPolicy": "Use DN", | ||
| "allowAlternateNumbersForRedirectingIdentity": "true", | ||
| "useGroupName": "false" | ||
| } | ||
| ) | ||
| ``` | ||
| {% endcode %} | ||
|
|
||
| ### Example Data Returned (Formatted) | ||
|
|
||
| ```json | ||
| { | ||
| "useUserCLIDSetting": False, | ||
| "useUserMediaSetting": False, | ||
| "useUserCallLimitsSetting": False, | ||
| "useUserDCLIDSetting": False, | ||
| "useUserTranslationRoutingSetting": False, | ||
| "useMaxSimultaneousCalls": True, | ||
| "maxSimultaneousCalls": 5, | ||
| "useMaxSimultaneousVideoCalls": True, | ||
| "maxSimultaneousVideoCalls": 5, | ||
| "useMaxCallTimeForAnsweredCalls": True, | ||
| "maxCallTimeForAnsweredCallsMinutes": 1440, | ||
| "useMaxCallTimeForUnansweredCalls": False, | ||
| "maxCallTimeForUnansweredCallsMinutes": 2, | ||
| "mediaPolicySelection": "No Restrictions", | ||
| "useMaxConcurrentRedirectedCalls": True, | ||
| "maxConcurrentRedirectedCalls": 5, | ||
| "useMaxFindMeFollowMeDepth": True, | ||
| "maxFindMeFollowMeDepth": 2, | ||
| "maxRedirectionDepth": 5, | ||
| "useMaxConcurrentFindMeFollowMeInvocations": True, | ||
| "maxConcurrentFindMeFollowMeInvocations": 2, | ||
| "clidPolicy": "Use DN", | ||
| "emergencyClidPolicy": "Use DN", | ||
| "allowAlternateNumbersForRedirectingIdentity": True, | ||
| "useGroupName": False, | ||
| "blockCallingNameForExternalCalls": False, | ||
| "enableDialableCallerID": False, | ||
| "allowConfigurableCLIDForRedirectingIdentity": True, | ||
| "allowDepartmentCLIDNameOverride": False, | ||
| "useUserPhoneListLookupSetting": False, | ||
| "enablePhoneListLookup": False, | ||
| "useMaxConcurrentTerminatingAlertingRequests": False, | ||
| "maxConcurrentTerminatingAlertingRequests": 10, | ||
| "includeRedirectionsInMaximumNumberOfConcurrentCalls": False, | ||
| "allowMobileDNForRedirectingIdentity": False, | ||
| "userId": "[email protected]" | ||
| } | ||
|
|
||
| ``` | ||
|
|
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,127 @@ | ||
| # 🙋♂️ POST - Group Hunt Group | ||
|
|
||
| Builds a hunt group (HG) in the specified group. | ||
|
|
||
| ### Parameters  | ||
|
|
||
| * service\_provider\_id (str): The service provider ID in which the target group is built. | ||
| * group\_id (str): The group ID where the HG should be built. | ||
| * service\_user\_id (str): The service user ID for the new HG. This must include the domain of the user. | ||
| * clid\_first\_name (str): The Calling Line ID first name. | ||
| * clid\_last\_name (str): The Calling Line ID last name. | ||
| * extension (str): The extension number for the HG. This must be entered as a string. | ||
| * payload (dict, optional): HG configuration data. | ||
| * agents (list, optional): List of user IDs (str) that should be assigned to the new HG. The user(s) must already exist in the group. | ||
| * policy (str, optional): Regular, Circular, Simultaneous, Uniform, Weighted. Defaults to Regular. | ||
| * no\_answer\_number\_of\_rings (int, optional): Defaults to 5. | ||
| * forward\_timeout\_seconds (int, optional): Defaults to 0. | ||
|
|
||
| ### Returns | ||
|
|
||
| * None: This method does not return any specific value. | ||
|
|
||
| ### How To Use: | ||
|
|
||
| ```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() | ||
|
|
||
| hunt_group_agents= [ | ||
| "[email protected]", | ||
| "[email protected]" | ||
| ] | ||
|
|
||
| my_api.post.group_hunt_group( | ||
| my_service_provider_id = "ServiceProviderID", | ||
| my_group_id = "GroupID", | ||
| service_user_id = "[email protected]", | ||
| clid_first_name = "odin", | ||
| clid_last_name = "mock.hg.2", | ||
| hunt_group_extension = "1234", | ||
| agents = hunt_group_agents, | ||
| policy = "Regular" | ||
| ) | ||
| ``` | ||
| ### Example Returned Data of Hunt Group (Formatted) | ||
|
|
||
| ```json | ||
| { | ||
| "serviceInstanceProfile": { | ||
| "name": "odin mock.hg.2", | ||
| "callingLineIdLastName": "mock.hg.2", | ||
| "callingLineIdFirstName": "odin", | ||
| "hiraganaLastName": "odin mock.hg.2", | ||
| "hiraganaFirstName": "Hunt Group", | ||
| "extension": "1234", | ||
| "language": "English", | ||
| "timeZone": "Europe/London", | ||
| "timeZoneDisplayName": "(GMT+01:00) Greenwich Mean Time", | ||
| "aliases": [] | ||
| }, | ||
| "policy": "Regular", | ||
| "huntAfterNoAnswer": False, | ||
| "noAnswerNumberOfRings": 5, | ||
| "forwardAfterTimeout": False, | ||
| "forwardTimeoutSeconds": 0, | ||
| "allowCallWaitingForAgents": False, | ||
| "useSystemHuntGroupCLIDSetting": False, | ||
| "includeHuntGroupNameInCLID": False, | ||
| "enableNotReachableForwarding": False, | ||
| "makeBusyWhenNotReachable": False, | ||
| "allowMembersToControlGroupBusy": False, | ||
| "enableGroupBusy": False, | ||
| "applyGroupBusyWhenTerminatingToAgent": False, | ||
| "serviceUserId": "[email protected]", | ||
| "resellerId": None, | ||
| "serviceProviderId": "ServiceProviderID", | ||
| "groupId": "GroupID", | ||
| "isEnterprise": True, | ||
| "agents": [ | ||
| { | ||
| "userId": "[email protected]", | ||
| "lastName": "1", | ||
| "firstName": "hunt_group_user", | ||
| "hiraganaLastName": "1", | ||
| "hiraganaFirstName": "hunt_group_user", | ||
| "weight": None, | ||
| "phoneNumber": None, | ||
| "extension": "111111", | ||
| "department": None, | ||
| "emailAddress": None, | ||
| "isPhoneNumberActivated": None, | ||
| "countryCode": None, | ||
| "nationalPrefix": None, | ||
| "departmentName": None, | ||
| "departmentType": None, | ||
| "parentDepartment": None, | ||
| "parentDepartmentType": None, | ||
| "groupId": "GroupID", | ||
| "groupName": "Group Name" | ||
| }, | ||
| { | ||
| "userId": "[email protected]", | ||
| "lastName": "2", | ||
| "firstName": "hunt_group_user", | ||
| "hiraganaLastName": "2", | ||
| "hiraganaFirstName": "hunt_group_user", | ||
| "weight": None, | ||
| "phoneNumber": None, | ||
| "extension": "222222", | ||
| "department": None, | ||
| "emailAddress": None, | ||
| "isPhoneNumberActivated": None, | ||
| "countryCode": None, | ||
| "nationalPrefix": None, | ||
| "departmentName": None, | ||
| "departmentType": None, | ||
| "parentDepartment": None, | ||
| "parentDepartmentType": None, | ||
| "groupId": "GroupID", | ||
| "groupName": "Group Name" | ||
| } | ||
| ] | ||
| } | ||
|
|
||
| ``` |
118 changes: 118 additions & 0 deletions
118
docs/docs/methods/trunk-groups/post-group-trunk-group.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,118 @@ | ||
| --- | ||
| description: api.post.group_trunk_group() | ||
| --- | ||
|
|
||
| # 🚿 POST - Group Trunk Group | ||
|
|
||
| Builds a Trunk Group (TG) in the specified group. Please note, several fields are set to have default values. Please see below. | ||
|
|
||
| ### Parameters  | ||
|
|
||
| * service\_provider\_id (str): Service provider ID for which the max active calls needs to be updated | ||
| * group\_id (str): The group ID where the HG should be built. | ||
| * trunk\_name (str): The name of the new TG. | ||
| * max\_active\_calls (str): The maximum active calls to be set on the TG. | ||
| * payload (dict, optional): Configuration for the TG. | ||
| * sip\_authentication\_username (str, optional): The SIP authentication username for the TG. This field is required if "requireAuthentication" in the payload is set to "true". | ||
| * sip\_authentication\_password (str, optional): The SIP authentication password for the TG. You can generate a password for this using get.sip_password_generator. This field is required if "requireAuthentication" in the payload is set to "true". | ||
|
|
||
| ### Returns | ||
|
|
||
| * Dict: Returns the Trunk Group profile. | ||
|
|
||
| ### Default Fields  | ||
|
|
||
| * "capacityExceededTrapInitialCalls":0, | ||
| * "capacityExceededTrapOffsetCalls":0, | ||
| * "clidSourceForScreenedCallsPolicy":"Profile Name Profile Number", | ||
| * "continuousOptionsSendingIntervalSeconds":30, | ||
| * "failureOptionsSendingIntervalSeconds":10, | ||
| * "failureThresholdCounter":1, | ||
| * "invitationTimeout":6, | ||
| * "inviteFailureThresholdCounter":1, | ||
| * "inviteFailureThresholdWindowSeconds":30, | ||
| * "pilotUserCallOptimizationPolicy":"Optimize For User Services", | ||
| * "pilotUserCallingLineAssertedIdentityPolicy":"Unscreened Originating Calls", | ||
| * "pilotUserCallingLineIdentityForEmergencyCallsPolicy":"No Calls", | ||
| * "pilotUserCallingLineIdentityForExternalCallsPolicy":"No Calls", | ||
| * "pilotUserChargeNumberPolicy":"No Calls", | ||
| * "requireAuthentication":"false", | ||
| * "successThresholdCounter":1, | ||
| * "useSystemUserLookupPolicy":"true", | ||
| * "userLookupPolicy":"Basic" | ||
|
|
||
|
|
||
| ### 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.group_trunk_group( | ||
| my_service_provider_id = "ServiceProviderID", | ||
| my_group_id = "GroupID", | ||
| my_trunk_group_name = "Odin Test Trunk" | ||
| max_active_calls = 2 | ||
| ) | ||
| ``` | ||
| {% endcode %} | ||
|
|
||
| ### Example Data Returned (Formatted) | ||
|
|
||
| ```json | ||
| { | ||
| "maxActiveCalls": 2, | ||
| "enableBursting": False, | ||
| "capacityExceededTrapInitialCalls": 0, | ||
| "capacityExceededTrapOffsetCalls": 0, | ||
| "invitationTimeout": 6, | ||
| "requireAuthentication": False, | ||
| "allowTerminationToTrunkGroupIdentity": False, | ||
| "allowTerminationToDtgIdentity": False, | ||
| "includeTrunkGroupIdentity": False, | ||
| "includeDtgIdentity": False, | ||
| "includeTrunkGroupIdentityForNetworkCalls": False, | ||
| "includeOtgIdentityForNetworkCalls": False, | ||
| "enableNetworkAddressIdentity": False, | ||
| "allowUnscreenedCalls": False, | ||
| "allowUnscreenedEmergencyCalls": False, | ||
| "pilotUserCallingLineIdentityForExternalCallsPolicy": "No Calls", | ||
| "pilotUserChargeNumberPolicy": "No Calls", | ||
| "routeToPeeringDomain": False, | ||
| "prefixEnabled": False, | ||
| "statefulReroutingEnabled": False, | ||
| "sendContinuousOptionsMessage": False, | ||
| "continuousOptionsSendingIntervalSeconds": 30, | ||
| "failureOptionsSendingIntervalSeconds": 10, | ||
| "failureThresholdCounter": 1, | ||
| "successThresholdCounter": 1, | ||
| "inviteFailureThresholdCounter": 1, | ||
| "inviteFailureThresholdWindowSeconds": 30, | ||
| "trunkGroupState": "Available", | ||
| "pilotUserCallingLineAssertedIdentityPolicy": "Unscreened Originating Calls", | ||
| "useSystemCallingLineAssertedIdentityPolicy": False, | ||
| "totalActiveIncomingCalls": 0, | ||
| "totalActiveOutgoingCalls": 0, | ||
| "pilotUserCallOptimizationPolicy": "Optimize For User Services", | ||
| "clidSourceForScreenedCallsPolicy": "Profile Name Profile Number", | ||
| "useSystemCLIDSourceForScreenedCallsPolicy": False, | ||
| "userLookupPolicy": "Basic", | ||
| "useSystemUserLookupPolicy": True, | ||
| "pilotUserCallingLineIdentityForEmergencyCallsPolicy": "No Calls", | ||
| "implicitRegistrationSetSupportPolicy": "Disabled", | ||
| "useSystemImplicitRegistrationSetSupportPolicy": True, | ||
| "sipIdentityForPilotAndProxyTrunkModesPolicy": "User", | ||
| "useSystemSIPIdentityForPilotAndProxyTrunkModesPolicy": True, | ||
| "useSystemSupportConnectedIdentityPolicy": True, | ||
| "supportConnectedIdentityPolicy": "Disabled", | ||
| "useSystemOptionsMessageResponseStatusCodes": True, | ||
| "serviceProviderId": "ServiceProviderID", | ||
| "groupId": "GroupID", | ||
| "name": "Odin Test Trunk", | ||
| "users": [] | ||
| } | ||
|
|
||
| ``` |
Oops, something went wrong.